OSDOCS-14094: Applied changes to Preparing your Environment

EricPonvelle · EricPonvelle · commit 8ff1da6518fe · 2025-07-11T10:54:51.000-05:00
diff --git a/modules/mos-network-prereqs-min-bandwidth.adoc b/modules/mos-network-prereqs-min-bandwidth.adoc
@@ -7,6 +7,13 @@
 [id="mos-network-prereqs-min-bandwidth_{context}"]
 = Minimum bandwidth
 
-During cluster deployment, {product-title} requires a minimum bandwidth of 120{nbsp}Mbps between cluster infrastructure and the public internet or private network locations that provide deployment artifacts and resources. When network connectivity is slower than 120{nbsp}Mbps (for example, when connecting through a proxy) the cluster installation process times out and deployment fails.
+During cluster deployment, 
+ifdef::openshift-rosa[]
+{rosa-classic-short} 
+endif::openshift-rosa[]
+ifdef::openshift-rosa-hcp[]
+{rosa-short} 
+endif::openshift-rosa-hcp[]
+requires a minimum bandwidth of 120{nbsp}Mbps between cluster infrastructure and the public internet or private network locations that provide deployment artifacts and resources. When network connectivity is slower than 120{nbsp}Mbps (for example, when connecting through a proxy) the cluster installation process times out and deployment fails.
 
 After cluster deployment, network requirements are determined by your workload. However, a minimum bandwidth of 120{nbsp}Mbps helps to ensure timely cluster and operator upgrades.
diff --git a/modules/osd-aws-privatelink-firewall-prerequisites.adoc b/modules/osd-aws-privatelink-firewall-prerequisites.adoc
@@ -7,7 +7,7 @@
 :_mod-docs-content-type: PROCEDURE
 ifdef::openshift-rosa[]
 [id="rosa-classic-firewall-prerequisites_{context}"]
-= Firewall prerequisites for ROSA (classic architecture) clusters using STS
+= Firewall prerequisites for {rosa-classic-short} clusters using STS
 endif::openshift-rosa[]
 ifdef::openshift-dedicated[]
 [id="osd-aws-privatelink-firewall-prerequisites_{context}"]
diff --git a/modules/rosa-aws-provisioned.adoc b/modules/rosa-aws-provisioned.adoc
@@ -6,7 +6,14 @@
 [id="rosa-aws-policy-provisioned_{context}"]
 = Provisioned AWS Infrastructure
 
-This is an overview of the provisioned {AWS} components on a deployed {product-title} (ROSA) cluster.
+This is an overview of the provisioned {AWS} components on a deployed 
+ifdef::openshift-rosa[]
+{rosa-classic-short} 
+endif::openshift-rosa[]
+ifdef::openshift-rosa-hcp[]
+{rosa-short} 
+endif::openshift-rosa-hcp[]
+cluster.
 
 [id="rosa-ec2-instances_{context}"]
 == EC2 instances
@@ -15,7 +22,12 @@ AWS EC2 instances are required to deploy
 ifndef::openshift-rosa-hcp[]
 the control plane and data plane functions for
 endif::openshift-rosa-hcp[]
-{product-title}.
+ifdef::openshift-rosa[]
+{rosa-classic-short}.
+endif::openshift-rosa[]
+ifdef::openshift-rosa-hcp[]
+{rosa-short}.
+endif::openshift-rosa-hcp[]
 
 ifndef::openshift-rosa-hcp[]
 Instance types can vary for control plane and infrastructure nodes, depending on the worker node count.
@@ -201,4 +213,11 @@ can add additional custom security groups during cluster creation. Custom securi
 
 * You must create the custom security groups in AWS before you create the cluster. For more information, see link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-security-groups.html[Amazon EC2 security groups for Linux instances].
 * You must associate the custom security groups with the VPC that the cluster will be installed into. Your custom security groups cannot be associated with another VPC.
-* You might need to request additional quota for your VPC if you are adding additional custom security groups. For information on AWS quota requirements for ROSA, see _Required AWS service quotas_ in _Prepare your environment_. For information on requesting an AWS quota increase, see link:https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html[Requesting a quota increase].
+* You might need to request additional quota for your VPC if you are adding additional custom security groups. For information on AWS quota requirements for 
+ifdef::openshift-rosa[]
+{rosa-classic-short}, 
+endif::openshift-rosa[]
+ifdef::openshift-rosa-hcp[]
+{rosa-short}, 
+endif::openshift-rosa-hcp[]
+see _Required AWS service quotas_ in _Prepare your environment_. For information on requesting an AWS quota increase, see link:https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html[Requesting a quota increase].
diff --git a/modules/rosa-hcp-firewall-prerequisites.adoc b/modules/rosa-hcp-firewall-prerequisites.adoc
@@ -6,9 +6,9 @@
 //TODO OSDOCS-11789: Why is this a procedure and not a reference?
 
 [id="rosa-hcp-firewall-prerequisites_{context}"]
-= Firewall prerequisites for {hcp-title}
+= Firewall prerequisites for {rosa-short}
 
-* If you are using a firewall to control egress traffic from {hcp-title-first}, your Virtual Private Cloud (VPC) must be able to complete requests from the cluster to the Amazon S3 service, for example, via an Amazon S3 gateway.
+* If you are using a firewall to control egress traffic from {rosa-short}, your Virtual Private Cloud (VPC) must be able to complete requests from the cluster to the Amazon S3 service, for example, via an Amazon S3 gateway.
 
 * You must also configure your firewall to grant access to the following domain and port combinations.
 //TODO OSDOCS-11789: From your deploy machine? From your cluster?
diff --git a/modules/rosa-requirements-deploying-in-opt-in-regions.adoc b/modules/rosa-requirements-deploying-in-opt-in-regions.adoc
@@ -5,7 +5,14 @@
 [id="rosa-requirements-deploying-in-opt-in-regions_{context}"]
 = Requirements for deploying a cluster in an opt-in region
 
-An AWS opt-in region is a region that is not enabled in your AWS account by default. If you want to deploy a {product-title} (ROSA) cluster that uses the AWS Security Token Service (STS) in an opt-in region, you must meet the following requirements:
+An AWS opt-in region is a region that is not enabled in your AWS account by default. If you want to deploy a 
+ifdef::openshift-rosa[]
+{rosa-classic-short} 
+endif::openshift-rosa[]
+ifdef::openshift-rosa-hcp[]
+{rosa-short} 
+endif::openshift-rosa-hcp[]
+cluster that uses the AWS Security Token Service (STS) in an opt-in region, you must meet the following requirements:
 
 * The region must be enabled in your AWS account. For more information about enabling opt-in regions, see link:https://docs.aws.amazon.com/general/latest/gr/rande-manage.html[Managing AWS Regions] in the AWS documentation.
 * The security token version in your AWS account must be set to version 2. You cannot use version 1 security tokens for opt-in regions.
diff --git a/modules/rosa-setting-the-aws-security-token-version.adoc b/modules/rosa-setting-the-aws-security-token-version.adoc
@@ -6,7 +6,14 @@
 [id="rosa-setting-the-aws-security-token-version_{context}"]
 = Setting the AWS security token version
 
-If you want to create a {product-title} (ROSA) cluster with the AWS Security Token Service (STS) in an AWS opt-in region, you must set the security token version to version 2 in your AWS account.
+If you want to create a 
+ifdef::openshift-rosa[]
+{rosa-classic-short} 
+endif::openshift-rosa[]
+ifdef::openshift-rosa-hcp[]
+{rosa-short} 
+endif::openshift-rosa-hcp[]
+cluster with the AWS Security Token Service (STS) in an AWS opt-in region, you must set the security token version to version 2 in your AWS account.
 
 .Prerequisites
 
diff --git a/modules/rosa-sts-associating-your-aws-account.adoc b/modules/rosa-sts-associating-your-aws-account.adoc
@@ -21,19 +21,19 @@ ifeval::["{context}" == "rosa-sts-creating-a-cluster-quickly"]
 endif::[]
 
 Before using {cluster-manager-first} on the {hybrid-console-url} to create
-ifdef::rosa-hcp[]
-{hcp-title} clusters
-endif::rosa-hcp[]
-ifndef::rosa-hcp[]
-{product-title} (ROSA) clusters
-endif::rosa-hcp[]
-that use the AWS Security Token Service (STS), create an {cluster-manager} IAM role and link it to your Red{nbsp}Hat organization. Then, create a user IAM role and link it to your Red{nbsp}Hat user account in the same Red{nbsp}Hat organization.
+ifdef::openshift-rosa[]
+{rosa-classic-short} 
+endif::openshift-rosa[]
+ifdef::openshift-rosa-hcp[]
+{rosa-short} 
+endif::openshift-rosa-hcp[]
+clusters that use the AWS Security Token Service (STS), create an {cluster-manager} IAM role and link it to your Red{nbsp}Hat organization. Then, create a user IAM role and link it to your Red{nbsp}Hat user account in the same Red{nbsp}Hat organization.
 
 ifdef::quick-install[]
 .Prerequisites
 
 ifdef::rosa-hcp[]
-* You have completed the AWS prerequisites for {hcp-title}.
+* You have completed the AWS prerequisites for {rosa-short}.
 endif::rosa-hcp[]
 ifndef::rosa-hcp[]
 * You have completed the AWS prerequisites for ROSA with STS.
@@ -46,7 +46,7 @@ endif::rosa-hcp[]
 ====
 To successfully install
 ifdef::rosa-hcp[]
-{hcp-title}
+{rosa-short}
 endif::rosa-hcp[]
 ifndef::rosa-hcp[]
 ROSA
@@ -65,7 +65,7 @@ endif::[]
 ====
 To enable automatic deployment of the cluster-specific Operator roles and the OpenID Connect (OIDC) provider using the {cluster-manager} {hybrid-console-second}, you must apply the administrative privileges to the role by choosing the _Admin OCM role_ command in the *Accounts and roles* step of creating a
 ifdef::rosa-hcp[]
-{hcp-title}
+{rosa-short}
 endif::rosa-hcp[]
 ifndef::rosa-hcp[]
 ROSA
@@ -77,14 +77,14 @@ cluster. For more information about the basic and administrative privileges for
 ====
 If you choose the _Basic OCM role_ command in the *Accounts and roles* step of creating a
 ifdef::rosa-hcp[]
-{hcp-title}
+{rosa-short}
 endif::rosa-hcp[]
 ifndef::rosa-hcp[]
 ROSA
 endif::rosa-hcp[]
 cluster in the {cluster-manager} {hybrid-console-second}, you must deploy a
 ifdef::rosa-hcp[]
-{hcp-title}
+{rosa-short}
 endif::rosa-hcp[]
 ifndef::rosa-hcp[]
 ROSA
diff --git a/modules/rosa-sts-aws-requirements-association-concept.adoc b/modules/rosa-sts-aws-requirements-association-concept.adoc
@@ -6,6 +6,13 @@
 [id="rosa-associating-concept_{context}"]
 = AWS account association
 
-When you provision {product-title} (ROSA) using {cluster-manager} (`console.redhat.com`), you must associate the `ocm-role` and `user-role` IAM roles with your AWS account using your Amazon Resource Name (ARN). This association process is also known as _account linking_.
+When you provision 
+ifdef::openshift-rosa[]
+{rosa-classic-short} 
+endif::openshift-rosa[]
+ifdef::openshift-rosa-hcp[]
+{rosa-short} 
+endif::openshift-rosa-hcp[]
+using {cluster-manager} (`console.redhat.com`), you must associate the `ocm-role` and `user-role` IAM roles with your AWS account using your Amazon Resource Name (ARN). This association process is also known as _account linking_.
 
 The `ocm-role` ARN is stored as a label in your Red{nbsp}Hat organization while the `user-role` ARN is stored as a label inside your Red{nbsp}Hat user account. Red{nbsp}Hat uses these ARN labels to confirm that the user is a valid account holder and that the correct permissions are available to perform provisioning tasks in the AWS account.
diff --git a/modules/rosa-sts-aws-requirements-creating-multi-association.adoc b/modules/rosa-sts-aws-requirements-creating-multi-association.adoc
@@ -7,7 +7,14 @@
 [id="rosa-associating-multiple-account_{context}"]
 = Associating multiple AWS accounts with your Red{nbsp}Hat organization
 
-You can associate multiple AWS accounts with your Red{nbsp}Hat organization. Associating multiple accounts lets you create {product-title} (ROSA) clusters on any of the associated AWS accounts from your Red{nbsp}Hat organization.
+You can associate multiple AWS accounts with your Red{nbsp}Hat organization. Associating multiple accounts lets you create 
+ifdef::openshift-rosa[]
+{rosa-classic-short} 
+endif::openshift-rosa[]
+ifdef::openshift-rosa-hcp[]
+{rosa-short} 
+endif::openshift-rosa-hcp[]
+clusters on any of the associated AWS accounts from your Red{nbsp}Hat organization.
 
 With this capability, you can create clusters on different AWS profiles according to characteristics that make sense for your business, for example, by using one AWS profile for each region to create region-bound environments.
 
@@ -17,7 +24,13 @@ With this capability, you can create clusters on different AWS profiles accordin
 * You are using {cluster-manager-url} to create clusters.
 * You have the permissions required to install AWS account-wide roles.
 * You have installed and configured the latest AWS (`aws`) and ROSA (`rosa`) CLIs on your installation host.
-* You have created the `ocm-role` and `user-role` IAM roles for ROSA.
+* You have created the `ocm-role` and `user-role` IAM roles for 
+ifdef::openshift-rosa[]
+{rosa-classic-short}.
+endif::openshift-rosa[]
+ifdef::openshift-rosa-hcp[]
+{rosa-short}.
+endif::openshift-rosa-hcp[]
 
 .Procedure
 
diff --git a/modules/rosa-sts-aws-requirements-security-req.adoc b/modules/rosa-sts-aws-requirements-security-req.adoc
@@ -7,4 +7,7 @@
 = Security requirements
 //TODO OSDOCS-11789: Red Hat as in RHSRE? Red Hat as in RH services in the cluster?
 * Red{nbsp}Hat must have ingress access to EC2 hosts and the API server from allow-listed IP addresses.
-* Red{nbsp}Hat must have egress allowed to the domains documented in the "Firewall prerequisites" section. Clusters with {zero-egress} are exempt from this requirement.
+* Red{nbsp}Hat must have egress allowed to the domains documented in the "Firewall prerequisites" section. 
+ifdef::openshift-rosa-hcp[]
+Clusters with {egress-zero} are exempt from this requirement.
+endif::openshift-rosa-hcp[]
diff --git a/modules/rosa-sts-aws-requirements-support-req.adoc b/modules/rosa-sts-aws-requirements-support-req.adoc
@@ -7,4 +7,11 @@
 * Red{nbsp}Hat recommends that the customer have at least link:https://aws.amazon.com/premiumsupport/plans/[Business Support] from AWS.
 * Red{nbsp}Hat may have permission from the customer to request AWS support on their behalf.
 * Red{nbsp}Hat may have permission from the customer to request AWS resource limit increases on the customer's account.
-* Red{nbsp}Hat manages the restrictions, limitations, expectations, and defaults for all {product-title} clusters in the same manner, unless otherwise specified in this requirements section.
+* Red{nbsp}Hat manages the restrictions, limitations, expectations, and defaults for all 
+ifdef::openshift-rosa[]
+{rosa-classic-short} 
+endif::openshift-rosa[]
+ifdef::openshift-rosa-hcp[]
+{rosa-short} 
+endif::openshift-rosa-hcp[]
+clusters in the same manner, unless otherwise specified in this requirements section.
diff --git a/rosa_planning/rosa-cloud-expert-prereq-checklist.adoc b/rosa_planning/rosa-cloud-expert-prereq-checklist.adoc
diff --git a/rosa_planning/rosa-sts-aws-prereqs.adoc b/rosa_planning/rosa-sts-aws-prereqs.adoc
diff --git a/snippets/rosa-sts.adoc b/snippets/rosa-sts.adoc
