Skip to content

Commit 662f3b0

Browse files
committed
Fixing Vale warnings and moving aws localzones/wavelength prereqs out of module into assemblies
1 parent 23b5fdc commit 662f3b0

File tree

6 files changed

+83
-96
lines changed

6 files changed

+83
-96
lines changed

installing/installing_aws/ipi/installing-aws-localzone.adoc

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,40 @@ You can quickly install an {product-title} cluster on Amazon Web Services (AWS)
1212
AWS {zone-type} is an infrastructure that place Cloud Resources close to metropolitan regions. For more information, see the link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-local-zones[AWS Local Zones Documentation].
1313

1414
// Infrastructure prerequisites
15-
include::modules/aws-zones-prerequisites.adoc[leveloffset=+1]
15+
[id="aws-zones-prerequisites_{context}"]
16+
== Infrastructure prerequisites
17+
18+
* You reviewed details about xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
19+
* You are familiar with xref:../../../installing/installing-preparing.adoc#installing-preparing[Selecting a cluster installation method and preparing it for users].
20+
* You xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[configured an AWS account] to host the cluster.
21+
+
22+
[WARNING]
23+
====
24+
If you have an AWS profile stored on your computer, it must not use a temporary session token that you generated while using a multi-factor authentication device. The cluster continues to use your current AWS credentials to create AWS resources for the entire life of the cluster, so you must use key-based, long-term credentials. To generate appropriate keys, see link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html[Managing Access Keys for IAM Users] in the AWS documentation. You can supply the keys when you run the installation program.
25+
====
26+
* You downloaded the AWS CLI and installed it on your computer. See link:https://docs.aws.amazon.com/cli/latest/userguide/install-bundle.html[Install the AWS CLI Using the Bundled Installer (Linux, macOS, or UNIX)] in the AWS documentation.
27+
* If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster must access.
28+
* You noted the region and supported link:https://aws.amazon.com/about-aws/global-infrastructure/localzones/locations[AWS Local Zones locations] to create the network resources in.
29+
* You read the link:https://aws.amazon.com/about-aws/global-infrastructure/localzones/features/[AWS Local Zones features] in the AWS documentation.
30+
* You added permissions for creating network resources that support AWS Local Zones to the Identity and Access Management (IAM) user or role. The following example enables a zone group that can provide a user or role access for creating network network resources that support AWS {zone-type}.
31+
+
32+
.Example of an additional IAM policy with the `ec2:ModifyAvailabilityZoneGroup` permission attached to an IAM user or role.
33+
+
34+
[source,yaml]
35+
----
36+
{
37+
"Version": "2012-10-17",
38+
"Statement": [
39+
{
40+
"Action": [
41+
"ec2:ModifyAvailabilityZoneGroup"
42+
],
43+
"Effect": "Allow",
44+
"Resource": "*"
45+
}
46+
]
47+
}
48+
----
1649

1750
[id="installation-about-local-zone-edge-compute-pool_{context}"]
1851
== About AWS Local Zones and edge compute pool
@@ -32,7 +65,7 @@ include::modules/edge-machine-pools-aws-local-zones.adoc[leveloffset=+2]
3265
* xref:../../../networking/changing-cluster-network-mtu.adoc#nw-ovn-ipsec-enable_configuring-ipsec-ovn[Changing the MTU for the cluster network]
3366
* xref:../../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations-about_nodes-scheduler-taints-tolerations[Understanding taints and tolerations]
3467
* xref:../../../storage/understanding-persistent-storage.adoc#pvc-storage-class_understanding-persistent-storage[Storage classes]
35-
* xref:../../../networking/ingress-sharding.html#nw-ingress-sharding_ingress-sharding[Ingress Controller sharding]
68+
* xref:../../../networking/ingress-sharding.adoc#nw-ingress-sharding_ingress-sharding[Ingress Controller sharding]
3669

3770
[id="installation-prereqs-aws-local-zone_{context}"]
3871
== Installation prerequisites
@@ -95,7 +128,7 @@ include::modules/aws-cluster-installation-options-aws-lzs.adoc[leveloffset=+1]
95128
Choose one of the following options to install an {product-title} cluster in an AWS {zone-type} environment:
96129

97130
* xref:../../../installing/installing_aws/ipi/installing-aws-localzone.adoc#installation-cluster-quickly-extend-compute-nodes_installing-aws-localzone[Installing a cluster quickly in AWS Local Zones]
98-
* xref:../../../installing/installing_aws/ipi/installing-aws-localzone.adoc#creating-aws-local-zone-environment-existing_installing-aws-localzone[Installing a cluster in an existing VPC with defined Local Zone subnets]
131+
* xref:../../../installing/installing_aws/ipi/installing-aws-localzone.adoc#creating-aws-local-zone-environment-existing_installing-aws-localzone[Installing a cluster in an existing VPC with defined AWS Local Zone subnets]
99132

100133
// Installing a cluster quickly in AWS Local Zones
101134
include::modules/installation-cluster-quickly-extend-compute-nodes.adoc[leveloffset=+1]

installing/installing_aws/ipi/installing-aws-wavelength-zone.adoc

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,49 @@ A Wavelength Zone embeds AWS compute and storage services within the 5G network
1919
* See link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-wavelength-zones[Wavelength Zones] in the AWS documentation.
2020
2121
// Infrastructure prerequisites
22-
include::modules/aws-zones-prerequisites.adoc[leveloffset=+1]
22+
[id="aws-zones-prerequisites_{context}"]
23+
== Infrastructure prerequisites
24+
25+
* You reviewed details about xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
26+
* You are familiar with xref:../../../installing/installing-preparing.adoc#installing-preparing[Selecting a cluster installation method and preparing it for users].
27+
* You xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[configured an AWS account] to host the cluster.
28+
+
29+
[WARNING]
30+
====
31+
If you have an AWS profile stored on your computer, it must not use a temporary session token that you generated while using a multi-factor authentication device. The cluster continues to use your current AWS credentials to create AWS resources for the entire life of the cluster, so you must use key-based, long-term credentials. To generate appropriate keys, see link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html[Managing Access Keys for IAM Users] in the AWS documentation. You can supply the keys when you run the installation program.
32+
====
33+
* You downloaded the AWS CLI and installed it on your computer. See link:https://docs.aws.amazon.com/cli/latest/userguide/install-bundle.html[Install the AWS CLI Using the Bundled Installer (Linux, macOS, or UNIX)] in the AWS documentation.
34+
* If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster must access.
35+
* You noted the region and supported link:https://aws.amazon.com/wavelength/locations[AWS Wavelength Zone locations] to create the network resources in.
36+
* You read link:https://aws.amazon.com/about-aws/global-infrastructure/localzones/features/[AWS Wavelength features] in the AWS documentation.
37+
* You read the link:https://docs.aws.amazon.com/wavelength/latest/developerguide/wavelength-quotas.html[Quotas and considerations for Wavelength Zones] in the AWS documentation.
38+
* You added permissions for creating network resources that support AWS Wavelength Zones to the Identity and Access Management (IAM) user or role. For example:
39+
+
40+
.Example of an additional IAM policy that attached `ec2:ModifyAvailabilityZoneGroup`, `ec2:CreateCarrierGateway`, and `ec2:DeleteCarrierGateway` permissions to a user or role
41+
+
42+
[source,yaml]
43+
----
44+
{
45+
"Version": "2012-10-17",
46+
"Statement": [
47+
{
48+
"Effect": "Allow",
49+
"Action": [
50+
"ec2:DeleteCarrierGateway",
51+
"ec2:CreateCarrierGateway"
52+
],
53+
"Resource": "*"
54+
},
55+
{
56+
"Action": [
57+
"ec2:ModifyAvailabilityZoneGroup"
58+
],
59+
"Effect": "Allow",
60+
"Resource": "*"
61+
}
62+
]
63+
}
64+
----
2365

2466
[id="about-aws-wavelength-zone-edge-compute-pool_{context}"]
2567
== About AWS Wavelength Zones and edge compute pool
@@ -39,7 +81,7 @@ include::modules/edge-machine-pools-aws-local-zones.adoc[leveloffset=+2]
3981
* xref:../../../networking/changing-cluster-network-mtu.adoc#nw-ovn-ipsec-enable_configuring-ipsec-ovn[Changing the MTU for the cluster network]
4082
* xref:../../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations-about_nodes-scheduler-taints-tolerations[Understanding taints and tolerations]
4183
* xref:../../../storage/understanding-persistent-storage.adoc#pvc-storage-class_understanding-persistent-storage[Storage classes]
42-
* xref:../../../networking/ingress-sharding.html#nw-ingress-sharding_ingress-sharding[Ingress Controller sharding]
84+
* xref:../../../networking/ingress-sharding.adoc#nw-ingress-sharding_ingress-sharding[Ingress Controller sharding]
4385

4486
[id="installation-prereqs-aws-wavelength-zone_{context}"]
4587
== Installation prerequisites

installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Because the installation media is on the mirror host, you can use that computer
2828
====
2929
If you have an AWS profile stored on your computer, it must not use a temporary session token that you generated while using a multi-factor authentication device. The cluster continues to use your current AWS credentials to create AWS resources for the entire life of the cluster, so you must use key-based, long-term credentials. To generate appropriate keys, see link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html[Managing Access Keys for IAM Users] in the AWS documentation. You can supply the keys when you run the installation program.
3030
====
31-
* You downloaded the AWS CLI and installed it on your computer. See link:https://docs.aws.amazon.com/cli/latest/userguide/install-bundle.html[Install the AWS CLI Using the Bundled Installer (Linux, macOS, or Unix)] in the AWS documentation.
31+
* You downloaded the AWS CLI and installed it on your computer. See link:https://docs.aws.amazon.com/cli/latest/userguide/install-bundle.html[Install the AWS CLI Using the Bundled Installer (Linux, macOS, or UNIX)] in the AWS documentation.
3232
* If you use a firewall and plan to use the Telemetry service, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured the firewall to allow the sites] that your cluster requires access to.
3333
+
3434
[NOTE]

installing/installing_aws/upi/installing-restricted-networks-aws.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Because the installation media is on the mirror host, you can use that computer
4242
====
4343
If you have an AWS profile stored on your computer, it must not use a temporary session token that you generated while using a multi-factor authentication device. The cluster continues to use your current AWS credentials to create AWS resources for the entire life of the cluster, so you must use key-based, long-term credentials. To generate appropriate keys, see link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html[Managing Access Keys for IAM Users] in the AWS documentation. You can supply the keys when you run the installation program.
4444
====
45-
* You downloaded the AWS CLI and installed it on your computer. See link:https://docs.aws.amazon.com/cli/latest/userguide/install-bundle.html[Install the AWS CLI Using the Bundled Installer (Linux, macOS, or Unix)] in the AWS documentation.
45+
* You downloaded the AWS CLI and installed it on your computer. See link:https://docs.aws.amazon.com/cli/latest/userguide/install-bundle.html[Install the AWS CLI Using the Bundled Installer (Linux, macOS, or UNIX)] in the AWS documentation.
4646
* If you use a firewall and plan to use the Telemetry service, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured the firewall to allow the sites] that your cluster requires access to.
4747
+
4848
[NOTE]

modules/aws-zones-prerequisites.adoc

Lines changed: 0 additions & 88 deletions
This file was deleted.

post_installation_configuration/configuring-multi-arch-compute-machines/creating-multi-arch-compute-nodes-aws.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
To create an AWS cluster with multi-architecture compute machines, you must first create a single-architecture AWS installer-provisioned cluster with the multi-architecture installer binary. For more information on AWS installations, refer to xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc[Installing a cluster on AWS with customizations]. You can then add a ARM64 compute machine set to your AWS cluster.
9+
To create an AWS cluster with multi-architecture compute machines, you must first create a single-architecture AWS installer-provisioned cluster with the multi-architecture installer binary. For more information on AWS installations, refer to xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Installing a cluster on AWS with customizations]. You can then add a ARM64 compute machine set to your AWS cluster.
1010

1111
include::modules/multi-architecture-verifying-cluster-compatibility.adoc[leveloffset=+1]
1212

0 commit comments

Comments
 (0)