From 188e6f485178f6eeab299ee024493416700fdbc5 Mon Sep 17 00:00:00 2001 From: Michael Shen Date: Tue, 7 Jan 2025 19:36:43 -0800 Subject: [PATCH] Clarify that the ROSA provider is currently for ROSA HCP clusters Signed-off-by: Michael Shen --- docs/book/src/topics/rosa/creating-a-cluster.md | 8 ++++---- docs/book/src/topics/rosa/enabling.md | 2 +- docs/book/src/topics/rosa/external-auth.md | 4 ++-- docs/book/src/topics/rosa/support.md | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/book/src/topics/rosa/creating-a-cluster.md b/docs/book/src/topics/rosa/creating-a-cluster.md index dd7dacdfc8..1c01ae7b88 100644 --- a/docs/book/src/topics/rosa/creating-a-cluster.md +++ b/docs/book/src/topics/rosa/creating-a-cluster.md @@ -1,8 +1,8 @@ -# Creating a ROSA cluster +# Creating a ROSA HCP cluster ## Permissions ### Authentication using service account credentials -CAPA controller requires service account credentials to be able to provision ROSA clusters: +CAPA controller requires service account credentials to be able to provision ROSA HCP clusters: 1. Visit [https://console.redhat.com/iam/service-accounts](https://console.redhat.com/iam/service-accounts) and create a new service account. 1. Create a new kubernetes secret with the service account credentials to be referenced later by `ROSAControlPlane` @@ -83,7 +83,7 @@ secret in the `capa-system` namespace with: Follow the guide [here](https://docs.aws.amazon.com/ROSA/latest/userguide/getting-started-hcp.html) up until [Step 3](https://docs.aws.amazon.com/ROSA/latest/userguide/getting-started-hcp.html#getting-started-hcp-step-3) to install the required tools and setup the prerequisite infrastructure. -Once Step 3 is done, you will be ready to proceed with creating a ROSA cluster using cluster-api. +Once Step 3 is done, you will be ready to proceed with creating a ROSA HCP cluster using cluster-api. ## Creating the cluster @@ -104,7 +104,7 @@ Once Step 3 is done, you will be ready to proceed with creating a ROSA cluster u export PRIVATE_SUBNET_ID="subnet-05e72222222222222" ``` -1. Render the cluster manifest using the ROSA cluster template: +1. Render the cluster manifest using the ROSA HCP cluster template: ```shell clusterctl generate cluster --from templates/cluster-template-rosa.yaml > rosa-capi-cluster.yaml ``` diff --git a/docs/book/src/topics/rosa/enabling.md b/docs/book/src/topics/rosa/enabling.md index aeae9ab5e7..9dcedfa8b1 100644 --- a/docs/book/src/topics/rosa/enabling.md +++ b/docs/book/src/topics/rosa/enabling.md @@ -1,6 +1,6 @@ # Enabling ROSA Support -To enable support for ROSA clusters, the ROSA feature flag must be set to true. This can be done using the **EXP_ROSA** environment variable. +To enable support for ROSA HCP clusters, the ROSA feature flag must be set to true. This can be done using the **EXP_ROSA** environment variable. Make sure to set up your AWS environment first as described [here](https://cluster-api.sigs.k8s.io/user/quick-start.html). ```shell diff --git a/docs/book/src/topics/rosa/external-auth.md b/docs/book/src/topics/rosa/external-auth.md index fb2702397c..180ef2869f 100644 --- a/docs/book/src/topics/rosa/external-auth.md +++ b/docs/book/src/topics/rosa/external-auth.md @@ -1,6 +1,6 @@ # External Auth Providers (BYOI) -ROSA allows you to Bring Your Own Identity (BYOI) to manage and authenticate cluster users. +ROSA HCP allows you to Bring Your Own Identity (BYOI) to manage and authenticate cluster users. ## Enabling @@ -16,7 +16,7 @@ spec: .... ``` -Note: This feauture requires OpenShift version `4.15.5` or newer. +Note: This feature requires OpenShift version `4.15.5` or newer. ## Usage diff --git a/docs/book/src/topics/rosa/support.md b/docs/book/src/topics/rosa/support.md index 1d3dbed96a..65b5e6b22f 100644 --- a/docs/book/src/topics/rosa/support.md +++ b/docs/book/src/topics/rosa/support.md @@ -1,6 +1,6 @@ # Create issue for ROSA -When creating issue for ROSA-HCP cluster, include the logs for the capa-controller-manager and capi-controller-manager deployment pods. The logs can be saved to text file using the commands below. Also include the yaml files for all the resources used to create the ROSA cluster: +When creating issue for ROSA HCP cluster, include the logs for the capa-controller-manager and capi-controller-manager deployment pods. The logs can be saved to text file using the commands below. Also include the yaml files for all the resources used to create the ROSA HCP cluster: - `Cluster` - `ROSAControlPlane` - `MachinePool`