From b6564f76250a781cba7c03022f5ae7afa122c720 Mon Sep 17 00:00:00 2001 From: Marco Braga Date: Thu, 27 Apr 2023 18:57:44 -0300 Subject: [PATCH 1/3] simplifying the zone group explanation --- ...tallation-aws-add-local-zone-locations.adoc | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/modules/installation-aws-add-local-zone-locations.adoc b/modules/installation-aws-add-local-zone-locations.adoc index 91aaaf8178a0..3d2eaaf787f1 100644 --- a/modules/installation-aws-add-local-zone-locations.adoc +++ b/modules/installation-aws-add-local-zone-locations.adoc @@ -24,28 +24,30 @@ $ export CLUSTER_REGION="" <1> <1> For ``, specify a valid AWS region name, such as `us-east-1`. . Review the list of zones that your region contains by running the following command: +List the zones available in your region by running the following command: + [source,terminal] ---- $ aws --region ${CLUSTER_REGION} ec2 describe-availability-zones \ - --query 'AvailabilityZones[].ZoneName' \ + --query 'AvailabilityZones[].[{ZoneName: ZoneName, GroupName: GroupName, Status: OptInStatus}]' \ + --filters Name=zone-type,Values=local-zone \ --all-availability-zones ---- + -Depending on the region, the list of available zones can be long. The different zones use the following naming conventions: +Depending on the region, the list of available zones can be long. The command will return the following fields: + -`${REGION}[a-z]`:: Availability zones available in the region. -`${REGION}-LID-N[a-z]`:: Available AWS Local Zones. `${REGION}-LID-N` represents the zone group identifier, and `[a-z]` represents the zone identifier. -`${REGION}-wl1-LID-wlz-[1-9]`:: Available Wavelength zones. +`ZoneName`:: The name of the Zone. +`GroupName`:: The group that the zone is part of. You need to save this name to opt-in. +`Status`:: The status of the Zone Group. If the status is `not-opted-in` you must opt-in the `GroupName` running the commands below. . Export a variable to contain the name of the Local Zone to host your VPC by running the following command: + [source,terminal] ---- -$ export ZONE_GROUP_NAME="${CLUSTER_REGION}--" <1> +$ export ZONE_GROUP_NAME="" <1> ---- -<1> For `-`, specify the location identifier and zone identifier for the Local Zone that you selected for your region. For example, specify `nyc-1` to use the US East (New York) Local Zone. -// TODO: Verify "`zone_identifier` stands for `N`" +<1> The ``, must be replaced by the name of the group of the Local Zone you want to create subnets. For example, specify `us-east-1-nyc-1` to use the zone `us-east-1-nyc-1a`, US East (New York). + . Opt in to the zone group on your AWS account by running the following command: + [source,terminal] From c92aafbc1e3583fcd7820423cabf262ecc6abd19 Mon Sep 17 00:00:00 2001 From: Marco Braga Date: Thu, 27 Apr 2023 20:27:25 -0300 Subject: [PATCH 2/3] Update modules/installation-aws-add-local-zone-locations.adoc Co-authored-by: Max Bridges <50179998+maxwelldb@users.noreply.github.com> --- modules/installation-aws-add-local-zone-locations.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/installation-aws-add-local-zone-locations.adoc b/modules/installation-aws-add-local-zone-locations.adoc index 3d2eaaf787f1..7a0fbe1eade3 100644 --- a/modules/installation-aws-add-local-zone-locations.adoc +++ b/modules/installation-aws-add-local-zone-locations.adoc @@ -37,7 +37,7 @@ $ aws --region ${CLUSTER_REGION} ec2 describe-availability-zones \ Depending on the region, the list of available zones can be long. The command will return the following fields: + `ZoneName`:: The name of the Zone. -`GroupName`:: The group that the zone is part of. You need to save this name to opt-in. +`GroupName`:: The group that the zone is part of. You need to save this name to opt in. `Status`:: The status of the Zone Group. If the status is `not-opted-in` you must opt-in the `GroupName` running the commands below. . Export a variable to contain the name of the Local Zone to host your VPC by running the following command: From 93ce6fe1b28a398378fe7131ec2f6d16a7b03bd7 Mon Sep 17 00:00:00 2001 From: Marco Braga Date: Thu, 27 Apr 2023 21:48:18 -0300 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Max Bridges <50179998+maxwelldb@users.noreply.github.com> --- .../installation-aws-add-local-zone-locations.adoc | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/modules/installation-aws-add-local-zone-locations.adoc b/modules/installation-aws-add-local-zone-locations.adoc index 7a0fbe1eade3..a020e9d45880 100644 --- a/modules/installation-aws-add-local-zone-locations.adoc +++ b/modules/installation-aws-add-local-zone-locations.adoc @@ -24,7 +24,7 @@ $ export CLUSTER_REGION="" <1> <1> For ``, specify a valid AWS region name, such as `us-east-1`. . Review the list of zones that your region contains by running the following command: -List the zones available in your region by running the following command: +List the zones that are available in your region by running the following command: + [source,terminal] ---- @@ -36,17 +36,20 @@ $ aws --region ${CLUSTER_REGION} ec2 describe-availability-zones \ + Depending on the region, the list of available zones can be long. The command will return the following fields: + -`ZoneName`:: The name of the Zone. +`ZoneName`:: The name of the Local Zone. `GroupName`:: The group that the zone is part of. You need to save this name to opt in. -`Status`:: The status of the Zone Group. If the status is `not-opted-in` you must opt-in the `GroupName` running the commands below. +`Status`:: The status of the Local Zone group. If the status is `not-opted-in`, you must opt in the `GroupName` by running the commands that follow. . Export a variable to contain the name of the Local Zone to host your VPC by running the following command: + [source,terminal] ---- -$ export ZONE_GROUP_NAME="" <1> +$ export ZONE_GROUP_NAME="" <1> ---- -<1> The ``, must be replaced by the name of the group of the Local Zone you want to create subnets. For example, specify `us-east-1-nyc-1` to use the zone `us-east-1-nyc-1a`, US East (New York). ++ +where: + +:: Specifies the name of the group of the Local Zone you want to create subnets on. For example, specify `us-east-1-nyc-1` to use the zone `us-east-1-nyc-1a`, US East (New York). . Opt in to the zone group on your AWS account by running the following command: +