Skip to content

Commit 0374ce9

Browse files
authored
Merge pull request #93569 from laubai/osdocs-14094-feedback-hcp-prepare-your-environment
OSDOCS-14094 Pre-publish feedback for Prepare your environment
2 parents 128d460 + 7520ad5 commit 0374ce9

24 files changed

+229
-837
lines changed

_attributes/attributes-openshift-dedicated.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,5 @@
5656
:rosa-classic-first: {product-title} (ROSA) (classic architecture)
5757
:egress-lockdown: {hcp-title} clusters with zero egress
5858
//ROSA CLI variables
59+
:zero-egress: zero egress
60+
//unclear whether this is going to be zero egress or egress lockdown

_topic_maps/_topic_map_rosa.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,7 @@ Topics:
265265
File: rosa-hcp-creating-cluster-with-aws-kms-key
266266
- Name: Creating a private cluster on ROSA with HCP
267267
File: rosa-hcp-aws-private-creating-cluster
268+
# Note the following title should use the same term as the {zero-egress} parameter does
268269
- Name: Creating a ROSA with HCP cluster with egress lockdown
269270
File: rosa-hcp-egress-lockdown-install
270271
- Name: Creating ROSA with HCP clusters with external authentication

_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,7 @@ Topics:
194194
File: rosa-hcp-creating-cluster-with-aws-kms-key
195195
- Name: Creating a private cluster on ROSA with HCP
196196
File: rosa-hcp-aws-private-creating-cluster
197+
# Note the following title should use the same term as the {zero-egress} parameter does
197198
- Name: Creating a ROSA with HCP cluster with egress lockdown
198199
File: rosa-hcp-egress-lockdown-install
199200
- Name: Creating ROSA with HCP clusters with external authentication

modules/machine-pools-hcp.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Each machine pool in an {hcp-title} cluster upgrades independently. Because the
1212

1313
The following image depicts how machine pools work within ROSA and {hcp-title} clusters:
1414

15-
image::hcp-rosa-machine-pools.png[Machine pools on ROSA classic and ROSA with HCP clusters]
15+
image::hcp-rosa-machine-pools.png[Machine pools on ROSA classic and {hcp-title} clusters]
1616

1717
[NOTE]
1818
====

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@
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 resources and public internet 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.
1111

12-
After deployment, network requirements are determined by your workload. However, a minimum bandwidth of 120{nbsp}Mbps helps to ensure timely cluster and operator upgrades.
12+
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-aws-provisioned.adoc

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,9 @@ The instance type shown for worker nodes is the default value, but you can custo
4141
[id="rosa-ebs-storage_{context}"]
4242
== Amazon Elastic Block Store storage
4343

44-
Amazon Elastic Block Store (Amazon EBS) block storage is used for both local node storage and persistent volume storage. The following values are the default size of the local, ephemeral storage provisioned for each EC2 instance.
45-
46-
Volume requirements for each EC2 instance:
44+
Amazon Elastic Block Store (Amazon EBS) block storage is used for both local node storage and persistent volume storage. By default, the following storage is provisioned for each EC2 instance:
4745

4846
ifndef::openshift-rosa-hcp[]
49-
5047
* Control Plane Volume
5148
** Size: 350GB
5249
** Type: gp3
@@ -57,18 +54,24 @@ ifndef::openshift-rosa-hcp[]
5754
** Type: gp3
5855
** Input/Output Operations Per Second: 900
5956

60-
endif::openshift-rosa-hcp[]
61-
6257
* Worker Volume
63-
** Default size: 300GB
64-
ifndef::openshift-rosa-hcp[]
58+
** Default size: 300{nbsp}GiB (adjustable at creation time)
6559
** Minimum size: 128GB
66-
endif::openshift-rosa-hcp[]
67-
ifndef::openshift-rosa-hcp[]
68-
** Minimum size: 75GB
69-
endif::openshift-rosa-hcp[]
7060
** Type: gp3
7161
** Input/Output Operations Per Second: 900
62+
endif::openshift-rosa-hcp[]
63+
ifdef::openshift-rosa-hcp[]
64+
* Node volumes
65+
** Type: `AWS EBS GP3`
66+
** Default size: 300{nbsp}GiB (adjustable at creation time)
67+
** Minimum size: 75{nbsp}GiB
68+
69+
* Workload persistent volumes
70+
** Default storage class: `gp3-csi`
71+
** Provisioner: `ebs.csi.aws.com`
72+
** Dynamic persistent volume provisioning
73+
endif::openshift-rosa-hcp[]
74+
7275

7376
ifndef::openshift-rosa-hcp[]
7477
[NOTE]
@@ -85,16 +88,16 @@ endif::openshift-rosa-hcp[]
8588
ifdef::openshift-rosa-hcp[]
8689
By default, one Network Load Balancer is created for use by the default ingress controller. You can create additional load balancers of the following types according to the needs of your workload:
8790

88-
* Classic Load Balancers
89-
* Network Load Balancers
90-
* Application Load Balancers
91+
* Classic Load Balancer
92+
* Network Load Balancer
93+
* Application Load Balancer
9194

9295
endif::openshift-rosa-hcp[]
9396
For more information, see the link:https://aws.amazon.com/elasticloadbalancing/features/#Details_for_Elastic_Load_Balancing_Products[ELB documentation for AWS].
9497

9598
[id="rosa-s3-storage_{context}"]
9699
== S3 storage
97-
The image registry is backed by AWS S3 storage. Resources Pruning of resources is performed regularly to optimize S3 usage and cluster performance.
100+
The image registry is backed by AWS S3 storage. Resources are pruned regularly to optimize S3 usage and cluster performance.
98101

99102
//TODO OSDOCS-11789: Confirm that this is still valid
100103
[NOTE]
@@ -107,13 +110,17 @@ Two buckets are required with a typical size of 2TB each.
107110

108111
Configure your VPC according to the following requirements:
109112

110-
* *Subnets*: Two subnets for a cluster with a single availability zone, or six subnets for a cluster with multiple availability zones.
113+
* *Subnets*: Every cluster requires a minimum of one private subnet for every availability zone. For example, 1 private subnet is required for a single-zone cluster, and 3 private subnets are required for a cluster with 3 availability zones.
114+
+
115+
If your cluster needs direct access to a network that is external to the cluster, including the public internet, you require at least one public subnet.
111116
+
112117
Red{nbsp}Hat strongly recommends using unique subnets for each cluster. Sharing subnets between multiple clusters is not recommended.
113118
+
114119
[NOTE]
115120
====
116-
A *public subnet* connects directly to the internet through an internet gateway. A *private subnet* connects to the internet through a network address translation (NAT) gateway.
121+
A *public subnet* connects directly to the internet through an internet gateway.
122+
123+
A *private subnet* connects to the internet through a network address translation (NAT) gateway.
117124
====
118125

119126
* *Route tables*: One route table per private subnet, and one additional table per cluster.
@@ -194,4 +201,4 @@ can add additional custom security groups during cluster creation. Custom securi
194201

195202
* 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].
196203
* 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.
197-
* 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].
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].

modules/rosa-create-objects.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -868,7 +868,7 @@ $ rosa create machinepool --cluster=mycluster --replicas=2 --instance-type=r5.2x
868868
[id="rosa-create-network_{context}"]
869869
== create network
870870

871-
Create a network that creates any necessary AWS resources through AWS CloudFormation templates. This helper command is intended to help create and configure a VPC for use with {hcp-title}. This command also supports zero egress clusters.
871+
Create a network that creates any necessary AWS resources through AWS CloudFormation templates. This helper command is intended to help create and configure a VPC for use with {hcp-title}. This command also supports {zero-egress} clusters.
872872

873873
[IMPORTANT]
874874
====

0 commit comments

Comments
 (0)