Skip to content

Commit

Permalink
Describe Hypershift and reference some concepts
Browse files Browse the repository at this point in the history
Add very brief description of Hypershift and reference where Management
and Hosted Clusters are described.
  • Loading branch information
yuumasato committed Aug 23, 2023
1 parent 662142c commit 19275e2
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions doc/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -573,13 +573,14 @@ error result.
## How to Use Compliance Operator with HyperShift Management Cluster
Compliance Operator is able to run a platform scan on the HyperShift Managment cluster
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.
Currently, we only support CIS profile and PCI-DSS profile,
you can either extend `ocp4-cis` or `ocp4-pci-dss`.

In order to scan a Hosted Cluster, you need to create a tailoredProfile to define the
In order to scan a Hosted Cluster, you need to create a TailoredProfile to define the
name and namespace of the Hosted cluster that you want to scan.
Set the value of `ocp4-hypershift-cluster` to the name of the target Hosted Cluster,
and set the value of `ocp4-hypershift-namespace-prefix` to the namespace where the
Expand Down Expand Up @@ -627,7 +628,7 @@ settingsRef:

## How to Use Compliance Operator with HyperShift Hosted Cluster

Compliance Operator is able to run a platform scan on the HyperShift Hosted cluster
Compliance Operator is able to run a platform scan on the [HyperShift Hosted Cluster](https://hypershift-docs.netlify.app/reference/concepts-and-personas/)
without any tailoredProfile. Any unsupport rules will be hidden from the `ComplianceCheckResult`.

However, you need to use a special subscription file to install Compliance Operator on the
Expand Down

0 comments on commit 19275e2

Please sign in to comment.