Updating Compliance Operator docs #29673

ahardin-rh · 2021-02-22T22:18:29Z

Preview Build: https://deploy-preview-29673--osdocs.netlify.app/openshift-enterprise/latest/security/compliance_operator/compliance-operator-installation.html

Addresses:

netlify · 2021-02-22T22:19:52Z

Deploy preview for osdocs ready!

Built with commit 344aa99

https://deploy-preview-29673--osdocs.netlify.app

security/compliance_operator/compliance-operator-installation.adoc

JAORMX

nice!!

ahardin-rh · 2021-03-31T20:54:35Z

@pdhamdhe Please provide QE review. Thank you!

JAORMX

Everything looks great! Just did a small comment and I think this is good to go.

modules/running-compliance-scans.adoc

modules/compliance-filtering-failed-results.adoc

xiaojiey · 2021-04-06T06:35:00Z

modules/compliance-operator-cli-installation.adoc

for the subscription, there is an important field called "channel":
a. Run the following command to set the OpenShift Container Platform major and minor version as an environment variable, which is used as the channel value in the next step.
OC_VERSION=$(oc version -o yaml | grep openshiftVersion | grep -o '[0-9]*[.][0-9]*' | head -1)
b. Create the Subscription object YAML file by running:

---- apiVersion: operators.coreos.com/v1alpha1 kind: Subscription metadata: name: compliance-operator-sub namespace: openshift-compliance spec: channel: "${OC_VERSION}" installPlanApproval: Automatic name: compliance-operator source: redhat-operators sourceNamespace: openshift-marketplace ----

It would be good if we mention channel while creating subscription but it is not mandatory. We can create subscription without mentioning channel and operator will get deployed using defaultChannel

$ oc get packagemanifest compliance-operator -oyaml |grep defaultChannel defaultChannel: "4.6"

@pdhamdhe If works for 4.6. What if a 4.7 cluster? It will have 2 packagemanifests(one for 4.6 and the other one for 4.7). If so, for fresh install, it is better to recommend users to use OCP version instead.

@xiaojiey Jfyi.. By default there will be only one packagemanifest for each ocp version for operator. So on 4.7 cluster, the compliance operator packagemanifest will only have defaultChannel : "4.7" . I was able to installed operator on both the cluster i.e 4.6 & 4.7 using the subscription yaml file which is mentioned in documentation. Though, I am fine with both the methods.

xiaojiey · 2021-04-06T06:37:40Z

modules/compliance-profilebundle.adoc

‘ProfileBundle’ is much reasonable, as it is a CR name.

pdhamdhe-zz · 2021-04-06T07:32:14Z

modules/compliance-operator-cli-installation.adoc

No need to apply the file if we are creating namespace resource using $ oc create -f <file-name>.yaml and step 2 can be merged in step 1

pdhamdhe-zz · 2021-04-06T11:57:44Z

modules/running-compliance-scans.adoc

This is ScanSetting object. In point 5 & 6, it is mentioned scan setting binding, please make correction.

Also ScanSetting runs scans at 01:00 everyday not periodically every hour.

pdhamdhe-zz · 2021-04-06T12:10:39Z

modules/running-compliance-scans.adoc

It would be good if we add -n openshift-compliance in all command mentioned in this section.

pdhamdhe-zz · 2021-04-06T12:22:45Z

modules/compliance-filtering-failed-results.adoc

Correct command would be :
$ oc get compliancecheckresults -l 'compliance.openshift.io/check-status=FAIL,compliance.openshift.io/automated-remmediation

pdhamdhe-zz · 2021-04-06T12:23:47Z

modules/compliance-filtering-failed-results.adoc

Also here, please update the selector to compliance.openshift.io/check-status=FAIL

lbarbeevargas

This reworking of the Compliance Operator section looks great. I left feedback for general guidelines adherence and minimalism/simplification purposes.

It looks like there is a mix of command lead-in sentences (this inconsistency is present through the OCP docs), so I gave some varying feedback depending on the assembly. Examples:

To list all failing checks that can be remediated automatically , run:
Search for any outdated remediations:
Create a namespace object YAML file by running:

For the sake of minimalism, I think the second example above works best.

lbarbeevargas · 2021-04-05T20:10:57Z

security/compliance_operator/compliance-scans.adoc

s/Compliance Operator Scans/Compliance Operator scans/

lbarbeevargas · 2021-04-05T20:13:06Z

security/compliance_operator/compliance-operator-installation.adoc

I think it would be helpful in this intro sentence to say "Compliance Operator."
s/Before you can use the Operator, you must ensure it is deployed in the cluster./Before you can use the Compliance Operator, you must ensure that it is deployed in the cluster./

lbarbeevargas · 2021-04-05T20:17:57Z

modules/compliance-operator-console-installation.adoc

In the "not installed successfully" section below, it says to "Navigate to the Operators -> Installed Operators page." Is it important in this first verification step to also include Operators in the navigation directions?

lbarbeevargas · 2021-04-05T20:19:31Z

modules/compliance-operator-console-installation.adoc

Might be good to specify the "Compliance Operator" here in case there are other Operators installed.
s/the Operator/the Compliance Operator/

lbarbeevargas · 2021-04-05T20:27:15Z

modules/compliance-operator-cli-installation.adoc

s/namespace/Namespace/

lbarbeevargas · 2021-04-06T19:25:11Z

modules/compliance-auto-update-remediations.adoc

Is this a Procedure module? If so, you can add .Procedure with a single bullet (or two bullets because this isn't necessarily a sequence).

lbarbeevargas · 2021-04-06T19:32:53Z

modules/compliance-filtering-failed-results.adoc

Is this a Procedure or Concept module? If Procedure, you can add .Procedure and then have bullets for each potential check? If Concept, I think the rest of the module looks okay as is, but you could change the title to something like "Filters for failed compliance check results".

lbarbeevargas · 2021-04-06T19:36:44Z

modules/compliance-filtering-failed-results.adoc

s/To list checks that belong to a specific suite, run:/List checks that belong to a specific suite:/

Similar rewording suggestion applies to the other commands in this module (for minimalism and consistency across the Compliance Operator book).

lbarbeevargas · 2021-04-06T19:38:37Z

modules/compliance-filtering-failed-results.adoc

Might be a good candidate to split the command into two lines with \.

lbarbeevargas · 2021-04-06T19:38:49Z

modules/compliance-filtering-failed-results.adoc

Might be a good candidate to split the command into two lines with \.

ahardin-rh · 2021-04-08T20:52:32Z

/cherrypick enterprise-4.6

ahardin-rh · 2021-04-08T20:52:46Z

/cherrypick enterprise-4.7

ahardin-rh · 2021-04-08T20:52:58Z

/cherrypick enterprise-4.8

openshift-cherrypick-robot · 2021-04-08T20:53:12Z

@ahardin-rh: new pull request created: #31436

Details

In response to this:

/cherrypick enterprise-4.6

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

openshift-cherrypick-robot · 2021-04-08T20:53:24Z

@ahardin-rh: new pull request created: #31437

Details

In response to this:

/cherrypick enterprise-4.7

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

openshift-cherrypick-robot · 2021-04-08T20:53:36Z

@ahardin-rh: new pull request created: #31438

Details

In response to this:

/cherrypick enterprise-4.8

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

ahardin-rh added branch/enterprise-4.6 branch/enterprise-4.7 labels Feb 22, 2021

ahardin-rh added this to the Next Release milestone Feb 22, 2021

ahardin-rh self-assigned this Feb 22, 2021

ahardin-rh requested review from aburdenthehand, codyhoag, jeana-redhat and vikram-redhat as code owners February 22, 2021 22:18

openshift-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 22, 2021

ahardin-rh added the branch/enterprise-4.8 label Feb 24, 2021

JAORMX suggested changes Mar 8, 2021

View reviewed changes

security/compliance_operator/compliance-operator-installation.adoc Outdated Show resolved Hide resolved

security/compliance_operator/compliance-operator-installation.adoc Outdated Show resolved Hide resolved

ahardin-rh force-pushed the cmp-operator-updates branch from ab972d0 to 2d22b19 Compare March 10, 2021 21:56

JAORMX suggested changes Mar 11, 2021

View reviewed changes

ahardin-rh mentioned this pull request Mar 17, 2021

[enterprise-4.7] Issue in file security/compliance_operator/compliance-operator-understanding.adoc #30514

Closed

ahardin-rh force-pushed the cmp-operator-updates branch from 2d22b19 to ff9c0fc Compare March 30, 2021 21:03

JAORMX approved these changes Mar 31, 2021

View reviewed changes

ahardin-rh force-pushed the cmp-operator-updates branch from ff9c0fc to d2a33a4 Compare March 31, 2021 19:29

ahardin-rh mentioned this pull request Mar 31, 2021

[enterprise-4.6] Issue in file security/compliance_operator/compliance-operator-understanding.adoc #27182

Closed

ahardin-rh changed the title ~~[WIP]Updating Compliance Operator docs~~ Updating Compliance Operator docs Mar 31, 2021

openshift-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 31, 2021

ahardin-rh requested a review from pdhamdhe-zz March 31, 2021 20:54

JAORMX reviewed Apr 1, 2021

View reviewed changes

modules/running-compliance-scans.adoc Outdated Show resolved Hide resolved

xiaojiey reviewed Apr 2, 2021

View reviewed changes

modules/compliance-filtering-failed-results.adoc Outdated Show resolved Hide resolved

ahardin-rh force-pushed the cmp-operator-updates branch from d2a33a4 to ce8dab1 Compare April 5, 2021 20:00

ahardin-rh added the peer-review-needed Signifies that the peer review team needs to review this PR label Apr 5, 2021

xiaojiey reviewed Apr 6, 2021

View reviewed changes

pdhamdhe-zz reviewed Apr 6, 2021

View reviewed changes

aburdenthehand removed their request for review April 6, 2021 09:31

pdhamdhe-zz reviewed Apr 6, 2021

View reviewed changes

lbarbeevargas reviewed Apr 6, 2021

View reviewed changes

lbarbeevargas added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Apr 6, 2021

vikram-redhat mentioned this pull request Apr 7, 2021

[enterprise-Branch Build] Issue in file security/compliance_operator/compliance-operator-remediation.adoc #31274

Closed

ahardin-rh force-pushed the cmp-operator-updates branch 2 times, most recently from 874812b to 25ea12b Compare April 8, 2021 20:36

Updating Compliance Operator docs

344aa99

ahardin-rh force-pushed the cmp-operator-updates branch from 25ea12b to 344aa99 Compare April 8, 2021 20:48

ahardin-rh merged commit e0ffb51 into openshift:master Apr 8, 2021

openshift-cherrypick-robot mentioned this pull request Apr 8, 2021

[enterprise-4.6] Updating Compliance Operator docs #31436

Merged

This was referenced Apr 8, 2021

[enterprise-4.7] Updating Compliance Operator docs #31437

Merged

[enterprise-4.8] Updating Compliance Operator docs #31438

Merged

Updating Compliance Operator docs #29673

Updating Compliance Operator docs #29673

Uh oh!

Conversation

ahardin-rh commented Feb 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Feb 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JAORMX left a comment

Choose a reason for hiding this comment

Uh oh!

ahardin-rh commented Mar 31, 2021

Uh oh!

JAORMX left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

xiaojiey Apr 6, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pdhamdhe-zz Apr 6, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xiaojiey Apr 6, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pdhamdhe-zz Apr 6, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pdhamdhe-zz Apr 6, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lbarbeevargas left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ahardin-rh commented Feb 22, 2021 •

edited

Loading

netlify bot commented Feb 22, 2021 •

edited

Loading

xiaojiey Apr 6, 2021 •

edited

Loading

pdhamdhe-zz Apr 6, 2021 •

edited

Loading

xiaojiey Apr 6, 2021 •

edited

Loading

pdhamdhe-zz Apr 6, 2021 •

edited

Loading

pdhamdhe-zz Apr 6, 2021 •

edited

Loading

lbarbeevargas left a comment •

edited

Loading