Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1917835

Summary: Significantly improve compliance operator documentation
Product: OpenShift Container Platform Reporter: Andreas Karis <akaris>
Component: DocumentationAssignee: Ashley Hardin <ahardin>
Status: CLOSED CURRENTRELEASE QA Contact: Xiaoli Tian <xtian>
Severity: unspecified Docs Contact: Vikram Goyal <vigoyal>
Priority: unspecified    
Version: 4.6CC: ahardin, aos-bugs, jokerman
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2021-04-09 21:23:54 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:

Description Andreas Karis 2021-01-19 13:53:08 UTC
Document URL: 
https://docs.openshift.com/container-platform/4.6/security/compliance_operator/compliance-operator-understanding.html

Describe the issue: 

Currently, admins who want to use the compliance operator must refer to several different resources in order to find an install and getting started guide. I used the following 4 resources:

    Documentation: https://docs.openshift.com/container-platform/4.6/security/compliance_operator/compliance-operator-understanding.html
    Blog part 1: https://www.openshift.com/blog/how-does-compliance-operator-work-for-openshift-part-1
    Blog part 2: https://www.openshift.com/blog/how-does-compliance-operator-work-for-openshift-part-2
    Operator README: https://github.com/openshift/compliance-operator

We need to improve the compliance operator documentation significantly.

At the moment, the documentation goes into very specific corner cases, but it does not answer basic questions such as:

* how to install the operator via GUI and CLI
* How to run a scan for the above profiles (cluster and nodes)
* How to get the scan report
* How to analyse the scan report
* How to remediate the compliance scan (specific rule or all rules)
* How to revert to the original configuration

Version-Release number of selected component (if applicable):
4.6

Suggestions for improvement: 

I created a full walk through of the aforementioned points and I'd expect our documentation to be of similar scope (plus the more specific points which are already part of our documentation): https://access.redhat.com/solutions/5712421

Comment 1 Ashley Hardin 2021-04-08 20:58:20 UTC
WIP: https://github.com/openshift/openshift-docs/pull/29673