Project

General

Profile

ErrataDesign » History » Version 9

Kyle Baker, 12/15/2014 01:27 PM

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