OSDOCS-14094: Applied changes to Preparing your Environment

EricPonvelle · EricPonvelle · commit d52345101f58 · 2025-07-10T17:13:28.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/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[]
+cluster.
 
 [id="rosa-ec2-instances_{context}"]
 == EC2 instances
@@ -15,7 +22,13 @@ 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[]
+.
 
 ifndef::openshift-rosa-hcp[]
 Instance types can vary for control plane and infrastructure nodes, depending on the worker node count.
@@ -201,4 +214,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[]
+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
@@ -8,7 +8,7 @@
 [id="rosa-hcp-firewall-prerequisites_{context}"]
 = Firewall prerequisites for {hcp-title}
 
-* 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-title}, 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[]
+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[]
+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,13 +21,13 @@ 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[]
+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
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[]
+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[]
+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[]
 
 .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
@@ -3,10 +3,10 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
 :context: rosa-cloud-expert-prereq-checklist
 [id="rosa-cloud-expert-prereq-checklist"]
 ifndef::openshift-rosa-hcp[]
-= Prerequisites checklist for deploying ROSA using STS
+= Prerequisites checklist for deploying {rosa-classic-short} using STS
 endif::[]
 ifdef::openshift-rosa-hcp[]
-= Prerequisites checklist for deploying ROSA with HCP
+= Prerequisites checklist for deploying {rosa-short}
 endif::openshift-rosa-hcp[]
 
 toc::[]
@@ -23,13 +23,11 @@ toc::[]
 //  - Diana Sari
 //---
 
-This is a high level checklist of prerequisites needed to create a
+This is a high level checklist of prerequisites needed to create a {product-title} cluster
 ifdef::openshift-rosa[]
-{rosa-classic-first} cluster with link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html[STS].
+ with link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html[STS]
 endif::openshift-rosa[]
-ifdef::openshift-rosa-hcp[]
-{hcp-title-first} cluster.
-endif::openshift-rosa-hcp[]
+.
 
 //TODO OSDOCS-11789: Consider adding the following to a subsection about the initiating/control machine, along with CLI sections?
 The machine that you run the installation process from must have access to the following:
@@ -126,7 +124,14 @@ $ rosa whoami
 
 === OpenShift CLI (`oc`)
 
-The OpenShift CLI (`oc`) is not required to deploy a {product-title} cluster, but is a useful tool for interacting with your cluster after it is deployed.
+The OpenShift CLI (`oc`) is not required to deploy a 
+ifdef::openshift-rosa[]
+{rosa-classic-short} 
+endif::openshift-rosa[]
+ifdef::openshift-rosa-hcp[]
+{rosa-short} 
+endif::openshift-rosa-hcp[]
+cluster, but is a useful tool for interacting with your cluster after it is deployed.
 
 . Download and install`oc` from the {cluster-manager} link:https://console.redhat.com/openshift/downloads#tool-oc[Command-line interface (CLI) tools] page, or follow the instructions in xref:../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[Getting started with the OpenShift CLI].
 . Verify that the OpenShift CLI has been installed correctly by running the following command:
@@ -148,20 +153,33 @@ $ rosa verify quota
 +
 This command only checks the total quota allocated to your account; it does not reflect the amount of quota already consumed from that quota. Running this command is optional because your quota is verified during cluster deployment. However, Red Hat recommends running this command to confirm your quota ahead of time so that deployment is not interrupted by issues with quota availability.
 ifdef::openshift-rosa[]
-* For more information about resources provisioned during ROSA cluster deployment, see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-aws-policy-provisioned_rosa-sts-aws-prereqs[Provisioned AWS Infrastructure].
+* For more information about resources provisioned during {rosa-classic-short} cluster deployment, see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-aws-policy-provisioned_rosa-sts-aws-prereqs[Provisioned AWS Infrastructure].
 * For more information about the required AWS service quotas, see xref:../rosa_planning/rosa-sts-required-aws-service-quotas.adoc#rosa-sts-required-aws-service-quotas[Required AWS service quotas].
 endif::openshift-rosa[]
 ifdef::openshift-rosa-hcp[]
-* For more information about resources provisioned during ROSA cluster deployment, see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-aws-policy-provisioned_rosa-hcp-prereqs[Provisioned AWS Infrastructure].
+* For more information about resources provisioned during {rosa-short} cluster deployment, see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-aws-policy-provisioned_rosa-hcp-prereqs[Provisioned AWS Infrastructure].
 * For more information about the required AWS service quotas, see xref:../rosa_planning/rosa-sts-required-aws-service-quotas.adoc#rosa-sts-required-aws-service-quotas[Required AWS service quotas].
 endif::openshift-rosa-hcp[]
 
 == Service Control Policy (SCP) prerequisites
 
-ROSA clusters are hosted in an AWS account within an AWS organizational unit. A link:https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scps.html[service control policy (SCP)] is created and applied to the AWS organizational unit that manages what services the AWS sub-accounts are permitted to access.
+ifdef::openshift-rosa[]
+{rosa-classic-short} 
+endif::openshift-rosa[]
+ifdef::openshift-rosa-hcp[]
+{rosa-short} 
+endif::openshift-rosa-hcp[]
+clusters are hosted in an AWS account within an AWS organizational unit. A link:https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scps.html[service control policy (SCP)] is created and applied to the AWS organizational unit that manages what services the AWS sub-accounts are permitted to access.
 
 * Ensure that your organization's SCPs are not more restrictive than the roles and policies required by the cluster. For more information, see the xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-minimum-scp_rosa-sts-about-iam-resources[Minimum set of effective permissions for SCPs].
-* When you create a ROSA cluster, an associated AWS OpenID Connect (OIDC) identity provider is created.
+* When you create a 
+ifdef::openshift-rosa[]
+{rosa-classic-short} 
+endif::openshift-rosa[]
+ifdef::openshift-rosa-hcp[]
+{rosa-short} 
+endif::openshift-rosa-hcp[]
+cluster, an associated AWS OpenID Connect (OIDC) identity provider is created.
 
 == Networking prerequisites
 
@@ -182,7 +200,7 @@ endif::openshift-rosa-hcp[]
 
 //Moving up prereqs that are actually required for deployment
 ifdef::openshift-rosa[]
-== VPC requirements for PrivateLink clusters
+=== VPC requirements for PrivateLink clusters
 
 If you choose to deploy a PrivateLink cluster, then be sure to deploy the cluster in the pre-existing BYO VPC:
 
@@ -206,13 +224,13 @@ xref:../networking/configuring-cluster-wide-proxy.adoc#configuring-cluster-wide-
 
 [NOTE]
 ====
-You can install a non-PrivateLink ROSA cluster in a pre-existing BYO VPC.
+You can install a non-PrivateLink {rosa-classic-short} cluster in a pre-existing BYO VPC.
 ====
 endif::openshift-rosa[]
 ifdef::openshift-rosa-hcp[]
 === Create VPC before cluster deployment
 
-{hcp-title} clusters must be deployed into an existing AWS Virtual Private Cloud (VPC).
+{rosa-short} clusters must be deployed into an existing AWS Virtual Private Cloud (VPC).
 
 include::snippets/rosa-existing-vpc-requirements.adoc[leveloffset=+0]
 
@@ -243,7 +261,14 @@ endif::openshift-rosa-hcp[]
 You can configure a custom domain name server and custom domain name for your cluster. To do so, complete the following prerequisites before you create the cluster:
 
 //TODO OSDOCS-11789: Needs verification from mmcneill
-* By default, ROSA clusters require you to set the `domain name servers` option to `AmazonProvidedDNS` to ensure successful cluster creation and operation.
+* By default, 
+ifdef::openshift-rosa[]
+{rosa-classic-short} 
+endif::openshift-rosa[]
+ifdef::openshift-rosa-hcp[]
+{rosa-short} 
+endif::openshift-rosa-hcp[]
+clusters require you to set the `domain name servers` option to `AmazonProvidedDNS` to ensure successful cluster creation and operation.
 * To use a custom DNS server and domain name for your cluster, the ROSA installer must be able to use VPC DNS with default DHCP options so that it can resolve internal IPs and services. This means that you must create a custom DHCP option set to forward DNS lookups to your DNS server, and associate this option set with your VPC before you create the cluster.
 ifdef::openshift-rosa[]
 For more information, see xref:../cloud_experts_tutorials/cloud-experts-custom-dns-resolver.adoc#cloud-experts-custom-dns-resolver[Deploying ROSA with a custom DNS resolver].
diff --git a/rosa_planning/rosa-sts-aws-prereqs.adoc b/rosa_planning/rosa-sts-aws-prereqs.adoc
