Skip to content

Commit 53cc08b

Browse files
mjpytlakmjpytlak
authored
Merge pull request #57130 from bscott-rh/OSDOCS-5340
OSDOCS-5340 Adding categories and projects to Nutanix install doc
2 parents 399809a + 088d423 commit 53cc08b

File tree

2 files changed

+119
-31
lines changed

2 files changed

+119
-31
lines changed

‎modules/installation-configuration-parameters.adoc

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1831,6 +1831,62 @@ Additional Nutanix configuration parameters are described in the following table
18311831
|====
18321832
|Parameter|Description|Values
18331833

1834+
|`compute.platform.nutanix.categories.key`
1835+
|The name of a prism category key to apply to compute VMs. This parameter must be accompanied by the `value` parameter, and both `key` and `value` parameters must exist in Prism Central. For more information on categories, see link:https://portal.nutanix.com/page/documents/details?targetId=Prism-Central-Guide-vpc_2022_6:ssp-ssp-categories-manage-pc-c.html[Category management].
1836+
|String
1837+
1838+
|`compute.platform.nutanix.categories.value`
1839+
|The value of a prism category key-value pair to apply to compute VMs. This parameter must be accompanied by the `key` parameter, and both `key` and `value` parameters must exist in Prism Central.
1840+
|String
1841+
1842+
|`compute.platform.nutanix.project.type`
1843+
|The type of identifier you use to select a project for compute VMs. Projects define logical groups of user roles for managing permissions, networks, and other parameters. For more information on projects, see link:https://portal.nutanix.com/page/documents/details?targetId=Prism-Central-Guide-vpc_2022_9:ssp-app-mgmt-project-env-c.html[Projects Overview].
1844+
|`name` or `uuid`
1845+
1846+
|`compute.platform.nutanix.project.name` or `compute.platform.nutanix.project.uuid`
1847+
|The name or UUID of a project with which compute VMs are associated. This parameter must be accompanied by the `type` parameter.
1848+
|String
1849+
1850+
|`compute.platform.nutanix.bootType`
1851+
|The boot type that the compute machines use. You must use the `Legacy` boot type in {product-title} {product-version}. For more information on boot types, see link:https://portal.nutanix.com/page/documents/kbs/details?targetId=kA07V000000H3K9SAK[Understanding UEFI, Secure Boot, and TPM in the Virtualized Environment].
1852+
|`Legacy`, `SecureBoot` or `UEFI`. The default is `Legacy`.
1853+
1854+
|`controlPlane.platform.nutanix.categories.key`
1855+
|The name of a prism category key to apply to control plane VMs. This parameter must be accompanied by the `value` parameter, and both `key` and `value` parameters must exist in Prism Central. For more information on categories, see link:https://portal.nutanix.com/page/documents/details?targetId=Prism-Central-Guide-vpc_2022_6:ssp-ssp-categories-manage-pc-c.html[Category management].
1856+
|String
1857+
1858+
|`controlPlane.platform.nutanix.categories.value`
1859+
|The value of a prism category key-value pair to apply to control plane VMs. This parameter must be accompanied by the `key` parameter, and both `key` and `value` parameters must exist in Prism Central.
1860+
|String
1861+
1862+
|`controlPlane.platform.nutanix.project.type`
1863+
|The type of identifier you use to select a project for control plane VMs. Projects define logical groups of user roles for managing permissions, networks, and other parameters. For more information on projects, see link:https://portal.nutanix.com/page/documents/details?targetId=Prism-Central-Guide-vpc_2022_9:ssp-app-mgmt-project-env-c.html[Projects Overview].
1864+
|`name` or `uuid`
1865+
1866+
|`controlPlane.platform.nutanix.project.name` or `controlPlane.platform.nutanix.project.uuid`
1867+
|The name or UUID of a project with which control plane VMs are associated. This parameter must be accompanied by the `type` parameter.
1868+
|String
1869+
1870+
|`platform.nutanix.defaultMachinePlatform.categories.key`
1871+
|The name of a prism category key to apply to all VMs. This parameter must be accompanied by the `value` parameter, and both `key` and `value` parameters must exist in Prism Central. For more information on categories, see link:https://portal.nutanix.com/page/documents/details?targetId=Prism-Central-Guide-vpc_2022_6:ssp-ssp-categories-manage-pc-c.html[Category management].
1872+
|String
1873+
1874+
|`platform.nutanix.defaultMachinePlatform.categories.value`
1875+
|The value of a prism category key-value pair to apply to all VMs. This parameter must be accompanied by the `key` parameter, and both `key` and `value` parameters must exist in Prism Central.
1876+
|String
1877+
1878+
|`platform.nutanix.defaultMachinePlatform.project.type`
1879+
|The type of identifier you use to select a project for all VMs. Projects define logical groups of user roles for managing permissions, networks, and other parameters. For more information on projects, see link:https://portal.nutanix.com/page/documents/details?targetId=Prism-Central-Guide-vpc_2022_9:ssp-app-mgmt-project-env-c.html[Projects Overview].
1880+
|`name` or `uuid`.
1881+
1882+
|`platform.nutanix.defaultMachinePlatform.project.name` or `platform.nutanix.defaultMachinePlatform.project.uuid`
1883+
|The name or UUID of a project with which all VMs are associated. This parameter must be accompanied by the `type` parameter.
1884+
|String
1885+
1886+
|`platform.nutanix.defaultMachinePlatform.bootType`
1887+
|The boot type for all machines. You must use the `Legacy` boot type in {product-title} {product-version}. For more information on boot types, see link:https://portal.nutanix.com/page/documents/kbs/details?targetId=kA07V000000H3K9SAK[Understanding UEFI, Secure Boot, and TPM in the Virtualized Environment].
1888+
|`Legacy`, `SecureBoot` or `UEFI`. The default is `Legacy`.
1889+
18341890
|`platform.nutanix.apiVIP`
18351891
|The virtual IP (VIP) address that you configured for control plane API access.
18361892
|IP address

‎modules/installation-nutanix-config-yaml.adoc

Lines changed: 63 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ compute: <2>
3737
memoryMiB: 8196
3838
osDisk:
3939
diskSizeGiB: 120
40+
categories: <5>
41+
- key: <category_key_name>
42+
value: <category_value>
4043
controlPlane: <2>
4144
hyperthreading: Enabled <3>
4245
name: master
@@ -48,6 +51,9 @@ controlPlane: <2>
4851
memoryMiB: 16384
4952
osDisk:
5053
diskSizeGiB: 120
54+
categories: <5>
55+
- key: <category_key_name>
56+
value: <category_value>
5157
metadata:
5258
creationTimestamp: null
5359
name: test-cluster <1>
@@ -57,12 +63,20 @@ networking:
5763
hostPrefix: 23
5864
machineNetwork:
5965
- cidr: 10.0.0.0/16
60-
networkType: OVNKubernetes <5>
66+
networkType: OVNKubernetes <6>
6167
serviceNetwork:
6268
- 172.30.0.0/16
6369
platform:
6470
nutanix:
6571
apiVIP: 10.40.142.7 <1>
72+
defaultMachinePlatform:
73+
bootType: Legacy
74+
categories: <5>
75+
- key: <category_key_name>
76+
value: <category_value>
77+
project: <7>
78+
type: name
79+
name: <project_name>
6680
ingressVIP: 10.40.142.8 <1>
6781
prismCentral:
6882
endpoint:
@@ -77,16 +91,16 @@ platform:
7791
uuid: 0005b0f1-8f43-a0f2-02b7-3cecef193712
7892
subnetUUIDs:
7993
- c7938dc6-7659-453e-a688-e26020c68e43
80-
clusterOSImage: http://example.com/images/rhcos-47.83.202103221318-0-nutanix.x86_64.qcow2 <6>
94+
clusterOSImage: http://example.com/images/rhcos-47.83.202103221318-0-nutanix.x86_64.qcow2 <8>
8195
credentialsMode: Manual
8296
publish: External
8397
pullSecret: '{"auths": ...}' <1>
8498
ifndef::openshift-origin[]
85-
fips: false <7>
86-
sshKey: ssh-ed25519 AAAA... <8>
99+
fips: false <9>
100+
sshKey: ssh-ed25519 AAAA... <10>
87101
endif::openshift-origin[]
88102
ifdef::openshift-origin[]
89-
sshKey: ssh-ed25519 AAAA... <7>
103+
sshKey: ssh-ed25519 AAAA... <9>
90104
endif::openshift-origin[]
91105
----
92106
<1> Required. The installation program prompts you for this value.
@@ -98,20 +112,22 @@ endif::openshift-origin[]
98112
If you disable simultaneous multithreading, ensure that your capacity planning accounts for the dramatically decreased machine performance.
99113
====
100114
<4> Optional: Provide additional configuration for the machine pool parameters for the compute and control plane machines.
101-
<5> The cluster network plugin to install. The supported values are `OVNKubernetes` and `OpenShiftSDN`. The default value is `OVNKubernetes`.
115+
<5> Optional: Provide one or more pairs of a prism category key and a prism category value. These category key-value pairs must exist in Prism Central. You can provide separate categories to compute machines, control plane machines, or all machines.
116+
<6> The cluster network plugin to install. The supported values are `OVNKubernetes` and `OpenShiftSDN`. The default value is `OVNKubernetes`.
102117
ifndef::openshift-origin[]
103-
<6> Optional: By default, the installation program downloads and installs the {op-system-first} image. If Prism Central does not have internet access, you can override the default behavior by hosting the {op-system} image on any HTTP server and pointing the installation program to the image.
104-
<7> Whether to enable or disable FIPS mode. By default, FIPS mode is not enabled. If FIPS mode is enabled, the {op-system-first} machines that {product-title} runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that are provided with {op-system} instead.
118+
<7> Optional: Specify a project with which VMs are associated. Specify either `name` or `uuid` for the project type, and then provide the corresponding UUID or project name. You can associate projects to compute machines, control plane machines, or all machines.
119+
<8> Optional: By default, the installation program downloads and installs the {op-system-first} image. If Prism Central does not have internet access, you can override the default behavior by hosting the {op-system} image on any HTTP server and pointing the installation program to the image.
120+
<9> Whether to enable or disable FIPS mode. By default, FIPS mode is not enabled. If FIPS mode is enabled, the {op-system-first} machines that {product-title} runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that are provided with {op-system} instead.
105121
+
106122
[IMPORTANT]
107123
====
108124
The use of FIPS Validated or Modules in Process cryptographic libraries is only supported on {product-title} deployments on the `x86_64` architecture.
109125
====
110-
<8> Optional: You can provide the `sshKey` value that you use to access the machines in your cluster.
126+
<10> Optional: You can provide the `sshKey` value that you use to access the machines in your cluster.
111127
endif::openshift-origin[]
112128
ifdef::openshift-origin[]
113-
<6> Optional: By default, the installation program downloads and installs the {op-system-first} image. If Prism Central does not have internet access, you can override the default behavior by hosting the {op-system} image on any HTTP server and pointing the installation program to the image.
114-
<7> Optional: You can provide the `sshKey` value that you use to access the machines in your cluster.
129+
<7> Optional: By default, the installation program downloads and installs the {op-system-first} image. If Prism Central does not have internet access, you can override the default behavior by hosting the {op-system} image on any HTTP server and pointing the installation program to the image.
130+
<8> Optional: You can provide the `sshKey` value that you use to access the machines in your cluster.
115131
endif::openshift-origin[]
116132
+
117133
[NOTE]
@@ -136,6 +152,9 @@ compute: <2>
136152
memoryMiB: 8196
137153
osDisk:
138154
diskSizeGiB: 120
155+
categories: <5>
156+
- key: <category_key_name>
157+
value: <category_value>
139158
controlPlane: <2>
140159
hyperthreading: Enabled <3>
141160
name: master
@@ -147,6 +166,9 @@ controlPlane: <2>
147166
memoryMiB: 16384
148167
osDisk:
149168
diskSizeGiB: 120
169+
categories: <5>
170+
- key: <category_key_name>
171+
value: <category_value>
150172
metadata:
151173
creationTimestamp: null
152174
name: test-cluster <1>
@@ -156,13 +178,21 @@ networking:
156178
hostPrefix: 23
157179
machineNetwork:
158180
- cidr: 10.0.0.0/16
159-
networkType: OVNKubernetes <5>
181+
networkType: OVNKubernetes <6>
160182
serviceNetwork:
161183
- 172.30.0.0/16
162184
platform:
163185
nutanix:
164186
apiVIP: 10.40.142.7 <1>
165187
ingressVIP: 10.40.142.8 <1>
188+
defaultMachinePlatform:
189+
bootType: Legacy
190+
categories: <5>
191+
- key: <category_key_name>
192+
value: <category_value>
193+
project: <7>
194+
type: name
195+
name: <project_name>
166196
prismCentral:
167197
endpoint:
168198
address: your.prismcentral.domainname <1>
@@ -176,23 +206,23 @@ platform:
176206
uuid: 0005b0f1-8f43-a0f2-02b7-3cecef193712
177207
subnetUUIDs:
178208
- c7938dc6-7659-453e-a688-e26020c68e43
179-
clusterOSImage: http://example.com/images/rhcos-47.83.202103221318-0-nutanix.x86_64.qcow2 <6>
209+
clusterOSImage: http://example.com/images/rhcos-47.83.202103221318-0-nutanix.x86_64.qcow2 <8>
180210
credentialsMode: Manual
181211
publish: External
182-
pullSecret: '{"auths":{"<local_registry>": {"auth": "<credentials>","email": "[email protected]"}}}' <7>
212+
pullSecret: '{"auths":{"<local_registry>": {"auth": "<credentials>","email": "[email protected]"}}}' <9>
183213
ifndef::openshift-origin[]
184-
fips: false <8>
185-
sshKey: ssh-ed25519 AAAA... <9>
214+
fips: false <10>
215+
sshKey: ssh-ed25519 AAAA... <11>
186216
endif::openshift-origin[]
187217
ifdef::openshift-origin[]
188-
sshKey: ssh-ed25519 AAAA... <8>
218+
sshKey: ssh-ed25519 AAAA... <10>
189219
endif::openshift-origin[]
190220
ifndef::openshift-origin[]
191-
additionalTrustBundle: | <10>
221+
additionalTrustBundle: | <12>
192222
-----BEGIN CERTIFICATE-----
193223
ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
194224
-----END CERTIFICATE-----
195-
imageContentSources: <11>
225+
imageContentSources: <13>
196226
- mirrors:
197227
- <local_registry>/<local_repository_name>/release
198228
source: quay.io/openshift-release-dev/ocp-release
@@ -201,11 +231,11 @@ imageContentSources: <11>
201231
source: quay.io/openshift-release-dev/ocp-v4.0-art-dev
202232
endif::openshift-origin[]
203233
ifdef::openshift-origin[]
204-
additionalTrustBundle: | <9>
234+
additionalTrustBundle: | <11>
205235
-----BEGIN CERTIFICATE-----
206236
ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
207237
-----END CERTIFICATE-----
208-
imageContentSources: <10>
238+
imageContentSources: <12>
209239
- mirrors:
210240
- <local_registry>/<local_repository_name>/release
211241
source: quay.io/openshift-release-dev/ocp-release
@@ -223,39 +253,41 @@ endif::openshift-origin[]
223253
If you disable simultaneous multithreading, ensure that your capacity planning accounts for the dramatically decreased machine performance.
224254
====
225255
<4> Optional: Provide additional configuration for the machine pool parameters for the compute and control plane machines.
226-
<5> The cluster network plugin to install. The supported values are `OVNKubernetes` and `OpenShiftSDN`. The default value is `OVNKubernetes`.
227-
<6> Optional: By default, the installation program downloads and installs the {op-system-first} image. If Prism Central does not have internet access, you can override the default behavior by hosting the {op-system} image on any HTTP server or Nutanix Objects and pointing the installation program to the image.
228-
<7> 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>`,
256+
<5> Optional: Provide one or more pairs of a prism category key and a prism category value. These category key-value pairs must exist in Prism Central. You can provide separate categories to compute machines, control plane machines, or all machines.
257+
<6> The cluster network plugin to install. The supported values are `OVNKubernetes` and `OpenShiftSDN`. The default value is `OVNKubernetes`.
258+
<7> Optional: Specify a project with which VMs are associated. Specify either `name` or `uuid` for the project type, and then provide the corresponding UUID or project name. You can associate projects to compute machines, control plane machines, or all machines.
259+
<8> Optional: By default, the installation program downloads and installs the {op-system-first} image. If Prism Central does not have internet access, you can override the default behavior by hosting the {op-system} image on any HTTP server or Nutanix Objects and pointing the installation program to the image.
260+
<9> 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>`,
229261
specify the base64-encoded user name and password for your mirror registry.
230262
ifndef::openshift-origin[]
231-
<8> Whether to enable or disable FIPS mode. By default, FIPS mode is not enabled. If FIPS mode is enabled, the {op-system-first} machines that {product-title} runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that are provided with {op-system} instead.
263+
<10> Whether to enable or disable FIPS mode. By default, FIPS mode is not enabled. If FIPS mode is enabled, the {op-system-first} machines that {product-title} runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that are provided with {op-system} instead.
232264
+
233265
[IMPORTANT]
234266
====
235267
The use of FIPS Validated or Modules in Process cryptographic libraries is only supported on {product-title} deployments on the `x86_64` architecture.
236268
====
237-
<9> Optional: You can provide the `sshKey` value that you use to access the machines in your cluster.
269+
<11> Optional: You can provide the `sshKey` value that you use to access the machines in your cluster.
238270
+
239271
[NOTE]
240272
====
241273
For production {product-title} clusters on which you want to perform installation debugging or disaster recovery, specify an SSH key that your `ssh-agent` process uses.
242274
====
243275
endif::openshift-origin[]
244276
ifdef::openshift-origin[]
245-
<8> Optional: You can provide the `sshKey` value that you use to access the machines in your cluster.
277+
<10> Optional: You can provide the `sshKey` value that you use to access the machines in your cluster.
246278
+
247279
[NOTE]
248280
====
249281
For production {product-title} clusters on which you want to perform installation debugging or disaster recovery, specify an SSH key that your `ssh-agent` process uses.
250282
====
251283
endif::openshift-origin[]
252284
ifndef::openshift-origin[]
253-
<10> Provide the contents of the certificate file that you used for your mirror registry.
254-
<11> Provide these values from the `metadata.name: release-0` section of the `imageContentSourcePolicy.yaml` file that was created when you mirrored the registry.
285+
<12> Provide the contents of the certificate file that you used for your mirror registry.
286+
<13> Provide these values from the `metadata.name: release-0` section of the `imageContentSourcePolicy.yaml` file that was created when you mirrored the registry.
255287
endif::openshift-origin[]
256288
ifdef::openshift-origin[]
257-
<9> Provide the contents of the certificate file that you used for your mirror registry.
258-
<10> Provide these values from the `metadata.name: release-0` section of the `imageContentSourcePolicy.yaml` file that was created when you mirrored the registry.
289+
<11> Provide the contents of the certificate file that you used for your mirror registry.
290+
<12> Provide these values from the `metadata.name: release-0` section of the `imageContentSourcePolicy.yaml` file that was created when you mirrored the registry.
259291
endif::openshift-origin[]
260292
endif::restricted[]
261293

0 commit comments

Comments
 (0)