Skip to content
This repository was archived by the owner on Apr 11, 2024. It is now read-only.

Commit 50d40b8

Browse files
committed
fix: added basic docs for nutanix mutations
1 parent df78890 commit 50d40b8

File tree

4 files changed

+203
-0
lines changed

4 files changed

+203
-0
lines changed
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
2+
+++
3+
title = "Nutanix"
4+
icon = "fa-brands fa-nutanix"
5+
+++
6+
7+
The customizations in this section are applicable only to Nutanix clusters. They will only be applied to clusters that
8+
use the `Nutanix` infrastructure provider, i.e. a CAPI `Cluster` that references an `NutanixCluster`.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
+++
2+
title = "Control Plane Endpoint"
3+
+++
4+
5+
Configure Control Plane Endpoint. Defines the host IP and port of the CAPX Kubernetes cluster.
6+
7+
## Examples
8+
9+
### Set Control Plane Endpoint
10+
11+
12+
```yaml
13+
apiVersion: cluster.x-k8s.io/v1beta1
14+
kind: Cluster
15+
metadata:
16+
name: <NAME>
17+
spec:
18+
topology:
19+
variables:
20+
- name: clusterConfig
21+
value:
22+
nutanix:
23+
controlPlaneEndpoint:
24+
host: x.x.x.x
25+
port: 6443
26+
```
27+
28+
Applying this configuration will result in the following value being set:
29+
30+
- control-plane NutanixClusterTemplate:
31+
32+
```yaml
33+
spec:
34+
template:
35+
spec:
36+
controlPlaneEndpoint:
37+
host: x.x.x.x
38+
port: 6443
39+
```
Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
+++
2+
title = "Machine Details"
3+
+++
4+
5+
Configure Machine Details of Control plane and Worker nodes
6+
7+
## Examples
8+
9+
### Set Machine details of Control Plane and Worker nodes
10+
11+
```yaml
12+
apiVersion: cluster.x-k8s.io/v1beta1
13+
kind: Cluster
14+
metadata:
15+
name: <NAME>
16+
spec:
17+
topology:
18+
variables:
19+
- name: clusterConfig
20+
value:
21+
controlPlane:
22+
nutanix:
23+
machineDetails:
24+
bootType: legacy
25+
cluster:
26+
name: pe-cluster-name
27+
type: name
28+
image:
29+
name: os-image-name
30+
type: name
31+
memorySize: 4Gi
32+
subnets:
33+
- name: subnet-name
34+
type: name
35+
systemDiskSize: 40Gi
36+
vcpuSockets: 2
37+
vcpusPerSocket: 1
38+
- name: workerConfig
39+
value:
40+
nutanix:
41+
machineDetails:
42+
bootType: legacy
43+
cluster:
44+
name: pe-cluster-name
45+
type: name
46+
image:
47+
name: os-image-name
48+
type: name
49+
memorySize: 4Gi
50+
subnets:
51+
- name: subnet-name
52+
type: name
53+
systemDiskSize: 40Gi
54+
vcpuSockets: 2
55+
vcpusPerSocket: 1
56+
```
57+
58+
Applying this configuration will result in the following value being set:
59+
60+
- control-plane NutanixMachineTemplate:
61+
62+
```yaml
63+
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
64+
kind: NutanixMachineTemplate
65+
metadata:
66+
name: nutanix-quick-start-cp-nmt
67+
spec:
68+
template:
69+
spec:
70+
bootType: legacy
71+
cluster:
72+
name: pe-cluster-name
73+
type: name
74+
image:
75+
name: os-image-name
76+
type: name
77+
memorySize: 4Gi
78+
providerID: nutanix://vm-uuid
79+
subnet:
80+
- name: subnet-name
81+
type: name
82+
systemDiskSize: 40Gi
83+
vcpuSockets: 2
84+
vcpusPerSocket: 1
85+
```
86+
87+
- worker nodes NutanixMachineTemplate:
88+
```yaml
89+
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
90+
kind: NutanixMachineTemplate
91+
metadata:
92+
name: nutanix-quick-start-md-nmt
93+
spec:
94+
template:
95+
spec:
96+
bootType: legacy
97+
cluster:
98+
name: pe-cluster-name
99+
type: name
100+
image:
101+
name: os-image-name
102+
type: name
103+
memorySize: 4Gi
104+
providerID: nutanix://vm-uuid
105+
subnet:
106+
- name: subnet-name
107+
type: name
108+
systemDiskSize: 40Gi
109+
vcpuSockets: 2
110+
vcpusPerSocket: 1
111+
```
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
+++
2+
title = "Prism Central Endpoint"
3+
+++
4+
5+
Configure Prism Central Endpoint to create machines on.
6+
7+
## Examples
8+
9+
### Set Prism Central Endpoint
10+
11+
```yaml
12+
apiVersion: cluster.x-k8s.io/v1beta1
13+
kind: Cluster
14+
metadata:
15+
name: <NAME>
16+
spec:
17+
topology:
18+
variables:
19+
- name: clusterConfig
20+
value:
21+
nutanix:
22+
prismCentralEndpoint:
23+
credentials:
24+
name: secret-name
25+
host: x.x.x.x
26+
insecure: false
27+
port: 9440
28+
```
29+
30+
Applying this configuration will result in the following value being set:
31+
32+
- control-plane NutanixClusterTemplate:
33+
34+
```yaml
35+
spec:
36+
template:
37+
spec:
38+
prismCentral:
39+
address: x.x.x.x
40+
insecure: false
41+
port: 9440
42+
credentialRef:
43+
kind: Secret
44+
name: secret-name
45+
```

0 commit comments

Comments
 (0)