Skip to content

Commit b6c0e7a

Browse files
jeana-redhatjeana-redhat
committed
[OSDOCS-6391]: Adds&fixes Nutanix compute machine set YAML params
1 parent bdba9d6 commit b6c0e7a

File tree

1 file changed

+57
-33
lines changed

1 file changed

+57
-33
lines changed

‎modules/machineset-yaml-nutanix.adoc

Lines changed: 57 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,19 @@ ifndef::infra[`<role>`]
2020
ifdef::infra[`<infra>`]
2121
is the node label to add.
2222

23+
[discrete]
24+
[id="machineset-yaml-nutanix-oc_{context}"]
25+
== Values obtained by using the OpenShift CLI
26+
27+
In the following example, you can obtain some of the values for your cluster by using the OpenShift CLI (`oc`).
28+
29+
Infrastructure ID:: The `<infrastructure_id>` string is the infrastructure ID that is based on the cluster ID that you set when you provisioned the cluster. If you have the OpenShift CLI installed, you can obtain the infrastructure ID by running the following command:
30+
+
31+
[source,terminal]
32+
----
33+
$ oc get -o jsonpath='{.status.infrastructureName}{"\n"}' infrastructure cluster
34+
----
35+
2336
[source,yaml]
2437
----
2538
apiVersion: machine.openshift.io/v1beta1
@@ -29,12 +42,12 @@ metadata:
2942
machine.openshift.io/cluster-api-cluster: <infrastructure_id> <1>
3043
ifndef::infra[]
3144
machine.openshift.io/cluster-api-machine-role: <role> <2>
32-
machine.openshift.io/cluster-api-machine-type: <role> <2>
45+
machine.openshift.io/cluster-api-machine-type: <role>
3346
name: <infrastructure_id>-<role>-<zone> <3>
3447
endif::infra[]
3548
ifdef::infra[]
3649
machine.openshift.io/cluster-api-machine-role: <infra> <2>
37-
machine.openshift.io/cluster-api-machine-type: <infra> <2>
50+
machine.openshift.io/cluster-api-machine-type: <infra>
3851
name: <infrastructure_id>-<infra>-<zone> <3>
3952
endif::infra[]
4053
namespace: openshift-machine-api
@@ -45,26 +58,26 @@ spec:
4558
replicas: 3
4659
selector:
4760
matchLabels:
48-
machine.openshift.io/cluster-api-cluster: <infrastructure_id> <1>
61+
machine.openshift.io/cluster-api-cluster: <infrastructure_id>
4962
ifndef::infra[]
50-
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>-<zone> <3>
63+
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>-<zone>
5164
endif::infra[]
5265
ifdef::infra[]
53-
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<infra>-<zone> <3>
66+
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<infra>-<zone>
5467
endif::infra[]
5568
template:
5669
metadata:
5770
labels:
58-
machine.openshift.io/cluster-api-cluster: <infrastructure_id> <1>
71+
machine.openshift.io/cluster-api-cluster: <infrastructure_id>
5972
ifndef::infra[]
60-
machine.openshift.io/cluster-api-machine-role: <role> <2>
61-
machine.openshift.io/cluster-api-machine-type: <role> <2>
62-
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>-<zone> <3>
73+
machine.openshift.io/cluster-api-machine-role: <role>
74+
machine.openshift.io/cluster-api-machine-type: <role>
75+
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>-<zone>
6376
endif::infra[]
6477
ifdef::infra[]
65-
machine.openshift.io/cluster-api-machine-role: <infra> <2>
66-
machine.openshift.io/cluster-api-machine-type: <infra> <2>
67-
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<infra>-<zone> <3>
78+
machine.openshift.io/cluster-api-machine-role: <infra>
79+
machine.openshift.io/cluster-api-machine-type: <infra>
80+
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<infra>-<zone>
6881
endif::infra[]
6982
spec:
7083
metadata:
@@ -78,36 +91,38 @@ endif::infra[]
7891
providerSpec:
7992
value:
8093
apiVersion: machine.openshift.io/v1
81-
cluster:
94+
bootType: "" <5>
95+
categories: <6>
96+
- key: <category_name>
97+
value: <category_value>
98+
cluster: <7>
8299
type: uuid
83100
uuid: <cluster_uuid>
84101
credentialsSecret:
85102
name: nutanix-creds-secret
86103
image:
87-
name: <infrastructure_id>-rhcos <5>
104+
name: <infrastructure_id>-rhcos <8>
88105
type: name
89106
kind: NutanixMachineProviderConfig
90-
memorySize: 16Gi <6>
107+
memorySize: 16Gi <9>
108+
project: <10>
109+
type: name
110+
name: <project_name>
91111
subnets:
92112
- type: uuid
93113
uuid: <subnet_uuid>
94-
systemDiskSize: 120Gi <7>
114+
systemDiskSize: 120Gi <11>
95115
userDataSecret:
96-
name: <user_data_secret> <8>
97-
vcpuSockets: 4 <9>
98-
vcpusPerSocket: 1 <10>
116+
name: <user_data_secret> <12>
117+
vcpuSockets: 4 <13>
118+
vcpusPerSocket: 1 <14>
99119
ifdef::infra[]
100-
taints: <11>
120+
taints: <15>
101121
- key: node-role.kubernetes.io/infra
102122
effect: NoSchedule
103123
endif::infra[]
104124
----
105-
<1> Specify the infrastructure ID that is based on the cluster ID that you set when you provisioned the cluster. If you have the OpenShift CLI (`oc`) installed, you can obtain the infrastructure ID by running the following command:
106-
+
107-
[source,terminal]
108-
----
109-
$ oc get -o jsonpath='{.status.infrastructureName}{"\n"}' infrastructure cluster
110-
----
125+
<1> For `<infrastructure_id>`, specify the infrastructure ID that is based on the cluster ID that you set when you provisioned the cluster.
111126
ifndef::infra[]
112127
<2> Specify the node label to add.
113128
<3> Specify the infrastructure ID, node label, and zone.
@@ -117,14 +132,23 @@ ifdef::infra[]
117132
<3> Specify the infrastructure ID, `<infra>` node label, and zone.
118133
endif::infra[]
119134
<4> Annotations for the cluster autoscaler.
120-
<5> Specify the image to use. Use an image from an existing default compute machine set for the cluster.
121-
<6> Specify the amount of memory for the cluster in Gi.
122-
<7> Specify the size of the system disk in Gi.
123-
<8> Specify the name of the secret in the user data YAML file that is in the `openshift-machine-api` namespace. Use the value that the installer populates in the default compute machine set.
124-
<9> Specify the number of vCPU sockets.
125-
<10> Specify the number of vCPUs per socket.
135+
<5> Specifies the boot type that the compute machines use. For more information about boot types, see link:https://portal.nutanix.com/page/documents/kbs/details?targetId=kA07V000000H3K9SAK[Understanding UEFI, Secure Boot, and TPM in the Virtualized Environment]. Valid values are `Legacy`, `SecureBoot`, or `UEFI`. The default is `Legacy`.
136+
+
137+
[NOTE]
138+
====
139+
You must use the `Legacy` boot type in {product-title} {product-version}.
140+
====
141+
<6> Specify one or more Nutanix Prism categories to apply to compute machines. This stanza requires `key` and `value` parameters for a category key-value pair that exists in Prism Central. For more information about 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].
142+
<7> Specify a Nutanix Prism Element cluster configuration. In this example, the cluster type is `uuid`, so there is a `uuid` stanza.
143+
<8> Specify the image to use. Use an image from an existing default compute machine set for the cluster.
144+
<9> Specify the amount of memory for the cluster in Gi.
145+
<10> Specify the Nutanix project that you use for your cluster. In this example, the project type is `name`, so there is a `name` stanza.
146+
<11> Specify the size of the system disk in Gi.
147+
<12> Specify the name of the secret in the user data YAML file that is in the `openshift-machine-api` namespace. Use the value that installation program populates in the default compute machine set.
148+
<13> Specify the number of vCPU sockets.
149+
<14> Specify the number of vCPUs per socket.
126150
ifdef::infra[]
127-
<11> Specify a taint to prevent user workloads from being scheduled on infra nodes.
151+
<15> Specify a taint to prevent user workloads from being scheduled on infra nodes.
128152
+
129153
[NOTE]
130154
====

0 commit comments

Comments
 (0)