feat: CAREN support for NutanixFailureDomain (#1192)

feature: CAREN support for NutanixFailureDomain

https://jira.nutanix.com/browse/NCN-107137
- add a CAREN Nutanix ClusterClass variable for control plane failure
domains
- refactor NutanixNodeSpec to NutanixControlPlaneNodeSpec and
NutanixWorkerNodeSpec
  - add inject handler for the controlplane failureDomains variable

Added unit tests and did integration test.

---------

Signed-off-by: Yanhua Li <yanhua.li@nutanix.com>
Co-authored-by: Sid Shukla <sid.shukla@nutanix.com>

Author: yanhua121

api/external/github.com/nutanix-cloud-native/cluster-api-provider-nutanix/api/v1beta1/conditions.go

@@ -24,15 +24,25 @@ const (
 	VolumeGroupDetachFailed = "VolumeGroupDetachFailed"
 )
 
+// Conditions and Reasons releated to failure domain
 const (
-	// FailureDomainsReconciled indicates the status of the failure domain reconciliation
-	FailureDomainsReconciled capiv1.ConditionType = "FailureDomainsReconciled"
+	// FailureDomainSafeForDeletionCondition indicates whether the failure domain object is safe for deletion,
+	// ie., when it is not used or referenced by other resources
+	FailureDomainSafeForDeletionCondition capiv1.ConditionType = "FailureDomainSafeForDeletion"
 
-	// NoFailureDomainsReconciled indicates no failure domains have been defined
-	NoFailureDomainsReconciled capiv1.ConditionType = "NoFailureDomainsReconciled"
+	// FailureDomainInUseReason indicates that the failure domain is used by
+	// Machines and/or referenced by cluster
+	FailureDomainInUseReason = "FailureDomainInUse"
 
-	// FailureDomainsReconciliationFailed indicates the failure domain reconciliation failed
-	FailureDomainsReconciliationFailed = "FailureDomainsReconciliationFailed"
+	// NoFailureDomainsConfiguredCondition indicates no failure domains have been configured
+	NoFailureDomainsConfiguredCondition capiv1.ConditionType = "NoFailureDomainsConfigured"
+
+	// FailureDomainsValidatedCondition indicates whether the failure domains are configured correctly or not.
+	FailureDomainsValidatedCondition capiv1.ConditionType = "FailureDomainsValidated"
+
+	// FailureDomainsMisconfiguredReason (Severity=Warning) indicates that some of the failure domains
+	// are misconfigured.
+	FailureDomainsMisconfiguredReason = "FailureDomainsMisconfigured"
 )
 
 const (

api/external/github.com/nutanix-cloud-native/cluster-api-provider-nutanix/api/v1beta1/nutanixcluster_types.go

@@ -24,7 +24,6 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	capiv1 "sigs.k8s.io/cluster-api/api/v1beta1"
-	"sigs.k8s.io/cluster-api/errors"
 )
 
 const (
@@ -34,8 +33,11 @@ const (
 	// NutanixClusterFinalizer allows NutanixClusterReconciler to clean up AHV
 	// resources associated with NutanixCluster before removing it from the
 	// API Server.
-	NutanixClusterFinalizer           = "nutanixcluster.infrastructure.cluster.x-k8s.io"
-	NutanixClusterCredentialFinalizer = "nutanixcluster/infrastructure.cluster.x-k8s.io"
+	NutanixClusterFinalizer           = "infrastructure.cluster.x-k8s.io/nutanixcluster"
+	DeprecatedNutanixClusterFinalizer = "nutanixcluster.infrastructure.cluster.x-k8s.io"
+
+	NutanixClusterCredentialFinalizer           = "infrastructure.cluster.x-k8s.io/nutanixclustercredential"
+	DeprecatedNutanixClusterCredentialFinalizer = "nutanixcluster/infrastructure.cluster.x-k8s.io"
 )
 
 // EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
@@ -64,7 +66,17 @@ type NutanixClusterSpec struct {
 	// +listType=map
 	// +listMapKey=name
 	// +optional
-	FailureDomains []NutanixFailureDomain `json:"failureDomains"`
+	//
+	// Deprecated: This field is replaced by the field controlPlaneFailureDomains and will be removed in the next apiVersion.
+	//
+	FailureDomains []NutanixFailureDomainConfig `json:"failureDomains,omitempty"`
+
+	// controlPlaneFailureDomains configures references to the NutanixFailureDomain objects
+	// that the cluster uses to deploy its control-plane machines.
+	// +listType=map
+	// +listMapKey=name
+	// +optional
+	ControlPlaneFailureDomains []corev1.LocalObjectReference `json:"controlPlaneFailureDomains,omitempty"`
 }
 
 // NutanixClusterStatus defines the observed state of NutanixCluster
@@ -75,6 +87,8 @@ type NutanixClusterStatus struct {
 	// +optional
 	Ready bool `json:"ready,omitempty"`
 
+	// failureDomains are a list of failure domains configured in the
+	// cluster's spec and validated by the cluster controller.
 	FailureDomains capiv1.FailureDomains `json:"failureDomains,omitempty"`
 
 	// Conditions defines current service state of the NutanixCluster.
@@ -83,7 +97,7 @@ type NutanixClusterStatus struct {
 
 	// Will be set in case of failure of Cluster instance
 	// +optional
-	FailureReason *errors.ClusterStatusError `json:"failureReason,omitempty"`
+	FailureReason *string `json:"failureReason,omitempty"`
 
 	// Will be set in case of failure of Cluster instance
 	// +optional
@@ -96,6 +110,7 @@ type NutanixClusterStatus struct {
 // +kubebuilder:storageversion
 // +kubebuilder:printcolumn:name="ControlplaneEndpoint",type="string",JSONPath=".spec.controlPlaneEndpoint.host",description="ControlplaneEndpoint"
 // +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.ready",description="in ready status"
+// +kubebuilder:printcolumn:name="FailureDomains",type="string",JSONPath=".status.failureDomains",description="NutanixCluster FailureDomains"
 
 // NutanixCluster is the Schema for the nutanixclusters API
 type NutanixCluster struct {
@@ -106,8 +121,10 @@ type NutanixCluster struct {
 	Status NutanixClusterStatus `json:"status,omitempty"`
 }
 
-// NutanixFailureDomain configures failure domain information for Nutanix.
-type NutanixFailureDomain struct {
+// NutanixFailureDomainConfig configures failure domain information for Nutanix.
+//
+// Deprecated: This type is replaced by the NutanixFailureDomain CRD type and will be removed in the next apiVersion.
+type NutanixFailureDomainConfig 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 (-).

api/external/github.com/nutanix-cloud-native/cluster-api-provider-nutanix/api/v1beta1/nutanixfailuredomain_types.go

@@ -0,0 +1,90 @@
+/*
+Copyright 2025 Nutanix
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1beta1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	capiv1 "sigs.k8s.io/cluster-api/api/v1beta1"
+)
+
+const (
+	// NutanixFailureDomainKind represents the Kind of NutanixFailureDomain
+	NutanixFailureDomainKind = "NutanixFailureDomain"
+
+	// NutanixFailureDomainFinalizer is the finalizer used by the NutanixFailureDomain controller to block
+	// deletion of the NutanixFailureDomain object if there are references to this object by other resources.
+	NutanixFailureDomainFinalizer = "infrastructure.cluster.x-k8s.io/nutanixfailuredomain"
+)
+
+// NutanixFailureDomainSpec defines the desired state of NutanixFailureDomain.
+type NutanixFailureDomainSpec struct {
+	// prismElementCluster is to identify the Prism Element cluster in the Prism Central for the failure domain.
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="prismElementCluster is immutable once set"
+	// +kubebuilder:validation:Required
+	PrismElementCluster NutanixResourceIdentifier `json:"prismElementCluster"`
+
+	// subnets holds a list of identifiers (one or more) of the PE cluster's network subnets
+	// for the Machine's VM to connect to.
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="subnets is immutable once set"
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinItems=1
+	Subnets []NutanixResourceIdentifier `json:"subnets"`
+}
+
+// NutanixFailureDomainStatus defines the observed state of NutanixFailureDomain resource.
+type NutanixFailureDomainStatus struct {
+	// conditions represent the latest states of the failure domain.
+	// +optional
+	Conditions []capiv1.Condition `json:"conditions,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+// +kubebuilder:resource:path=nutanixfailuredomains,shortName=nfd,scope=Namespaced,categories=cluster-api
+// +kubebuilder:subresource:status
+// +kubebuilder:storageversion
+
+// NutanixFailureDomain is the Schema for the NutanixFailureDomain API.
+type NutanixFailureDomain struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   NutanixFailureDomainSpec   `json:"spec,omitempty"`
+	Status NutanixFailureDomainStatus `json:"status,omitempty"`
+}
+
+// GetConditions returns the set of conditions for this object.
+func (nfd *NutanixFailureDomain) GetConditions() capiv1.Conditions {
+	return nfd.Status.Conditions
+}
+
+// SetConditions sets the conditions on this object.
+func (nfd *NutanixFailureDomain) SetConditions(conditions capiv1.Conditions) {
+	nfd.Status.Conditions = conditions
+}
+
+// +kubebuilder:object:root=true
+
+// NutanixFailureDomainList contains a list of NutanixFailureDomain
+type NutanixFailureDomainList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []NutanixFailureDomain `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&NutanixFailureDomain{}, &NutanixFailureDomainList{})
+}

api/external/github.com/nutanix-cloud-native/cluster-api-provider-nutanix/api/v1beta1/nutanixmachine_types.go

@@ -21,7 +21,6 @@ import (
 	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	capiv1 "sigs.k8s.io/cluster-api/api/v1beta1"
-	"sigs.k8s.io/cluster-api/errors"
 )
 
 // EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
@@ -34,7 +33,8 @@ const (
 	// NutanixMachineFinalizer allows NutanixMachineReconciler to clean up AHV
 	// resources associated with NutanixMachine before removing it from the
 	// API Server.
-	NutanixMachineFinalizer = "nutanixmachine.infrastructure.cluster.x-k8s.io"
+	NutanixMachineFinalizer           = "infrastructure.cluster.x-k8s.io/nutanixmachine"
+	DeprecatedNutanixMachineFinalizer = "nutanixmachine.infrastructure.cluster.x-k8s.io"
 
 	// NutanixMachineBootstrapRefKindSecret represents the Kind of Secret
 	// referenced by NutanixMachine's BootstrapRef.
@@ -270,11 +270,15 @@ type NutanixMachineStatus struct {
 
 	// Will be set in case of failure of Machine instance
 	// +optional
-	FailureReason *errors.MachineStatusError `json:"failureReason,omitempty"`
+	FailureReason *string `json:"failureReason,omitempty"`
 
 	// Will be set in case of failure of Machine instance
 	// +optional
 	FailureMessage *string `json:"failureMessage,omitempty"`
+
+	// failureDomain is the name of the failure domain where this Machine has been placed in.
+	// +optional
+	FailureDomain *string `json:"failureDomain,omitempty"`
 }
 
 // +kubebuilder:object:root=true
@@ -284,6 +288,7 @@ type NutanixMachineStatus struct {
 // +kubebuilder:printcolumn:name="Address",type="string",JSONPath=".status.addresses[0].address",description="The VM address"
 // +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.ready",description="NutanixMachine ready status"
 // +kubebuilder:printcolumn:name="ProviderID",type="string",JSONPath=".spec.providerID",description="NutanixMachine instance ID"
+// +kubebuilder:printcolumn:name="FailureDomain",type="string",JSONPath=".status.failureDomain",description="NutanixMachine FailureDomain"
 // NutanixMachine is the Schema for the nutanixmachines API
 type NutanixMachine struct {
 	metav1.TypeMeta   `json:",inline"`