Skip to content

Commit b29a227

Browse files
authored
Merge pull request #71093 from mjpytlak/osdocs-8719
OSDOCS#8719: Refactor of pre-installation tasks for an IPI installation
2 parents f2bb296 + a683e8b commit b29a227

10 files changed

+44
-60
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -477,6 +477,8 @@ Topics:
477477
Topics:
478478
- Name: vSphere installation requirements
479479
File: ipi-vsphere-installation-reqs
480+
- Name: Preparing to install a cluster
481+
File: ipi-vsphere-preparing-to-install
480482
- Name: Installing a cluster
481483
File: installing-vsphere-installer-provisioned
482484
- Name: Installing a cluster with customizations

installing/installing_vsphere/ipi/installing-restricted-networks-installer-provisioned-vsphere.adoc

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ include::snippets/vcenter-support.adoc[]
1313
[id="prerequisites_installing-restricted-networks-installer-provisioned-vsphere"]
1414
== Prerequisites
1515

16+
* You have completed the tasks in xref:../../../installing/installing_vsphere/ipi/ipi-vsphere-preparing-to-install.adoc#ipi-vsphere-preparing-to-install[Preparing to install a cluster using installer-provisioned infrastructure].
1617
* You reviewed your VMware platform licenses. Red{nbsp}Hat does not place any restrictions on your VMware licenses, but some VMware infrastructure components require licensing.
1718
* You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
1819
* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
@@ -36,10 +37,6 @@ include::modules/installation-about-restricted-network.adoc[leveloffset=+1]
3637

3738
include::modules/cluster-entitlements.adoc[leveloffset=+1]
3839

39-
include::modules/ssh-agent-using.adoc[leveloffset=+1]
40-
41-
include::modules/installation-adding-vcenter-root-certificates.adoc[leveloffset=+1]
42-
4340
include::modules/installation-creating-image-restricted.adoc[leveloffset=+1]
4441

4542
include::modules/installation-vsphere-regions-zones.adoc[leveloffset=+1]
@@ -69,8 +66,6 @@ include::modules/configuring-vsphere-regions-zones.adoc[leveloffset=+2]
6966

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

72-
include::modules/cli-installing-cli.adoc[leveloffset=+1]
73-
7469
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
7570

7671
include::modules/olm-restricted-networks-configuring-operatorhub.adoc[leveloffset=+1]

installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ include::snippets/vcenter-support.adoc[]
1414

1515
== Prerequisites
1616

17+
* You have completed the tasks in xref:../../../installing/installing_vsphere/ipi/ipi-vsphere-preparing-to-install.adoc#ipi-vsphere-preparing-to-install[Preparing to install a cluster using installer-provisioned infrastructure].
1718
* You reviewed your VMware platform licenses. Red{nbsp}Hat does not place any restrictions on your VMware licenses, but some VMware infrastructure components require licensing.
1819
* You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
1920
* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
@@ -29,12 +30,6 @@ Be sure to also review this site list if you are configuring a proxy.
2930

3031
include::modules/cluster-entitlements.adoc[leveloffset=+1]
3132

32-
include::modules/ssh-agent-using.adoc[leveloffset=+1]
33-
34-
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
35-
36-
include::modules/installation-adding-vcenter-root-certificates.adoc[leveloffset=+1]
37-
3833
include::modules/installation-vsphere-regions-zones.adoc[leveloffset=+1]
3934

4035
[role="_additional-resources"]
@@ -62,8 +57,6 @@ include::modules/configuring-vsphere-regions-zones.adoc[leveloffset=+2]
6257

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

65-
include::modules/cli-installing-cli.adoc[leveloffset=+1]
66-
6760
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
6861

6962
[id="installing-vsphere-installer-provisioned-customizations-registry"]

installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-network-customizations.adoc

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ include::snippets/vcenter-support.adoc[]
1515

1616
== Prerequisites
1717

18+
* You have completed the tasks in xref:../../../installing/installing_vsphere/ipi/ipi-vsphere-preparing-to-install.adoc#ipi-vsphere-preparing-to-install[Preparing to install a cluster using installer-provisioned infrastructure].
1819
* You reviewed your VMware platform licenses. Red{nbsp}Hat does not place any restrictions on your VMware licenses, but some VMware infrastructure components require licensing.
1920
* You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
2021
* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
@@ -31,12 +32,6 @@ Be sure to also review this site list if you are configuring a proxy.
3132

3233
include::modules/cluster-entitlements.adoc[leveloffset=+1]
3334

34-
include::modules/ssh-agent-using.adoc[leveloffset=+1]
35-
36-
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
37-
38-
include::modules/installation-adding-vcenter-root-certificates.adoc[leveloffset=+1]
39-
4035
include::modules/installation-vsphere-regions-zones.adoc[leveloffset=+1]
4136

4237
[role="_additional-resources"]
@@ -72,8 +67,6 @@ include::modules/nw-operator-cr.adoc[leveloffset=+1]
7267

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

75-
include::modules/cli-installing-cli.adoc[leveloffset=+1]
76-
7770
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
7871

7972
[id="installing-vsphere-installer-provisioned-network-customizations-registry"]

installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned.adoc

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ include::snippets/vcenter-support.adoc[]
1313

1414
== Prerequisites
1515

16+
* You have completed the tasks in xref:../../../installing/installing_vsphere/ipi/ipi-vsphere-preparing-to-install.adoc#ipi-vsphere-preparing-to-install[Preparing to install a cluster using installer-provisioned infrastructure].
1617
* You reviewed your VMware platform licenses. Red{nbsp}Hat does not place any restrictions on your VMware licenses, but some VMware infrastructure components require licensing.
1718
* You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
1819
* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
@@ -29,16 +30,8 @@ Be sure to also review this site list if you are configuring a proxy.
2930

3031
include::modules/cluster-entitlements.adoc[leveloffset=+1]
3132

32-
include::modules/ssh-agent-using.adoc[leveloffset=+1]
33-
34-
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
35-
36-
include::modules/installation-adding-vcenter-root-certificates.adoc[leveloffset=+1]
37-
3833
include::modules/installation-launching-installer.adoc[leveloffset=+1]
3934

40-
include::modules/cli-installing-cli.adoc[leveloffset=+1]
41-
4235
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
4336

4437
[id="installing-vsphere-installer-provisioned-registry"]
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="ipi-vsphere-preparing-to-install"]
3+
= Preparing to install a cluster using installer-provisioned infrastructure
4+
include::_attributes/common-attributes.adoc[]
5+
:context: ipi-vsphere-preparing-to-install
6+
7+
toc::[]
8+
9+
You prepare to install an {product-title} cluster on vSphere by completing the following steps:
10+
11+
* Downloading the installation program.
12+
+
13+
[NOTE]
14+
====
15+
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].
16+
====
17+
* Installing the {oc-first}.
18+
+
19+
[NOTE]
20+
====
21+
If you are installing in a disconnected environment, install `oc` to the mirror host.
22+
====
23+
* Generating an SSH key pair. You can use this key pair to authenticate into the {product-title} cluster's nodes after it is deployed.
24+
* Adding your vCenter’s trusted root CA certificates to your system trust.
25+
26+
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
27+
28+
include::modules/cli-installing-cli.adoc[leveloffset=+1]
29+
30+
include::modules/ssh-agent-using.adoc[leveloffset=+1]
31+
32+
include::modules/installation-adding-vcenter-root-certificates.adoc[leveloffset=+1]

modules/cli-installing-cli.adoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,6 @@
3535
// * installing/installing_ibm_cloud_public/installing-ibm-cloud-private.adoc
3636
// * installing/install_config/installing-restricted-networks-preparations.adoc
3737
// * installing/installing_vsphere/installing-vsphere.adoc
38-
// * installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc
39-
// * installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc
40-
// * installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc
41-
// * installing/installing_vsphere/installing-restricted-networks-installer-provisioned-vsphere.adoc
4238
// * installing/installing_ibm_z/installing-ibm-z.adoc
4339
// * openshift_images/samples-operator-alt-registry.adoc
4440
// * updating/updating-restricted-network-cluster/mirroring-image-repository.adoc
@@ -51,6 +47,7 @@
5147
// * installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc
5248
// * installing/installing-restricted-networks-azure-installer-provisioned.adoc
5349
// * installing/installing_azure/installing-restricted-networks-azure-user-provisioned.adoc
50+
// * installing/installing_vsphere/ipi/ipi-vsphere-preparing-to-install.adoc
5451
// AMQ docs link to this; do not change anchor
5552

5653
ifeval::["{context}" == "mirroring-ocp-image-repository"]

modules/installation-adding-vcenter-root-certificates.adoc

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
// Module included in the following assemblies:
2-
//
3-
// * installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc
4-
// * installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc
5-
// * installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc
6-
// * installing/installing_vsphere/installing-restricted-networks-installer-provisioned-vsphere.adoc
2+
// * installing/installing_vsphere/ipi/ipi-vsphere-preparing-to-install.adoc
73

84
:_mod-docs-content-type: PROCEDURE
95
[id="installation-adding-vcenter-root-certificates_{context}"]

modules/installation-obtaining-installer.adoc

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,11 @@
3535
// * installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc
3636
// * installing/installing_vsphere/installing-vsphere.adoc
3737
// * installing/installing_vsphere/installing-vsphere-network-customizations.adoc
38-
// * installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc
39-
// * installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc
40-
// * installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc
4138
// * installing/installing_ibm_z/installing-ibm-z.adoc
4239
// * installing/installing_ibm_z/installing-ibm-z-kvm.adoc
4340
// * installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc
4441
// * installing/installing_azure/installing-restricted-networks-azure-user-provisioned.adoc
42+
// * installing/installing_vsphere/ipi/ipi-vsphere-preparing-to-install.adoc
4543

4644

4745
ifeval::["{context}" == "installing-ibm-z"]
@@ -62,13 +60,7 @@ endif::[]
6260
ifeval::["{context}" == "installing-ibm-cloud-private"]
6361
:private:
6462
endif::[]
65-
ifeval::["{context}" == "installing-vsphere-installer-provisioned"]
66-
:vsphere:
67-
endif::[]
68-
ifeval::["{context}" == "installing-vsphere-installer-provisioned-customizations"]
69-
:vsphere:
70-
endif::[]
71-
ifeval::["{context}" == "installing-vsphere-installer-provisioned-network-customizations"]
63+
ifeval::["{context}" == "ipi-vsphere-preparing-to-install"]
7264
:vsphere:
7365
endif::[]
7466

@@ -170,12 +162,6 @@ endif::[]
170162
ifeval::["{context}" == "installing-ibm-cloud-private"]
171163
:!private:
172164
endif::[]
173-
ifeval::["{context}" == "installing-vsphere-installer-provisioned"]
174-
:!vsphere:
175-
endif::[]
176-
ifeval::["{context}" == "installing-vsphere-installer-provisioned-customizations"]
177-
:!vsphere:
178-
endif::[]
179-
ifeval::["{context}" == "installing-vsphere-installer-provisioned-network-customizations"]
165+
ifeval::["{context}" == "ipi-vsphere-preparing-to-install"]
180166
:!vsphere:
181167
endif::[]

modules/ssh-agent-using.adoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,6 @@
4343
// * installing/installing_vsphere/installing-restricted-networks-vsphere.adoc
4444
// * installing/installing_vsphere/installing-vsphere.adoc
4545
// * installing/installing_vsphere/installing-vsphere-network-customizations.adoc
46-
// * installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc
47-
// * installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc
48-
// * installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc
49-
// * installing/installing_vsphere/installing-restricted-networks-installer-provisioned-vsphere.adoc
5046
// * installing/installing_ibm_z/installing-ibm-z.adoc
5147
// * installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc
5248
// * installing/installing_ibm_z/installing-ibm-z-kvm.adoc
@@ -56,6 +52,7 @@
5652
// * installing/installing-restricted-networks-nutanix-installer-provisioned.adoc
5753
// * installing/installing_azure/installing-restricted-networks-azure-installer-provisioned.adoc
5854
// * installing/installing_azure/installing-restricted-networks-azure-user-provisioned.adoc
55+
// * installing/installing_vsphere/ipi/ipi-vsphere-preparing-to-install.adoc
5956

6057

6158
ifeval::["{context}" == "installing-restricted-networks-vsphere"]

0 commit comments

Comments
 (0)