Skip to content

Commit 671ec74

Browse files
committed
OSDOCS-16990: AWS IPI CQA
1 parent 53115b8 commit 671ec74

8 files changed

Lines changed: 128 additions & 97 deletions

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

Lines changed: 12 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,18 @@ include::_attributes/common-attributes.adoc[]
88
toc::[]
99

1010
[role="_abstract"]
11-
In {product-title} version {product-version}, you can install a cluster on {aws-first} by using installer-provisioned infrastructure with customizations, including network configuration options. In each, you modify parameters in the `install-config.yaml` file before you install the cluster. By customizing your network configuration, your cluster can coexist with existing IP address allocations in your environment and integrate with existing MTU and VXLAN configurations. You must set most of the network configuration parameters during installation, and you can modify only `kubeProxy` configuration parameters in a running cluster.
11+
In {product-title} version {product-version}, you can install a cluster on {aws-first} by using installer-provisioned infrastructure with customizations, including network configuration options.
12+
13+
In each, you modify parameters in the `install-config.yaml` file before you install the cluster. By customizing your network configuration, your cluster can coexist with existing IP address allocations in your environment and integrate with existing MTU and VXLAN configurations.
14+
15+
You must set most of the network configuration parameters during installation, and you can modify only `kubeProxy` configuration parameters in a running cluster.
1216

1317
[NOTE]
1418
====
1519
The scope of the {product-title} installation configurations is intentionally narrow. It is designed for simplicity and ensured success. You can complete many more {product-title} configuration tasks after an installation completes.
1620
====
1721

18-
== Prerequisites
19-
20-
* You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
21-
* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
22-
* You xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[configured an AWS account] to host the cluster.
23-
+
24-
[IMPORTANT]
25-
====
26-
If you have an {aws-short} 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-short} credentials to create {aws-short} resources for the entire life of the cluster, so you must use 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-short} documentation. You can supply the keys when you run the installation program.
27-
====
28-
* If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall-module_configuring-firewall[configured it to allow the sites] that your cluster requires access to.
22+
include::modules/installing-aws-custom-prereqs.adoc[leveloffset=+1]
2923

3024
include::modules/installation-aws-marketplace-subscribe.adoc[leveloffset=+1]
3125

@@ -128,13 +122,11 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
128122
include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1]
129123

130124
[role="_additional-resources"]
131-
.Additional resources
125+
[id="additional-resources_{context}"]
126+
== Additional resources
132127

133128
* xref:../../../web_console/web-console.adoc#web-console[Accessing the web console]
134-
135-
== Next steps
136-
137-
* xref:../../../installing/validation_and_troubleshooting/validating-an-installation.adoc#validating-an-installation[Validating an installation].
138-
* xref:../../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
139-
* If necessary, you can xref:../../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting].
140-
* If necessary, you can xref:../../../post_installation_configuration/changing-cloud-credentials-configuration.adoc#manually-removing-cloud-creds_changing-cloud-credentials-configuration[remove cloud provider credentials].
129+
* xref:../../../installing/validation_and_troubleshooting/validating-an-installation.adoc#validating-an-installation[Validating an installation]
130+
* xref:../../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]
131+
* xref:../../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting]
132+
* xref:../../../post_installation_configuration/changing-cloud-credentials-configuration.adoc#manually-removing-cloud-creds_changing-cloud-credentials-configuration[Removing cloud provider credentials]

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

Lines changed: 9 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,10 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
In {product-title} version {product-version}, you can install a cluster on
10-
Amazon Web Services (AWS) that uses the default configuration options.
9+
[role="_abstract"]
10+
In {product-title} version {product-version}, you can install a cluster on Amazon Web Services (AWS) that uses the default configuration options.
1111

12-
== Prerequisites
13-
14-
* You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
15-
* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
16-
* You xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[configured an AWS account] to host the cluster.
17-
+
18-
[IMPORTANT]
19-
====
20-
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.
21-
====
22-
* If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall-module_configuring-firewall[configured it to allow the sites] that your cluster requires access to.
12+
include::modules/installing-aws-default-prereqs.adoc[leveloffset=+1]
2313

2414
include::modules/installation-launching-installer.adoc[leveloffset=+1]
2515

@@ -33,13 +23,11 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
3323
include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1]
3424

3525
[role="_additional-resources"]
36-
.Additional resources
26+
[id="additional-resources_{context}"]
27+
== Additional resources
3728

3829
* xref:../../../web_console/web-console.adoc#web-console[Accessing the web console]
39-
40-
== Next steps
41-
42-
* xref:../../../installing/validation_and_troubleshooting/validating-an-installation.adoc#validating-an-installation[Validating an installation].
43-
* xref:../../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
44-
* If necessary, you can xref:../../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting].
45-
* If necessary, you can xref:../../../post_installation_configuration/changing-cloud-credentials-configuration.adoc#manually-removing-cloud-creds_changing-cloud-credentials-configuration[remove cloud provider credentials].
30+
* xref:../../../installing/validation_and_troubleshooting/validating-an-installation.adoc#validating-an-installation[Validating an installation]
31+
* xref:../../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Available cluster customizations]
32+
* xref:../../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting]
33+
* xref:../../../post_installation_configuration/changing-cloud-credentials-configuration.adoc#manually-removing-cloud-creds_changing-cloud-credentials-configuration[Removing cloud provider credentials]

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

Lines changed: 6 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -12,40 +12,7 @@ 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-
[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/overview/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 multifactor 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-module_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 give a user or role access for creating 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-
----
15+
include::modules/installing-aws-localzone-prereqs.adoc[leveloffset=+1]
4916

5017
[id="installation-about-local-zone-edge-compute-pool_{context}"]
5118
== About AWS Local Zones and edge compute pool
@@ -213,7 +180,9 @@ include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+2]
213180
// Verifying nodes that were created with edge compute pool
214181
include::modules/machine-edge-pool-review-nodes.adoc[leveloffset=+2]
215182

216-
.Next steps
183+
[role="_additional-resources"]
184+
[id="additional-resources_{context}"]
185+
== Additional resources
217186

218-
* xref:../../../installing/validation_and_troubleshooting/validating-an-installation.adoc#validating-an-installation[Validating an installation].
219-
* If necessary, you can xref:../../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting].
187+
* xref:../../../installing/validation_and_troubleshooting/validating-an-installation.adoc#validating-an-installation[Validating an installation]
188+
* xref:../../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting]

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

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,7 @@ toc::[]
99
[role="_abstract"]
1010
In {product-title} version {product-version}, you can install a private cluster into an existing Virtual Private Cloud (VPC) on {aws-first}. The installation program provisions the rest of the required infrastructure, which you can further customize. To customize the installation, you modify parameters in the `install-config.yaml` file before you install the cluster.
1111

12-
== Prerequisites
13-
14-
* You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
15-
* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
16-
* You xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[configured an AWS account] to host the cluster.
17-
+
18-
[IMPORTANT]
19-
====
20-
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 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.
21-
====
22-
* If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall-module_configuring-firewall[configured it to allow the sites] that your cluster requires access to.
12+
include::modules/installing-aws-private-prereqs.adoc[leveloffset=+1]
2313

2414
include::modules/private-clusters-default.adoc[leveloffset=+1]
2515

@@ -108,13 +98,11 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
10898
include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1]
10999

110100
[role="_additional-resources"]
111-
.Additional resources
101+
[id="additional-resources_{context}"]
102+
== Additional resources
112103

113104
* xref:../../../web_console/web-console.adoc#web-console[Accessing the web console]
114-
115-
== Next steps
116-
117-
* xref:../../../installing/validation_and_troubleshooting/validating-an-installation.adoc#validating-an-installation[Validating an installation].
118-
* xref:../../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
119-
* If necessary, you can xref:../../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting].
120-
* If necessary, you can xref:../../../post_installation_configuration/changing-cloud-credentials-configuration.adoc#manually-removing-cloud-creds_changing-cloud-credentials-configuration[remove cloud provider credentials].
105+
* xref:../../../installing/validation_and_troubleshooting/validating-an-installation.adoc#validating-an-installation[Validating an installation]
106+
* xref:../../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]
107+
* xref:../../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting]
108+
* xref:../../../post_installation_configuration/changing-cloud-credentials-configuration.adoc#manually-removing-cloud-creds_changing-cloud-credentials-configuration[Removing cloud provider credentials]
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:_mod-docs-content-type: REFERENCE
2+
[id="installing-aws-default-prereqs_{context}"]
3+
= Prerequisites
4+
5+
[role="_abstract"]
6+
Before you install a cluster on Amazon Web Services (AWS) by using installer-provisioned infrastructure with customizations, you must meet several prerequisites.
7+
8+
The following prerequisites must be met:
9+
10+
* You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
11+
* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
12+
* You xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[configured an AWS account] to host the cluster.
13+
+
14+
[IMPORTANT]
15+
====
16+
If you have an {aws-short} 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-short} credentials to create {aws-short} resources for the entire life of the cluster, so you must use 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-short} documentation. You can supply the keys when you run the installation program.
17+
====
18+
* If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall-module_configuring-firewall[configured it to allow the sites] that your cluster requires access to.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
2+
:_mod-docs-content-type: REFERENCE
3+
[id="installing-aws-default-prereqs_{context}"]
4+
= Prerequisites
5+
6+
[role="_abstract"]
7+
Before you install a cluster on Amazon Web Services (AWS) that uses the default configuration options, you must meet several prerequisites.
8+
9+
The following prerequisites must be met:
10+
11+
* You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
12+
* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
13+
* You xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[configured an AWS account] to host the cluster.
14+
+
15+
[IMPORTANT]
16+
====
17+
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.
18+
====
19+
* If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall-module_configuring-firewall[configured it to allow the sites] that your cluster requires access to.

0 commit comments

Comments
 (0)