Skip to content

Commit 351c76f

Browse files
authored
Merge pull request #72693 from AedinC/OSDOCS-8786
[OSDOCS#8786] Update CLI guides with new longer cluster name feature
2 parents b9ff473 + 5362e7b commit 351c76f

12 files changed

+110
-58
lines changed

modules/creating-cluster-with-aws-kms-key.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,11 +133,14 @@ $ aws kms put-key-policy --key-id $KMS_ARN \
133133
----
134134

135135
. Create the cluster by running the following command:
136-
136+
+
137+
--
138+
include::snippets/rosa-long-cluster-name.adoc[]
139+
--
137140
+
138141
[source,terminal]
139142
----
140-
$ rosa create cluster --cluster-name <cluster_name> \
143+
$ rosa create cluster --cluster-name <cluster_name> \
141144
--subnet-ids <private_subnet_id>,<public_subnet_id> \
142145
--sts \
143146
--mode auto \

modules/rosa-aws-privatelink-create-cluster.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,11 @@ If you use a firewall, you must configure it so that {product-title} can access
3030

3131
For more information, see the AWS PrivateLink firewall prerequisites section.
3232
====
33-
34-
33+
+
34+
--
35+
include::snippets/rosa-long-cluster-name.adoc[]
36+
--
37+
+
3538
** To create a Single-AZ cluster:
3639
+
3740
[source,terminal]

modules/rosa-cluster-autoscaler-cli-during.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,17 @@ You can use the ROSA CLI (`rosa`) to set cluster-wide autoscaling behavior durin
1111
.Procedure
1212

1313
- During cluster creation, type `--enable autoscaling` after the cluster name to enable machine autoscaling:
14-
+
14+
15+
include::snippets/rosa-long-cluster-name.adoc[]
16+
1517
.Example:
1618
[source,terminal]
1719
----
1820
$ rosa create cluster --cluster-name <cluster_name> --enable-autoscaling
1921
----
20-
+
22+
2123
Set at least one parameter to enable cluster autoscaling by running the following command:
22-
+
24+
2325
.Example:
2426
[source,terminal]
2527
----

modules/rosa-cluster-autoscaler-cli-interactive-during.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,10 @@ Interactive mode provides more information about available configurable paramete
1919
----
2020
$ rosa create cluster --cluster-name <cluster_name> --enable-autoscaling --interactive
2121
----
22-
+
22+
include::snippets/rosa-long-cluster-name.adoc[]
23+
2324
When the following prompt appears, enter *y* to go through all available autoscaling options.
24-
+
25+
2526
.Example interactive prompt:
2627
[source,terminal]
2728
----

modules/rosa-create-objects.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ $ rosa create cluster --cluster-name=<cluster_name> [arguments]
126126
|The identifier of one or more additional security groups to use along with the default security groups that are used with the control plane nodes created alongside the cluster. For more information on additional security groups, see the requirements for _Security groups_ under _Additional resources_.
127127

128128
a|--cluster-name <cluster_name>
129-
|Required. The name of the cluster. When used with the `create cluster` command, this argument is used to set the cluster name and to generate a sub-domain for your cluster on `openshiftapps.com`. The value for this argument must be unique within your organization.
129+
|Required. The name of the cluster. When used with the `create cluster` command, this argument is used to set the cluster name and can hold up to 54 characters. The value for this argument must be unique within your organization.
130130

131131
|--compute-machine-type <instance_type>
132132
|The instance type for compute nodes in the cluster. This determines the amount of memory and vCPU that is allocated to each compute node. For more information on valid instance types, see _AWS Instance types_ in _ROSA service definition_.
@@ -140,6 +140,10 @@ a|--cluster-name <cluster_name>
140140
|--dry-run
141141
|Simulates creating the cluster.
142142

143+
|--domain-prefix
144+
|Optional: When used with the `create cluster` command, this argument sets the subdomain for your cluster on `*.openshiftapps.com`. The value for this argument must be unique within your organization, cannot be longer than 15 characters, and cannot be changed after cluster creation.
145+
If the argument is not supplied, an autogenerated value is created that depends on the length of the cluster name. If the cluster name is fewer than or equal to 15 characters, that name is used for the domain prefix. If the cluster name is longer than 15 characters, the domain prefix is randomly generated to a 15 character string.
146+
143147
|--ec2-metadata-http-tokens string
144148
|Configures the use of IMDSv2 for EC2 instances. Valid values are `optional` (default) or `required`.
145149

modules/rosa-hcp-sts-creating-a-cluster-cli.adoc

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ When using the {product-title} (ROSA) CLI, `rosa`, to create a cluster, you can
3535
When creating a {hcp-title} cluster, the default machine Classless Inter-Domain Routing (CIDR) is `10.0.0.0/16`. If this does not correspond to the CIDR range for your VPC subnets, add `--machine-cidr <address_block>` to the following commands. To learn more about the default CIDR ranges for {product-title}, see xref:../networking/cidr-range-definitions.adoc#cidr-range-definitions[CIDR range definitions].
3636
====
3737
+
38-
--
3938
* If you did not set environmental variables, run the following command:
4039
+
4140
[source,terminal]
@@ -46,15 +45,14 @@ $ rosa create cluster --cluster-name=<cluster_name> \ <.>
4645
--oidc-config-id <id-of-oidc-configuration> \
4746
--subnet-ids=<public-subnet-id>,<private-subnet-id>
4847
----
49-
<.> Specify the name of your cluster, ensuring that the cluster name consists of no more than 15 lowercase alphanumeric characters or '-', starts with a letter, and ends with an alphanumeric character.
48+
<.> Specify the name of your cluster. If your cluster name is longer than 15 characters, it will contain an autogenerated domain prefix as a subdomain for your provisioned cluster on openshiftapps.com. To customize the subdomain, use the `--domain-prefix` flag. The domain prefix cannot be longer than 15 characters, must be unique, and cannot be changed after cluster creation.
5049
<.> Optional: The `--private` argument is used to create private {hcp-title} clusters. If you use this argument, ensure that you only use your private subnet ID for `--subnet-ids`.
5150
<.> By default, the cluster-specific Operator role names are prefixed with the cluster name and a random 4-digit hash. You can optionally specify a custom prefix to replace `<cluster_name>-<hash>` in the role names. The prefix is applied when you create the cluster-specific Operator IAM roles. For information about the prefix, see _About custom Operator IAM role prefixes_.
5251
+
5352
[NOTE]
5453
====
5554
If you specified custom ARN paths when you created the associated account-wide roles, the custom path is automatically detected. The custom path is applied to the cluster-specific Operator roles when you create them in a later step.
5655
====
57-
--
5856
+
5957
* If you set the environmental variables, create a cluster with a single, initial machine pool, using either a publicly or privately available API, and a publicly or privately available Ingress by running the following command:
6058
+
@@ -71,7 +69,7 @@ $ rosa create cluster --private --cluster-name=<cluster_name> \
7169
----
7270
$ rosa create cluster --cluster-name=<cluster_name> --mode=auto --hosted-cp --operator-roles-prefix=$OPERATOR_ROLES_PREFIX --oidc-config-id=$ODIC_CONFIG --subnet-ids=$SUBNET_IDS
7371
----
74-
72+
+
7573
. Check the status of your cluster by running the following command:
7674
+
7775
[source,terminal]
@@ -90,11 +88,11 @@ The following `State` field changes are listed in the output as the cluster inst
9088
====
9189
If the installation fails or the `State` field does not change to `ready` after more than 10 minutes, check the installation troubleshooting documentation for details. For more information, see _Troubleshooting installations_. For steps to contact Red Hat Support for assistance, see _Getting support for Red Hat OpenShift Service on AWS_.
9290
====
93-
91+
+
9492
. Track the progress of the cluster creation by watching the {product-title} installation program logs. To check the logs, run the following command:
9593
+
9694
[source,terminal]
9795
----
98-
$ rosa logs install --cluster=<cluster_name> --watch \ <1>
96+
$ rosa logs install --cluster=<cluster_name> --watch \ <.>
9997
----
100-
<1> Optional: To watch for new log messages as the installation progresses, use the `--watch` argument.
98+
<.> Optional: To watch for new log messages as the installation progresses, use the `--watch` argument.

modules/rosa-sharing-vpc-cluster-creation.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,6 @@ image::372_OpenShift_on_AWS_persona_worflows_0923_4.png[]
2525
[source,terminal]
2626
----
2727
rosa create cluster --cluster-name <cluster_name> --sts --operator-roles-prefix <prefix> --oidc-config-id <oidc_config_id> --region us-east-1 --subnet-ids <subnet_ids> --private-hosted-zone-id <hosted_zone_ID> --shared-vpc-role-arn <vpc-role-arn> --base-domain <dns-domain>
28-
----
28+
----
29+
+
30+
include::snippets/rosa-long-cluster-name.adoc[]

modules/rosa-sts-creating-a-cluster-quickly-cli.adoc

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,20 +39,21 @@ $ rosa create account-roles --mode auto
3939
====
4040
When using `auto` mode, you can optionally specify the `-y` argument to bypass the interactive prompts and automatically confirm operations.
4141
====
42-
42+
+
4343
. Create a cluster with STS using the defaults. When you use the defaults, the latest stable OpenShift version is installed:
4444
+
45+
--
4546
[source,terminal]
4647
----
47-
$ rosa create cluster --cluster-name <cluster_name> --sts --mode auto <1>
48+
$ rosa create cluster --cluster-name <cluster_name> \ <1>
49+
--sts --mode auto <2>
4850
----
51+
4952
<1> Replace `<cluster_name>` with the name of your cluster.
53+
<2> When you specify `--mode auto`, the `rosa create cluster` command creates the cluster-specific Operator IAM roles and the OIDC provider automatically. The Operators use the OIDC provider to authenticate.
54+
include::snippets/rosa-long-cluster-name.adoc[]
55+
--
5056
+
51-
[NOTE]
52-
====
53-
When you specify `--mode auto`, the `rosa create cluster` command creates the cluster-specific Operator IAM roles and the OIDC provider automatically. The Operators use the OIDC provider to authenticate.
54-
====
55-
5657
. Check the status of your cluster:
5758
+
5859
[source,terminal]

0 commit comments

Comments
 (0)