first version of failure domain support for CAPX

api/v1alpha4/conditions.go

@@ -30,7 +30,7 @@ const (
 )
 
 const (
-	//PrismCentralClientCondition indicates the status of the client used to connect to Prism Central
+	// PrismCentralClientCondition indicates the status of the client used to connect to Prism Central
 	PrismCentralClientCondition capiv1.ConditionType = "PrismClientInit"
 
 	PrismCentralClientInitializationFailed = "PrismClientInitFailed"

api/v1alpha4/nutanixcluster_types.go

@@ -50,6 +50,14 @@ type NutanixClusterSpec struct {
 	// proxy spec.noProxy list.
 	// +optional
 	PrismCentral *credentialTypes.NutanixPrismEndpoint `json:"prismCentral"`
+
+	// failureDomains configures failure domains information for the Nutanix platform.
+	// When set, the failure domains defined here may be used to spread Machines across
+	// prism element clusters to improve fault tolerance of the cluster.
+	// +listType=map
+	// +listMapKey=name
+	// +optional
+	FailureDomains []NutanixFailureDomain `json:"failureDomains"`
 }
 
 // NutanixClusterStatus defines the observed state of NutanixCluster
@@ -90,6 +98,39 @@ type NutanixCluster struct {
 	Status NutanixClusterStatus `json:"status,omitempty"`
 }
 
+// NutanixFailureDomain configures failure domain information for Nutanix.
+type NutanixFailureDomain struct {
+	// name defines the unique name of a failure domain.
+	// Name is required and must be at most 64 characters in length.
+	// It must consist of only lower case alphanumeric characters and hyphens (-).
+	// It must start and end with an alphanumeric character.
+	// This value is arbitrary and is used to identify the failure domain within the platform.
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=64
+	// +kubebuilder:validation:Pattern=`[a-z0-9]([-a-z0-9]*[a-z0-9])?`
+	Name string `json:"name"`
+
+	// cluster is to identify the cluster (the Prism Element under management of the Prism Central),
+	// in which the Machine's VM will be created. The cluster identifier (uuid or name) can be obtained
+	// from the Prism Central console or using the prism_central API.
+	// +kubebuilder:validation:Required
+	Cluster NutanixResourceIdentifier `json:"cluster"`
+
+	// subnets holds a list of identifiers (one or more) of the cluster's network subnets
+	// for the Machine's VM to connect to. The subnet identifiers (uuid or name) can be
+	// obtained from the Prism Central console or using the prism_central API.
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinItems=1
+	// +listType=map
+	// +listMapKey=type
+	Subnets []NutanixResourceIdentifier `json:"subnets"`
+
+	// indicates if a failure domain is suited for control plane nodes
+	// +kubebuilder:validation:Required
+	ControlPlane bool `json:"controlPlane,omitempty"`
+}
+
 // GetConditions returns the set of conditions for this object.
 func (ncl *NutanixCluster) GetConditions() capiv1.Conditions {
 	return ncl.Status.Conditions

api/v1alpha4/nutanixmachine_types.go

@@ -61,12 +61,12 @@ type NutanixMachineSpec struct {
 	// of the Prism Central), in which the Machine's VM will be created.
 	// The cluster identifier (uuid or name) can be obtained from the Prism Central console
 	// or using the prism_central API.
-	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:Optional
 	Cluster NutanixResourceIdentifier `json:"cluster"`
 	// subnet is to identify the cluster's network subnet to use for the Machine's VM
 	// The cluster identifier (uuid or name) can be obtained from the Prism Central console
 	// or using the prism_central API.
-	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:Optional
 	// +kubebuilder:validation:MinItems=1
 	Subnets []NutanixResourceIdentifier `json:"subnet"`
 	// List of categories that need to be added to the machines. Categories must already exist in Prism Central

api/v1beta1/conditions.go

@@ -22,6 +22,16 @@ const (
 	DeletionFailed = "DeletionFailed"
 )
 
+const (
+	// FailureDomainsReconciled indicates the status of the failure domain reconciliation
+	FailureDomainsReconciled capiv1.ConditionType = "FailureDomainsReconciled"
+
+	// NoFailureDomainsReconciled indicates no failure domains have been defined
+	NoFailureDomainsReconciled capiv1.ConditionType = "NoFailureDomainsReconciled"
+
+	FailureDomainsReconciliationFailed = "FailureDomainsReconciliationFailed"
+)
+
 const (
 	// ClusterCategoryCreatedCondition indicates the status of the category linked to the NutanixCluster
 	ClusterCategoryCreatedCondition capiv1.ConditionType = "ClusterCategoryCreated"

api/v1beta1/nutanixcluster_types.go

@@ -50,6 +50,14 @@ type NutanixClusterSpec struct {
 	// proxy spec.noProxy list.
 	// +optional
 	PrismCentral *credentialTypes.NutanixPrismEndpoint `json:"prismCentral"`
+
+	// failureDomains configures failure domains information for the Nutanix platform.
+	// When set, the failure domains defined here may be used to spread Machines across
+	// prism element clusters to improve fault tolerance of the cluster.
+	// +listType=map
+	// +listMapKey=name
+	// +optional
+	FailureDomains []NutanixFailureDomain `json:"failureDomains"`
 }
 
 // NutanixClusterStatus defines the observed state of NutanixCluster
@@ -91,6 +99,39 @@ type NutanixCluster struct {
 	Status NutanixClusterStatus `json:"status,omitempty"`
 }
 
+// NutanixFailureDomain configures failure domain information for Nutanix.
+type NutanixFailureDomain struct {
+	// name defines the unique name of a failure domain.
+	// Name is required and must be at most 64 characters in length.
+	// It must consist of only lower case alphanumeric characters and hyphens (-).
+	// It must start and end with an alphanumeric character.
+	// This value is arbitrary and is used to identify the failure domain within the platform.
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=64
+	// +kubebuilder:validation:Pattern=`[a-z0-9]([-a-z0-9]*[a-z0-9])?`
+	Name string `json:"name"`
+
+	// cluster is to identify the cluster (the Prism Element under management of the Prism Central),
+	// in which the Machine's VM will be created. The cluster identifier (uuid or name) can be obtained
+	// from the Prism Central console or using the prism_central API.
+	// +kubebuilder:validation:Required
+	Cluster NutanixResourceIdentifier `json:"cluster"`
+
+	// subnets holds a list of identifiers (one or more) of the cluster's network subnets
+	// for the Machine's VM to connect to. The subnet identifiers (uuid or name) can be
+	// obtained from the Prism Central console or using the prism_central API.
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinItems=1
+	// +listType=map
+	// +listMapKey=type
+	Subnets []NutanixResourceIdentifier `json:"subnets"`
+
+	// indicates if a failure domain is suited for control plane nodes
+	// +kubebuilder:validation:Required
+	ControlPlane bool `json:"controlPlane,omitempty"`
+}
+
 // GetConditions returns the set of conditions for this object.
 func (ncl *NutanixCluster) GetConditions() capiv1.Conditions {
 	return ncl.Status.Conditions

api/v1beta1/nutanixmachine_types.go

@@ -61,12 +61,12 @@ type NutanixMachineSpec struct {
 	// of the Prism Central), in which the Machine's VM will be created.
 	// The cluster identifier (uuid or name) can be obtained from the Prism Central console
 	// or using the prism_central API.
-	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:Optional
 	Cluster NutanixResourceIdentifier `json:"cluster"`
 	// subnet is to identify the cluster's network subnet to use for the Machine's VM
 	// The cluster identifier (uuid or name) can be obtained from the Prism Central console
 	// or using the prism_central API.
-	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:Optional
 	// +kubebuilder:validation:MinItems=1
 	Subnets []NutanixResourceIdentifier `json:"subnet"`
 	// List of categories that need to be added to the machines. Categories must already exist in Prism Central