Skip to content

Commit dfb6501

Browse files
committed
OSDOCS-14094: Applied changes to Preparing your Environment
1 parent 40696da commit dfb6501

23 files changed

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

Lines changed: 1 addition & 1 deletion
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 architecture) clusters using STS
10+
= Firewall prerequisites for {rosa-classic-short} clusters using STS
1111
endif::openshift-rosa[]
1212
ifdef::openshift-dedicated[]
1313
[id="osd-aws-privatelink-firewall-prerequisites_{context}"]

modules/rosa-aws-provisioned.adoc

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,14 @@
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 {product-title} (ROSA) cluster.
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.
1017

1118
[id="rosa-ec2-instances_{context}"]
1219
== EC2 instances
@@ -15,7 +22,12 @@ AWS EC2 instances are required to deploy
1522
ifndef::openshift-rosa-hcp[]
1623
the control plane and data plane functions for
1724
endif::openshift-rosa-hcp[]
18-
{product-title}.
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[]
1931

2032
ifndef::openshift-rosa-hcp[]
2133
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
201213

202214
* 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].
203215
* 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.
204-
* 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].
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].

modules/rosa-hcp-creating-account-wide-sts-roles-and-policies.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ endif::[]
1111
[id="rosa-sts-creating-account-wide-sts-roles-and-policies_{context}"]
1212
= Creating the account-wide STS roles and policies
1313

14-
Before you create your {hcp-title-first} cluster, you must create the required account-wide roles and policies.
14+
Before you create your {rosa-short} cluster, you must create the required account-wide roles and policies.
1515

1616
[NOTE]
1717
====
18-
Specific AWS-managed policies for {hcp-title} must be attached to each role. Customer-managed policies must not be used with these required account roles. For more information regarding AWS-managed policies for {hcp-title} clusters, see link:https://docs.aws.amazon.com/ROSA/latest/userguide/security-iam-awsmanpol-account-policies.html[AWS managed policies for ROSA].
18+
Specific AWS-managed policies for {rosa-short} must be attached to each role. Customer-managed policies must not be used with these required account roles. For more information regarding AWS-managed policies for {rosa-short} clusters, see link:https://docs.aws.amazon.com/ROSA/latest/userguide/security-iam-awsmanpol-account-policies.html[AWS managed policies for ROSA].
1919
====
2020

2121
.Prerequisites
2222

23-
* You have completed the AWS prerequisites for {hcp-title}.
23+
* You have completed the AWS prerequisites for {rosa-short}.
2424
* You have available AWS service quotas.
2525
* You have enabled the ROSA service in the AWS Console.
2626
* You have installed and configured the latest ROSA CLI (`rosa`) on your installation host.

modules/rosa-hcp-firewall-prerequisites.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
//TODO OSDOCS-11789: Why is this a procedure and not a reference?
77

88
[id="rosa-hcp-firewall-prerequisites_{context}"]
9-
= Firewall prerequisites for {hcp-title}
9+
= Firewall prerequisites for {rosa-short}
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-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.
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-prereq-roles-overview.adoc

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,28 @@
11
// Module included in the following assemblies:
2-
// * rosa_planning/rosa-hcp-prepare-iam-resources.adoc
2+
// * rosa_planning/rosa-sts-ocm-role.adoc
3+
// * rosa_planning/rosa-hcp-prepare-iam-roles-resources.adoc
4+
35
:_mod-docs-content-type: MODULE
46
[id="rosa-prereq-roles-overview"]
57
= Overview of required roles
68

7-
To create and manage your {product-title} cluster, you must create several account-wide and cluster-wide roles. If you intend to use {cluster-manager} to create or manage your cluster, you need some additional roles.
9+
To create and manage your
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, you must create several account-wide and cluster-wide roles. If you intend to use {cluster-manager} to create or manage your cluster, you need some additional roles.
817

9-
To create and manage clusters:: Several account-wide roles are required to create and manage ROSA clusters. These roles only need to be created once per AWS account, and do not need to be created fresh for each cluster. One or more AWS managed policies are attached to each role to grant that role the required capabilities. You can specify your own prefix, or use the default prefix (`ManagedOpenShift`).
18+
To create and manage clusters:: Several account-wide roles are required to create and manage
19+
ifdef::openshift-rosa[]
20+
{rosa-classic-short}
21+
endif::openshift-rosa[]
22+
ifdef::openshift-rosa-hcp[]
23+
{rosa-short}
24+
endif::openshift-rosa-hcp[]
25+
clusters. These roles only need to be created once per AWS account, and do not need to be created fresh for each cluster. One or more AWS managed policies are attached to each role to grant that role the required capabilities. You can specify your own prefix, or use the default prefix (`ManagedOpenShift`).
1026
+
1127
[NOTE]
1228
====
@@ -52,7 +68,7 @@ Role creation does not request your AWS access or secret keys. AWS Security Toke
5268
To use Operator-managed cluster capabilities:: Some cluster capabilities, including several capabilities provided by default, are managed using Operators. Cluster-specific Operator roles (`operator-roles` in the ROSA CLI) are required to use these capabilities. These roles are used to obtain the temporary permissions required to carry out cluster operations such as managing back-end storage, ingress, and registry. Obtaining these permissions requires the configuration of an OpenID Connect (OIDC) provider, which connects to AWS Security Token Service (STS) to authenticate Operator access to AWS resources.
5369
ifndef::openshift-rosa-hcp[]
5470
+
55-
The following Operator roles are required for {product-title} clusters:
71+
The following Operator roles are required for {rosa-classic-short} clusters:
5672

5773
** `openshift-cluster-csi-drivers-ebs-cloud-credentials`
5874
** `openshift-cloud-network-config-controller-cloud-credentials`
@@ -65,7 +81,7 @@ The following Operator roles are required for {product-title} clusters:
6581
endif::openshift-rosa-hcp[]
6682
ifdef::openshift-rosa-hcp[]
6783
+
68-
For {hcp-title} clusters, you must create the following Operator roles and attach the indicated AWS Managed policies:
84+
For {rosa-short} clusters, you must create the following Operator roles and attach the indicated AWS Managed policies:
6985
+
7086
.Required Operator roles and AWS Managed policies for {hcp-title}
7187
[options="header"]
@@ -101,7 +117,6 @@ For {hcp-title} clusters, you must create the following Operator roles and attac
101117
endif::openshift-rosa-hcp[]
102118
When you create Operator roles using the `rosa create operator-role` command, the roles created are named using the pattern `<cluster_name>-<hash>-<role_name>`, for example, `test-abc1-kube-system-control-plane-operator`. When your cluster name is longer than 15 characters, the role name is truncated.
103119

104-
105120
To use {cluster-manager}:: The web user interface, {cluster-manager}, requires you to create additional roles in your AWS account to create a trust relationship between that AWS account and the {cluster-manager}.
106121
+
107122
This trust relationship is achieved through the creation and association of the `ocm-role` AWS IAM role. This role has a trust policy with the AWS installer that links your Red{nbsp}Hat account to your AWS account. In addition, you also need a `user-role` AWS IAM role for each web UI user, which serves to identify these users. This `user-role` AWS IAM role has no permissions.

modules/rosa-requirements-deploying-in-opt-in-regions.adoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,14 @@
55
[id="rosa-requirements-deploying-in-opt-in-regions_{context}"]
66
= Requirements for deploying a cluster in an opt-in region
77

8-
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:
8+
An AWS opt-in region is a region that is not enabled in your AWS account by default. If you want to deploy a
9+
ifdef::openshift-rosa[]
10+
{rosa-classic-short}
11+
endif::openshift-rosa[]
12+
ifdef::openshift-rosa-hcp[]
13+
{rosa-short}
14+
endif::openshift-rosa-hcp[]
15+
cluster that uses the AWS Security Token Service (STS) in an opt-in region, you must meet the following requirements:
916

1017
* 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.
1118
* 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.

modules/rosa-setting-the-aws-security-token-version.adoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,14 @@
66
[id="rosa-setting-the-aws-security-token-version_{context}"]
77
= Setting the AWS security token version
88

9-
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.
9+
If you want to create a
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 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.
1017

1118
.Prerequisites
1219

modules/rosa-sts-about-ocm-role.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[id="rosa-sts-about-ocm-role_{context}"]
66
= About the ocm-role IAM resource
77

8-
You must create the `ocm-role` IAM resource to enable a Red{nbsp}Hat organization of users to create {product-title} (ROSA) clusters. Within the context of linking to AWS, a Red{nbsp}Hat organization is a single user within {cluster-manager}.
8+
You must create the `ocm-role` IAM resource to enable a Red{nbsp}Hat organization of users to create {rosa-classic-short} clusters. Within the context of linking to AWS, a Red{nbsp}Hat organization is a single user within {cluster-manager}.
99

1010
Some considerations for your `ocm-role` IAM resource are:
1111

modules/rosa-sts-associating-your-aws-account.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,19 @@ ifeval::["{context}" == "rosa-sts-creating-a-cluster-quickly"]
2121
endif::[]
2222

2323
Before using {cluster-manager-first} on the {hybrid-console-url} to create
24-
ifdef::rosa-hcp[]
25-
{hcp-title} clusters
26-
endif::rosa-hcp[]
27-
ifndef::rosa-hcp[]
28-
{product-title} (ROSA) clusters
29-
endif::rosa-hcp[]
30-
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.
24+
ifdef::openshift-rosa[]
25+
{rosa-classic-short}
26+
endif::openshift-rosa[]
27+
ifdef::openshift-rosa-hcp[]
28+
{rosa-short}
29+
endif::openshift-rosa-hcp[]
30+
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.
3131

3232
ifdef::quick-install[]
3333
.Prerequisites
3434

3535
ifdef::rosa-hcp[]
36-
* You have completed the AWS prerequisites for {hcp-title}.
36+
* You have completed the AWS prerequisites for {rosa-short}.
3737
endif::rosa-hcp[]
3838
ifndef::rosa-hcp[]
3939
* You have completed the AWS prerequisites for ROSA with STS.
@@ -46,7 +46,7 @@ endif::rosa-hcp[]
4646
====
4747
To successfully install
4848
ifdef::rosa-hcp[]
49-
{hcp-title}
49+
{rosa-short}
5050
endif::rosa-hcp[]
5151
ifndef::rosa-hcp[]
5252
ROSA
@@ -65,7 +65,7 @@ endif::[]
6565
====
6666
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
6767
ifdef::rosa-hcp[]
68-
{hcp-title}
68+
{rosa-short}
6969
endif::rosa-hcp[]
7070
ifndef::rosa-hcp[]
7171
ROSA
@@ -77,14 +77,14 @@ cluster. For more information about the basic and administrative privileges for
7777
====
7878
If you choose the _Basic OCM role_ command in the *Accounts and roles* step of creating a
7979
ifdef::rosa-hcp[]
80-
{hcp-title}
80+
{rosa-short}
8181
endif::rosa-hcp[]
8282
ifndef::rosa-hcp[]
8383
ROSA
8484
endif::rosa-hcp[]
8585
cluster in the {cluster-manager} {hybrid-console-second}, you must deploy a
8686
ifdef::rosa-hcp[]
87-
{hcp-title}
87+
{rosa-short}
8888
endif::rosa-hcp[]
8989
ifndef::rosa-hcp[]
9090
ROSA

0 commit comments

Comments
 (0)