Skip to content

Commit 062f2ce

Browse files
jab-rhjab-rh
authored
Merge pull request #71019 from alishaIBM/smt
OCP 4.15: Setting SMT levels for Power in OpenShift Installer
2 parents f124014 + 50b0762 commit 062f2ce

File tree

1 file changed

+100
-60
lines changed

1 file changed

+100
-60
lines changed

‎modules/installation-ibm-power-vs-config-yaml.adoc

Lines changed: 100 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,17 @@ compute: <1> <2>
3838
- architecture: ppc64le
3939
hyperthreading: Enabled <3>
4040
name: worker
41-
platform: {}
41+
platform:
42+
powervs:
43+
smtLevel: 8 <4>
4244
replicas: 3
4345
controlPlane: <1> <2>
4446
architecture: ppc64le
4547
hyperthreading: Enabled <3>
4648
name: master
47-
platform: {}
49+
platform:
50+
powervs:
51+
smtLevel: 8 <4>
4852
replicas: 3
4953
metadata:
5054
creationTimestamp: null
@@ -55,20 +59,20 @@ networking:
5559
hostPrefix: 23
5660
machineNetwork:
5761
- cidr: 192.168.0.0/24
58-
networkType: OVNKubernetes <4>
62+
networkType: OVNKubernetes <5>
5963
serviceNetwork:
6064
- 172.30.0.0/16
6165
platform:
6266
powervs:
6367
userID: ibm-user-id
6468
region: powervs-region
6569
zone: powervs-zone
66-
powervsResourceGroup: "ibmcloud-resource-group" <5>
70+
powervsResourceGroup: "ibmcloud-resource-group" <6>
6771
serviceInstanceGUID: "powervs-region-service-instance-guid"
6872
vpcRegion : vpc-region
6973
publish: External
70-
pullSecret: '{"auths": ...}' <6>
71-
sshKey: ssh-ed25519 AAAA... <7>
74+
pullSecret: '{"auths": ...}' <7>
75+
sshKey: ssh-ed25519 AAAA... <8>
7276
----
7377
<1> If you do not provide these parameters and values, the installation program provides the default value.
7478
<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 {product-title} will support defining multiple compute pools during installation. Only one control plane pool is used.
@@ -87,11 +91,17 @@ If you disable simultaneous multithreading, ensure that your capacity planning a
8791
//====
8892
//<6> You can optionally provide the `sshKey` value that you use to access the machines in your cluster.
8993
//endif::openshift-origin[]
90-
<4> The cluster network plugin to install. The supported values are `OVNKubernetes` and `OpenShiftSDN`. The default value is `OVNKubernetes`.
91-
<5> The name of an existing resource group.
92-
<6> Required. The installation program prompts you for this value.
94+
<4> The smtLevel specifies the level of SMT to set to the control plane and compute machines. The supported values are 1, 2, 4, 8, `'off'` and `'on'`. The default value is 8. The smtLevel `'off'` sets SMT to off and smtlevel `'on'` sets SMT to the default value 8 on the cluster nodes.
95+
+
96+
[NOTE]
97+
====
98+
When simultaneous multithreading (SMT), or hyperthreading is not enabled, one vCPU is equivalent to one physical core. When enabled, total vCPUs is computed as: (Thread(s) per core * Core(s) per socket) * Socket(s). The smtLevel controls the threads per core. Lower SMT levels may require additional assigned cores when deploying the cluster nodes. You can do this by setting the `'processors'` parameter in the `install-config.yaml` file to an appropriate value to meet the requirements for deploying {product-title} successfully.
99+
====
100+
<5> The cluster network plugin to install. The supported value is `OVNKubernetes`.
101+
<6> The name of an existing resource group.
102+
<7> Required. The installation program prompts you for this value.
93103
ifdef::openshift-origin[]
94-
<7> You can optionally provide the `sshKey` value that you use to access the machines in your cluster.
104+
<8> Optional. You can optionally provide the `sshKey` value that you use to access the machines in your cluster.
95105
endif::openshift-origin[]
96106
+
97107
[NOTE]
@@ -109,50 +119,60 @@ compute: <1> <2>
109119
- architecture: ppc64le
110120
hyperthreading: Enabled <3>
111121
name: worker
112-
platform: {}
122+
platform:
123+
powervs:
124+
smtLevel: 8 <4>
113125
replicas: 3
114126
controlPlane: <1> <2>
115127
architecture: ppc64le
116128
hyperthreading: Enabled <3>
117129
name: master
118-
platform: {}
130+
platform:
131+
powervs:
132+
smtLevel: 8 <4>
119133
replicas: 3
120134
metadata:
121135
creationTimestamp: null
122136
name: example-private-cluster-name
123137
networking:
124138
clusterNetwork:
125-
- cidr: 10.128.0.0/14 <4>
139+
- cidr: 10.128.0.0/14 <5>
126140
hostPrefix: 23
127141
machineNetwork:
128142
- cidr: 192.168.0.0/24
129-
networkType: OVNKubernetes <5>
143+
networkType: OVNKubernetes <6>
130144
serviceNetwork:
131145
- 172.30.0.0/16
132146
platform:
133147
powervs:
134148
userID: ibm-user-id
135149
powervsResourceGroup: "ibmcloud-resource-group"
136150
region: powervs-region
137-
vpcName: name-of-existing-vpc <6>
151+
vpcName: name-of-existing-vpc <7>
138152
vpcSubnets:
139153
- powervs-region-example-subnet-1
140154
vpcRegion : vpc-region
141155
zone: powervs-zone
142156
serviceInstanceGUID: "powervs-region-service-instance-guid"
143-
publish: Internal <7>
144-
pullSecret: '{"auths": ...}' <8>
145-
sshKey: ssh-ed25519 AAAA... <9>
157+
publish: Internal <8>
158+
pullSecret: '{"auths": ...}' <9>
159+
sshKey: ssh-ed25519 AAAA... <10>
146160
----
147161
<1> If you do not provide these parameters and values, the installation program provides the default value.
148162
<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. Both sections currently define a single machine pool. Only one control plane pool is used.
149163
<3> 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.
150-
<4> The machine CIDR must contain the subnets for the compute machines and control plane machines.
151-
<5> The cluster network plugin to install. The supported values are `OVNKubernetes` and `OpenShiftSDN`. The default value is `OVNKubernetes`.
152-
<6> Specify the name of an existing VPC.
153-
<7> How to publish the user-facing endpoints of your cluster. Set publish to `Internal` to deploy a private cluster.
154-
<8> Required. The installation program prompts you for this value.
155-
<9> Provide the `sshKey` value that you use to access the machines in your cluster.
164+
<4> The smtLevel specifies the level of SMT to set to the control plane and compute machines. The supported values are 1, 2, 4, 8, `'off'` and `'on'`. The default value is 8. The smtLevel `'off'` sets SMT to off and smtlevel `'on'` sets SMT to the default value 8 on the cluster nodes.
165+
+
166+
[NOTE]
167+
====
168+
When simultaneous multithreading (SMT), or hyperthreading is not enabled, one vCPU is equivalent to one physical core. When enabled, total vCPUs is computed as (Thread(s) per core * Core(s) per socket) * Socket(s). The smtLevel controls the threads per core. Lower SMT levels may require additional assigned cores when deploying the cluster nodes. You can do this by setting the `'processors'` parameter in the `install-config.yaml` file to an appropriate value to meet the requirements for deploying {product-title} successfully.
169+
====
170+
<5> The machine CIDR must contain the subnets for the compute machines and control plane machines.
171+
<6> The cluster network plugin to install. The supported value is `OVNKubernetes`.
172+
<7> Specify the name of an existing VPC.
173+
<8> Specify how to publish the user-facing endpoints of your cluster. Set publish to `Internal` to deploy a private cluster.
174+
<9> Required. The installation program prompts you for this value.
175+
<10> Provide the `sshKey` value that you use to access the machines in your cluster.
156176
+
157177
[IMPORTANT]
158178
====
@@ -187,24 +207,28 @@ compute: <1> <2>
187207
- architecture: ppc64le
188208
hyperthreading: Enabled <3>
189209
name: worker
190-
platform: {}
210+
platform:
211+
powervs:
212+
smtLevel: 8 <4>
191213
replicas: 3
192214
controlPlane: <1> <2>
193215
architecture: ppc64le
194216
hyperthreading: Enabled <3>
195217
name: master
196-
platform: {}
218+
platform:
219+
powervs:
220+
smtLevel: 8 <4>
197221
replicas: 3
198222
metadata:
199223
creationTimestamp: null
200224
name: example-cluster-existing-vpc
201225
networking:
202226
clusterNetwork:
203-
- cidr: 10.128.0.0/14 <4>
227+
- cidr: 10.128.0.0/14 <5>
204228
hostPrefix: 23
205229
machineNetwork:
206230
- cidr: 192.168.0.0/24
207-
networkType: OVNKubernetes <5>
231+
networkType: OVNKubernetes <6>
208232
serviceNetwork:
209233
- 172.30.0.0/16
210234
platform:
@@ -213,27 +237,33 @@ platform:
213237
powervsResourceGroup: "ibmcloud-resource-group"
214238
region: powervs-region
215239
vpcRegion : vpc-region
216-
vpcName: name-of-existing-vpc <6>
217-
vpcSubnets: <7>
240+
vpcName: name-of-existing-vpc <7>
241+
vpcSubnets: <8>
218242
- powervs-region-example-subnet-1
219243
zone: powervs-zone
220244
serviceInstanceGUID: "powervs-region-service-instance-guid"
221245
credentialsMode: Manual
222-
publish: External <8>
223-
pullSecret: '{"auths": ...}' <9>
246+
publish: External <9>
247+
pullSecret: '{"auths": ...}' <10>
224248
fips: false
225-
sshKey: ssh-ed25519 AAAA... <10>
249+
sshKey: ssh-ed25519 AAAA... <11>
226250
----
227251
<1> If you do not provide these parameters and values, the installation program provides the default value.
228252
<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. Both sections currently define a single machine pool. Only one control plane pool is used.
229253
<3> 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.
230-
<4> The machine CIDR must contain the subnets for the compute machines and control plane machines.
231-
<5> The cluster network plugin to install. The supported values are `OVNKubernetes` and `OpenShiftSDN`. The default value is `OVNKubernetes`.
232-
<6> Specify the name of an existing VPC.
233-
<7> Specify the name of the existing VPC subnet. The subnets must belong to the VPC that you specified. Specify a subnet for each availability zone in the region.
234-
<8> How to publish the user-facing endpoints of your cluster.
235-
<9> Required. The installation program prompts you for this value.
236-
<10> Provide the `sshKey` value that you use to access the machines in your cluster.
254+
<4> The smtLevel specifies the level of SMT to set to the control plane and compute machines. The supported values are 1, 2, 4, 8, `'off'` and `'on'`. The default value is 8. The smtLevel `'off'` sets SMT to off and smtlevel `'on'` sets SMT to the default value 8 on the cluster nodes.
255+
+
256+
[NOTE]
257+
====
258+
When simultaneous multithreading (SMT), or hyperthreading is not enabled, one vCPU is equivalent to one physical core. When enabled, total vCPUs is computed as (Thread(s) per core * Core(s) per socket) * Socket(s). The smtLevel controls the threads per core. Lower SMT levels may require additional assigned cores when deploying the cluster nodes. You can do this by setting the `'processors'` parameter in the `install-config.yaml` file to an appropriate value to meet the requirements for deploying {product-title} successfully.
259+
====
260+
<5> The machine CIDR must contain the subnets for the compute machines and control plane machines.
261+
<6> The cluster network plugin for installation. The supported value is `OVNKubernetes`.
262+
<7> Specify the name of an existing VPC.
263+
<8> Specify the name of the existing VPC subnet. The subnets must belong to the VPC that you specified. Specify a subnet for each availability zone in the region.
264+
<9> Specify how to publish the user-facing endpoints of your cluster.
265+
<10> Required. The installation program prompts you for this value.
266+
<11> Provide the `sshKey` value that you use to access the machines in your cluster.
237267
+
238268
[IMPORTANT]
239269
====
@@ -268,44 +298,48 @@ controlPlane: <2> <3>
268298
hyperthreading: Enabled <4>
269299
name: master
270300
platform:
301+
powervs:
302+
smtLevel: 8 <5>
271303
replicas: 3
272304
compute: <2> <3>
273305
- hyperthreading: Enabled <4>
274306
name: worker
275307
platform:
308+
powervs:
309+
smtLevel: 8 <5>
276310
ibmcloud: {}
277311
replicas: 3
278312
metadata:
279313
name: example-restricted-cluster-name <1>
280314
networking:
281315
clusterNetwork:
282-
- cidr: 10.128.0.0/14 <5>
316+
- cidr: 10.128.0.0/14 <6>
283317
hostPrefix: 23
284318
machineNetwork:
285-
- cidr: 10.0.0.0/16 <6>
286-
networkType: OVNKubernetes <7>
319+
- cidr: 10.0.0.0/16 <7>
320+
networkType: OVNKubernetes <8>
287321
serviceNetwork:
288322
- 192.168.0.0/24
289323
platform:
290324
powervs:
291325
userid: ibm-user-id
292-
powervsResourceGroup: "ibmcloud-resource-group" <8>
326+
powervsResourceGroup: "ibmcloud-resource-group" <9>
293327
region: "powervs-region"
294328
vpcRegion: "vpc-region"
295-
vpcName: name-of-existing-vpc <9>
296-
vpcSubnets: <10>
329+
vpcName: name-of-existing-vpc <10>
330+
vpcSubnets: <11>
297331
- name-of-existing-vpc-subnet
298332
zone: "powervs-zone"
299333
serviceInstanceID: "service-instance-id"
300334
publish: Internal
301335
credentialsMode: Manual
302-
pullSecret: '{"auths":{"<local_registry>": {"auth": "<credentials>","email": "you@example.com"}}}' <11>
303-
sshKey: ssh-ed25519 AAAA... <12>
304-
additionalTrustBundle: | <13>
336+
pullSecret: '{"auths":{"<local_registry>": {"auth": "<credentials>","email": "you@example.com"}}}' <12>
337+
sshKey: ssh-ed25519 AAAA... <13>
338+
additionalTrustBundle: | <14>
305339
-----BEGIN CERTIFICATE-----
306340
<MY_TRUSTED_CA_CERT>
307341
-----END CERTIFICATE-----
308-
imageContentSources: <14>
342+
imageContentSources: <15>
309343
- mirrors:
310344
- <local_registry>/<local_repository_name>/release
311345
source: quay.io/openshift-release-dev/ocp-release
@@ -322,16 +356,22 @@ imageContentSources: <14>
322356
====
323357
If you disable simultaneous multithreading, ensure that your capacity planning accounts for the dramatically decreased machine performance. Use larger machine types, such as `n1-standard-8`, for your machines if you disable simultaneous multithreading.
324358
====
325-
<5> The machine CIDR must contain the subnets for the compute machines and control plane machines.
326-
<6> The CIDR must contain the subnets defined in `platform.ibmcloud.controlPlaneSubnets` and `platform.ibmcloud.computeSubnets`.
327-
<7> The cluster network plugin to install. The supported values are `OVNKubernetes` and `OpenShiftSDN`. The default value is `OVNKubernetes`.
328-
<8> The name of an existing resource group. The existing VPC and subnets should be in this resource group. The cluster is deployed to this resource group.
329-
<9> Specify the name of an existing VPC.
330-
<10> Specify the name of the existing VPC subnet. The subnets must belong to the VPC that you specified. Specify a subnet for each availability zone in the region.
331-
<11> For `<local_registry>`, specify the registry domain name, and optionally the port, that your mirror registry uses to serve content. For example, registry.example.com or registry.example.com:5000. For `<credentials>`, specify the base64-encoded user name and password for your mirror registry.
332-
<12> You can optionally provide the `sshKey` value that you use to access the machines in your cluster.
333-
<13> Provide the contents of the certificate file that you used for your mirror registry.
334-
<14> Provide the `imageContentSources` section from the output of the command to mirror the repository.
359+
<5> The smtLevel specifies the level of SMT to set to the control plane and compute machines. The supported values are 1, 2, 4, 8, `'off'` and `'on'`. The default value is 8. The smtLevel `'off'` sets SMT to off and smtlevel `'on'` sets SMT to the default value 8 on the cluster nodes.
360+
+
361+
[NOTE]
362+
====
363+
When simultaneous multithreading (SMT), or hyperthreading is not enabled, one vCPU is equivalent to one physical core. When enabled, total vCPUs is computed as (Thread(s) per core * Core(s) per socket) * Socket(s). The smtLevel controls the threads per core. Lower SMT levels may require additional assigned cores when deploying the cluster nodes. You can do this by setting the `'processors'` parameter in the `install-config.yaml` file to an appropriate value to meet the requirements for deploying {product-title} successfully.
364+
====
365+
<6> The machine CIDR must contain the subnets for the compute machines and control plane machines.
366+
<7> The CIDR must contain the subnets defined in `platform.ibmcloud.controlPlaneSubnets` and `platform.ibmcloud.computeSubnets`.
367+
<8> The cluster network plugin to install. The supported value is `OVNKubernetes`.
368+
<9> The name of an existing resource group. The existing VPC and subnets should be in this resource group. The cluster is deployed to this resource group.
369+
<10> Specify the name of an existing VPC.
370+
<11> Specify the name of the existing VPC subnet. The subnets must belong to the VPC that you specified. Specify a subnet for each availability zone in the region.
371+
<12> For `<local_registry>`, specify the registry domain name, and optionally the port, that your mirror registry uses to serve content. For example, registry.example.com or registry.example.com:5000. For `<credentials>`, specify the base64-encoded user name and password for your mirror registry.
372+
<13> You can optionally provide the `sshKey` value that you use to access the machines in your cluster.
373+
<14> Provide the contents of the certificate file that you used for your mirror registry.
374+
<15> Provide the `imageContentSources` section from the output of the command to mirror the repository.
335375
+
336376
[NOTE]
337377
====

0 commit comments

Comments
 (0)