ROX-19799: Update docs for VM2.0

[kcarmichael08]

Version(s):
4.5+

Issue

Links to docs previews:

Managing vulnerabilities - Reorganized top-level page and pages underneath for VM:

• Vulnerability management overview - Made this into the "overview" chapter explaining VM concepts - moved tasks into the "Viewing and addressing vulnerabilities" chapter
• Viewing and addressing vulnerabilities - moved all tasks in this chapter, renamed
• Using the VM dashboard - moved all "legacy" dashboard info under this section for deprecation and removal in future release - please do not review for content, only inaccuracy/egregious errors
• Scanning RHCOS node hosts - added include for new VM section
• Vulnerability reporting - minor updates after verifying against GUI

Examining images for vulnerabilities - updated VM link only
Creating and using deployment collections - updated VM reporting link only

QE review: ACS has no QE, reviewed/approved by SMEs

• QE has approved this change.

Additional information:

Note to reviewers (Final draft, July 2024):

Updating the instructions for the Dashboard tasks (https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/vulnerability-management-dashboard) is beyond the scope of this PR. Please do not focus on this section and only mark inaccuracies. This functionality will be deprecated soon.

Old notes to reviewers (first draft, June 2024):

• There is still some reorganization needed with the "common tasks" section. These are all Dashboard-based instructions, while some of the Workload CVEs equivalents are provided in the "Vulnerability Management" section. Some of the equivalents in the Workload CVEs page need to be added. For now, please focus on reviewing the Workload CVEs information for accuracy, as this information is new or updated following the GUI changes.
• Need some help documenting the deferral approvals workflow since I don't think the staging environment is capturing my tests with request to defer.

[openshift-ci-robot]

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

In response to this:

Version(s):
4.5+

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.

[ocpdocs-previewbot]

🤖 Wed Jul 24 20:50:46 - Prow CI generated the docs preview:

https://78059--ocpdocs-pr.netlify.app/
https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/create-use-collections.html
https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/examine-images-for-vulnerabilities.html
https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/common-vuln-management-tasks.html
https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/scan-rhcos-node-host.html
https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/vulnerability-management-dashboard.html
https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/vulnerability-management.html
https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/vulnerability-reporting.html

[openshift-ci-robot]

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

In response to this:

Version(s):
4.5+

Issue

Links to docs previews:

78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/examine-images-for-vulnerabilities.html
78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/vulnerability-management.html

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]

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

In response to this:

Version(s):
4.5+

Issue

Links to docs previews:

78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/vulnerability-management.html
https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/examine-images-for-vulnerabilities.html#scan-inactive-images_examine-images-for-vulnerabilities

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]

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

In response to this:

Version(s):
4.5+

Issue

Links to docs previews:

78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/vulnerability-management.html
https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/examine-images-for-vulnerabilities.html#scan-inactive-images_examine-images-for-vulnerabilities

QE review:

• QE has approved this change.

Additional information:

Note to reviewers:

• There is still some reorganization needed with the "common tasks" section. These are all Dashboard-based instructions, while some of the Workload CVEs equivalents are provided in the "Vulnerability Management" section. Some of the equivalents in the Workload CVEs page need to be added. For now, please focus on reviewing the Workload CVEs information for accuracy, as this information is new or updated following the GUI changes.

• Need some help documenting the deferral approvals workflow since I don't think the staging environment is capturing my tests with request to defer.

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.

[charmik-redhat]

Since Vulnerability Management -> Dashboard is deprecated, do you think that all the places that tell user to go the dashboard should also mention that it is deprecated and that the similar outcome can be achieved using Workload CVEs, Node CVE and Platform CVEs ?

Also, I do not see docs for Node CVEs, Platform CVEs and Exception Management. Would those be added in a separate branch?

Edit : I missed the note in the PR about focusing on just workload CVEs part

[openshift-ci-robot]

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

In response to this:

Version(s):
4.5+

Issue

Links to docs previews:

78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/vulnerability-management.html
https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/examine-images-for-vulnerabilities.html#scan-inactive-images_examine-images-for-vulnerabilities

QE review:

• QE has approved this change.

Additional information:

Note to reviewers:

Final draft (July 2024)

Updating the instructions for the Dashboard tasks (https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/vulnerability-management-dashboard) is beyond the scope of this PR. Please do not focus on this section and only mark inaccuracies. This functionality will be deprecated soon.

First draft (June 2024)

• There is still some reorganization needed with the "common tasks" section. These are all Dashboard-based instructions, while some of the Workload CVEs equivalents are provided in the "Vulnerability Management" section. Some of the equivalents in the Workload CVEs page need to be added. For now, please focus on reviewing the Workload CVEs information for accuracy, as this information is new or updated following the GUI changes.

• Need some help documenting the deferral approvals workflow since I don't think the staging environment is capturing my tests with request to defer.

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]

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

In response to this:

Version(s):
4.5+

Issue

Links to docs previews:

78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/vulnerability-management.html
https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/examine-images-for-vulnerabilities.html#scan-inactive-images_examine-images-for-vulnerabilities

QE review:

• QE has approved this change.

Additional information:

Note to reviewers:

• Final draft (July 2024): Updating the instructions for the Dashboard tasks (https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/vulnerability-management-dashboard) is beyond the scope of this PR. Please do not focus on this section and only mark inaccuracies. This functionality will be deprecated soon.

• Old notes to reviewers (first draft, June 2024):*

• There is still some reorganization needed with the "common tasks" section. These are all Dashboard-based instructions, while some of the Workload CVEs equivalents are provided in the "Vulnerability Management" section. Some of the equivalents in the Workload CVEs page need to be added. For now, please focus on reviewing the Workload CVEs information for accuracy, as this information is new or updated following the GUI changes.

• Need some help documenting the deferral approvals workflow since I don't think the staging environment is capturing my tests with request to defer.

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]

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

In response to this:

Version(s):
4.5+

Issue

Links to docs previews:

78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/vulnerability-management.html
https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/examine-images-for-vulnerabilities.html#scan-inactive-images_examine-images-for-vulnerabilities

QE review:

• QE has approved this change.

Additional information:

Note to reviewers:

• Final draft (July 2024): Updating the instructions for the Dashboard tasks (https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/vulnerability-management-dashboard) is beyond the scope of this PR. Please do not focus on this section and only mark inaccuracies. This functionality will be deprecated soon.

Old notes to reviewers (first draft, June 2024):

• There is still some reorganization needed with the "common tasks" section. These are all Dashboard-based instructions, while some of the Workload CVEs equivalents are provided in the "Vulnerability Management" section. Some of the equivalents in the Workload CVEs page need to be added. For now, please focus on reviewing the Workload CVEs information for accuracy, as this information is new or updated following the GUI changes.
• Need some help documenting the deferral approvals workflow since I don't think the staging environment is capturing my tests with request to defer.

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]

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

In response to this:

Version(s):
4.5+

Issue

Links to docs previews:

Managing vulnerabilities - Reorganized top-level page and pages underneath for VM:

• Vulnerability management overview - Made this into the "overview" chapter explaining VM concepts
• Viewing and addressing vulnerabilities - moved all tasks in this chapter, renamed
• Using the VM dashboard - moved all "legacy" dashboard info under this section for deprecation and removal in future release - please do not review for content, only inaccuracy/egregious errors
• Scanning RHCOS node hosts - added include for new VM section
• Vulnerability reporting - minor updates after verifying against GUI

Examining images for vulnerabilities - updated VM link only
Creating and using deployment collections - updated VM reporting link only

QE review:

• QE has approved this change.

Additional information:

Note to reviewers (Final draft, July 2024):

Updating the instructions for the Dashboard tasks (https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/vulnerability-management-dashboard) is beyond the scope of this PR. Please do not focus on this section and only mark inaccuracies. This functionality will be deprecated soon.

Old notes to reviewers (first draft, June 2024):

• There is still some reorganization needed with the "common tasks" section. These are all Dashboard-based instructions, while some of the Workload CVEs equivalents are provided in the "Vulnerability Management" section. Some of the equivalents in the Workload CVEs page need to be added. For now, please focus on reviewing the Workload CVEs information for accuracy, as this information is new or updated following the GUI changes.
• Need some help documenting the deferral approvals workflow since I don't think the staging environment is capturing my tests with request to defer.

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]

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

In response to this:

Version(s):
4.5+

Issue

Links to docs previews:

Managing vulnerabilities - Reorganized top-level page and pages underneath for VM:

• Vulnerability management overview - Made this into the "overview" chapter explaining VM concepts
• Viewing and addressing vulnerabilities - moved all tasks in this chapter, renamed
• Using the VM dashboard - moved all "legacy" dashboard info under this section for deprecation and removal in future release - please do not review for content, only inaccuracy/egregious errors
• Scanning RHCOS node hosts - added include for new VM section
• Vulnerability reporting - minor updates after verifying against GUI

Examining images for vulnerabilities - updated VM link only
Creating and using deployment collections - updated VM reporting link only

QE review: ACS has no QE, reviewed/approved by SMEs

• QE has approved this change.

Additional information:

Note to reviewers (Final draft, July 2024):

Updating the instructions for the Dashboard tasks (https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/vulnerability-management-dashboard) is beyond the scope of this PR. Please do not focus on this section and only mark inaccuracies. This functionality will be deprecated soon.

Old notes to reviewers (first draft, June 2024):

• There is still some reorganization needed with the "common tasks" section. These are all Dashboard-based instructions, while some of the Workload CVEs equivalents are provided in the "Vulnerability Management" section. Some of the equivalents in the Workload CVEs page need to be added. For now, please focus on reviewing the Workload CVEs information for accuracy, as this information is new or updated following the GUI changes.
• Need some help documenting the deferral approvals workflow since I don't think the staging environment is capturing my tests with request to defer.

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]

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

In response to this:

Version(s):
4.5+

Issue

Links to docs previews:

Managing vulnerabilities - Reorganized top-level page and pages underneath for VM:

• Vulnerability management overview - Made this into the "overview" chapter explaining VM concepts
• Viewing and addressing vulnerabilities - moved all tasks in this chapter, renamed
• Using the VM dashboard - moved all "legacy" dashboard info under this section for deprecation and removal in future release - please do not review for content, only inaccuracy/egregious errors
• Scanning RHCOS node hosts - added include for new VM section
• Vulnerability reporting - minor updates after verifying against GUI

Examining images for vulnerabilities - updated VM link only
Creating and using deployment collections - updated VM reporting link only

QE review: ACS has no QE, reviewed/approved by SMEs

• QE has approved this change.

Additional information:

Note to reviewers (Final draft, July 2024):

Updating the instructions for the Dashboard tasks (https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/vulnerability-management-dashboard) is beyond the scope of this PR. Please do not focus on this section and only mark inaccuracies. This functionality will be deprecated soon.

Old notes to reviewers (first draft, June 2024):

• There is still some reorganization needed with the "common tasks" section. These are all Dashboard-based instructions, while some of the Workload CVEs equivalents are provided in the "Vulnerability Management" section. Some of the equivalents in the Workload CVEs page need to be added. For now, please focus on reviewing the Workload CVEs information for accuracy, as this information is new or updated following the GUI changes.
• Need some help documenting the deferral approvals workflow since I don't think the staging environment is capturing my tests with request to defer.

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]

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

In response to this:

Version(s):
4.5+

Issue

Links to docs previews:

Managing vulnerabilities - Reorganized top-level page and pages underneath for VM:

• Vulnerability management overview - Made this into the "overview" chapter explaining VM concepts - moved tasks into the "Viewing and managing vulnerabilities" chapter
• Viewing and addressing vulnerabilities - moved all tasks in this chapter, renamed
• Using the VM dashboard - moved all "legacy" dashboard info under this section for deprecation and removal in future release - please do not review for content, only inaccuracy/egregious errors
• Scanning RHCOS node hosts - added include for new VM section
• Vulnerability reporting - minor updates after verifying against GUI

Examining images for vulnerabilities - updated VM link only
Creating and using deployment collections - updated VM reporting link only

QE review: ACS has no QE, reviewed/approved by SMEs

• QE has approved this change.

Additional information:

Note to reviewers (Final draft, July 2024):

Updating the instructions for the Dashboard tasks (https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/vulnerability-management-dashboard) is beyond the scope of this PR. Please do not focus on this section and only mark inaccuracies. This functionality will be deprecated soon.

Old notes to reviewers (first draft, June 2024):

• There is still some reorganization needed with the "common tasks" section. These are all Dashboard-based instructions, while some of the Workload CVEs equivalents are provided in the "Vulnerability Management" section. Some of the equivalents in the Workload CVEs page need to be added. For now, please focus on reviewing the Workload CVEs information for accuracy, as this information is new or updated following the GUI changes.
• Need some help documenting the deferral approvals workflow since I don't think the staging environment is capturing my tests with request to defer.

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]

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

In response to this:

Version(s):
4.5+

Issue

Links to docs previews:

Managing vulnerabilities - Reorganized top-level page and pages underneath for VM:

• Vulnerability management overview - Made this into the "overview" chapter explaining VM concepts - moved tasks into the "Viewing and addressing vulnerabilities" chapter
• Viewing and addressing vulnerabilities - moved all tasks in this chapter, renamed
• Using the VM dashboard - moved all "legacy" dashboard info under this section for deprecation and removal in future release - please do not review for content, only inaccuracy/egregious errors
• Scanning RHCOS node hosts - added include for new VM section
• Vulnerability reporting - minor updates after verifying against GUI

Examining images for vulnerabilities - updated VM link only
Creating and using deployment collections - updated VM reporting link only

QE review: ACS has no QE, reviewed/approved by SMEs

• QE has approved this change.

Additional information:

Note to reviewers (Final draft, July 2024):

Updating the instructions for the Dashboard tasks (https://78059--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-vulnerabilities/vulnerability-management-dashboard) is beyond the scope of this PR. Please do not focus on this section and only mark inaccuracies. This functionality will be deprecated soon.

Old notes to reviewers (first draft, June 2024):

• There is still some reorganization needed with the "common tasks" section. These are all Dashboard-based instructions, while some of the Workload CVEs equivalents are provided in the "Vulnerability Management" section. Some of the equivalents in the Workload CVEs page need to be added. For now, please focus on reviewing the Workload CVEs information for accuracy, as this information is new or updated following the GUI changes.
• Need some help documenting the deferral approvals workflow since I don't think the staging environment is capturing my tests with request to defer.

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.

[dvail]

Thanks for the work on this Kerry - it looks great! A handful of minor corrections from me but otherwise gtg. 🚢

[agantony]

/label peer-review-in-progress

[agantony]

Added suggestions for your consideration; overall lgtm!

[agantony]

/remove-label peer-review-in-progress
/remove-label peer-review-needed
/label peer-review-done

[kcarmichael08]

Thank you Agil for the feedback - it really helped the doc improve, I think!

[openshift-ci]

@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]

/cherrypick rhacs-docs-4.5

[openshift-cherrypick-robot]

@kcarmichael08: new pull request created: #79410

In response to this:

/cherrypick rhacs-docs-4.5

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.