Skip to content

Commit 3095619

Browse files
authored
Merge pull request #77208 from bscott-rh/OSDOCS-10086
OSDOCS#10086 reorganizing AWS UPI pre-install (UPI)
2 parents 886d283 + 77e6c11 commit 3095619

File tree

5 files changed

+86
-73
lines changed

5 files changed

+86
-73
lines changed

_topic_maps/_topic_map.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,10 @@ Topics:
196196
Dir: upi
197197
Distros: openshift-origin,openshift-enterprise
198198
Topics:
199+
- Name: Preparing to install a cluster
200+
File: upi-aws-preparing-to-install
201+
- Name: Installation requirements
202+
File: upi-aws-installation-reqs
199203
- Name: Installing a cluster using CloudFormation templates
200204
File: installing-aws-user-infra
201205
- Name: Installing a cluster in a restricted network with user-provisioned infrastructure

installing/installing_aws/upi/installing-aws-user-infra.adoc

Lines changed: 1 addition & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ The steps for performing a user-provisioned infrastructure installation are prov
2626
====
2727
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.
2828
====
29+
* You xref:../../../installing/installing_aws/upi/upi-aws-installation-reqs#upi-aws-installation-reqs[prepared the user-provisioned infrastructure.]
2930
* 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.
3031
* If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to.
3132
+
@@ -35,38 +36,6 @@ Be sure to also review this site list if you are configuring a proxy.
3536
====
3637
* If the cloud identity and access management (IAM) APIs are not accessible in your environment, or if you do not want to store an administrator-level credential secret in the `kube-system` namespace, you can xref:../../../installing/installing_aws/ipi/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[manually create and maintain long-term credentials].
3738

38-
include::modules/cluster-entitlements.adoc[leveloffset=+1]
39-
40-
[id="installation-requirements-user-infra_{context}"]
41-
== Requirements for a cluster with user-provisioned infrastructure
42-
43-
For a cluster that contains user-provisioned infrastructure, you must deploy all
44-
of the required machines.
45-
46-
This section describes the requirements for deploying {product-title} on user-provisioned infrastructure.
47-
48-
include::modules/installation-machine-requirements.adoc[leveloffset=+2]
49-
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
50-
51-
[role="_additional-resources"]
52-
.Additional resources
53-
54-
* xref:../../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage]
55-
56-
include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2]
57-
include::modules/installation-aws-arm-tested-machine-types.adoc[leveloffset=+2]
58-
include::modules/csr-management.adoc[leveloffset=+2]
59-
60-
include::modules/installation-aws-user-infra-requirements.adoc[leveloffset=+1]
61-
62-
include::modules/installation-aws-permissions.adoc[leveloffset=+2]
63-
64-
include::modules/installation-aws-marketplace-subscribe.adoc[leveloffset=+1]
65-
66-
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
67-
68-
include::modules/ssh-agent-using.adoc[leveloffset=+1]
69-
7039
include::modules/installation-user-infra-generate.adoc[leveloffset=+1]
7140

7241
include::modules/installation-disk-partitioning-upi-templates.adoc[leveloffset=+2]
@@ -175,8 +144,6 @@ include::modules/installation-aws-user-infra-bootstrap.adoc[leveloffset=+1]
175144

176145
* You can view details about the running instances that are created by using the link:https://console.aws.amazon.com/ec2[AWS EC2 console].
177146

178-
include::modules/cli-installing-cli.adoc[leveloffset=+1]
179-
180147
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
181148

182149
include::modules/installation-approve-csrs.adoc[leveloffset=+1]
@@ -204,13 +171,6 @@ include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1]
204171

205172
* See xref:../../../web_console/web-console.adoc#web-console[Accessing the web console] for more details about accessing and understanding the {product-title} web console.
206173

207-
include::modules/cluster-telemetry.adoc[leveloffset=+1]
208-
209-
[role="_additional-resources"]
210-
.Additional resources
211-
212-
* See xref:../../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] for more information about the Telemetry service.
213-
214174
[role="_additional-resources"]
215175
[id="installing-aws-user-infra-additional-resources"]
216176
== Additional resources

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

Lines changed: 3 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +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 xref:../../../installing/installing_aws/upi/upi-aws-installation-reqs#upi-aws-installation-reqs[prepared the user-provisioned infrastructure.]
4546
* 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.
4647
* 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.
4748
+
@@ -53,36 +54,8 @@ Be sure to also review this site list if you are configuring a proxy.
5354

5455
include::modules/installation-about-restricted-network.adoc[leveloffset=+1]
5556

56-
include::modules/cluster-entitlements.adoc[leveloffset=+1]
57-
58-
[id="installation-requirements-user-infra_{context}"]
59-
== Requirements for a cluster with user-provisioned infrastructure
60-
61-
For a cluster that contains user-provisioned infrastructure, you must deploy all
62-
of the required machines.
63-
64-
This section describes the requirements for deploying {product-title} on user-provisioned infrastructure.
65-
66-
include::modules/installation-machine-requirements.adoc[leveloffset=+2]
67-
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
68-
69-
[role="_additional-resources"]
70-
.Additional resources
71-
72-
* xref:../../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage]
73-
74-
include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2]
75-
include::modules/installation-aws-arm-tested-machine-types.adoc[leveloffset=+2]
76-
include::modules/csr-management.adoc[leveloffset=+2]
77-
78-
include::modules/installation-aws-user-infra-requirements.adoc[leveloffset=+1]
79-
80-
include::modules/installation-aws-permissions.adoc[leveloffset=+2]
81-
8257
//You extract the installation program from the mirrored content.
8358

84-
include::modules/ssh-agent-using.adoc[leveloffset=+1]
85-
8659
include::modules/installation-user-infra-generate.adoc[leveloffset=+1]
8760

8861
include::modules/installation-disk-partitioning-upi-templates.adoc[leveloffset=+2]
@@ -163,8 +136,6 @@ include::modules/installation-aws-user-infra-bootstrap.adoc[leveloffset=+1]
163136

164137
//You can install the CLI on the mirror host.
165138

166-
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
167-
168139
include::modules/installation-approve-csrs.adoc[leveloffset=+1]
169140

170141
include::modules/installation-operators-config.adoc[leveloffset=+1]
@@ -183,15 +154,15 @@ include::modules/installation-create-ingress-dns-records.adoc[leveloffset=+1]
183154

184155
include::modules/installation-aws-user-infra-installation.adoc[leveloffset=+1]
185156

157+
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
158+
186159
include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1]
187160

188161
[role="_additional-resources"]
189162
.Additional resources
190163

191164
* See xref:../../../web_console/web-console.adoc#web-console[Accessing the web console] for more details about accessing and understanding the {product-title} web console.
192165

193-
include::modules/cluster-telemetry.adoc[leveloffset=+1]
194-
195166
[role="_additional-resources"]
196167
.Additional resources
197168

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="upi-aws-installation-reqs"]
3+
= Installation requirements for user-provisioned infrastructure on AWS
4+
include::_attributes/common-attributes.adoc[]
5+
:context: upi-aws-installation-reqs
6+
7+
toc::[]
8+
9+
Before you begin an installation on infrastructure that you provision, be sure that your AWS environment meets the following installation requirements.
10+
11+
For a cluster that contains user-provisioned infrastructure, you must deploy all
12+
of the required machines.
13+
14+
15+
include::modules/installation-machine-requirements.adoc[leveloffset=+1]
16+
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
17+
18+
[role="_additional-resources"]
19+
.Additional resources
20+
21+
* xref:../../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage]
22+
23+
include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2]
24+
include::modules/installation-aws-arm-tested-machine-types.adoc[leveloffset=+2]
25+
26+
include::modules/csr-management.adoc[leveloffset=+1]
27+
28+
include::modules/installation-aws-user-infra-requirements.adoc[leveloffset=+1]
29+
30+
include::modules/installation-aws-permissions.adoc[leveloffset=+1]
31+
32+
include::modules/installation-aws-marketplace-subscribe.adoc[leveloffset=+1]
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="upi-aws-preparing-to-install"]
3+
= Preparing to install a cluster on AWS
4+
include::_attributes/common-attributes.adoc[]
5+
:context: upi-aws-preparing-to-install
6+
7+
toc::[]
8+
9+
You prepare to install an {product-title} cluster on AWS by completing the following steps:
10+
11+
* Verifying internet connectivity for your cluster.
12+
13+
* xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[Configuring an AWS account].
14+
15+
* Downloading the installation program.
16+
+
17+
[NOTE]
18+
====
19+
If you are installing in a disconnected environment, you extract the installation program from the mirrored content. For more information, see xref:../../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[Mirroring images for a disconnected installation].
20+
====
21+
* Installing the {oc-first}.
22+
+
23+
[NOTE]
24+
====
25+
If you are installing in a disconnected environment, install `oc` to the mirror host.
26+
====
27+
* Generating an SSH key pair. You can use this key pair to authenticate into the {product-title} cluster's nodes after it is deployed.
28+
29+
* xref:../../../installing/installing_aws/upi/upi-aws-installation-reqs#upi-aws-installation-reqs[Preparing the user-provisioned infrastructure.]
30+
31+
* If the cloud identity and access management (IAM) APIs are not accessible in your environment, or if you do not want to store an administrator-level credential secret in the `kube-system` namespace, xref:../../../installing/installing_aws/ipi/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[manually creating long-term credentials for AWS] or xref:../../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-with-short-term-creds_installing-aws-customizations[configuring an AWS cluster to use short-term credentials] with Amazon Web Services Security Token Service (AWS STS).
32+
33+
include::modules/cluster-entitlements.adoc[leveloffset=+1]
34+
35+
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
36+
37+
include::modules/cli-installing-cli.adoc[leveloffset=+1]
38+
39+
include::modules/ssh-agent-using.adoc[leveloffset=+1]
40+
41+
include::modules/cluster-telemetry.adoc[leveloffset=+1]
42+
43+
[role="_additional-resources"]
44+
.Additional resources
45+
46+
* See xref:../../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] for more information about the Telemetry service.

0 commit comments

Comments
 (0)