Skip to content

Commit efb5985

Browse files
committed
OSDOCS-14486: Pruning 'Prepare Your Environment' book
1 parent 12b6324 commit efb5985

File tree

53 files changed

+151
-589
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+151
-589
lines changed

_topic_maps/_topic_map_rosa.yml

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -233,21 +233,12 @@ Topics:
233233
- Name: Prerequisites checklist for deploying ROSA using STS
234234
File: rosa-cloud-expert-prereq-checklist
235235
- Name: Detailed requirements for deploying ROSA using STS
236-
File: rosa-classic-aws-prereqs
237-
- Name: Detailed requirements for deploying ROSA with HCP
238-
File: rosa-hcp-aws-prereqs
239-
# Hiding this entry until the HCP migration is completed
240-
# - Name: Detailed requirements for deploying ROSA using STS
241-
# File: rosa-sts-aws-prereqs
236+
File: rosa-sts-aws-prereqs
242237
- Name: ROSA Classic IAM role resources
243238
File: rosa-sts-ocm-role
244-
- Name: ROSA with HCP IAM roles and resources
245-
File: rosa-hcp-prepare-iam-roles-resources
246239
##### NOTE: THE BELOW IS REMOVED AS PART OF OSDOCS-13310
247240
# - Name: Limits and scalability
248241
# File: rosa-limits-scalability
249-
#- Name: ROSA with HCP limits and scalability
250-
# File: rosa-hcp-limits-scalability
251242
##### NOTE: THE ABOVE IS REMOVED AS PART OF OSDOCS-13310F
252243
- Name: Planning your environment
253244
File: rosa-planning-environment

_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -164,15 +164,10 @@ Topics:
164164
- Name: Prerequisites checklist for deploying ROSA with HCP
165165
File: rosa-cloud-expert-prereq-checklist
166166
- Name: Detailed requirements for deploying ROSA with HCP
167-
File: rosa-hcp-aws-prereqs
168-
# Hiding this entry until the HCP migration is completed
169-
# - Name: Detailed requirements for deploying ROSA with HCP
170-
# File: rosa-sts-aws-prereqs
167+
File: rosa-sts-aws-prereqs
171168
- Name: Required IAM roles and resources
172169
File: rosa-hcp-prepare-iam-roles-resources
173170
##### NOTE: THE BELOW IS REMOVED AS PART OF OSDOCS-13310
174-
# - Name: Limits and scalability
175-
# File: rosa-limits-scalability
176171
#- Name: ROSA with HCP limits and scalability
177172
# File: rosa-hcp-limits-scalability
178173
##### NOTE: THE ABOVE IS REMOVED AS PART OF OSDOCS-13310
@@ -182,8 +177,6 @@ Topics:
182177
File: rosa-sts-setting-up-environment
183178
- Name: Planning resource usage in your cluster
184179
File: rosa-planning-environment
185-
# - Name: Preparing Terraform to install ROSA clusters
186-
# File: rosa-understanding-terraform
187180
---
188181
Name: Install ROSA with HCP clusters
189182
Dir: rosa_hcp

cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-getting-started-deploying/cloud-experts-getting-started-detailed-cli-guide.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ The default settings are as follows:
142142
** 2 infrastructure nodes
143143
** 2 worker nodes
144144
** No autoscaling
145-
** See the documentation on xref:../../../rosa_planning/rosa-classic-aws-prereqs.adoc#rosa-ec2-instances_rosa-classic-aws-prereqs[ec2 instances] for more details.
145+
** See the documentation on xref:../../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-ec2-instances_rosa-sts-aws-prereqs[ec2 instances] for more details.
146146
// This link needs to remain hidden until the HCP migration is published
147147
// ** See the documentation on xref:../../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-ec2-instances_rosa-sts-aws-prereqs[ec2 instances] for more details.
148148
* Region: As configured for the `aws` CLI

cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-getting-started-deploying/cloud-experts-getting-started-hcp.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ echo "export PRIVATE_SUBNET_ID=$PRIVATE_SUBNET_ID"
152152
+
153153
[role="_additional-resources"]
154154
.Additional resources
155-
* For more about VPC requirements, see the xref:../../../rosa_planning/rosa-classic-aws-prereqs.adoc#rosa-vpc_rosa-classic-aws-prereqs[VPC documentation].
155+
* For more about VPC requirements, see the xref:../../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-vpc_rosa-sts-aws-prereqs[VPC documentation].
156156
// This link needs to remain hidden until the HCP migration is published
157157
// * For more about VPC requirements, see the xref:../../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-vpc_rosa-sts-aws-prereqs[VPC documentation].
158158

cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-getting-started-what-is-rosa.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ etcd encryption is configured the same as in OpenShift Container Platform. The a
134134
Currently, the ROSA CLI does not accept multi-region KMS keys for EBS encryption. This feature is in our backlog for product updates. The ROSA CLI accepts single region KMS keys for EBS encryption if it is defined at cluster creation.
135135

136136
== Infrastructure
137-
ROSA uses several different cloud services such as virtual machines, storage, and load balancers. You can see a defined list in the xref:../../rosa_planning/rosa-classic-aws-prereqs.adoc#rosa-aws-policy-provisioned_rosa-classic-aws-prereqs[AWS prerequisites].
137+
ROSA uses several different cloud services such as virtual machines, storage, and load balancers. You can see a defined list in the xref:../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-aws-policy-provisioned_rosa-sts-aws-prereqs[AWS prerequisites].
138138
// This section needs to remain hidden until the HCP migration is published
139139
// ROSA uses several different cloud services such as virtual machines, storage, and load balancers. You can see a defined list in the xref:../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-aws-policy-provisioned_rosa-sts-aws-prereqs[AWS prerequisites].
140140

cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-rosa-sts-explained.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ STS roles and policies must be created for each ROSA cluster. To make this easie
6464

6565
[id="components-specific-to-rosa-with-sts"]
6666
== Components specific to ROSA with STS
67-
* *AWS infrastructure* - This provides the infrastructure required for the cluster. It contains the actual EC2 instances, storage, and networking components. See xref:../../rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc#rosa-sdpolicy-aws-compute-types_rosa-service-definition[AWS compute types] to see supported instance types for compute nodes and xref:../../rosa_planning/rosa-classic-aws-prereqs.adoc#rosa-ec2-instances_rosa-classic-aws-prereqs[provisioned AWS infrastructure] for control plane and infrastructure node configuration.
67+
* *AWS infrastructure* - This provides the infrastructure required for the cluster. It contains the actual EC2 instances, storage, and networking components. See xref:../../rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc#rosa-sdpolicy-aws-compute-types_rosa-service-definition[AWS compute types] to see supported instance types for compute nodes and xref:../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-ec2-instances_rosa-sts-aws-prereqs[provisioned AWS infrastructure] for control plane and infrastructure node configuration.
6868
// This section needs to remain hidden until the HCP migration is done
6969
// * *AWS infrastructure* - This provides the infrastructure required for the cluster. It contains the actual EC2 instances, storage, and networking components. See xref:../../rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc#rosa-sdpolicy-aws-compute-types_rosa-service-definition[AWS compute types] to see supported instance types for compute nodes and xref:../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-ec2-instances_rosa-sts-aws-prereqs[provisioned AWS infrastructure] for control plane and infrastructure node configuration.
7070
* *AWS STS* - See the credential method section above.

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

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

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

1912
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/osd-aws-privatelink-firewall-prerequisites.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
:_mod-docs-content-type: PROCEDURE
88
ifdef::openshift-rosa[]
99
[id="rosa-classic-firewall-prerequisites_{context}"]
10-
= Firewall prerequisites for {rosa-classic-short} clusters using STS
10+
= Firewall prerequisites for {product-title} clusters using STS
1111
endif::openshift-rosa[]
1212
ifdef::openshift-dedicated[]
1313
[id="osd-aws-privatelink-firewall-prerequisites_{context}"]
@@ -108,7 +108,7 @@ endif::[]
108108

109109
|`oidc.op1.openshiftapps.com`
110110
|443
111-
|Used by ROSA for STS implementation with managed OIDC configuration.
111+
|Used by {product-title} for STS implementation with managed OIDC configuration.
112112
|===
113113
+
114114
. Allowlist the following telemetry URLs:

modules/rosa-aws-provisioned.adoc

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,7 @@
66
[id="rosa-aws-policy-provisioned_{context}"]
77
= Provisioned AWS Infrastructure
88

9-
This is an overview of the provisioned {AWS} components on a deployed
10-
ifdef::openshift-rosa[]
11-
{rosa-classic-short}
12-
endif::openshift-rosa[]
13-
ifdef::openshift-rosa-hcp[]
14-
{rosa-short}
15-
endif::openshift-rosa-hcp[]
16-
cluster.
9+
This is an overview of the provisioned {AWS} components on a deployed {product-title} cluster.
1710

1811
[id="rosa-ec2-instances_{context}"]
1912
== EC2 instances
@@ -22,13 +15,7 @@ AWS EC2 instances are required to deploy
2215
ifndef::openshift-rosa-hcp[]
2316
the control plane and data plane functions for
2417
endif::openshift-rosa-hcp[]
25-
ifdef::openshift-rosa[]
26-
{rosa-classic-short}.
27-
endif::openshift-rosa[]
28-
ifdef::openshift-rosa-hcp[]
29-
{rosa-short}.
30-
endif::openshift-rosa-hcp[]
31-
18+
{product-title}.
3219
ifndef::openshift-rosa-hcp[]
3320
Instance types can vary for control plane and infrastructure nodes, depending on the worker node count.
3421

@@ -213,11 +200,4 @@ can add additional custom security groups during cluster creation. Custom securi
213200

214201
* 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].
215202
* 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.
216-
* 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
217-
ifdef::openshift-rosa[]
218-
{rosa-classic-short},
219-
endif::openshift-rosa[]
220-
ifdef::openshift-rosa-hcp[]
221-
{rosa-short},
222-
endif::openshift-rosa-hcp[]
223-
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].
203+
* 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 {product-title} 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].

modules/rosa-getting-started-install-configure-cli-tools.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ $ aws sts get-caller-identity --output text
4444
+
4545
. Install and configure the latest ROSA CLI (`rosa`).
4646
.. Navigate to link:https://console.redhat.com/openshift/downloads[*Downloads*].
47-
.. Find *Red Hat OpenShift Service on AWS command line interface (`rosa)* in the list of tools and click *Download*.
47+
.. Find *Red Hat OpenShift Service on AWS command line interface (`rosa`)* in the list of tools and click *Download*.
4848
+
4949
The `rosa-linux.tar.gz` file is downloaded to your default download location.
5050
.. Extract the `rosa` binary file from the downloaded archive. The following example extracts the binary from a Linux tar archive:

0 commit comments

Comments
 (0)