Project

General

Profile

ErrataDesign » History » Revision 6

Revision 5 (Kyle Baker, 12/04/2014 09:46 AM) → Revision 6/10 (Kyle Baker, 12/04/2014 11:21 AM)

h1. Errata Management 

 h2. Summary 

 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.  

 For these requirements we use these definitions: 
 * Applicable: An errata will be applied if the host runs yum update 
 * Available: An errata has been synced, but not promoted to where a host can consume it 
 * Present: An errata has been synced, but would never be applied to a host by yum update. 

 h2. Targeted Release 

 Foreman 1.7 1.8 / Katello 2.2 

 h2. Trackers 

 -- 

 h2. Targeted Persona 

 System Engineer  

 h2. Status 

 h3. User Stories 

 Owner - David Caplan 
 Status - Finished 
 Blockers - None 

 h3. Requirements  

 Owner - Mike Mccune / David Caplan 
 Status - Done 
 Blockers    - None 

 h3. Wireframes 

 Owner - Kyle Baker 
 Status - Done 
 Blockers - None 
 Last updated 10/29/2014 - https://dl.dropboxusercontent.com/u/5892944/Errata%20Management-2014-10-29.pdf 

 h3. Development Stories 

 Owner - Walden Raines 
 Status - In Progress 
 Expected Delivery - TBD 
 Blockers - None 

 h2. Documentation 

 h3. User Stories 

 * 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. 
 
 h3. Requirements 

 1. Users should be able to subscribe to email notifications from Satellite 6 

 2. The following notification types should be supported for Errata: 
 * Per Sync Emails. This notification shows new errata which have been synced and which environemnts/hosts the errata are applicable for.  
 ** One email is sent per sync 
 ** 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.  
 * Per Promotion. This notification states states new errata have been promoted to an environment and the hosts which are impacted.  
 ** This should be one email per promotion 
 ** Plain Text Email should be a list of Errata that were synced with descriptions and links to the errata detail page 
 ** Users should be able to select which environment I can get notifications on 
 * My Visible Host Email: This is a daily email for "My Hosts" 
 ** MY Hosts should be the hosts which the user can see via RBAC, grouped by organization 
 ** 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 
 ** System Name should be a link the system detail page. 

 3. Existing Puppet reports should be an email notification type that users can subscribe to. 

 4. Users should be able to subscribe to errata notifications 
 * see also https://bugzilla.redhat.com/show_bug.cgi?id=766757 
 * Users should be able to limit the environments they receive per promotion notifications on. 
 * Users should be able to select, or not, each notification type 
 * RBAC should control access to this selection page. 

 5. Errata Page 
 * The Errata Dashboard Widget should show the newly synced errata. Clicking on dashboard widget should take user to an errata page 
 * Errata Page 
 ** Should be able to filter errata by product 
 ** Should be able to filter by errata type 
 ** Should be able to order all errata by date 
 ** Should be able to search by CVE 
 *** This will meet https://bugzilla.redhat.com/show_bug.cgi?id=1124992 
 ** The listings should show product, number of systems impacted, updated, short description 
 *** The number be clickable and take you to the bulk action page for those systems with that errata selected 
 ** Should be able to get details on the errata including what hosts will be impacted (globally or per environment) 

 6. Host View 
 * 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 
 ** This will meet    https://bugzilla.redhat.com/show_bug.cgi?id=588876 
 ** This will meet https://bugzilla.redhat.com/show_bug.cgi?id=1118474 
 ** This will meet https://bugzilla.redhat.com/show_bug.cgi?id=1126570 
 ** This sill meet https://bugzilla.redhat.com/show_bug.cgi?id=538539 
 * It should be possible to install the errata from this view. 

 7. The content host list should include the applicable errata count. 

 8. Environment / Content View 
 * It should be possible to view an Environment and Content View, and see the available errata based on the previous environement or the library 

 9. Email sending should support local sendmail or SMTP. 

 10. Hammer should be updated to expose all features 
 * Hammer should support finding errata detail regardless of product (https://bugzilla.redhat.com/show_bug.cgi?id=910078) 


 h3. Development Tasks 

 * Errata Management: 
 ** http://projects.theforeman.org/projects/katello/issues?query_id=64 
 * Errata Management Email Notifications 
 ** http://projects.theforeman.org/projects/katello/issues?query_id=67 
 * Errata Management Environment/Content Views 
 ** http://projects.theforeman.org/projects/katello/issues?query_id=68 
 * Errata Management Errata View 
 ** http://projects.theforeman.org/projects/katello/issues?query_id=66 
 * Errata Management Host View 
 ** http://projects.theforeman.org/projects/katello/issues?query_id=65 
 * Email Features: 
 ** http://projects.theforeman.org/projects/katello/issues?query_id=67 

 h3. Impacted 

 # Katello: Main Features 
 # Foreman: Notification Engine 
 # Bastion: Content Browser 

 h3. Future Requirements (specifically not in) 

 # Online editing of errata notifications 
 # Unique smtp servers per org. 
 # SMS / Text Notification 
 # Determining what errata would be pulled down if you synced 

 h3. More Information 

 # 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. 
 # Dan Lahs Portal Requirements: https://mojo.redhat.com/docs/DOC-968347 
 # Customer Portal Link: https://access.redhat.com/comment/808703