Skip to content

Commit 9d8d5f0

Browse files
authored
Merge pull request #4956 from sabre1041/rosa-doc-enhancements
📖ROSA: Updates to creating a ROSA cluster documentation
2 parents 7201fec + 849c0ce commit 9d8d5f0

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/book/src/topics/rosa/creating-a-cluster.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ CAPA controller requires an API token in order to be able to provision ROSA clus
55

66
1. Visit [https://console.redhat.com/openshift/token](https://console.redhat.com/openshift/token) to retrieve your API authentication token
77

8-
1. Create a credentials secret with the token to be referenced later by `ROSAControlePlane`
8+
1. Create a credentials secret within the target namespace with the token to be referenced later by `ROSAControlePlane`
99
```shell
1010
kubectl create secret generic rosa-creds-secret \
1111
--from-literal=ocmToken='eyJhbGciOiJIUzI1NiIsI....' \
@@ -39,7 +39,7 @@ Once Step 3 is done, you will be ready to proceed with creating a ROSA cluster u
3939
export OPENSHIFT_VERSION="4.14.5"
4040
export AWS_REGION="us-west-2"
4141
export AWS_AVAILABILITY_ZONE="us-west-2a"
42-
export AWS_ACCOUNT_ID="<account_id"
42+
export AWS_ACCOUNT_ID="<account_id>"
4343
export AWS_CREATOR_ARN="<user_arn>" # can be retrieved e.g. using `aws sts get-caller-identity`
4444
4545
export OIDC_CONFIG_ID="<oidc_id>" # OIDC config id creating previously with `rosa create oidc-config`
@@ -55,8 +55,9 @@ Once Step 3 is done, you will be ready to proceed with creating a ROSA cluster u
5555
```shell
5656
clusterctl generate cluster <cluster-name> --from templates/cluster-template-rosa.yaml > rosa-capi-cluster.yaml
5757
```
58+
Note: The AWS role name must be no more than 64 characters in length. Otherwise an error will be returned. Truncate values exceeding 64 characters.
5859

59-
1. If a credentials secret was created earlier, edit `ROSAControlPlane` to refernce it:
60+
1. If a credentials secret was created earlier, edit `ROSAControlPlane` to reference it:
6061
```yaml
6162
apiVersion: controlplane.cluster.x-k8s.io/v1beta2
6263
kind: ROSAControlPlane
@@ -81,7 +82,7 @@ Once Step 3 is done, you will be ready to proceed with creating a ROSA cluster u
8182
...
8283
```
8384

84-
Otherwise, make sure the following `AWSClusterControllerIdentity` singleton exists in your managment cluster:
85+
Otherwise, make sure the following `AWSClusterControllerIdentity` singleton exists in your management cluster:
8586
```yaml
8687
apiVersion: infrastructure.cluster.x-k8s.io/v1beta2
8788
kind: AWSClusterControllerIdentity

0 commit comments

Comments
 (0)