Skip to content

Commit 7824f25

Browse files
authored
Merge pull request #49245 from mjpytlak/bz2088485
BZ2088485: Removed future statement for sample install config yaml files
2 parents 07cded5 + d990d21 commit 7824f25

7 files changed

+17
-26
lines changed

modules/installation-aws-config-yaml.adoc

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ endif::[]
4242

4343
:_content-type: REFERENCE
4444
[id="installation-aws-config-yaml_{context}"]
45-
= Sample customized `install-config.yaml` file for AWS
45+
= Sample customized install-config.yaml file for AWS
4646

4747
You can customize the installation configuration file (`install-config.yaml`) to specify more details about
4848
your {product-title} cluster's platform or modify the values of the required
@@ -292,13 +292,10 @@ endif::gov,secret,china[]
292292
<2> Optional: Add this parameter to force the Cloud Credential Operator (CCO) to use the specified mode, instead of having the CCO dynamically try to determine the capabilities of the credentials. For details about CCO modes, see the _Cloud Credential Operator_ entry in the _Red Hat Operators reference_ content.
293293
<3> If you do not provide these parameters and values, the installation program
294294
provides the default value.
295-
<4> The `controlPlane` section is a single mapping, but the compute section is a
295+
<4> The `controlPlane` section is a single mapping, but the `compute` section is a
296296
sequence of mappings. To meet the requirements of the different data structures,
297297
the first line of the `compute` section must begin with a hyphen, `-`, and the
298-
first line of the `controlPlane` section must not. Although both sections
299-
currently define a single machine pool, it is possible that future versions
300-
of {product-title} will support defining multiple compute pools during
301-
installation. Only one control plane pool is used.
298+
first line of the `controlPlane` section must not. Only one control plane pool is used.
302299
<5> Whether to enable or disable simultaneous multithreading, or
303300
`hyperthreading`. By default, simultaneous multithreading is enabled
304301
to increase the performance of your machines' cores. You can disable it by

modules/installation-azure-config-yaml.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ ifeval::["{context}" == "installing-azure-government-region"]
2323
endif::[]
2424

2525
[id="installation-azure-config-yaml_{context}"]
26-
= Sample customized `install-config.yaml` file for Azure
26+
= Sample customized install-config.yaml file for Azure
2727

2828
You can customize the `install-config.yaml` file to specify more details about your {product-title} cluster's platform or modify the values of the required parameters.
2929

@@ -190,7 +190,7 @@ ifdef::gov[]
190190
<1> Required.
191191
endif::gov[]
192192
<2> If you do not provide these parameters and values, the installation program provides the default value.
193-
<3> The `controlPlane` section is a single mapping, but the compute section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the `compute` section must begin with a hyphen, `-`, and the first line of the `controlPlane` section must not. Although both sections currently define a single machine pool, it is possible that future versions of {product-title} will support defining multiple compute pools during installation. Only one control plane pool is used.
193+
<3> The `controlPlane` section is a single mapping, but the `compute` section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the `compute` section must begin with a hyphen, `-`, and the first line of the `controlPlane` section must not. Only one control plane pool is used.
194194
<4> Whether to enable or disable simultaneous multithreading, or `hyperthreading`. By default, simultaneous multithreading is enabled to increase the performance of your machines' cores. You can disable it by setting the parameter value to `Disabled`. If you disable simultaneous multithreading in some cluster machines, you must disable it in all cluster machines.
195195
+
196196
[IMPORTANT]

modules/installation-azure-stack-hub-config-yaml.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ capabilities:
8989
additionalEnabledCapabilities:
9090
- openshift-samples
9191
----
92-
<1> The `controlPlane` section is a single mapping, but the compute section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the `compute` section must begin with a hyphen, `-`, and the first line of the `controlPlane` section must not. Although both sections currently define a single machine pool, it is possible that future versions of {product-title} will support defining multiple compute pools during installation. Only one control plane pool is used.
92+
<1> The `controlPlane` section is a single mapping, but the `compute` section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the `compute` section must begin with a hyphen, `-`, and the first line of the `controlPlane` section must not. Only one control plane pool is used.
9393
<2> You can specify the size of the disk to use in GB. Minimum recommendation for control plane nodes is 1024 GB.
9494
<3> Specify the name of the cluster.
9595
<4> Specify the Azure Resource Manager endpoint that your Azure Stack Hub operator provides.

modules/installation-bare-metal-config-yaml.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,19 +47,19 @@ endif::[]
4747
// Assumption is that attribute once outside ifdef works for several level one headings.
4848
[id="installation-bare-metal-config-yaml_{context}"]
4949
ifndef::ibm-z,ibm-z-kvm,ibm-power,agnostic,rhv[]
50-
= Sample `install-config.yaml` file for bare metal
50+
= Sample install-config.yaml file for bare metal
5151
endif::ibm-z,ibm-z-kvm,ibm-power,agnostic,rhv[]
5252
ifdef::ibm-z,ibm-z-kvm[]
53-
= Sample `install-config.yaml` file for IBM Z
53+
= Sample install-config.yaml file for IBM Z
5454
endif::ibm-z,ibm-z-kvm[]
5555
ifdef::ibm-power[]
56-
= Sample `install-config.yaml` file for IBM Power
56+
= Sample install-config.yaml file for IBM Power
5757
endif::ibm-power[]
5858
ifdef::agnostic[]
59-
= Sample `install-config.yaml` file for other platforms
59+
= Sample install-config.yaml file for other platforms
6060
endif::agnostic[]
6161
ifdef::rhv[]
62-
= Sample `install-config.yaml` file for RHV
62+
= Sample install-config.yaml file for RHV
6363
endif::rhv[]
6464

6565
You can customize the `install-config.yaml` file to specify more details about your {product-title} cluster's platform or modify the values of the required parameters.
@@ -211,7 +211,7 @@ capabilities:
211211
- openshift-samples
212212
----
213213
<1> The base domain of the cluster. All DNS records must be sub-domains of this base and include the cluster name.
214-
<2> The `controlPlane` section is a single mapping, but the `compute` section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the `compute` section must begin with a hyphen, `-`, and the first line of the `controlPlane` section must not. Although both sections currently define a single machine pool, it is possible that future versions of {product-title} will support defining multiple compute pools during installation. Only one control plane pool is used.
214+
<2> The `controlPlane` section is a single mapping, but the `compute` section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the `compute` section must begin with a hyphen, `-`, and the first line of the `controlPlane` section must not. Only one control plane pool is used.
215215
<3> Specifies whether to enable or disable simultaneous multithreading (SMT), or hyperthreading. By default, SMT is enabled to increase the performance of the cores in your machines. You can disable it by setting the parameter value to `Disabled`. If you disable SMT, you must disable it in all cluster machines; this includes both control plane and compute machines.
216216
ifndef::ibm-z,ibm-z-kvm[]
217217
+

modules/installation-gcp-config-yaml.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ ifeval::["{context}" == "installing-restricted-networks-gcp-installer-provisione
2424
endif::[]
2525

2626
[id="installation-gcp-config-yaml_{context}"]
27-
= Sample customized `install-config.yaml` file for GCP
27+
= Sample customized install-config.yaml file for GCP
2828

2929
You can customize the `install-config.yaml` file to specify more details about your {product-title} cluster's platform or modify the values of the required parameters.
3030

@@ -181,7 +181,7 @@ capabilities:
181181
----
182182
<1> Required. The installation program prompts you for this value.
183183
<2> If you do not provide these parameters and values, the installation program provides the default value.
184-
<3> The `controlPlane` section is a single mapping, but the compute section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the `compute` section must begin with a hyphen, `-`, and the first line of the `controlPlane` section must not. Although both sections currently define a single machine pool, it is possible that future versions of {product-title} will support defining multiple compute pools during installation. Only one control plane pool is used.
184+
<3> The `controlPlane` section is a single mapping, but the `compute` section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the `compute` section must begin with a hyphen, `-`, and the first line of the `controlPlane` section must not. Only one control plane pool is used.
185185
<4> Whether to enable or disable simultaneous multithreading, or `hyperthreading`. By default, simultaneous multithreading is enabled to increase the performance of your machines' cores. You can disable it by setting the parameter value to `Disabled`. If you disable simultaneous multithreading in some cluster machines, you must disable it in all cluster machines.
186186
+
187187
[IMPORTANT]

modules/installation-ibm-cloud-config-yaml.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ capabilities:
7878
----
7979
<1> Required. The installation program prompts you for this value.
8080
<2> If you do not provide these parameters and values, the installation program provides the default value.
81-
<3> The `controlPlane` section is a single mapping, but the compute section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the `compute` section must begin with a hyphen, `-`, and the first line of the `controlPlane` section must not. Although both sections currently define a single machine pool, it is possible that future versions of {product-title} will support defining multiple compute pools during installation. Only one control plane pool is used.
81+
<3> The `controlPlane` section is a single mapping, but the `compute` section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the `compute` section must begin with a hyphen, `-`, and the first line of the `controlPlane` section must not. Only one control plane pool is used.
8282
<4> Whether to enable or disable simultaneous multithreading, or `hyperthreading`. By default, simultaneous multithreading is enabled to increase the performance of your machines' cores. You can disable it by setting the parameter value to `Disabled`. If you disable simultaneous multithreading in some cluster machines, you must disable it in all cluster machines.
8383
+
8484
[IMPORTANT]

modules/installation-installer-provisioned-vsphere-config-yaml.adoc

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ endif::[]
2323
[id="installation-installer-provisioned-vsphere-config-yaml_{context}"]
2424
= Sample install-config.yaml file for an installer-provisioned VMware vSphere cluster
2525

26-
You can customize the `install-config.yaml` file to specify more details about
26+
You can customize the install-config.yaml file to specify more details about
2727
your {product-title} cluster's platform or modify the values of the required
2828
parameters.
2929

@@ -118,13 +118,7 @@ capabilities:
118118
----
119119
<1> The base domain of the cluster. All DNS records must be sub-domains of this
120120
base and include the cluster name.
121-
<2> The `controlPlane` section is a single mapping, but the compute section is a
122-
sequence of mappings. To meet the requirements of the different data structures,
123-
the first line of the `compute` section must begin with a hyphen, `-`, and the
124-
first line of the `controlPlane` section must not. Although both sections
125-
currently define a single machine pool, it is possible that future versions
126-
of {product-title} will support defining multiple compute pools during
127-
installation. Only one control plane pool is used.
121+
<2> The `controlPlane` section is a single mapping, but the `compute` section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the `compute` section must begin with a hyphen, `-`, and the first line of the `controlPlane` section must not. Only one control plane pool is used.
128122
<3> Whether to enable or disable simultaneous multithreading, or
129123
`hyperthreading`. By default, simultaneous multithreading is enabled
130124
to increase the performance of your machines' cores. You can disable it by

0 commit comments

Comments
 (0)