Update types documentation

yannickstruyf3 · Jan 10, 2024 · e34e2c2 · e34e2c2
1 parent fdb8d13
commit e34e2c2
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 3 deletions.
diff --git a/docs/capx/v1.3.x/types/nutanix_cluster.md b/docs/capx/v1.3.x/types/nutanix_cluster.md
@@ -48,6 +48,17 @@ The table below provides an overview of the supported parameters of the `spec` a
 |prismCentral.additionalTrustBundle.kind     |string|Kind of the additionalTrustBundle. Allowed value: `ConfigMap`                     |
 |prismCentral.additionalTrustBundle.name     |string|Name of the `ConfigMap` containing the Prism Central trust bundle.                |
 |prismCentral.additionalTrustBundle.namespace|string|(Optional) Namespace of the `ConfigMap` containing the Prism Central trust bundle.|
+|failureDomains                              |list  |(Optional) Failure domains for the Kubernetes nodes                               |
+|failureDomains.[].name                      |string|Name of the failure domain                                                        |
+|failureDomains.[].cluster                   |object|Reference (name or uuid) to the Prism Element cluster. Name or UUID can be passed |
+|failureDomains.[].cluster.type              |string|Type to identify the Prism Element cluster. Allowed values: `name` and `uuid`     |
+|failureDomains.[].cluster.name              |string|Name of the Prism Element cluster.                                                |
+|failureDomains.[].cluster.uuid              |string|UUID of the Prism Element cluster.                                                |
+|failureDomains.[].subnets                   |list  |(Optional) Reference (name or uuid) to the subnets to be assigned to the VMs.     |
+|failureDomains.[].subnets.[].type           |string|Type to identify the subnet. Allowed values: `name` and `uuid`                    |
+|failureDomains.[].subnets.[].name           |string|Name of the subnet.                                                               |
+|failureDomains.[].subnets.[].uuid           |string|UUID of the subnet.                                                               |
+|failureDomains.[].controlPlane              |bool  |Indicates if a failure domain is suited for control plane nodes
 
 !!! note
     To prevent duplicate IP assignments, it is required to assign an IP-address to the `controlPlaneEndpoint.host` variable that is not part of the Nutanix IPAM or DHCP range assigned to the subnet of the CAPX cluster.
diff --git a/docs/capx/v1.3.x/types/nutanix_machine_template.md b/docs/capx/v1.3.x/types/nutanix_machine_template.md
@@ -60,11 +60,11 @@ The table below provides an overview of the supported parameters of the `spec` a
 |image.type                          |string|Type to identify the OS image. Allowed values: `name` and `uuid`                                        |
 |image.name                          |string|Name of the image.                                                                                      |
 |image.uuid                          |string|UUID of the image.                                                                                      |
-|cluster                             |object|Reference (name or uuid) to the Prism Element cluster. Name or UUID can be passed                       |
+|cluster                             |object|(Optional) Reference (name or uuid) to the Prism Element cluster. Name or UUID can be passed            |
 |cluster.type                        |string|Type to identify the Prism Element cluster. Allowed values: `name` and `uuid`                           |
 |cluster.name                        |string|Name of the Prism Element cluster.                                                                      |
 |cluster.uuid                        |string|UUID of the Prism Element cluster.                                                                      |
-|subnets                             |list  |Reference (name or uuid) to the subnets to be assigned to the VMs.                                      |
+|subnets                             |list  |(Optional) Reference (name or uuid) to the subnets to be assigned to the VMs.                           |
 |subnets.[].type                     |string|Type to identify the subnet. Allowed values: `name` and `uuid`                                          |
 |subnets.[].name                     |string|Name of the subnet.                                                                                     |
 |subnets.[].uuid                     |string|UUID of the subnet.                                                                                     |
@@ -78,4 +78,7 @@ The table below provides an overview of the supported parameters of the `spec` a
 |gpus                                |object|Reference (name or deviceID) to the GPUs to be assigned to the VMs. Can be vGPU or Passthrough.         |
 |gpus.[].type                        |string|Type to identify the GPU. Allowed values: `name` and `deviceID`                                         |
 |gpus.[].name                        |string|Name of the GPU or the vGPU profile                                                                     |
-|gpus.[].deviceID                    |string|DeviceID of the GPU or the vGPU profile                                                                 |
+|gpus.[].deviceID                    |string|DeviceID of the GPU or the vGPU profile                                                                 |
+
+!!! note
+    The `cluster` or `subnets` configuration parameters are optional in case failure domains are defined on the `NutanixCluster` and `MachineDeployment` resources.