diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml index 396eb2b811..bb860ad76b 100644 --- a/_topic_maps/_topic_map_rosa.yml +++ b/_topic_maps/_topic_map_rosa.yml @@ -214,6 +214,8 @@ Topics: Topics: - Name: About machine pools File: rosa-nodes-machinepools-about + - Name: Configuring machine pools + File: rosa-nodes-machinepools-configuring - Name: Managing compute nodes File: rosa-managing-worker-nodes Distros: openshift-rosa diff --git a/modules/rosa-nodes-machine-pools-local-zones.adoc b/modules/rosa-nodes-machine-pools-local-zones.adoc new file mode 100644 index 0000000000..aebdd26680 --- /dev/null +++ b/modules/rosa-nodes-machine-pools-local-zones.adoc @@ -0,0 +1,73 @@ + +// Module included in the following assemblies: +// +// * assemblies/rosa-nodes-machinepools-configuring.adoc + +:_content-type: PROCEDURE +[id="rosa-nodes-machine-pools-local-zones_{context}"] += Configuring Local Zones for machine pools + +Use the following steps to configure Local Zones for machine pools. + +[IMPORTANT] +==== +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. +==== +.Prerequisites + +* 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. +* The ROSA cluster was initially built in an existing Amazon VPC (BYO-VPC). +* The maximum transmission unit (MTU) for the ROSA cluster is set at 1200. ++ +[IMPORTANT] +==== +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. +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: + +- OVN-Kubernetes: `100 bytes` +- OpenShift SDN: `50 bytes` + +The network plugin could provide additional features that may also decrease the MTU. Check the documentation for additional information. + +==== +* 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]. +* 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. +* The AWS account has a subnet that is associated with a routing table that has a route to a NAT gateway. +* The AWS account has the tag `kubernetes.io/cluster/: shared' on the associated subnet. + +.Procedure + +. Create a machine pool on the cluster by running the following ROSA CLI command. ++ +[source,terminal] +---- +$ rosa create machinepool -c -i +---- ++ +. Add the subnet and instance type for the machine pool in ROSA CLI. After several minutes, the cluster will provision the nodes. ++ +[source, terminal] +---- +I: Enabling interactive mode <1> +? Machine pool name: xx-lz-xx <2> +? Create multi-AZ machine pool: No <3> +? Select subnet for a single AZ machine pool (optional): Yes <4> +? Subnet ID: subnet- (region-info) <5> +? Enable autoscaling (optional): No <6> +? Replicas: 2 <7> +I: Fetching instance types <8> +---- ++ + +<1> Enables interactive mode. +<2> Names the machine pool. This is limited to alphanumeric and a maximum length of 30 characters. +<3> Set this option to no. +<4> Set this option to yes. +<5> Selects a subnet ID from the list. +<6> Select yes to enable autoscaling or no to disable autoscaling. +<7> Selects the number of machines for the machine pool. This number can be anywhere from 1 - 180. +<8> Selects an instance type from the list. Only instance types that are supported in the selected Local Zone will appear. + +. Provide the subnet ID to provision the machine pool in the Local Zone. + +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. \ No newline at end of file diff --git a/modules/rosa-sdpolicy-am-local-zones.adoc b/modules/rosa-sdpolicy-am-local-zones.adoc new file mode 100644 index 0000000000..36ccc74037 --- /dev/null +++ b/modules/rosa-sdpolicy-am-local-zones.adoc @@ -0,0 +1,11 @@ + +// Module included in the following assemblies: +// +// * assemblies/rosa-service-definition.adoc +:_content-type: CONCEPT +[id="rosa-sdpolicy-am-local-zones_{context}"] += Local Zones + +{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]. + +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]. \ No newline at end of file diff --git a/modules/rosa-sdpolicy-am-regions-az.adoc b/modules/rosa-sdpolicy-am-regions-az.adoc index a7d97f5d0b..60eb8b9155 100644 --- a/modules/rosa-sdpolicy-am-regions-az.adoc +++ b/modules/rosa-sdpolicy-am-regions-az.adoc @@ -7,6 +7,9 @@ = Regions and availability zones 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. +.AWS Regions +[%collapsible] +==== * af-south-1 (Cape Town, AWS opt-in required) * ap-east-1 (Hong Kong, AWS opt-in required) * ap-northeast-1 (Tokyo) @@ -29,6 +32,7 @@ The following AWS regions are supported by Red Hat OpenShift 4 and are supported * us-east-2 (Ohio) * us-west-1 (N. California) * us-west-2 (Oregon) +==== 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. @@ -37,4 +41,5 @@ Each new {product-title} cluster is installed within an installer-created or pre [WARNING] ==== The region and the choice of single or multiple availability zone cannot be changed after a cluster has been deployed. -==== \ No newline at end of file +==== + diff --git a/modules/rosa-sdpolicy-am-sla.adoc b/modules/rosa-sdpolicy-am-sla.adoc index d43b3cfac5..0e8399e46b 100644 --- a/modules/rosa-sdpolicy-am-sla.adoc +++ b/modules/rosa-sdpolicy-am-sla.adoc @@ -5,4 +5,5 @@ :_content-type: CONCEPT [id="rosa-sdpolicy-sla_{context}"] = Service Level Agreement (SLA) -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)]. + +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)]. \ No newline at end of file diff --git a/modules/rosa-sdpolicy-am-support.adoc b/modules/rosa-sdpolicy-am-support.adoc index fbd02ab38e..b53863718b 100644 --- a/modules/rosa-sdpolicy-am-support.adoc +++ b/modules/rosa-sdpolicy-am-support.adoc @@ -5,6 +5,7 @@ :_content-type: CONCEPT [id="rosa-sdpolicy-support_{context}"] = Support + {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]. See {product-title} link:https://access.redhat.com/support/offerings/openshift/sla?extIdCarryOver=true&sc_cid=701f2000001Css5AAC[SLAs] for support response times. diff --git a/rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc b/rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc index c54cae33b6..eeb09d8c9c 100644 --- a/rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc +++ b/rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc @@ -31,6 +31,7 @@ include::modules/rosa-sdpolicy-am-aws-compute-types.adoc[leveloffset=+2] * link:https://aws.amazon.com/ec2/instance-types[AWS Instance Types] include::modules/rosa-sdpolicy-am-regions-az.adoc[leveloffset=+2] +include::modules/rosa-sdpolicy-am-local-zones.adoc[leveloffset=+2] include::modules/rosa-sdpolicy-am-sla.adoc[leveloffset=+2] include::modules/rosa-sdpolicy-am-limited-support.adoc[leveloffset=+2] include::modules/rosa-sdpolicy-am-support.adoc[leveloffset=+2] diff --git a/rosa_cli/rosa-manage-objects-cli.adoc b/rosa_cli/rosa-manage-objects-cli.adoc index 9f335ec199..5587fdc0ba 100644 --- a/rosa_cli/rosa-manage-objects-cli.adoc +++ b/rosa_cli/rosa-manage-objects-cli.adoc @@ -2,6 +2,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[] [id="rosa-managing-objects-cli"] = Managing objects with the rosa CLI + :context: rosa-managing-objects-cli toc::[] diff --git a/rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-configuring.adoc b/rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-configuring.adoc new file mode 100644 index 0000000000..d4fe473207 --- /dev/null +++ b/rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-configuring.adoc @@ -0,0 +1,10 @@ +:_content-type: ASSEMBLY +include::_attributes/attributes-openshift-dedicated.adoc[] +[id="rosa-nodes-machinepools-configuring"] += Configuring machine pools +:context: rosa-nodes-machinepools-configuring + +toc::[] +This document describes how to configure machine pools with {product-title} (ROSA). + +include::modules/rosa-nodes-machine-pools-local-zones.adoc[leveloffset=+1]