Skip to content

Commit 8a947b4

Browse files
authored
Merge pull request #66140 from AedinC/OSDOCS-7176
[OSDOCS#7176]:Added documentation for AWS custom tags.
2 parents 93d8f70 + 8f79b98 commit 8a947b4

File tree

3 files changed

+37
-9
lines changed

3 files changed

+37
-9
lines changed

modules/rosa-create-objects.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,16 @@ When using `--private-link`, the `--subnet-ids` argument is required and only on
202202
|--support-role-arn string
203203
|The ARN of the role used by Red Hat Site Reliabilty Engineers (SREs) to enable access to the cluster account to provide support.
204204

205+
|--tags
206+
a|Tags that are used on resources created by {product-title} in AWS. Tags can help you manage, identify, organize, search for, and filter resources within AWS. Tags are comma separated, for example: "key value, foo bar".
207+
[IMPORTANT]
208+
====
209+
{product-title} only supports custom tags to Red Hat OpenShift resources during cluster creation. Once added, the tags cannot be removed or edited.
210+
Tags that are added by Red Hat are required for clusters to stay in compliance with Red Hat production service level agreements (SLAs). These tags must not be removed.
211+
212+
{product-title} does not support adding additional tags outside of ROSA cluster-managed resources. These tags can be lost when AWS resources are managed by the ROSA cluster. In these cases, you might need custom solutions or tools to reconcile the tags and keep them intact.
213+
====
214+
205215
|--version string
206216
|The version of ROSA that will be used to install the cluster or cluster resources. For `cluster` use an `X.Y.Z` format, for example, `4.12.9`. For `account-role` use an `X.Y` format, for example, `4.12`.
207217

modules/rosa-sts-creating-a-cluster-with-customizations-cli.adoc

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -230,24 +230,26 @@ I: Using arn:aws:iam::<aws_account_id>:role/ManagedOpenShift-Worker-Role for the
230230
I: Using arn:aws:iam::<aws_account_id>:role/ManagedOpenShift-Support-Role for the Support role
231231
? External ID (optional):
232232
? Operator roles prefix: <cluster_name>-<random_string> <5>
233-
? Multiple availability zones (optional): No <6>
233+
? Deploy cluster using pre registered OIDC Configuration ID:
234+
? Tags (optional) <6>
235+
? Multiple availability zones (optional): No <7>
234236
? AWS region: us-east-1
235237
? PrivateLink cluster (optional): No
236238
? Install into an existing VPC (optional): No
237239
? Select availability zones (optional): No
238-
? Enable Customer Managed key (optional): No <7>
240+
? Enable Customer Managed key (optional): No <8>
239241
? Compute nodes instance type (optional):
240242
? Enable autoscaling (optional): No
241243
? Compute nodes: 2
242244
? Machine CIDR: 10.0.0.0/16
243245
? Service CIDR: 172.30.0.0/16
244246
? Pod CIDR: 10.128.0.0/14
245247
? Host prefix: 23
246-
? Encrypt etcd data (optional): No <8>
248+
? Encrypt etcd data (optional): No <9>
247249
? Disable Workload monitoring (optional): No
248250
I: Creating cluster '<cluster_name>'
249251
I: To create this cluster again in the future, you can run:
250-
rosa create cluster --cluster-name <cluster_name> --role-arn arn:aws:iam::<aws_account_id>:role/ManagedOpenShift-Installer-Role --support-role-arn arn:aws:iam::<aws_account_id>:role/ManagedOpenShift-Support-Role --master-iam-role arn:aws:iam::<aws_account_id>:role/ManagedOpenShift-ControlPlane-Role --worker-iam-role arn:aws:iam::<aws_account_id>:role/ManagedOpenShift-Worker-Role --operator-roles-prefix <cluster_name>-<random_string> --region us-east-1 --version 4.8.9 --compute-nodes 2 --machine-cidr 10.0.0.0/16 --service-cidr 172.30.0.0/16 --pod-cidr 10.128.0.0/14 --host-prefix 23 <9>
252+
rosa create cluster --cluster-name <cluster_name> --role-arn arn:aws:iam::<aws_account_id>:role/ManagedOpenShift-Installer-Role --support-role-arn arn:aws:iam::<aws_account_id>:role/ManagedOpenShift-Support-Role --master-iam-role arn:aws:iam::<aws_account_id>:role/ManagedOpenShift-ControlPlane-Role --worker-iam-role arn:aws:iam::<aws_account_id>:role/ManagedOpenShift-Worker-Role --operator-roles-prefix <cluster_name>-<random_string> --region us-east-1 --version 4.8.9 --compute-nodes 2 --machine-cidr 10.0.0.0/16 --service-cidr 172.30.0.0/16 --pod-cidr 10.128.0.0/14 --host-prefix 23 <10>
251253
I: To view a list of clusters and their status, run 'rosa list clusters'
252254
I: Cluster '<cluster_name>' has been created.
253255
I: Once the cluster is installed you will need to add an Identity Provider before you can login into the cluster. See 'rosa create idp --help' for more information.
@@ -268,8 +270,17 @@ The Instance Metadata Service settings cannot be changed after your cluster is c
268270
====
269271
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.
270272
====
271-
<6> Optional: Multiple availability zones are recommended for production workloads. The default is a single availability zone.
272-
<7> Optional: Enable this option if you are using your own AWS KMS key to encrypt the control plane, infrastructure, worker node root volumes, and PVs. Specify the ARN for the KMS key that you added to the account-wide role ARN in the preceding step.
273+
<6> Optional: Specify a tag that is used on all resources created by {product-title} in AWS. Tags can help you manage, identify, organize, search for, and filter resources within AWS. Tags are comma separated, for example: "key value, foo bar".
274+
+
275+
[IMPORTANT]
276+
====
277+
{product-title} only supports custom tags to Red Hat OpenShift resources during cluster creation. Once added, the tags cannot be removed or edited.
278+
Tags that are added by Red Hat are required for clusters to stay in compliance with Red Hat production service level agreements (SLAs). These tags must not be removed.
279+
280+
{product-title} does not support adding additional tags outside of ROSA cluster-managed resources. These tags can be lost when AWS resources are managed by the ROSA cluster. In these cases, you might need custom solutions or tools to reconcile the tags and keep them intact.
281+
====
282+
<7> Optional: Multiple availability zones are recommended for production workloads. The default is a single availability zone.
283+
<8> Optional: Enable this option if you are using your own AWS KMS key to encrypt the control plane, infrastructure, worker node root volumes, and PVs. Specify the ARN for the KMS key that you added to the account-wide role ARN in the preceding step.
273284
+
274285
[IMPORTANT]
275286
====
@@ -278,14 +289,14 @@ Only persistent volumes (PVs) created from the default storage class are encrypt
278289
PVs created by using any other storage class are still encrypted, but the PVs are not encrypted with this key unless the storage class is specifically configured to use this key.
279290
====
280291
281-
<8> Optional: Only enable this option if your use case requires etcd key value encryption in addition to the control plane storage encryption that encrypts the etcd volumes by default. With this option, the etcd key values are encrypted but not the keys.
292+
<9> Optional: Only enable this option if your use case requires etcd key value encryption in addition to the control plane storage encryption that encrypts the etcd volumes by default. With this option, the etcd key values are encrypted but not the keys.
282293
+
283294
[IMPORTANT]
284295
====
285296
By enabling etcd encryption for the key values in etcd, you will incur a performance overhead of approximately 20%. The overhead is a result of introducing this second layer of encryption, in addition to the default control plane storage encryption that encrypts the etcd volumes. Red Hat recommends that you enable etcd encryption only if you specifically require it for your use case.
286297
====
287298
+
288-
<9> The output includes a custom command that you can run to create a cluster with the same configuration in the future.
299+
<10> The output includes a custom command that you can run to create a cluster with the same configuration in the future.
289300
--
290301
+
291302
As an alternative to using the `--interactive` mode, you can specify the customization options directly when you run the `rosa create cluster` command. Run the `rosa create cluster --help` command to view a list of available CLI options, or see _create cluster_ in _Managing objects with the ROSA CLI_.

modules/rosa-sts-interactive-cluster-creation-mode-options.adoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,14 @@ The ROSA with Hosted Control Planes functionality is currently offered as a Tech
5151
|Specify if you want to use a pre-configured OIDC configuration or if you want to create a new OIDC configuration as part of the cluster creation process.
5252

5353
|`Tags (optional)`
54-
|Specify a tag that is used on all resources created by ROSA in AWS. Tags are comma separated, for example: "key value, foo bar".
54+
|Specify a tag that is used on all resources created by {product-title} in AWS. Tags can help you manage, identify, organize, search for, and filter resources within AWS. Tags are comma separated, for example: "key value, foo bar".
55+
[IMPORTANT]
56+
====
57+
{product-title} only supports custom tags to Red Hat OpenShift resources during cluster creation. Once added, the tags cannot be removed or edited.
58+
Tags that are added by Red Hat are required for clusters to stay in compliance with Red Hat production service level agreements (SLAs). These tags must not be removed.
59+
60+
{product-title} does not support adding additional tags outside of ROSA cluster-managed resources. These tags can be lost when AWS resources are managed by the ROSA cluster. In these cases, you might need custom solutions or tools to reconcile the tags and keep them intact.
61+
====
5562

5663
|`Multiple availability zones (optional)`
5764
|Deploy the cluster to multiple availability zones in the AWS region. The default is `No`, which results in a cluster being deployed to a single availability zone. If you deploy a cluster into multiple availability zones, the AWS region must have at least 3 availability zones. Multiple availability zones are recommended for production workloads.

0 commit comments

Comments
 (0)