From 3c1c943aee8e386d404d68c07f0d73d69e3cba4c Mon Sep 17 00:00:00 2001 From: SNiemann15 Date: Wed, 16 Aug 2023 15:20:48 +0200 Subject: [PATCH] restructure bare metal config parms to book level --- _topic_maps/_topic_map.yml | 2 + ...installing-azure-stack-hub-user-infra.adoc | 5 ++ ...allation-config-parameters-bare-metal.adoc | 12 +++++ ...ing-bare-metal-network-customizations.adoc | 4 +- .../installing-bare-metal.adoc | 4 +- ...alling-restricted-networks-bare-metal.adoc | 4 +- ...installation-configuration-parameters.adoc | 50 ++++++++----------- 7 files changed, 49 insertions(+), 32 deletions(-) create mode 100644 installing/installing_bare_metal/installation-config-parameters-bare-metal.adoc diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 6120eacff7..7df8418610 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -320,6 +320,8 @@ Topics: File: installing-restricted-networks-bare-metal - Name: Scaling a user-provisioned installation with the bare metal operator File: scaling-a-user-provisioned-cluster-with-the-bare-metal-operator + - Name: Installation configuration parameters for bare metal + File: installation-config-parameters-bare-metal - Name: Installing on-premise with Assisted Installer Dir: installing_on_prem_assisted Distros: openshift-enterprise diff --git a/installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc b/installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc index f96cdaca9d..0eb73fca0e 100644 --- a/installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc +++ b/installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc @@ -68,6 +68,11 @@ include::modules/ssh-agent-using.adoc[leveloffset=+1] include::modules/installation-user-infra-generate.adoc[leveloffset=+1] include::modules/installation-initializing-manual.adoc[leveloffset=+2] + +[role="_additional-resources"] +.Additional resources +* xref:../../installing/installing_azure_stack_hub/installation-config-parameters-ash.adoc#installation-config-parameters-ash[Installation configuration parameters for Azure Stack Hub] + include::modules/installation-azure-stack-hub-config-yaml.adoc[leveloffset=+2] include::modules/installation-configure-proxy.adoc[leveloffset=+2] diff --git a/installing/installing_bare_metal/installation-config-parameters-bare-metal.adoc b/installing/installing_bare_metal/installation-config-parameters-bare-metal.adoc new file mode 100644 index 0000000000..77ac1c6d60 --- /dev/null +++ b/installing/installing_bare_metal/installation-config-parameters-bare-metal.adoc @@ -0,0 +1,12 @@ +:_content-type: ASSEMBLY +[id="installation-config-parameters-bare-metal"] += Installation configuration parameters for bare metal +include::_attributes/common-attributes.adoc[] +:context: installation-config-parameters-bare-metal +:platform: bare metal + +toc::[] + +Before you deploy an {product-title} cluster, you provide a customized `install-config.yaml` installation configuration file that describes the details for your environment. + +include::modules/installation-configuration-parameters.adoc[leveloffset=+1] diff --git a/installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc b/installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc index 5ba1910e9c..781c773c04 100644 --- a/installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc +++ b/installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc @@ -94,7 +94,9 @@ include::modules/cli-installing-cli.adoc[leveloffset=+1] include::modules/installation-initializing-manual.adoc[leveloffset=+1] -include::modules/installation-configuration-parameters.adoc[leveloffset=+2] +[role="_additional-resources"] +.Additional resources +* xref:../../installing/installing_bare_metal/installation-config-parameters-bare-metal.adoc#installation-config-parameters-bare-metal[Installation configuration parameters for bare metal] include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2] diff --git a/installing/installing_bare_metal/installing-bare-metal.adoc b/installing/installing_bare_metal/installing-bare-metal.adoc index 9febfd635b..443eac915b 100644 --- a/installing/installing_bare_metal/installing-bare-metal.adoc +++ b/installing/installing_bare_metal/installing-bare-metal.adoc @@ -105,7 +105,9 @@ include::modules/cli-installing-cli.adoc[leveloffset=+1] include::modules/installation-initializing-manual.adoc[leveloffset=+1] -include::modules/installation-configuration-parameters.adoc[leveloffset=+2] +[role="_additional-resources"] +.Additional resources +* xref:../../installing/installing_bare_metal/installation-config-parameters-bare-metal.adoc#installation-config-parameters-bare-metal[Installation configuration parameters for bare metal] include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2] diff --git a/installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc b/installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc index 6887619c59..04ebaea872 100644 --- a/installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc +++ b/installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc @@ -109,7 +109,9 @@ include::modules/ssh-agent-using.adoc[leveloffset=+1] include::modules/installation-initializing-manual.adoc[leveloffset=+1] -include::modules/installation-configuration-parameters.adoc[leveloffset=+2] +[role="_additional-resources"] +.Additional resources +* xref:../../installing/installing_bare_metal/installation-config-parameters-bare-metal.adoc#installation-config-parameters-bare-metal[Installation configuration parameters for bare metal] include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2] diff --git a/modules/installation-configuration-parameters.adoc b/modules/installation-configuration-parameters.adoc index b7288c02b4..a0cbf3f918 100644 --- a/modules/installation-configuration-parameters.adoc +++ b/modules/installation-configuration-parameters.adoc @@ -18,9 +18,6 @@ // * installing/installing_azure/installing-azure-network-customizations.adoc // * installing/installing_azure/installing-azure-private.adoc // * installing/installing_azure/installing-azure-vnet.adoc -// * installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc -// * installing/installing_bare_metal/installing-bare-metal.adoc -// * installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc // * installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc // * installing/installing_ibm_cloud_public/installing-ibm-cloud-network-customizations.adoc // * installing/installing_ibm_cloud_public/installing-ibm-cloud-vpc.adoc @@ -50,10 +47,11 @@ // * installing/installing-restricted-networks-nutanix-installer-provisioned.adoc // * installing/installing_vsphere/installation-config-parameters-vsphere.adoc // * installing/installing_gcp/installation-config-parameters-gcp.adoc -// * installing/installing_gcp/installation-config-parameters-ibm-z.adoc -// * installing/installing_gcp/installation-config-parameters-ibm-z-kvm.adoc -// * installing/installing_gcp/installation-config-parameters-ibm-power.adoc +// * installing/installing_ibm_z/installation-config-parameters-ibm-z.adoc +// * installing/installing_ibm_z/installation-config-parameters-ibm-z-kvm.adoc +// * installing/installing_ibm_power/installation-config-parameters-ibm-power.adoc // * installing/installing_azure_stack_hub/installation-config-parameters-ash.adoc +// * installing/installing_bare_metal/installation-config-parameters-bare-metal.adoc ifeval::["{context}" == "installing-alibaba-customizations"] :alibabacloud: @@ -102,15 +100,6 @@ endif::[] ifeval::["{context}" == "installing-azure-vnet"] :azure: endif::[] -ifeval::["{context}" == "installing-bare-metal"] -:bare: -endif::[] -ifeval::["{context}" == "installing-bare-metal-network-customizations"] -:bare: -endif::[] -ifeval::["{context}" == "installing-restricted-networks-bare-metal"] -:bare: -endif::[] ifeval::["{context}" == "installing-aws-customizations"] :aws: endif::[] @@ -216,20 +205,23 @@ endif::[] ifeval::["{context}" == "installation-config-parameters-ash"] :ash: endif::[] +ifeval::["{context}" == "installation-config-parameters-bare-metal"] +:bare: +endif::[] :_content-type: CONCEPT [id="installation-configuration-parameters_{context}"] -ifndef::vsphere,gcp,ibm-z,ibm-power,ash[] +ifndef::vsphere,gcp,ibm-z,ibm-power,ash,bare[] = Installation configuration parameters -endif::vsphere,gcp,ibm-z,ibm-power,ash[] +endif::vsphere,gcp,ibm-z,ibm-power,ash,bare[] // Managing headings is required as part of the effort for https://issues.redhat.com/browse/OSDOCS-6493. // This accommodates the existing IA of the installation assemblies, while the improvement is implemented. // As part of the updates for the last provider, the conditions can be removed and the following heading can be used. -ifdef::vsphere,gcp,ibm-z,ibm-power,ash[] +ifdef::vsphere,gcp,ibm-z,ibm-power,ash,bare[] = Available installation configuration parameters for {platform} -endif::vsphere,gcp,ibm-z,ibm-power,ash[] +endif::vsphere,gcp,ibm-z,ibm-power,ash,bare[] // If install-config.yaml is generated by openshift-install // 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 endif::bare,ibm-power,ibm-z,ash,vsphere,gcp[] // If the user manually creates install-config.yaml -ifdef::bare,ibm-power-vs[] +ifdef::ibm-power-vs[] Before you deploy an {product-title} cluster, you provide a customized `install-config.yaml` installation configuration file that describes the details for your environment. -endif::bare,ibm-power-vs[] +endif::ibm-power-vs[] // A condition for this note is required as part of the effort for https://issues.redhat.com/browse/OSDOCS-6493. // This accommodates the existing content for installation assemblies, while the improvement is implemented. -// As part of the updates for the last provider, this note can be removed from the module -ifndef::vsphere,gcp,ibm-z,ibm-power,ash[] +// As part of the updates for the last provider, this note can be removed from the module. +ifndef::vsphere,gcp,ibm-z,ibm-power,ash,bare[] [NOTE] ==== After installation, you cannot modify these parameters in the `install-config.yaml` file. ==== -endif::vsphere,gcp,ibm-z,ibm-power,ash[] +endif::vsphere,gcp,ibm-z,ibm-power,ash,bare[] // This condition is required as part of the effort for https://issues.redhat.com/browse/OSDOCS-6493. // As part of the update for each provider, this content applies to the net new provider-specific installation configuration parameter assembly. // As part of the updates for the last provider, the conditions can be completely removed. -ifdef::vsphere,gcp,ibm-z,ibm-power,ash[] +ifdef::vsphere,gcp,ibm-z,ibm-power,ash,bare[] The following tables specify the required, optional, and {platform}-specific installation configuration parameters that you can set as part of the installation process. [NOTE] ==== After installation, you cannot modify these parameters in the `install-config.yaml` file. ==== -endif::vsphere,gcp,ibm-z,ibm-power,ash[] +endif::vsphere,gcp,ibm-z,ibm-power,ash,bare[] [id="installation-configuration-parameters-required_{context}"] == Required configuration parameters @@ -2122,9 +2114,6 @@ Additional Nutanix configuration parameters are described in the following table -- endif::nutanix[] -ifdef::bare[] -:!bare: -endif::bare[] ifeval::["{context}" == "installing-alibaba-customizations"] :!alibabacloud: endif::[] @@ -2266,4 +2255,7 @@ endif::[] ifeval::["{context}" == "installation-config-parameters-ash"] :!ash: endif::[] +ifeval::["{context}" == "installation-config-parameters-bare-metal"] +:!bare: +endif::[] :!platform: