From 19275e2a742a3d08478a73bc15228428fd9a0d3f Mon Sep 17 00:00:00 2001 From: Watson Sato Date: Tue, 15 Aug 2023 14:12:24 +0200 Subject: [PATCH] Describe Hypershift and reference some concepts Add very brief description of Hypershift and reference where Management and Hosted Clusters are described. --- doc/usage.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/usage.md b/doc/usage.md index e59275f1d..cd6a12f1b 100644 --- a/doc/usage.md +++ b/doc/usage.md @@ -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 @@ -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