Bug 2112004 - [RFE] Openscap documentation
Summary: [RFE] Openscap documentation
Keywords:
Status: RELEASE_PENDING
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Documentation
Version: 6.11.1
Hardware: x86_64
OS: Linux
medium
medium
Target Milestone: Unspecified
Assignee: Zuzana Lena Ansorgova
QA Contact:
URL:
Whiteboard:
: 1928849 2177292 (view as bug list)
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-07-28 15:20 UTC by Kenny Tordeurs
Modified: 2023-07-14 11:38 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed:
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker SAT-15328 0 None None None 2023-01-31 17:31:29 UTC
Red Hat Issue Tracker SAT-18182 0 None None None 2023-06-10 07:17:31 UTC

Internal Links: 2177292

Description Kenny Tordeurs 2022-07-28 15:20:34 UTC
Document URL: 
https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/managing_hosts/index
https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/installing_satellite_server_in_a_connected_network_environment/index#Enabling_the_Client_Repository_satellite

Section Number and Name: 

Describe the issue: 
There is no mention about the rubygem-foreman_scap_client package being shipped in the new client repository.

Suggestions for improvement: 
Add steps for Openscap and that the package is shipped in the Client repository

Additional information: 
https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/administering_red_hat_satellite/index#Configuring_a_Host_for_OpenSCAP_admin is providing some steps but they are with puppet, I think it will be useful to change this to Ansible by default and explain that without the client repo the package cannot be installed on the systems.

Comment 2 Evgeni Golov 2022-12-02 12:13:42 UTC
A BZ with multiple requests in it is not really actionable :(

I see the following asks:

> Adding "rubygem-foreman_scap_client" to the list of packages provided by the "Client" repo as done for k-agent and others in https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/installing_satellite_server_in_a_connected_network_environment/index#Enabling_the_Client_Repository_satellite

I think this is a bad idea, that means that the docs need to play catch-up all the time we add things there (like we now did for 6.12 with the mqtt framework, or the fact that puppet is really "puppet-agent").
Instead I'd reword that to something like "The Satellite Client 6 repository provides various packages responsible for integration of clients registered to Satellite Server."


> Adding an OpenSCAP section to https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/managing_hosts/index

This sounds like a good idea, but will certainly require some work, as there is currently zero content about OpenSCAP in that document.
On the other hand, there is https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/administering_red_hat_satellite/index#Configuring_a_Host_for_OpenSCAP_admin which talks about all that, but it's in the Admin guide, not Host guide, which people could find confusing (as that's a thing you do on hosts at the end)

> Adding Ansible instructions to https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/administering_red_hat_satellite/index#Configuring_a_Host_for_OpenSCAP_admin

Again, good idea, and can be achieved today with a rather simple extension of the docs that will yield big gains.



Personally, I'd start with the last point. Then clean up the "client repo contents" (first point) and then start thinking whether re-shuffling content is a good idea or not (second point).

Comment 3 Kenny Tordeurs 2022-12-02 19:40:45 UTC
Hey Evgeni \o,

I just captured all the hurdles I saw and wanted to be sure we capture them all to try and improve them.
Feel free to address whatever is possible and we can of course split this off into multiple BZ's that's not an issue.

Thanks

Comment 4 Zuzana Lena Ansorgova 2022-12-05 12:53:11 UTC
Btw, there's also https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/administering_red_hat_satellite/index#Managing_Security_Compliance_admin

Perhaps it should be reviewed as well and maybe the two chapters should be merged?

Comment 10 Zuzana Lena Ansorgova 2023-03-14 15:19:03 UTC
*** Bug 2177292 has been marked as a duplicate of this bug. ***

Comment 11 Zuzana Lena Ansorgova 2023-04-25 10:28:34 UTC
*** Bug 1928849 has been marked as a duplicate of this bug. ***

Comment 14 Zuzana Lena Ansorgova 2023-04-28 00:05:19 UTC
First PR of multiple: https://github.com/theforeman/foreman-documentation/pull/2173

Comment 16 Zuzana Lena Ansorgova 2023-06-28 17:05:08 UTC
This will be published with the planned Satellite 6.14 GA.


Note You need to log in before you can comment on or make changes to this bug.