Skip to content

Commit f22e0ea

Browse files
committed
OSDOCS-14094: Applied changes to Preparing your Environment
1 parent ed42879 commit f22e0ea

6 files changed

+69
-27
lines changed

modules/mos-network-prereqs-min-bandwidth.adoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@
77
[id="mos-network-prereqs-min-bandwidth_{context}"]
88
= Minimum bandwidth
99

10-
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.
10+
During cluster deployment,
11+
ifdef::openshift-rosa[]
12+
{rosa-classic-short}
13+
endif::openshift-rosa[]
14+
ifdef::openshift-rosa-hcp[]
15+
{rosa-short}
16+
endif::openshift-rosa-hcp[]
17+
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.
1118

1219
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.

modules/rosa-hcp-firewall-prerequisites.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[id="rosa-hcp-firewall-prerequisites_{context}"]
99
= Firewall prerequisites for {hcp-title}
1010

11-
* 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.
11+
* 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.
1212

1313
* You must also configure your firewall to grant access to the following domain and port combinations.
1414
//TODO OSDOCS-11789: From your deploy machine? From your cluster?

modules/rosa-sts-aws-requirements-security-req.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,7 @@
77
= Security requirements
88
//TODO OSDOCS-11789: Red Hat as in RHSRE? Red Hat as in RH services in the cluster?
99
* Red{nbsp}Hat must have ingress access to EC2 hosts and the API server from allow-listed IP addresses.
10-
* 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.
10+
* Red{nbsp}Hat must have egress allowed to the domains documented in the "Firewall prerequisites" section.
11+
ifdef::openshift-rosa-hcp[]
12+
Clusters with {egress-zero} are exempt from this requirement.
13+
endif::openshift-rosa-hcp[]

modules/rosa-sts-aws-requirements-support-req.adoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,11 @@
77
* Red{nbsp}Hat recommends that the customer have at least link:https://aws.amazon.com/premiumsupport/plans/[Business Support] from AWS.
88
* Red{nbsp}Hat may have permission from the customer to request AWS support on their behalf.
99
* Red{nbsp}Hat may have permission from the customer to request AWS resource limit increases on the customer's account.
10-
* 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.
10+
* Red{nbsp}Hat manages the restrictions, limitations, expectations, and defaults for all
11+
ifdef::openshift-rosa[]
12+
{rosa-classic-short}
13+
endif::openshift-rosa[]
14+
ifdef::openshift-rosa-hcp[]
15+
{rosa-short}
16+
endif::openshift-rosa-hcp[]
17+
clusters in the same manner, unless otherwise specified in this requirements section.

rosa_planning/rosa-cloud-expert-prereq-checklist.adoc

Lines changed: 41 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
33
:context: rosa-cloud-expert-prereq-checklist
44
[id="rosa-cloud-expert-prereq-checklist"]
55
ifndef::openshift-rosa-hcp[]
6-
= Prerequisites checklist for deploying ROSA using STS
6+
= Prerequisites checklist for deploying {rosa-classic-short} using STS
77
endif::[]
88
ifdef::openshift-rosa-hcp[]
9-
= Prerequisites checklist for deploying ROSA with HCP
9+
= Prerequisites checklist for deploying {rosa-short}
1010
endif::openshift-rosa-hcp[]
1111

1212
toc::[]
@@ -23,13 +23,11 @@ toc::[]
2323
// - Diana Sari
2424
//---
2525

26-
This is a high level checklist of prerequisites needed to create a
26+
This is a high level checklist of prerequisites needed to create a {product-title} cluster
2727
ifdef::openshift-rosa[]
28-
{rosa-classic-first} cluster with link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html[STS].
28+
with link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html[STS]
2929
endif::openshift-rosa[]
30-
ifdef::openshift-rosa-hcp[]
31-
{hcp-title-first} cluster.
32-
endif::openshift-rosa-hcp[]
30+
.
3331

3432
//TODO OSDOCS-11789: Consider adding the following to a subsection about the initiating/control machine, along with CLI sections?
3533
The machine that you run the installation process from must have access to the following:
@@ -126,7 +124,14 @@ $ rosa whoami
126124

127125
=== OpenShift CLI (`oc`)
128126

129-
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.
127+
The OpenShift CLI (`oc`) is not required to deploy a
128+
ifdef::openshift-rosa[]
129+
{rosa-classic-short}
130+
endif::openshift-rosa[]
131+
ifdef::openshift-rosa-hcp[]
132+
{rosa-short}
133+
endif::openshift-rosa-hcp[]
134+
cluster, but is a useful tool for interacting with your cluster after it is deployed.
130135

131136
. 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].
132137
. Verify that the OpenShift CLI has been installed correctly by running the following command:
@@ -148,20 +153,33 @@ $ rosa verify quota
148153
+
149154
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.
150155
ifdef::openshift-rosa[]
151-
* 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].
156+
* 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].
152157
* 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].
153158
endif::openshift-rosa[]
154159
ifdef::openshift-rosa-hcp[]
155-
* 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].
160+
* 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].
156161
* 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].
157162
endif::openshift-rosa-hcp[]
158163

159164
== Service Control Policy (SCP) prerequisites
160165

161-
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.
166+
ifdef::openshift-rosa[]
167+
{rosa-classic-short}
168+
endif::openshift-rosa[]
169+
ifdef::openshift-rosa-hcp[]
170+
{rosa-short}
171+
endif::openshift-rosa-hcp[]
172+
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.
162173

163174
* 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].
164-
* When you create a ROSA cluster, an associated AWS OpenID Connect (OIDC) identity provider is created.
175+
* When you create a
176+
ifdef::openshift-rosa[]
177+
{rosa-classic-short}
178+
endif::openshift-rosa[]
179+
ifdef::openshift-rosa-hcp[]
180+
{rosa-short}
181+
endif::openshift-rosa-hcp[]
182+
cluster, an associated AWS OpenID Connect (OIDC) identity provider is created.
165183

166184
== Networking prerequisites
167185

@@ -182,7 +200,7 @@ endif::openshift-rosa-hcp[]
182200

183201
//Moving up prereqs that are actually required for deployment
184202
ifdef::openshift-rosa[]
185-
== VPC requirements for PrivateLink clusters
203+
=== VPC requirements for PrivateLink clusters
186204

187205
If you choose to deploy a PrivateLink cluster, then be sure to deploy the cluster in the pre-existing BYO VPC:
188206

@@ -206,13 +224,13 @@ xref:../networking/configuring-cluster-wide-proxy.adoc#configuring-cluster-wide-
206224

207225
[NOTE]
208226
====
209-
You can install a non-PrivateLink ROSA cluster in a pre-existing BYO VPC.
227+
You can install a non-PrivateLink {rosa-classic-short} cluster in a pre-existing BYO VPC.
210228
====
211229
endif::openshift-rosa[]
212230
ifdef::openshift-rosa-hcp[]
213231
=== Create VPC before cluster deployment
214232

215-
{hcp-title} clusters must be deployed into an existing AWS Virtual Private Cloud (VPC).
233+
{rosa-short} clusters must be deployed into an existing AWS Virtual Private Cloud (VPC).
216234

217235
include::snippets/rosa-existing-vpc-requirements.adoc[leveloffset=+0]
218236

@@ -243,7 +261,14 @@ endif::openshift-rosa-hcp[]
243261
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:
244262

245263
//TODO OSDOCS-11789: Needs verification from mmcneill
246-
* By default, ROSA clusters require you to set the `domain name servers` option to `AmazonProvidedDNS` to ensure successful cluster creation and operation.
264+
* By default,
265+
ifdef::openshift-rosa[]
266+
{rosa-classic-short}
267+
endif::openshift-rosa[]
268+
ifdef::openshift-rosa-hcp[]
269+
{rosa-short}
270+
endif::openshift-rosa-hcp[]
271+
clusters require you to set the `domain name servers` option to `AmazonProvidedDNS` to ensure successful cluster creation and operation.
247272
* 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.
248273
ifdef::openshift-rosa[]
249274
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].

rosa_planning/rosa-sts-aws-prereqs.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
44
ifndef::openshift-rosa-hcp[]
55
:context: rosa-sts-aws-prereqs
66
[id="rosa-sts-aws-prereqs"]
7-
= Detailed requirements for deploying ROSA (classic architecture) using STS
7+
= Detailed requirements for deploying {product-title} using STS
88
endif::openshift-rosa-hcp[]
99
ifdef::openshift-rosa-hcp[]
1010
:context: rosa-hcp-prereqs
1111
[id="rosa-hcp-prereqs"]
12-
= Detailed requirements for deploying {hcp-title}
12+
= Detailed requirements for deploying {product-title}
1313
endif::openshift-rosa-hcp[]
1414

1515
toc::[]
1616

17-
{product-title} (ROSA) provides a model that allows Red{nbsp}Hat to deploy clusters into a customer’s existing Amazon Web Service (AWS) account.
17+
{product-title} provides a model that allows Red{nbsp}Hat to deploy clusters into a customer’s existing Amazon Web Service (AWS) account.
1818

1919
ifndef::openshift-rosa-hcp[]
2020
include::snippets/rosa-sts.adoc[leveloffset=+0]
@@ -26,13 +26,13 @@ ifndef::openshift-rosa-hcp[]
2626
[id="rosa-sts-customer-requirements_{context}"]
2727
== Customer requirements when using STS for deployment
2828

29-
The following prerequisites must be complete before you deploy a {product-title} (ROSA) cluster that uses the AWS Security Token Service (STS).
29+
The following prerequisites must be complete before you deploy a {rosa-classic-short} cluster that uses the AWS Security Token Service (STS).
3030
endif::openshift-rosa-hcp[]
3131
ifdef::openshift-rosa-hcp[]
3232
[id="rosa-hcp-customer-requirements_{context}"]
33-
== Customer requirements for all {hcp-title} clusters
33+
== Customer requirements for all {rosa-short} clusters
3434

35-
The following prerequisites must be complete before you deploy a {hcp-title} cluster.
35+
The following prerequisites must be complete before you deploy a {rosa-short} cluster.
3636
endif::openshift-rosa-hcp[]
3737

3838
include::modules/rosa-sts-aws-requirements-account.adoc[leveloffset=+2]
@@ -81,7 +81,7 @@ ifdef::openshift-rosa,openshift-rosa-hcp[]
8181
[role="_additional-resources"]
8282
[id="additional-resources_creating-association_{context}"]
8383
== Additional resources
84-
* See xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-account-wide-roles-and-policies_rosa-sts-about-iam-resources[Account-wide IAM role and policy reference] for a list of IAM roles needed for cluster creation.
84+
* xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-account-wide-roles-and-policies_rosa-sts-about-iam-resources[Account-wide IAM role and policy reference]
8585
endif::openshift-rosa,openshift-rosa-hcp[]
8686

8787
include::modules/rosa-sts-aws-requirements-creating-multi-association.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)