Skip to content
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.

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

Document namespace prefix when scanning a hosted cluster #382

Conversation

yuumasato
Copy link
Member

When using hypershift and scanning a hosted cluster, the namespace of the hosted cluster needs to be defined as well.

The namespace where clusters are installed can vary, and should be set accordingly for th scans to work.

@openshift-ci openshift-ci bot requested review from jhrozek and rhmdnd August 14, 2023 14:07
@yuumasato yuumasato requested a review from Vincent056 August 14, 2023 15:16
doc/usage.md Outdated Show resolved Hide resolved
@yuumasato yuumasato force-pushed the document_hypershift_hosted_cluster_namespace branch from 340f19a to 90fbb12 Compare August 15, 2023 12:15
doc/usage.md Outdated Show resolved Hide resolved
doc/usage.md Outdated Show resolved Hide resolved
doc/usage.md Outdated Show resolved Hide resolved
Copy link

@rhmdnd rhmdnd left a comment

Choose a reason for hiding this comment

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

Looks good, I only have minor comments inline about style. Thank you for adding the reference to the Hypershift documentation.

@yuumasato yuumasato force-pushed the document_hypershift_hosted_cluster_namespace branch 2 times, most recently from 19275e2 to 71baf7e Compare August 29, 2023 15:03
@yuumasato
Copy link
Member Author

I have fixed a small typo and rephrased one sentence.
Changed from define the name and namespace to specifying the name and namespace

@openshift-ci
Copy link

openshift-ci bot commented Aug 31, 2023

@yuumasato: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-aws-parallel 71baf7e link true /test e2e-aws-parallel
ci/prow/e2e-aws-serial 71baf7e link true /test e2e-aws-serial

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

@yuumasato yuumasato force-pushed the document_hypershift_hosted_cluster_namespace branch from 71baf7e to 3638385 Compare September 5, 2023 14:17
doc/usage.md Outdated
you can either extend `ocp4-cis` or `ocp4-pci-dss`.

In order to scan a Hosted Cluster, you need to create a TailoredProfile specifying the
name and namespace of the Hosted cluster that you want to scan.
Copy link

Choose a reason for hiding this comment

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

nit: Hosted Cluster (to be consistent with the line above).

Copy link
Member Author

Choose a reason for hiding this comment

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

Addressed.

doc/usage.md Outdated
for the Hosted Cluster with a tailoredProfile.
[Hypershift](https://hypershift-docs.netlify.app/) allows one to create and manage clusters on existing infrastructure.
Compliance Operator is able to create a platform scan on the [HyperShift Management Cluster](https://hypershift-docs.netlify.app/reference/concepts-and-personas/)
for the Hosted Cluster with a TailoredProfile.
Copy link

Choose a reason for hiding this comment

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

Similar to my comments on another review. What are our thoughts on using literals for formal CRD names?

Copy link
Member Author

Choose a reason for hiding this comment

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

Should be fixed as well.

Copy link

@rhmdnd rhmdnd left a comment

Choose a reason for hiding this comment

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

Looks good, only two minor questions.

When using hypershift and scanning a hosted cluster, the namespace of
the hosted cluster needs to be defined as well.

The namespace where clusters are installed can vary, and should be set
accordingly for th scans to work.
Add very brief description of Hypershift and reference where Management
and Hosted Clusters are described.
Also, for consistency, capitalize term Hosted Cluster.
@yuumasato yuumasato force-pushed the document_hypershift_hosted_cluster_namespace branch from 3638385 to c6e904f Compare September 29, 2023 16:02
Copy link

@rhmdnd rhmdnd left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci
Copy link

openshift-ci bot commented Oct 5, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rhmdnd, yuumasato

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved label Oct 5, 2023
@rhmdnd rhmdnd requested a review from sheriff-rh October 5, 2023 18:55
@rhmdnd
Copy link

rhmdnd commented Oct 5, 2023

/px-approved
/doc-approved
/qe-approved

Applying necessary labels since this documenting existing behavior. Adding @sheriff-rh for downstream documentation awareness.

@openshift-ci openshift-ci bot merged commit c7fff97 into ComplianceAsCode:master Oct 5, 2023
5 checks passed
@yuumasato yuumasato deleted the document_hypershift_hosted_cluster_namespace branch October 16, 2023 14:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants