Skip to content

Commit 7418f9a

Browse files
authored
Merge pull request #63813 from mjpytlak/osdocs-6503
OSDOCS#6503: IBM Cloud VPC - move install config parameters out of as…
2 parents 8e81dde + bc9f92b commit 7418f9a

7 files changed

+46
-49
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,8 @@ Topics:
290290
File: installing-ibm-cloud-vpc
291291
- Name: Installing a private cluster on IBM Cloud VPC
292292
File: installing-ibm-cloud-private
293+
- Name: Installation configuration parameters for IBM Cloud VPC
294+
File: installation-config-parameters-ibm-cloud-vpc
293295
- Name: Uninstalling a cluster on IBM Cloud VPC
294296
File: uninstalling-cluster-ibm-cloud
295297
- Name: Installing on Nutanix
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
:_content-type: ASSEMBLY
2+
[id="installation-config-parameters-ibm-cloud-vpc"]
3+
= Installation configuration parameters for IBM Cloud VPC
4+
include::_attributes/common-attributes.adoc[]
5+
:context: installation-config-parameters-ibm-cloud-vpc
6+
:platform: IBM Cloud VPC
7+
8+
toc::[]
9+
10+
Before you deploy an {product-title} cluster on IBM Cloud VPC, you provide parameters to customize your cluster and the platform that hosts it. When you create the `install-config.yaml` file, you provide values for the required parameters through the command line. You can then modify the `install-config.yaml` file to customize your cluster further.
11+
12+
include::modules/installation-configuration-parameters.adoc[leveloffset=+1]

installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ include::modules/installation-ibm-cloud-export-variables.adoc[leveloffset=+1]
2727

2828
include::modules/installation-initializing.adoc[leveloffset=+1]
2929

30-
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
30+
[role="_additional-resources"]
31+
.Additional resources
32+
* xref:../../installing/installing_ibm_cloud_public/installation-config-parameters-ibm-cloud-vpc.adoc#installation-config-parameters-ibm-cloud-vpc[Installation configuration parameters for IBM Cloud VPC]
3133

3234
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
3335

installing/installing_ibm_cloud_public/installing-ibm-cloud-network-customizations.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ include::modules/installation-ibm-cloud-export-variables.adoc[leveloffset=+1]
3030

3131
include::modules/installation-initializing.adoc[leveloffset=+1]
3232

33-
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
33+
[role="_additional-resources"]
34+
.Additional resources
35+
* xref:../../installing/installing_ibm_cloud_public/installation-config-parameters-ibm-cloud-vpc.adoc#installation-config-parameters-ibm-cloud-vpc[Installation configuration parameters for IBM Cloud VPC]
3436

3537
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
3638

installing/installing_ibm_cloud_public/installing-ibm-cloud-private.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ include::modules/installation-ibm-cloud-export-variables.adoc[leveloffset=+1]
3333

3434
include::modules/installation-initializing-manual.adoc[leveloffset=+1]
3535

36-
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
36+
[role="_additional-resources"]
37+
.Additional resources
38+
* xref:../../installing/installing_ibm_cloud_public/installation-config-parameters-ibm-cloud-vpc.adoc#installation-config-parameters-ibm-cloud-vpc[Installation configuration parameters for IBM Cloud VPC]
3739

3840
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
3941

installing/installing_ibm_cloud_public/installing-ibm-cloud-vpc.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@ include::modules/installation-ibm-cloud-export-variables.adoc[leveloffset=+1]
2929

3030
include::modules/installation-initializing.adoc[leveloffset=+1]
3131

32-
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
32+
[role="_additional-resources"]
33+
.Additional resources
34+
* xref:../../installing/installing_ibm_cloud_public/installation-config-parameters-ibm-cloud-vpc.adoc#installation-config-parameters-ibm-cloud-vpc[Installation configuration parameters for IBM Cloud VPC]
3335

3436
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
3537

modules/installation-configuration-parameters.adoc

Lines changed: 20 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,6 @@
1818
// * installing/installing_azure/installing-azure-network-customizations.adoc
1919
// * installing/installing_azure/installing-azure-private.adoc
2020
// * installing/installing_azure/installing-azure-vnet.adoc
21-
// * installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc
22-
// * installing/installing_ibm_cloud_public/installing-ibm-cloud-network-customizations.adoc
23-
// * installing/installing_ibm_cloud_public/installing-ibm-cloud-vpc.adoc
24-
// * installing/installing_ibm_cloud_public/intalling-ibm-cloud-private.adoc
2521
// * installing/installing_ibm_powervs/installing-ibm-power-vs-customizations.adoc
2622
// * installing/installing_ibm_powervs/installing-ibm-power-vs-private-cluster.adoc
2723
// * installing/installing_ibm_powervs/installing-restricted-networks-ibm-power-vs.adoc
@@ -52,6 +48,7 @@
5248
// * installing/installing_ibm_power/installation-config-parameters-ibm-power.adoc
5349
// * installing/installing_azure_stack_hub/installation-config-parameters-ash.adoc
5450
// * installing/installing_bare_metal/installation-config-parameters-bare-metal.adoc
51+
// * installing/installing_ibm_cloud_public/installation-config-parameters-ibm-cloud-vps.adoc
5552

5653
ifeval::["{context}" == "installing-alibaba-customizations"]
5754
:alibabacloud:
@@ -103,20 +100,6 @@ endif::[]
103100
ifeval::["{context}" == "installing-aws-customizations"]
104101
:aws:
105102
endif::[]
106-
ifeval::["{context}" == "installing-ibm-cloud-customizations"]
107-
:ibm-cloud:
108-
endif::[]
109-
ifeval::["{context}" == "installing-ibm-cloud-network-customizations"]
110-
:ibm-cloud:
111-
endif::[]
112-
ifeval::["{context}" == "installing-ibm-cloud-vpc"]
113-
:ibm-cloud:
114-
:ibm-cloud-vpc:
115-
endif::[]
116-
ifeval::["{context}" == "installing-ibm-cloud-private"]
117-
:ibm-cloud:
118-
:ibm-cloud-vpc:
119-
endif::[]
120103
ifeval::["{context}" == "installing-openstack-installer-custom"]
121104
:osp:
122105
:osp-custom:
@@ -208,28 +191,31 @@ endif::[]
208191
ifeval::["{context}" == "installation-config-parameters-bare-metal"]
209192
:bare:
210193
endif::[]
194+
ifeval::["{context}" == "installation-config-parameters-ibm-cloud-vpc"]
195+
:ibm-cloud:
196+
endif::[]
211197

212198

213199
:_content-type: CONCEPT
214200
[id="installation-configuration-parameters_{context}"]
215-
ifndef::vsphere,gcp,ibm-z,ibm-power,ash,bare[]
201+
ifndef::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud[]
216202
= Installation configuration parameters
217-
endif::vsphere,gcp,ibm-z,ibm-power,ash,bare[]
203+
endif::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud[]
218204

219205
// Managing headings is required as part of the effort for https://issues.redhat.com/browse/OSDOCS-6493.
220206
// This accommodates the existing IA of the installation assemblies, while the improvement is implemented.
221207
// As part of the updates for the last provider, the conditions can be removed and the following heading can be used.
222-
ifdef::vsphere,gcp,ibm-z,ibm-power,ash,bare[]
208+
ifdef::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud[]
223209
= Available installation configuration parameters for {platform}
224-
endif::vsphere,gcp,ibm-z,ibm-power,ash,bare[]
210+
endif::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud[]
225211

226212
// If install-config.yaml is generated by openshift-install
227213
// The addition of providers beyond bare,ibm-power,ibm-z,ash is necessary as part of the effort for https://issues.redhat.com/browse/OSDOCS-6493
228214
// This accommodates the existing IA of the installation assemblies, while the improvement is implemented.
229215
// As part of the updates for the last provider, content between lines 277-292 can be completely removed.
230-
ifndef::bare,ibm-power,ibm-z,ash,vsphere,gcp[]
216+
ifndef::bare,ibm-power,ibm-z,ash,vsphere,gcp,ibm-cloud[]
231217
Before you deploy an {product-title} cluster, you provide parameter values to describe your account on the cloud platform that hosts your cluster and optionally customize your cluster's platform. When you create the `install-config.yaml` installation configuration file, you provide values for the required parameters through the command line. If you customize your cluster, you can modify the `install-config.yaml` file to provide more details about the platform.
232-
endif::bare,ibm-power,ibm-z,ash,vsphere,gcp[]
218+
endif::bare,ibm-power,ibm-z,ash,vsphere,gcp,ibm-cloud[]
233219

234220
// If the user manually creates install-config.yaml
235221
ifdef::ibm-power-vs[]
@@ -239,24 +225,24 @@ endif::ibm-power-vs[]
239225
// A condition for this note is required as part of the effort for https://issues.redhat.com/browse/OSDOCS-6493.
240226
// This accommodates the existing content for installation assemblies, while the improvement is implemented.
241227
// As part of the updates for the last provider, this note can be removed from the module.
242-
ifndef::vsphere,gcp,ibm-z,ibm-power,ash,bare[]
228+
ifndef::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud[]
243229
[NOTE]
244230
====
245231
After installation, you cannot modify these parameters in the `install-config.yaml` file.
246232
====
247-
endif::vsphere,gcp,ibm-z,ibm-power,ash,bare[]
233+
endif::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud[]
248234

249235
// This condition is required as part of the effort for https://issues.redhat.com/browse/OSDOCS-6493.
250236
// As part of the update for each provider, this content applies to the net new provider-specific installation configuration parameter assembly.
251237
// As part of the updates for the last provider, the conditions can be completely removed.
252-
ifdef::vsphere,gcp,ibm-z,ibm-power,ash,bare[]
238+
ifdef::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud[]
253239
The following tables specify the required, optional, and {platform}-specific installation configuration parameters that you can set as part of the installation process.
254240

255241
[NOTE]
256242
====
257243
After installation, you cannot modify these parameters in the `install-config.yaml` file.
258244
====
259-
endif::vsphere,gcp,ibm-z,ibm-power,ash,bare[]
245+
endif::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud[]
260246

261247
[id="installation-configuration-parameters-required_{context}"]
262248
== Required configuration parameters
@@ -524,9 +510,9 @@ networking:
524510
|`networking.machineNetwork.cidr`
525511
|
526512
Required if you use `networking.machineNetwork`. An IP address block. The default value is `10.0.0.0/16` for all platforms other than libvirt and {ibmpowerProductName} Virtual Server. For libvirt, the default value is `192.168.126.0/24`. For {ibmpowerProductName} Virtual Server, the default value is `192.168.0.0/24`.
527-
ifdef::ibm-cloud-vpc[]
528-
The CIDR must contain the subnets defined in `platform.ibmcloud.controlPlaneSubnets` and `platform.ibmcloud.computeSubnets`.
529-
endif::ibm-cloud-vpc[]
513+
ifdef::ibm-cloud[]
514+
If you are deploying the cluster to an existing Virtual Private Cloud (VPC), the CIDR must contain the subnets defined in `platform.ibmcloud.controlPlaneSubnets` and `platform.ibmcloud.computeSubnets`.
515+
endif::ibm-cloud[]
530516
|
531517
An IP network block in CIDR notation.
532518

@@ -2157,20 +2143,6 @@ endif::[]
21572143
ifeval::["{context}" == "installing-aws-customizations"]
21582144
:!aws:
21592145
endif::[]
2160-
ifeval::["{context}" == "installing-ibm-cloud-customizations"]
2161-
:!ibm-cloud:
2162-
endif::[]
2163-
ifeval::["{context}" == "installing-ibm-cloud-network-customizations"]
2164-
:!ibm-cloud:
2165-
endif::[]
2166-
ifeval::["{context}" == "installing-ibm-cloud-vpc"]
2167-
:!ibm-cloud:
2168-
:!ibm-cloud-vpc:
2169-
endif::[]
2170-
ifeval::["{context}" == "installing-ibm-cloud-private"]
2171-
:!ibm-cloud:
2172-
:!ibm-cloud-vpc:
2173-
endif::[]
21742146
ifeval::["{context}" == "installing-openstack-installer-custom"]
21752147
:!osp:
21762148
:!osp-custom:
@@ -2253,4 +2225,7 @@ endif::[]
22532225
ifeval::["{context}" == "installation-config-parameters-bare-metal"]
22542226
:!bare:
22552227
endif::[]
2228+
ifeval::["{context}" == "installation-config-parameters-ibm-cloud-vpc"]
2229+
:!ibm-cloud:
2230+
endif::[]
22562231
:!platform:

0 commit comments

Comments
 (0)