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.

Sign up for GitHub

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

📖 Clarify that the ROSA provider is currently for ROSA HCP clusters #5268

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −8
Open

📖 Clarify that the ROSA provider is currently for ROSA HCP clusters #5268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/book/src/topics/rosa/creating-a-cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`
Expand Down Expand Up @@ -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

Expand All @@ -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 <cluster-name> --from templates/cluster-template-rosa.yaml > rosa-capi-cluster.yaml
```
Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/topics/rosa/enabling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/book/src/topics/rosa/external-auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/topics/rosa/support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`
Expand Down
Loading