Skip to content

simplifying the Zone group explanation for Local Zones OSDOCS-5240 #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maxwelldb merged 3 commits into from
Apr 28, 2023
Merged

simplifying the Zone group explanation for Local Zones OSDOCS-5240 #3

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b6564f7
simplifying the zone group explanation
mtulio Apr 27, 2023
c92aafb
Update modules/installation-aws-add-local-zone-locations.adoc
mtulio Apr 27, 2023
93ce6fe
Apply suggestions from code review
mtulio Apr 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions modules/installation-aws-add-local-zone-locations.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,28 +24,33 @@ $ export CLUSTER_REGION="<region_name>" <1>
<1> For `<region_name>`, 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 that are 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 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 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="${CLUSTER_REGION}-<location_identifier>-<zone_identifier>" <1>
$ export ZONE_GROUP_NAME="<value_of_GroupName>" <1>
----
<1> For `<location_identifier>-<zone_identifier>`, 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`"
+
where:

<value_of_GroupName>:: 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:
+
[source,terminal]
Expand Down