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

Commit

Permalink
fix: added basic docs for nutanix mutations
Browse files Browse the repository at this point in the history
  • Loading branch information
deepakm-ntnx committed Apr 2, 2024
1 parent df78890 commit 50d40b8
Show file tree
Hide file tree
Showing 4 changed files with 203 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/content/customization/nutanix/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

+++
title = "Nutanix"
icon = "fa-brands fa-nutanix"
+++

The customizations in this section are applicable only to Nutanix clusters. They will only be applied to clusters that
use the `Nutanix` infrastructure provider, i.e. a CAPI `Cluster` that references an `NutanixCluster`.
39 changes: 39 additions & 0 deletions docs/content/customization/nutanix/control-plane-endpoint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
+++
title = "Control Plane Endpoint"
+++

Configure Control Plane Endpoint. Defines the host IP and port of the CAPX Kubernetes cluster.

## Examples

### Set Control Plane Endpoint


```yaml
apiVersion: cluster.x-k8s.io/v1beta1
kind: Cluster
metadata:
name: <NAME>
spec:
topology:
variables:
- name: clusterConfig
value:
nutanix:
controlPlaneEndpoint:
host: x.x.x.x
port: 6443
```
Applying this configuration will result in the following value being set:
- control-plane NutanixClusterTemplate:
```yaml
spec:
template:
spec:
controlPlaneEndpoint:
host: x.x.x.x
port: 6443
```
111 changes: 111 additions & 0 deletions docs/content/customization/nutanix/machine-details.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
+++
title = "Machine Details"
+++

Configure Machine Details of Control plane and Worker nodes

## Examples

### Set Machine details of Control Plane and Worker nodes

```yaml
apiVersion: cluster.x-k8s.io/v1beta1
kind: Cluster
metadata:
name: <NAME>
spec:
topology:
variables:
- name: clusterConfig
value:
controlPlane:
nutanix:
machineDetails:
bootType: legacy
cluster:
name: pe-cluster-name
type: name
image:
name: os-image-name
type: name
memorySize: 4Gi
subnets:
- name: subnet-name
type: name
systemDiskSize: 40Gi
vcpuSockets: 2
vcpusPerSocket: 1
- name: workerConfig
value:
nutanix:
machineDetails:
bootType: legacy
cluster:
name: pe-cluster-name
type: name
image:
name: os-image-name
type: name
memorySize: 4Gi
subnets:
- name: subnet-name
type: name
systemDiskSize: 40Gi
vcpuSockets: 2
vcpusPerSocket: 1
```
Applying this configuration will result in the following value being set:
- control-plane NutanixMachineTemplate:
```yaml
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
kind: NutanixMachineTemplate
metadata:
name: nutanix-quick-start-cp-nmt
spec:
template:
spec:
bootType: legacy
cluster:
name: pe-cluster-name
type: name
image:
name: os-image-name
type: name
memorySize: 4Gi
providerID: nutanix://vm-uuid
subnet:
- name: subnet-name
type: name
systemDiskSize: 40Gi
vcpuSockets: 2
vcpusPerSocket: 1
```
- worker nodes NutanixMachineTemplate:
```yaml
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
kind: NutanixMachineTemplate
metadata:
name: nutanix-quick-start-md-nmt
spec:
template:
spec:
bootType: legacy
cluster:
name: pe-cluster-name
type: name
image:
name: os-image-name
type: name
memorySize: 4Gi
providerID: nutanix://vm-uuid
subnet:
- name: subnet-name
type: name
systemDiskSize: 40Gi
vcpuSockets: 2
vcpusPerSocket: 1
```
45 changes: 45 additions & 0 deletions docs/content/customization/nutanix/prism-central-endpoint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
+++
title = "Prism Central Endpoint"
+++

Configure Prism Central Endpoint to create machines on.

## Examples

### Set Prism Central Endpoint

```yaml
apiVersion: cluster.x-k8s.io/v1beta1
kind: Cluster
metadata:
name: <NAME>
spec:
topology:
variables:
- name: clusterConfig
value:
nutanix:
prismCentralEndpoint:
credentials:
name: secret-name
host: x.x.x.x
insecure: false
port: 9440
```
Applying this configuration will result in the following value being set:
- control-plane NutanixClusterTemplate:
```yaml
spec:
template:
spec:
prismCentral:
address: x.x.x.x
insecure: false
port: 9440
credentialRef:
kind: Secret
name: secret-name
```

0 comments on commit 50d40b8

Please sign in to comment.