Skip to content

ROX-24197: [rhacs-docs-4.6] Update docs for RHCOS scanning with Scanner V4 #84256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Nov 26, 2024
Merged

ROX-24197: [rhacs-docs-4.6] Update docs for RHCOS scanning with Scanner V4 #84256

merged 1 commit into from
Nov 26, 2024

Conversation

@kcarmichael08
Copy link
Contributor

@kcarmichael08 kcarmichael08 commented Oct 30, 2024 •
edited
Loading

Version(s):
4.6+

Issue

Links to docs previews:

QE review: ACS has no QE, approved by SMEs

  • QE has approved this change.

Additional information:

@openshift-ci-robot
Copy link

openshift-ci-robot commented Oct 30, 2024 •
edited by openshift-ci bot
Loading

@kcarmichael08: This pull request references ROX-24197 which is a valid jira issue.

In response to this:

Version(s):
4.6+

Issue

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Oct 30, 2024
@openshift-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 30, 2024
@kcarmichael08 kcarmichael08 added this to the Continuous Release milestone Oct 30, 2024
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Oct 30, 2024 •
edited
Loading

🤖 Tue Nov 26 22:21:22 - Prow CI generated the docs preview:

https://84256--ocpdocs-pr.netlify.app/openshift-acs/latest/cloud_service/upgrading-cloud/upgrade-cloudsvc-roxctl.html
https://84256--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/scan-rhcos-node-host.html
https://84256--ocpdocs-pr.netlify.app/openshift-acs/latest/upgrading/upgrade-roxctl.html

@kcarmichael08 kcarmichael08 force-pushed the ROX-24197-scannerv4-rhcos branch from f6e2c2d to dcbb5a6 Compare October 30, 2024 20:01
@openshift-ci-robot
Copy link

openshift-ci-robot commented Nov 4, 2024 •
edited by openshift-ci bot
Loading

@kcarmichael08: This pull request references ROX-24197 which is a valid jira issue.

In response to this:

Version(s):
4.6+

Issue

Links to docs previews:

QE review:

  • QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

@kcarmichael08 kcarmichael08 force-pushed the ROX-24197-scannerv4-rhcos branch 2 times, most recently from bda9063 to 22b95e6 Compare November 4, 2024 14:49
@openshift-ci-robot
Copy link

openshift-ci-robot commented Nov 4, 2024 •
edited by openshift-ci bot
Loading

@kcarmichael08: This pull request references ROX-24197 which is a valid jira issue.

In response to this:

Version(s):
4.6+

Issue

Links to docs previews:

QE review:

  • QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

Maddosaurus
Maddosaurus reviewed Nov 4, 2024
View reviewed changes
@kcarmichael08 kcarmichael08 force-pushed the ROX-24197-scannerv4-rhcos branch from 22b95e6 to 19b70e0 Compare November 8, 2024 20:24
@openshift-ci-robot
Copy link

openshift-ci-robot commented Nov 12, 2024 •
edited by openshift-ci bot
Loading

@kcarmichael08: This pull request references ROX-24197 which is a valid jira issue.

In response to this:

Version(s):
4.7+

Issue

Links to docs previews:

QE review:

  • QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

@kcarmichael08 kcarmichael08 added rhacs-docs-4.7 do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Nov 12, 2024
@kcarmichael08 kcarmichael08 changed the title ROX-24197: Update docs for RHCOS scanning with Scanner V4 ROX-24197: [rhacs-docs-4.7] Update docs for RHCOS scanning with Scanner V4 Nov 13, 2024
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 13, 2024
RTann
RTann reviewed Nov 16, 2024
View reviewed changes
@RTann
Copy link

RTann commented Nov 16, 2024

@Maddosaurus do we want this in 4.7 or should this also be in 4.6 since we are releasing this in tech preview in 4.6?

@kcarmichael08
Copy link
Contributor Author

kcarmichael08 commented Nov 18, 2024

@Maddosaurus do we want this in 4.7 or should this also be in 4.6 since we are releasing this in tech preview in 4.6?

Ah, sorry, I was told it was moved to 4.7, so if you two can make sure I have all the instructions someone will need to enable for 4.6, that will work. :)

@Maddosaurus
Copy link

Maddosaurus commented Nov 21, 2024

This was released in 4.6 (TP), so I'd like it to be included for the 4.6 documentation. From what I can see, all the required steps to enable Node Indexing are in this PR.
To make sure, let me list them again:

  • Have Scanner V4 installed and available
  • Set environment var ROX_NODE_INDEX_ENABLED=true for Central, Sensor, and Compliance
    The env var for Compliance is set on the Collector DaemonSet, so I think we're good to go.

@kcarmichael08 kcarmichael08 force-pushed the ROX-24197-scannerv4-rhcos branch from 19b70e0 to 3652f58 Compare November 21, 2024 18:29
@kcarmichael08
Copy link
Contributor Author

kcarmichael08 commented Nov 21, 2024

This was released in 4.6 (TP), so I'd like it to be included for the 4.6 documentation. From what I can see, all the required steps to enable Node Indexing are in this PR. To make sure, let me list them again:

  • Have Scanner V4 installed and available
  • Set environment var ROX_NODE_INDEX_ENABLED=true for Central, Sensor, and Compliance
    The env var for Compliance is set on the Collector DaemonSet, so I think we're good to go.

I just realized that the commands were split up from the examples, so I restructured this a little. Now there are steps for 1) Central 2) Compliance (Collector DaemonSet). But there's not a specific command to set the environment variable on the secured cluster itself - should there be? (for Sensor)

@kcarmichael08 kcarmichael08 mentioned this pull request Nov 21, 2024
Merged
1 task
@kcarmichael08 kcarmichael08 changed the title ROX-24197: [rhacs-docs-4.7] Update docs for RHCOS scanning with Scanner V4 ROX-24197: [rhacs-docs-4.6] Update docs for RHCOS scanning with Scanner V4 Nov 21, 2024
RTann
RTann reviewed Nov 25, 2024
View reviewed changes
Copy link

@RTann RTann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need to mention it's in tech preview here, or would that be in the release notes?

@kcarmichael08
Copy link
Contributor Author

kcarmichael08 commented Nov 26, 2024

do we need to mention it's in tech preview here, or would that be in the release notes?

That is what the technology preview snippet does.
Screenshot 2024-11-26 at 8 15 20 AM

@kcarmichael08 kcarmichael08 force-pushed the ROX-24197-scannerv4-rhcos branch from 3652f58 to f0af7cb Compare November 26, 2024 13:27
@openshift-ci-robot
Copy link

openshift-ci-robot commented Nov 26, 2024 •
edited by openshift-ci bot
Loading

@kcarmichael08: This pull request references ROX-24197 which is a valid jira issue.

In response to this:

Version(s):
4.7+

Issue

Links to docs previews:

QE review: ACS has no QE, approved by SMEs

  • QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Nov 26, 2024 •
edited by openshift-ci bot
Loading

@kcarmichael08: This pull request references ROX-24197 which is a valid jira issue.

In response to this:

Version(s):
4.7+

Issue

Links to docs previews:

QE review: ACS has no QE, approved by SMEs

  • QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Nov 26, 2024 •
edited by openshift-ci bot
Loading

@kcarmichael08: This pull request references ROX-24197 which is a valid jira issue.

In response to this:

Version(s):
4.6+

Issue

Links to docs previews:

QE review: ACS has no QE, approved by SMEs

  • QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

@kcarmichael08 kcarmichael08 added the peer-review-needed Signifies that the peer review team needs to review this PR label Nov 26, 2024
@mburke5678 mburke5678 added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Nov 26, 2024
mburke5678
mburke5678 reviewed Nov 26, 2024
View reviewed changes
mburke5678
mburke5678 reviewed Nov 26, 2024
View reviewed changes
mburke5678
mburke5678 reviewed Nov 26, 2024
View reviewed changes
mburke5678
mburke5678 reviewed Nov 26, 2024
View reviewed changes
@mburke5678
Copy link
Contributor

mburke5678 commented Nov 26, 2024

@kcarmichael08 A few suggestions. Otherwise LGTM

@mburke5678 mburke5678 added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR peer-review-needed Signifies that the peer review team needs to review this PR labels Nov 26, 2024
@kcarmichael08 kcarmichael08 force-pushed the ROX-24197-scannerv4-rhcos branch from 96e2de6 to abe1a4d Compare November 26, 2024 22:02
@openshift-ci
Copy link

openshift-ci bot commented Nov 26, 2024

@kcarmichael08: all tests passed!

Full PR test history. Your PR dashboard.

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-sigs/prow repository. I understand the commands that are listed here.

@kcarmichael08 kcarmichael08 merged commit 1ffb9d3 into openshift:rhacs-docs-main Nov 26, 2024
2 checks passed
@kcarmichael08 kcarmichael08 deleted the ROX-24197-scannerv4-rhcos branch November 26, 2024 22:28
@kcarmichael08
Copy link
Contributor Author

kcarmichael08 commented Nov 26, 2024

/cherrypick rhacs-docs-4.6

@openshift-cherrypick-robot
Copy link

openshift-cherrypick-robot commented Nov 26, 2024

@kcarmichael08: new pull request created: #85531

In response to this:

/cherrypick rhacs-docs-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-sigs/prow repository.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Nov 26, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mburke5678 mburke5678 mburke5678 left review comments

+2 more reviewers

@RTann RTann RTann left review comments

@Maddosaurus Maddosaurus Maddosaurus left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. peer-review-done Signifies that the peer review team has reviewed this PR rhacs-docs-4.6 size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Milestone

Continuous Release

Development

Successfully merging this pull request may close these issues.

7 participants

@kcarmichael08 @openshift-ci-robot @ocpdocs-previewbot @RTann @Maddosaurus @mburke5678 @openshift-cherrypick-robot