Skip to content

Commit 153bd35

Browse files
committed
OSDOCS-8683: Removed the hyperthreading parameter from the vSphere docs
1 parent b93f251 commit 153bd35

5 files changed

+127
-120
lines changed

installing/installing_ibm_powervs/installation-config-parameters-ibm-power-vs.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ include::_attributes/common-attributes.adoc[]
77

88
toc::[]
99

10-
Before you deploy an {product-title} on {{ibm-power-server-name}, 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.
10+
Before you deploy an {product-title} on {ibm-power-server-name}, 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.
1111

1212
include::modules/installation-configuration-parameters.adoc[leveloffset=+1]

modules/installation-configuration-parameters.adoc

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -468,7 +468,7 @@ See _Supported installation methods for different platforms_ in _Installing_ doc
468468
endif::aws[]
469469
|String
470470
endif::openshift-origin[]
471-
471+
ifndef::vsphere[]
472472
|compute:
473473
hyperthreading:
474474
|Whether to enable or disable simultaneous multithreading, or `hyperthreading`, on compute machines. By default, simultaneous multithreading is enabled to increase the performance of your machines' cores.
@@ -478,6 +478,7 @@ If you disable simultaneous multithreading, ensure that your capacity planning
478478
accounts for the dramatically decreased machine performance.
479479
====
480480
|`Enabled` or `Disabled`
481+
endif::vsphere[]
481482

482483
|compute:
483484
name:
@@ -548,6 +549,7 @@ endif::aws[]
548549
|String
549550
endif::openshift-origin[]
550551

552+
ifndef::vsphere[]
551553
|controlPlane:
552554
hyperthreading:
553555
|Whether to enable or disable simultaneous multithreading, or `hyperthreading`, on control plane machines. By default, simultaneous multithreading is enabled to increase the performance of your machines' cores.
@@ -557,6 +559,7 @@ If you disable simultaneous multithreading, ensure that your capacity planning
557559
accounts for the dramatically decreased machine performance.
558560
====
559561
|`Enabled` or `Disabled`
562+
endif::vsphere[]
560563

561564
|controlPlane:
562565
name:
@@ -710,27 +713,29 @@ endif::ibm-power-vs[]
710713
[.small]
711714
--
712715
1. Not all CCO modes are supported for all cloud providers. For more information about CCO modes, see the "Managing cloud provider credentials" entry in the _Authentication and authorization_ content.
713-
+
714716
ifdef::aws,gcp[]
717+
+
715718
[NOTE]
716719
====
717720
ifdef::aws[If your AWS account has service control policies (SCP) enabled, you must configure the `credentialsMode` parameter to `Mint`, `Passthrough`, or `Manual`.]
718721
ifdef::gcp[If you are installing on GCP into a shared virtual private cloud (VPC), `credentialsMode` must be set to `Passthrough` or `Manual`.]
719722
====
720-
+
721723
endif::aws,gcp[]
724+
ifdef::aws,gcp,azure[]
725+
+
722726
[IMPORTANT]
723727
====
724-
ifdef::aws,gcp,azure[Setting this parameter to `Manual` enables alternatives to storing administrator-level secrets in the `kube-system` project, which require additional configuration steps. For more information, see "Alternatives to storing administrator-level secrets in the kube-system project".]
728+
Setting this parameter to `Manual` enables alternatives to storing administrator-level secrets in the `kube-system` project, which require additional configuration steps. For more information, see "Alternatives to storing administrator-level secrets in the kube-system project".
725729
====
726-
--
727-
730+
endif::aws,gcp,azure[]
728731
ifdef::ibm-power-vs[]
732+
+
729733
[NOTE]
730734
====
731735
Cloud connections are no longer supported in the `install-config.yaml` while deploying in the `dal10` region, as they have been replaced by the Power Edge Router (PER).
732736
====
733737
endif::ibm-power-vs[]
738+
--
734739

735740
ifdef::aws[]
736741
[id="installation-configuration-parameters-optional-aws_{context}"]

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

Lines changed: 22 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -24,45 +24,43 @@ apiVersion: v1
2424
baseDomain: example.com <1>
2525
compute: <2>
2626
- architecture: amd64
27-
hyperthreading: Enabled <3>
2827
name: <worker_node>
2928
platform: {}
3029
replicas: 3
3130
controlPlane: <2>
3231
architecture: amd64
33-
hyperthreading: Enabled <3>
3432
name: <parent_node>
3533
platform: {}
3634
replicas: 3
3735
metadata:
3836
creationTimestamp: null
39-
name: test <4>
37+
name: test <3>
4038
ifdef::network[]
4139
networking:
4240
clusterNetwork:
4341
- cidr: 10.128.0.0/14
4442
hostPrefix: 23
4543
machineNetwork:
4644
- cidr: 10.0.0.0/16
47-
networkType: OVNKubernetes <10>
45+
networkType: OVNKubernetes <9>
4846
serviceNetwork:
4947
- 172.30.0.0/16
5048
endif::network[]
5149
platform:
52-
vsphere: <5>
50+
vsphere: <4>
5351
apiVIPs:
5452
- 10.0.0.1
55-
failureDomains: <6>
53+
failureDomains: <5>
5654
- name: <failure_domain_name>
5755
region: <default_region_name>
5856
server: <fully_qualified_domain_name>
5957
topology:
6058
computeCluster: "/<datacenter>/host/<cluster>"
6159
datacenter: <datacenter>
62-
datastore: "/<datacenter>/datastore/<datastore>" <7>
60+
datastore: "/<datacenter>/datastore/<datastore>" <6>
6361
networks:
6462
- <VM_Network_name>
65-
resourcePool: "/<datacenter>/host/<cluster>/Resources/<resourcePool>" <8>
63+
resourcePool: "/<datacenter>/host/<cluster>/Resources/<resourcePool>" <7>
6664
folder: "/<datacenter_name>/vm/<folder_name>/<subfolder_name>"
6765
zone: <default_zone_name>
6866
ingressVIPs:
@@ -74,9 +72,9 @@ platform:
7472
port: 443
7573
server: <fully_qualified_domain_name>
7674
77-
diskType: thin <9>
75+
diskType: thin <8>
7876
ifdef::restricted[]
79-
clusterOSImage: http://mirror.example.com/images/rhcos-47.83.202103221318-0-vmware.x86_64.ova <10>
77+
clusterOSImage: http://mirror.example.com/images/rhcos-47.83.202103221318-0-vmware.x86_64.ova <9>
8078
endif::restricted[]
8179
ifndef::openshift-origin[]
8280
fips: false
@@ -85,15 +83,15 @@ ifndef::restricted[]
8583
pullSecret: '{"auths": ...}'
8684
endif::restricted[]
8785
ifdef::restricted[]
88-
pullSecret: '{"auths":{"<local_registry>": {"auth": "<credentials>","email": "[email protected]"}}}' <11>
86+
pullSecret: '{"auths":{"<local_registry>": {"auth": "<credentials>","email": "[email protected]"}}}' <10>
8987
endif::restricted[]
9088
sshKey: 'ssh-ed25519 AAAA...'
9189
ifdef::restricted[]
92-
additionalTrustBundle: | <12>
90+
additionalTrustBundle: | <11>
9391
-----BEGIN CERTIFICATE-----
9492
ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
9593
-----END CERTIFICATE-----
96-
imageContentSources: <13>
94+
imageContentSources: <12>
9795
- mirrors:
9896
- <local_registry>/<local_repository_name>/release
9997
source: quay.io/openshift-release-dev/ocp-release
@@ -104,37 +102,30 @@ endif::restricted[]
104102
----
105103
<1> The base domain of the cluster. All DNS records must be sub-domains of this base and include the cluster name.
106104
<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.
107-
<3> Whether to enable or disable simultaneous multithreading, or `hyperthreading`. By default, simultaneous multithreading is enabled
108-
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.
109-
+
110-
[IMPORTANT]
111-
====
112-
If you disable simultaneous multithreading, ensure that your capacity planning accounts for the dramatically decreased machine performance. Your machines must use at least 8 CPUs and 32 GB of RAM if you disable simultaneous multithreading.
113-
====
114-
<4> The cluster name that you specified in your DNS records.
115-
<5> Optional: Provides additional configuration for the machine pool parameters for the compute and control plane machines.
116-
<6> Establishes the relationships between a region and zone. You define a failure domain by using vCenter objects, such as a `datastore` object. A failure domain defines the vCenter location for {product-title} cluster nodes.
117-
<7> The path to the vSphere datastore that holds virtual machine files, templates, and ISO images.
105+
<3> The cluster name that you specified in your DNS records.
106+
<4> Optional: Provides additional configuration for the machine pool parameters for the compute and control plane machines.
107+
<5> Establishes the relationships between a region and zone. You define a failure domain by using vCenter objects, such as a `datastore` object. A failure domain defines the vCenter location for {product-title} cluster nodes.
108+
<6> The path to the vSphere datastore that holds virtual machine files, templates, and ISO images.
118109
+
119110
[IMPORTANT]
120111
====
121112
You can specify the path of any datastore that exists in a datastore cluster. By default, Storage vMotion is automatically enabled for a datastore cluster. Red Hat does not support Storage vMotion, so you must disable Storage vMotion to avoid data loss issues for your {product-title} cluster.
122113
123114
If you must specify VMs across multiple datastores, use a `datastore` object to specify a failure domain in your cluster's `install-config.yaml` configuration file. For more information, see "VMware vSphere region and zone enablement".
124115
====
125-
<8> Optional: Provides an existing resource pool for machine creation. If you do not specify a value, the installation program uses the root resource pool of the vSphere cluster.
126-
<9> The vSphere disk provisioning method.
116+
<7> Optional: Provides an existing resource pool for machine creation. If you do not specify a value, the installation program uses the root resource pool of the vSphere cluster.
117+
<8> The vSphere disk provisioning method.
127118
ifdef::network[]
128-
<10> The cluster network plugin to install. The supported values are `OVNKubernetes` and `OpenShiftSDN`. The default value is `OVNKubernetes`.
119+
<9> The cluster network plugin to install. The supported values are `OVNKubernetes` and `OpenShiftSDN`. The default value is `OVNKubernetes`.
129120
endif::network[]
130121
ifdef::restricted[]
131-
<10> The location of the {op-system-first} image that is accessible from the bastion server.
132-
<11> For `<local_registry>`, specify the registry domain name, and optionally the
122+
<9> The location of the {op-system-first} image that is accessible from the bastion server.
123+
<10> For `<local_registry>`, specify the registry domain name, and optionally the
133124
port, that your mirror registry uses to serve content. For example
134125
`registry.example.com` or `registry.example.com:5000`. For `<credentials>`,
135126
specify the base64-encoded user name and password for your mirror registry.
136-
<12> Provide the contents of the certificate file that you used for your mirror registry.
137-
<13> Provide the `imageContentSources` section from the output of the command to mirror the repository.
127+
<11> Provide the contents of the certificate file that you used for your mirror registry.
128+
<12> Provide the `imageContentSources` section from the output of the command to mirror the repository.
138129
endif::restricted[]
139130

140131
[NOTE]

modules/installation-minimum-resource-requirements.adoc

Lines changed: 45 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,12 @@ endif::[]
6363
ifeval::["{context}" == "installing-azure-user-infra"]
6464
:azure:
6565
endif::[]
66+
ifeval::["{context}" == "installing-restricted-networks-azure-installer-provisioned"]
67+
:azure:
68+
endif::[]
69+
ifeval::["{context}" == "installing-restricted-networks-azure-user-provisioned"]
70+
:azure:
71+
endif::[]
6672
ifeval::["{context}" == "installing-bare-metal"]
6773
:bare-metal:
6874
endif::[]
@@ -102,11 +108,14 @@ endif::[]
102108
ifeval::["{context}" == "installing-ibm-cloud-private"]
103109
:ibm-cloud-vpc:
104110
endif::[]
105-
ifeval::["{context}" == "installing-restricted-networks-azure-installer-provisioned"]
106-
:azure:
111+
ifeval::["{context}" == "installing-vsphere"]
112+
:vsphere:
107113
endif::[]
108-
ifeval::["{context}" == "installing-restricted-networks-azure-user-provisioned"]
109-
:azure:
114+
ifeval::["{context}" == "installing-vsphere-network-customizations"]
115+
:vsphere:
116+
endif::[]
117+
ifeval::["{context}" == "installing-restricted-networks-vsphere"]
118+
:vsphere:
110119
endif::[]
111120

112121
:_mod-docs-content-type: CONCEPT
@@ -122,22 +131,25 @@ Each cluster machine must meet the following minimum requirements:
122131
|Machine
123132
|Operating System
124133
ifndef::bare-metal[]
125-
ifndef::ibm-cloud-vpc[]
134+
ifndef::ibm-cloud-vpc,vsphere[]
126135
|vCPU ^[1]^
127-
endif::ibm-cloud-vpc[]
128-
ifdef::ibm-cloud-vpc[]
136+
endif::ibm-cloud-vpc,vsphere[]
137+
ifdef::ibm-cloud-vpc,vsphere[]
129138
|vCPU
130-
endif::ibm-cloud-vpc[]
139+
endif::ibm-cloud-vpc,vsphere[]
131140
|Virtual RAM
132141
endif::bare-metal[]
133142
ifdef::bare-metal[]
134143
|CPU ^[1]^
135144
|RAM
136145
endif::bare-metal[]
137146
|Storage
138-
ifndef::ibm-z,ibm-cloud-vpc[]
147+
ifndef::ibm-z,ibm-cloud-vpc,vsphere[]
139148
|Input/Output Per Second (IOPS)^[2]^
140-
endif::ibm-z,ibm-cloud-vpc[]
149+
endif::ibm-z,ibm-cloud-vpc,vsphere[]
150+
ifdef::vsphere[]
151+
|Input/Output Per Second (IOPS)^[1]^
152+
endif::vsphere[]
141153
ifdef::ibm-z,ibm-cloud-vpc[]
142154
|Input/Output Per Second (IOPS)
143155
endif::ibm-z,ibm-cloud-vpc[]
@@ -172,7 +184,8 @@ endif::ibm-z[]
172184
ifndef::openshift-origin[]
173185
|Compute
174186
ifdef::ibm-z,ibm-power,ibm-cloud-vpc[|{op-system}]
175-
ifndef::ibm-z,ibm-power,ibm-cloud-vpc[|{op-system}, {op-system-base} 8.6, {op-system-base} 8.7, or {op-system-base} 8.8 ^[3]^]
187+
ifndef::ibm-z,ibm-power,ibm-cloud-vpc,vsphere[|{op-system}, {op-system-base} 8.6, {op-system-base} 8.7, or {op-system-base} 8.8 ^[3]^]
188+
ifdef::vsphere[|{op-system}, {op-system-base} 8.6, {op-system-base} 8.7, or {op-system-base} 8.8 ^[2]^]
176189
|2
177190
|8 GB
178191
|100 GB
@@ -206,16 +219,20 @@ endif::ibm-z[]
206219
ifdef::bare-metal[]
207220
1. One CPU is equivalent to one physical core when simultaneous multithreading (SMT), or hyperthreading, is not enabled. When enabled, use the following formula to calculate the corresponding ratio: (threads per core × cores) × sockets = CPUs.
208221
endif::bare-metal[]
209-
ifndef::ibm-z,bare-metal,ibm-cloud-vpc[]
222+
ifndef::ibm-z,bare-metal,ibm-cloud-vpc,vsphere[]
210223
1. One vCPU is equivalent to one physical core when simultaneous multithreading (SMT), or hyperthreading, is not enabled. When enabled, use the following formula to calculate the corresponding ratio: (threads per core × cores) × sockets = vCPUs.
211-
endif::ibm-z,bare-metal,ibm-cloud-vpc[]
212-
ifndef::ibm-z,ibm-power,ibm-cloud-vpc[]
224+
endif::ibm-z,bare-metal,ibm-cloud-vpc,vsphere[]
225+
ifndef::ibm-z,ibm-power,ibm-cloud-vpc,vsphere[]
213226
2. {product-title} and Kubernetes are sensitive to disk performance, and faster storage is recommended, particularly for etcd on the control plane nodes which require a 10 ms p99 fsync duration. Note that on many cloud platforms, storage size and IOPS scale together, so you might need to over-allocate storage volume to obtain sufficient performance.
214227
3. As with all user-provisioned installations, if you choose to use {op-system-base} compute machines in your cluster, you take responsibility for all operating system life cycle management and maintenance, including performing system updates, applying patches, and completing all other required tasks. Use of {op-system-base} 7 compute machines is deprecated and has been removed in {product-title} 4.10 and later.
215-
endif::ibm-z,ibm-power,ibm-cloud-vpc[]
228+
endif::ibm-z,ibm-power,ibm-cloud-vpc,vsphere[]
216229
ifdef::ibm-power[]
217230
2. {product-title} and Kubernetes are sensitive to disk performance, and faster storage is recommended, particularly for etcd on the control plane nodes. Note that on many cloud platforms, storage size and IOPS scale together, so you might need to over-allocate storage volume to obtain sufficient performance.
218231
endif::ibm-power[]
232+
ifdef::vsphere[]
233+
1. {product-title} and Kubernetes are sensitive to disk performance, and faster storage is recommended, particularly for etcd on the control plane nodes which require a 10 ms p99 fsync duration. Note that on many cloud platforms, storage size and IOPS scale together, so you might need to over-allocate storage volume to obtain sufficient performance.
234+
2. As with all user-provisioned installations, if you choose to use {op-system-base} compute machines in your cluster, you take responsibility for all operating system life cycle management and maintenance, including performing system updates, applying patches, and completing all other required tasks. Use of {op-system-base} 7 compute machines is deprecated and has been removed in {product-title} 4.10 and later.
235+
endif::vsphere[]
219236
--
220237

221238
ifdef::azure[]
@@ -245,6 +262,12 @@ endif::[]
245262
ifeval::["{context}" == "installing-azure-user-infra"]
246263
:!azure:
247264
endif::[]
265+
ifeval::["{context}" == "installing-restricted-networks-azure-installer-provisioned"]
266+
:!azure:
267+
endif::[]
268+
ifeval::["{context}" == "installing-restricted-networks-azure-user-provisioned"]
269+
:!azure:
270+
endif::[]
248271
ifeval::["{context}" == "installing-bare-metal"]
249272
:!bare-metal:
250273
endif::[]
@@ -284,9 +307,12 @@ endif::[]
284307
ifeval::["{context}" == "installing-ibm-cloud-private"]
285308
:!ibm-cloud-vpc:
286309
endif::[]
287-
ifeval::["{context}" == "installing-restricted-networks-azure-installer-provisioned"]
288-
:!azure:
310+
ifeval::["{context}" == "installing-vsphere"]
311+
:!vsphere:
289312
endif::[]
290-
ifeval::["{context}" == "installing-restricted-networks-azure-user-provisioned"]
291-
:!azure:
313+
ifeval::["{context}" == "installing-vsphere-network-customizations"]
314+
:!vsphere:
315+
endif::[]
316+
ifeval::["{context}" == "installing-restricted-networks-vsphere"]
317+
:!vsphere:
292318
endif::[]

0 commit comments

Comments
 (0)