Skip to content

Commit 113c791

Browse files
maxwelldbmaxwelldb
authored
Merge pull request #53695 from eohartman/osdocs-4491
OSDOCS-4491 / OSDOCS-5258: Adding local zones documentation
2 parents c465c61 + 66e5c2f commit 113c791

File tree

9 files changed

+107
-2
lines changed

9 files changed

+107
-2
lines changed

‎_topic_maps/_topic_map_rosa.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,8 @@ Topics:
214214
Topics:
215215
- Name: About machine pools
216216
File: rosa-nodes-machinepools-about
217+
- Name: Configuring machine pools
218+
File: rosa-nodes-machinepools-configuring
217219
- Name: Managing compute nodes
218220
File: rosa-managing-worker-nodes
219221
Distros: openshift-rosa

‎modules/rosa-nodes-machine-pools-local-zones.adoc

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
2+
// Module included in the following assemblies:
3+
//
4+
// * assemblies/rosa-nodes-machinepools-configuring.adoc
5+
6+
:_content-type: PROCEDURE
7+
[id="rosa-nodes-machine-pools-local-zones_{context}"]
8+
= Configuring Local Zones for machine pools
9+
10+
Use the following steps to configure Local Zones for machine pools.
11+
12+
[IMPORTANT]
13+
====
14+
AWS Local Zones are supported on Red Hat OpenShift Service on AWS 4.12. See the link:https://access.redhat.com/articles/6989889[Red Hat Knowledgebase article] for information on how to enable Local Zones.
15+
====
16+
.Prerequisites
17+
18+
* ROSA is generally available in the parent region of choice. See the link:https://aws.amazon.com/about-aws/global-infrastructure/localzones/locations/?pg=ln&cp=bn#GA[AWS generally available locations list] to determine the Local Zone available to specific AWS regions.
19+
* The ROSA cluster was initially built in an existing Amazon VPC (BYO-VPC).
20+
* The maximum transmission unit (MTU) for the ROSA cluster is set at 1200.
21+
+
22+
[IMPORTANT]
23+
====
24+
Generally, the Maximum Transmission Unit (MTU) between an Amazon EC2 instance in a Local Zone and an Amazon EC2 instance in the Region is 1300. See link:https://docs.aws.amazon.com/local-zones/latest/ug/how-local-zones-work.html[How Local Zones work] in the AWS documentation.
25+
The cluster network MTU must always be less than the EC2 MTU to account for the overhead. The specific overhead is determined by your network plugin, for example:
26+
27+
- OVN-Kubernetes: `100 bytes`
28+
- OpenShift SDN: `50 bytes`
29+
30+
The network plugin could provide additional features that may also decrease the MTU. Check the documentation for additional information.
31+
32+
====
33+
* The AWS account has link:https://docs.aws.amazon.com/local-zones/latest/ug/getting-started.html#getting-started-find-local-zone[Local Zones enabled].
34+
* The AWS account has a link:https://docs.aws.amazon.com/local-zones/latest/ug/getting-started.html#getting-started-create-local-zone-subnet[Local Zone subnet] for the same VPC as the cluster.
35+
* The AWS account has a subnet that is associated with a routing table that has a route to a NAT gateway.
36+
* The AWS account has the tag `kubernetes.io/cluster/<infra_id>: shared' on the associated subnet.
37+
38+
.Procedure
39+
40+
. Create a machine pool on the cluster by running the following ROSA CLI command.
41+
+
42+
[source,terminal]
43+
----
44+
$ rosa create machinepool -c <cluster-name> -i
45+
----
46+
+
47+
. Add the subnet and instance type for the machine pool in ROSA CLI. After several minutes, the cluster will provision the nodes.
48+
+
49+
[source, terminal]
50+
----
51+
I: Enabling interactive mode <1>
52+
? Machine pool name: xx-lz-xx <2>
53+
? Create multi-AZ machine pool: No <3>
54+
? Select subnet for a single AZ machine pool (optional): Yes <4>
55+
? Subnet ID: subnet-<a> (region-info) <5>
56+
? Enable autoscaling (optional): No <6>
57+
? Replicas: 2 <7>
58+
I: Fetching instance types <8>
59+
----
60+
+
61+
62+
<1> Enables interactive mode.
63+
<2> Names the machine pool. This is limited to alphanumeric and a maximum length of 30 characters.
64+
<3> Set this option to no.
65+
<4> Set this option to yes.
66+
<5> Selects a subnet ID from the list.
67+
<6> Select yes to enable autoscaling or no to disable autoscaling.
68+
<7> Selects the number of machines for the machine pool. This number can be anywhere from 1 - 180.
69+
<8> Selects an instance type from the list. Only instance types that are supported in the selected Local Zone will appear.
70+
71+
. Provide the subnet ID to provision the machine pool in the Local Zone.
72+
73+
See the link:https://aws.amazon.com/about-aws/global-infrastructure/localzones/locations/[AWS Local Zones locations] list on AWS for generally available and announced AWS Local Zone locations.

‎modules/rosa-sdpolicy-am-local-zones.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
// Module included in the following assemblies:
3+
//
4+
// * assemblies/rosa-service-definition.adoc
5+
:_content-type: CONCEPT
6+
[id="rosa-sdpolicy-am-local-zones_{context}"]
7+
= Local Zones
8+
9+
{product-title} supports the use of AWS Local Zones, which are metropolis-centralized availability zones where customers can place latency-sensitive application workloads. Local Zones are extensions of AWS Regions that have their own internet connection. For more information about AWS Local Zones, see the AWS documentation link:https://docs.aws.amazon.com/local-zones/latest/ug/how-local-zones-work.html[How Local Zones work].
10+
11+
For steps to enable AWS Local Zones and add a Local Zone to a machine pool, see xref:../../rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-configuring.adoc#rosa-nodes-machine-pools-local-zones[Configuring Local Zones for machine pulls].

‎modules/rosa-sdpolicy-am-regions-az.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
= Regions and availability zones
88
The following AWS regions are supported by Red Hat OpenShift 4 and are supported for {product-title}. Note: China and GovCloud (US) regions are not supported, regardless of their support on OpenShift 4.
99

10+
.AWS Regions
11+
[%collapsible]
12+
====
1013
* af-south-1 (Cape Town, AWS opt-in required)
1114
* ap-east-1 (Hong Kong, AWS opt-in required)
1215
* ap-northeast-1 (Tokyo)
@@ -29,6 +32,7 @@ The following AWS regions are supported by Red Hat OpenShift 4 and are supported
2932
* us-east-2 (Ohio)
3033
* us-west-1 (N. California)
3134
* us-west-2 (Oregon)
35+
====
3236
3337
Multiple availability zone clusters can only be deployed in regions with at least 3 availability zones. For more information, see the link:https://aws.amazon.com/about-aws/global-infrastructure/regions_az/[Regions and Availability Zones] section in the AWS documentation.
3438

@@ -37,4 +41,5 @@ Each new {product-title} cluster is installed within an installer-created or pre
3741
[WARNING]
3842
====
3943
The region and the choice of single or multiple availability zone cannot be changed after a cluster has been deployed.
40-
====
44+
====
45+

‎modules/rosa-sdpolicy-am-sla.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@
55
:_content-type: CONCEPT
66
[id="rosa-sdpolicy-sla_{context}"]
77
= Service Level Agreement (SLA)
8-
Any SLAs for the service itself are defined in Appendix 4 of the link:https://www.redhat.com/licenses/Appendix_4_Red_Hat_Online_Services_20220720.pdf[Red Hat Enterprise Agreement Appendix 4 (Online Subscription Services)].
8+
9+
Any SLAs for the service itself are defined in Appendix 4 of the link:https://www.redhat.com/licenses/Appendix_4_Red_Hat_Online_Services_20220720.pdf[Red Hat Enterprise Agreement Appendix 4 (Online Subscription Services)].

‎modules/rosa-sdpolicy-am-support.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
:_content-type: CONCEPT
66
[id="rosa-sdpolicy-support_{context}"]
77
= Support
8+
89
{product-title} includes Red Hat Premium Support, which can be accessed by using the link:https://access.redhat.com/support?extIdCarryOver=true&sc_cid=701f2000001Css5AAC[Red Hat Customer Portal].
910

1011
See {product-title} link:https://access.redhat.com/support/offerings/openshift/sla?extIdCarryOver=true&sc_cid=701f2000001Css5AAC[SLAs] for support response times.

‎rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ include::modules/rosa-sdpolicy-am-aws-compute-types.adoc[leveloffset=+2]
3131
* link:https://aws.amazon.com/ec2/instance-types[AWS Instance Types]
3232

3333
include::modules/rosa-sdpolicy-am-regions-az.adoc[leveloffset=+2]
34+
include::modules/rosa-sdpolicy-am-local-zones.adoc[leveloffset=+2]
3435
include::modules/rosa-sdpolicy-am-sla.adoc[leveloffset=+2]
3536
include::modules/rosa-sdpolicy-am-limited-support.adoc[leveloffset=+2]
3637
include::modules/rosa-sdpolicy-am-support.adoc[leveloffset=+2]

‎rosa_cli/rosa-manage-objects-cli.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
include::_attributes/attributes-openshift-dedicated.adoc[]
33
[id="rosa-managing-objects-cli"]
44
= Managing objects with the rosa CLI
5+
56
:context: rosa-managing-objects-cli
67

78
toc::[]

‎rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-configuring.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
:_content-type: ASSEMBLY
2+
include::_attributes/attributes-openshift-dedicated.adoc[]
3+
[id="rosa-nodes-machinepools-configuring"]
4+
= Configuring machine pools
5+
:context: rosa-nodes-machinepools-configuring
6+
7+
toc::[]
8+
This document describes how to configure machine pools with {product-title} (ROSA).
9+
10+
include::modules/rosa-nodes-machine-pools-local-zones.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)