Skip to content

Commit 3399420

Browse files
authored
Merge pull request #63621 from SNiemann15/osdocs6507
[OSDOCS6507] Restructure bare metal config parms to book level
2 parents b8fe131 + 3fb8de4 commit 3399420

7 files changed

+49
-32
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -320,6 +320,8 @@ Topics:
320320
File: installing-restricted-networks-bare-metal
321321
- Name: Scaling a user-provisioned installation with the bare metal operator
322322
File: scaling-a-user-provisioned-cluster-with-the-bare-metal-operator
323+
- Name: Installation configuration parameters for bare metal
324+
File: installation-config-parameters-bare-metal
323325
- Name: Installing on-premise with Assisted Installer
324326
Dir: installing_on_prem_assisted
325327
Distros: openshift-enterprise

installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,11 @@ include::modules/ssh-agent-using.adoc[leveloffset=+1]
6868

6969
include::modules/installation-user-infra-generate.adoc[leveloffset=+1]
7070
include::modules/installation-initializing-manual.adoc[leveloffset=+2]
71+
72+
[role="_additional-resources"]
73+
.Additional resources
74+
* xref:../../installing/installing_azure_stack_hub/installation-config-parameters-ash.adoc#installation-config-parameters-ash[Installation configuration parameters for Azure Stack Hub]
75+
7176
include::modules/installation-azure-stack-hub-config-yaml.adoc[leveloffset=+2]
7277

7378
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
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-bare-metal"]
3+
= Installation configuration parameters for bare metal
4+
include::_attributes/common-attributes.adoc[]
5+
:context: installation-config-parameters-bare-metal
6+
:platform: bare metal
7+
8+
toc::[]
9+
10+
Before you deploy an {product-title} cluster, you provide a customized `install-config.yaml` installation configuration file that describes the details for your environment.
11+
12+
include::modules/installation-configuration-parameters.adoc[leveloffset=+1]

installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,9 @@ include::modules/cli-installing-cli.adoc[leveloffset=+1]
9494

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

97-
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
97+
[role="_additional-resources"]
98+
.Additional resources
99+
* xref:../../installing/installing_bare_metal/installation-config-parameters-bare-metal.adoc#installation-config-parameters-bare-metal[Installation configuration parameters for bare metal]
98100

99101
include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2]
100102

installing/installing_bare_metal/installing-bare-metal.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,9 @@ include::modules/cli-installing-cli.adoc[leveloffset=+1]
105105

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

108-
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
108+
[role="_additional-resources"]
109+
.Additional resources
110+
* xref:../../installing/installing_bare_metal/installation-config-parameters-bare-metal.adoc#installation-config-parameters-bare-metal[Installation configuration parameters for bare metal]
109111

110112
include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2]
111113

installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,9 @@ include::modules/ssh-agent-using.adoc[leveloffset=+1]
109109

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

112-
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
112+
[role="_additional-resources"]
113+
.Additional resources
114+
* xref:../../installing/installing_bare_metal/installation-config-parameters-bare-metal.adoc#installation-config-parameters-bare-metal[Installation configuration parameters for bare metal]
113115

114116
include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2]
115117

modules/installation-configuration-parameters.adoc

Lines changed: 21 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +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_bare_metal/installing-bare-metal-network-customizations.adoc
22-
// * installing/installing_bare_metal/installing-bare-metal.adoc
23-
// * installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc
2421
// * installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc
2522
// * installing/installing_ibm_cloud_public/installing-ibm-cloud-network-customizations.adoc
2623
// * installing/installing_ibm_cloud_public/installing-ibm-cloud-vpc.adoc
@@ -50,10 +47,11 @@
5047
// * installing/installing-restricted-networks-nutanix-installer-provisioned.adoc
5148
// * installing/installing_vsphere/installation-config-parameters-vsphere.adoc
5249
// * installing/installing_gcp/installation-config-parameters-gcp.adoc
53-
// * installing/installing_gcp/installation-config-parameters-ibm-z.adoc
54-
// * installing/installing_gcp/installation-config-parameters-ibm-z-kvm.adoc
55-
// * installing/installing_gcp/installation-config-parameters-ibm-power.adoc
50+
// * installing/installing_ibm_z/installation-config-parameters-ibm-z.adoc
51+
// * installing/installing_ibm_z/installation-config-parameters-ibm-z-kvm.adoc
52+
// * installing/installing_ibm_power/installation-config-parameters-ibm-power.adoc
5653
// * installing/installing_azure_stack_hub/installation-config-parameters-ash.adoc
54+
// * installing/installing_bare_metal/installation-config-parameters-bare-metal.adoc
5755

5856
ifeval::["{context}" == "installing-alibaba-customizations"]
5957
:alibabacloud:
@@ -102,15 +100,6 @@ endif::[]
102100
ifeval::["{context}" == "installing-azure-vnet"]
103101
:azure:
104102
endif::[]
105-
ifeval::["{context}" == "installing-bare-metal"]
106-
:bare:
107-
endif::[]
108-
ifeval::["{context}" == "installing-bare-metal-network-customizations"]
109-
:bare:
110-
endif::[]
111-
ifeval::["{context}" == "installing-restricted-networks-bare-metal"]
112-
:bare:
113-
endif::[]
114103
ifeval::["{context}" == "installing-aws-customizations"]
115104
:aws:
116105
endif::[]
@@ -216,20 +205,23 @@ endif::[]
216205
ifeval::["{context}" == "installation-config-parameters-ash"]
217206
:ash:
218207
endif::[]
208+
ifeval::["{context}" == "installation-config-parameters-bare-metal"]
209+
:bare:
210+
endif::[]
219211

220212

221213
:_content-type: CONCEPT
222214
[id="installation-configuration-parameters_{context}"]
223-
ifndef::vsphere,gcp,ibm-z,ibm-power,ash[]
215+
ifndef::vsphere,gcp,ibm-z,ibm-power,ash,bare[]
224216
= Installation configuration parameters
225-
endif::vsphere,gcp,ibm-z,ibm-power,ash[]
217+
endif::vsphere,gcp,ibm-z,ibm-power,ash,bare[]
226218

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

234226
// If install-config.yaml is generated by openshift-install
235227
// 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
@@ -240,31 +232,31 @@ Before you deploy an {product-title} cluster, you provide parameter values to de
240232
endif::bare,ibm-power,ibm-z,ash,vsphere,gcp[]
241233

242234
// If the user manually creates install-config.yaml
243-
ifdef::bare,ibm-power-vs[]
235+
ifdef::ibm-power-vs[]
244236
Before you deploy an {product-title} cluster, you provide a customized `install-config.yaml` installation configuration file that describes the details for your environment.
245-
endif::bare,ibm-power-vs[]
237+
endif::ibm-power-vs[]
246238

247239
// A condition for this note is required as part of the effort for https://issues.redhat.com/browse/OSDOCS-6493.
248240
// This accommodates the existing content for installation assemblies, while the improvement is implemented.
249-
// As part of the updates for the last provider, this note can be removed from the module
250-
ifndef::vsphere,gcp,ibm-z,ibm-power,ash[]
241+
// 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[]
251243
[NOTE]
252244
====
253245
After installation, you cannot modify these parameters in the `install-config.yaml` file.
254246
====
255-
endif::vsphere,gcp,ibm-z,ibm-power,ash[]
247+
endif::vsphere,gcp,ibm-z,ibm-power,ash,bare[]
256248

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

263255
[NOTE]
264256
====
265257
After installation, you cannot modify these parameters in the `install-config.yaml` file.
266258
====
267-
endif::vsphere,gcp,ibm-z,ibm-power,ash[]
259+
endif::vsphere,gcp,ibm-z,ibm-power,ash,bare[]
268260

269261
[id="installation-configuration-parameters-required_{context}"]
270262
== Required configuration parameters
@@ -2117,9 +2109,6 @@ Additional Nutanix configuration parameters are described in the following table
21172109
--
21182110
endif::nutanix[]
21192111

2120-
ifdef::bare[]
2121-
:!bare:
2122-
endif::bare[]
21232112
ifeval::["{context}" == "installing-alibaba-customizations"]
21242113
:!alibabacloud:
21252114
endif::[]
@@ -2261,4 +2250,7 @@ endif::[]
22612250
ifeval::["{context}" == "installation-config-parameters-ash"]
22622251
:!ash:
22632252
endif::[]
2253+
ifeval::["{context}" == "installation-config-parameters-bare-metal"]
2254+
:!bare:
2255+
endif::[]
22642256
:!platform:

0 commit comments

Comments
 (0)