Project

General

Profile

ErrataDesign » History » Version 5

Kyle Baker, 12/04/2014 09:46 AM

1 2 Kyle Baker
h1. Errata Management
2 1 Mike McCune
3 2 Kyle Baker
h2. Summary
4 1 Mike McCune
5 2 Kyle Baker
Errata Management should be improved so that a user can know when new errata have been brought down, and can view the relationship between errata and hosts. Errata Notifications should be simplified so that customers recieve fewer coarse grained emails, rather then more fine grained emails. 
6 1 Mike McCune
7 2 Kyle Baker
For these requirements we use these definitions:
8
* Applicable: An errata will be applied if the host runs yum update
9
* Available: An errata has been synced, but not promoted to where a host can consume it
10
* Present: An errata has been synced, but would never be applied to a host by yum update.
11 1 Mike McCune
12 2 Kyle Baker
h2. Targeted Release
13 1 Mike McCune
14 3 Kyle Baker
Foreman 1.8 / Katello 2.2
15 1 Mike McCune
16 2 Kyle Baker
h2. Trackers
17 1 Mike McCune
18 4 Kyle Baker
--
19 1 Mike McCune
20 2 Kyle Baker
h2. Targeted Persona
21 1 Mike McCune
22 3 Kyle Baker
System Engineer 
23 1 Mike McCune
24 2 Kyle Baker
h2. Status
25 1 Mike McCune
26
h3. User Stories
27 2 Kyle Baker
28 3 Kyle Baker
Owner - David Caplan
29
Status - Finished
30 1 Mike McCune
Blockers - None
31
32
h3. Requirements 
33 2 Kyle Baker
34 3 Kyle Baker
Owner - Mike Mccune / David Caplan
35
Status - Done
36
Blockers  - None
37 1 Mike McCune
38 2 Kyle Baker
h3. Wireframes
39 1 Mike McCune
40 3 Kyle Baker
Owner - Kyle Baker
41
Status - Done
42
Blockers - None
43
Last updated 10/29/2014 - https://dl.dropboxusercontent.com/u/5892944/Errata%20Management-2014-10-29.pdf
44 1 Mike McCune
45
h3. Development Stories
46
47 3 Kyle Baker
Owner - Walden Raines
48
Status - In Progress
49 1 Mike McCune
Expected Delivery - TBD
50
Blockers - None
51
52
h2. Documentation
53
54
h3. User Stories
55
56
* Please include a story describing how the user would transverse this feature including the workflow. This story ideally would include what their actions would be before and after completion of the task.
57
 
58
h3. Requirements
59
60 5 Kyle Baker
1. Users should be able to subscribe to email notifications from Satellite 6
61 1 Mike McCune
62 5 Kyle Baker
2. The following notification types should be supported for Errata:
63
* Per Sync Emails. This notification shows new errata which have been synced and which environemnts/hosts the errata are applicable for. 
64
** One email is sent per sync
65
** The email is a plain Text Email should be a list of Errata that were synced with descriptions and links to the errata detail page. 
66
* Per Promotion. This notification states states new errata have been promoted to an environment and the hosts which are impacted. 
67
** This should be one email per promotion
68
** Plain Text Email should be a list of Errata that were synced with descriptions and links to the errata detail page
69
** Users should be able to select which environment I can get notifications on
70
* My Visible Host Email: This is a daily email for "My Hosts"
71
** MY Hosts should be the hosts which the user can see via RBAC, grouped by organization
72
** This email is a plain text email should be a list of the systems, with count of available and count of  applicable errata by types
73
** System Name should be a link the system detail page.
74
75
3. Existing Puppet reports should be an email notification type that users can subscribe to.
76
77
4. Users should be able to subscribe to errata notifications
78
* see also https://bugzilla.redhat.com/show_bug.cgi?id=766757
79
* Users should be able to limit the environments they receive per promotion notifications on.
80
* Users should be able to select, or not, each notification type
81
* RBAC should control access to this selection page.
82
83
5. Errata Page
84
* The Errata Dashboard Widget should show the newly synced errata. Clicking on dashboard widget should take user to an errata page
85
* Errata Page
86
** Should be able to filter errata by product
87
** Should be able to filter by errata type
88
** Should be able to order all errata by date
89
** Should be able to search by CVE
90
*** This will meet https://bugzilla.redhat.com/show_bug.cgi?id=1124992
91
** The listings should show product, number of systems impacted, updated, short description
92
*** The number be clickable and take you to the bulk action page for those systems with that errata selected
93
** Should be able to get details on the errata including what hosts will be impacted (globally or per environment)
94
95
6. Host View
96
* It should be possible to view a host, and see the errata applicable from the current environment and available from the previous and the library
97
** This will meet  https://bugzilla.redhat.com/show_bug.cgi?id=588876
98
** This will meet https://bugzilla.redhat.com/show_bug.cgi?id=1118474
99
** This will meet https://bugzilla.redhat.com/show_bug.cgi?id=1126570
100
** This sill meet https://bugzilla.redhat.com/show_bug.cgi?id=538539
101
* It should be possible to install the errata from this view.
102
103
7. The content host list should include the applicable errata count.
104
105
8. Environment / Content View
106
* It should be possible to view an Environment and Content View, and see the available errata based on the previous environement or the library
107
108
9. Email sending should support local sendmail or SMTP.
109
110
10. Hammer should be updated to expose all features
111
* Hammer should support finding errata detail regardless of product (https://bugzilla.redhat.com/show_bug.cgi?id=910078)
112
113
114 4 Kyle Baker
h3. Development Tasks
115
116
* Errata Management:
117
** http://projects.theforeman.org/projects/katello/issues?query_id=64
118
* Errata Management Email Notifications
119
** http://projects.theforeman.org/projects/katello/issues?query_id=67
120
* Errata Management Environment/Content Views
121
** http://projects.theforeman.org/projects/katello/issues?query_id=68
122
* Errata Management Errata View
123
** http://projects.theforeman.org/projects/katello/issues?query_id=66
124
* Errata Management Host View
125
** http://projects.theforeman.org/projects/katello/issues?query_id=65
126
* Email Features:
127
** http://projects.theforeman.org/projects/katello/issues?query_id=67
128 3 Kyle Baker
129
h3. Impacted
130 1 Mike McCune
131 5 Kyle Baker
# Katello: Main Features
132
# Foreman: Notification Engine
133
# Bastion: Content Browser
134
135 3 Kyle Baker
h3. Future Requirements (specifically not in)
136 1 Mike McCune
137 5 Kyle Baker
# Online editing of errata notifications
138
# Unique smtp servers per org.
139
# SMS / Text Notification
140
# Determining what errata would be pulled down if you synced
141
142 1 Mike McCune
h3. More Information
143 5 Kyle Baker
144
# Tracking Bug: https://bugzilla.redhat.com/show_bug.cgi?id=1130651- It is believed that all bugs on this link will be met by the design above.
145
# Dan Lahs Portal Requirements: https://mojo.redhat.com/docs/DOC-968347
146
# Customer Portal Link: https://access.redhat.com/comment/808703