Bug 1906164
| Summary: | [RFE] Provide erratum.synopsis option to Applicable errata Reporting template | |||
|---|---|---|---|---|
| Product: | Red Hat Satellite | Reporter: | Steffen Froemer <sfroemer> | |
| Component: | Reporting | Assignee: | Marek Hulan <mhulan> | |
| Status: | CLOSED ERRATA | QA Contact: | Lukáš Hellebrandt <lhellebr> | |
| Severity: | high | Docs Contact: | ||
| Priority: | unspecified | |||
| Version: | 6.8.0 | CC: | dmatoule, ehelms, mhulan, oprazak, pcreech | |
| Target Milestone: | 6.9.0 | Keywords: | FutureFeature, Triaged | |
| Target Release: | Unused | |||
| Hardware: | x86_64 | |||
| OS: | Linux | |||
| Whiteboard: | ||||
| Fixed In Version: | tfm-rubygem-katello-3.18.1.1-1 | Doc Type: | If docs needed, set a value | |
| Doc Text: | Story Points: | --- | ||
| Clone Of: | ||||
| : | 1933162 (view as bug list) | Environment: | ||
| Last Closed: | 2021-04-21 13:24:23 UTC | Type: | Bug | |
| Regression: | --- | Mount Type: | --- | |
| Documentation: | --- | CRM: | ||
| Verified Versions: | Category: | --- | ||
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | ||
| Cloudforms Team: | --- | Target Upstream Version: | ||
| Embargoed: | ||||
Hello, I think it would be better to keep the report up to the user, it seems they are interested in host, erratum and synopsis, while our existing applicable report includes many more columns. However we should definitely add erratum title and summary to enabled methods once can use in the report. The report in the comment would then work, just the synopsis will be called title (like in the API) Would that work? I'm opening the patch with this right now. This would be easy to backport. Created redmine issue https://projects.theforeman.org/issues/31530 from this bug Upstream bug assigned to mhulan Upstream bug assigned to mhulan Marek yes. There is no requirement in changing the default report. Having the options available for custom reports is totally enough. Moving this bug to POST for triage into Satellite since the upstream issue https://projects.theforeman.org/issues/31530 has been resolved. Verified with Sat 6.9.0 snap 12.
It's now possible to use `erratum.title` in the report template, which contains synopsis of the erratum, e.g. "Important: freetype security update". Example based on Applicable Errata report template:
```
<%#
name: Host - Applicable Errata
snippet: false
template_inputs:
- name: Hosts filter
required: false
input_type: user
description: Limit the report only on hosts found by this search query. Keep empty
for report on all available hosts.
advanced: false
value_type: search
resource_type: Host
- name: Errata filter
required: false
input_type: user
description: Limit the report only on errata found by this search query. Keep empty
for report on all available errata.
advanced: false
model: ReportTemplate
require:
- plugin: katello
 version: 3.16.0
-%>
<%- report_headers 'Host', 'Operating System', 'Environment', 'Erratum', 'Type', 'Published', 'Applicable since', 'Severity', 'Packages', 'CVEs', 'Reboot suggested' -%>
<%- load_hosts(search: input('Hosts filter'), preload: [:operatingsystem, :lifecycle_environment]).each_record do |host| -%>
<%- host_applicable_errata_filtered(host, input('Errata filter')).each do |erratum| -%>
<%- report_row(
'Host': host.name,
'Operating System': host.operatingsystem,
'Environment': host.lifecycle_environment,
'Erratum': erratum.errata_id,
'Type': erratum.errata_type,
'Published': erratum.issued,
'Applicable since': erratum.created_at,
'Severity': erratum.severity,
'Packages': erratum.package_names,
'CVEs': erratum.cves.map { |c| c.cve_id },
'Reboot suggested': erratum.reboot_suggested,
'Synopsis': erratum.title
) -%>
<%- end -%>
<%- end -%>
<%= report_render -%>
```
Since the problem described in this bug report should be resolved in a recent advisory, it has been closed with a resolution of ERRATA. For information on the advisory (Moderate: Satellite 6.9 Release), and where to find the updated files, follow the link below. If the solution does not work for you, open a new bug report. https://access.redhat.com/errata/RHSA-2021:1313 |
1. Proposed title of this feature request [RFE] Provide erratum.synopsis option to Applicable errata Reporting template 3. What is the nature and description of the request? To know what kind of errata the specific errata is type of, it's expected to have synopsis reflected as well. 4. Why does the customer need this? (List the business requirements here) Customers process with additional tools and CMDB does require the synopsis content. This feature was available in satellite-5 and is a requirement to satellite-6 as full sat-5 replacement 5. How would the customer like to achieve this? (List the functional requirements here) The reporting engine should provide an option for Katello::Erratum like - erratum.synopsis 6. For each functional requirement listed, specify how Red Hat and the customer can test to confirm the requirement is successfully implemented. Proposal template <%- report_headers 'Host', 'Erratum', 'Patch Synopsis' -%> <%- load_hosts(search: input('Hosts filter'), includes: [:operatingsystem, :applicable_errata, :lifecycle_environment]).each_record do |host| -%> <%- host_applicable_errata_filtered(host, input('Errata filter')).each do |erratum| -%> <%- report_row( 'Host': host.name, 'Erratum': erratum.errata_id, 'Patch Synopsis': erratum.synopsis, ) -%> <%- end -%> <%- end -%> Expected result (for example erratum https://access.redhat.com/errata/RHSA-2020:4060) Host,Erratum,Patch Synopsis host.example.com,RHSA-2020:4060,Important: kernel security, bug fix, and enhancement update 7. Is there already an existing RFE upstream or in Red Hat Bugzilla? no 8. Does the customer have any specific timeline dependencies and which release would they like to target (i.e. RHEL5, RHEL6)? asap 9. Is the sales team involved in this request and do they have any additional input? no 10. List any affected packages or components. Satellite report engine 11. Would the customer be able to assist in testing this functionality if implemented? yes, workarounds or pre-releases are welcome