feat(preflight): Storage container checks for Nutanix (#1136)

thunderboltsid · dlipovetsky · web-flow · commit 3ef53dcb09f1 · 2025-06-23T09:45:07.000-07:00
Add pre-flight checks to ensure the storage container mentioned in CSI
Provider storage class config parameters is present in all relevant AOS
clusters i.e. control plane and workers.

---------

Co-authored-by: Daniel Lipovetsky &lt;daniel.lipovetsky@nutanix.com&gt;
Co-authored-by: Daniel Lipovetsky &lt;daniel.lipovetsky@gmail.com&gt;
diff --git a/pkg/webhook/preflight/nutanix/checker.go b/pkg/webhook/preflight/nutanix/checker.go
@@ -18,9 +18,10 @@ import (
 )
 
 var Checker = &nutanixChecker{
-	configurationCheckFactory: newConfigurationCheck,
-	credentialsCheckFactory:   newCredentialsCheck,
-	vmImageChecksFactory:      newVMImageChecks,
+	configurationCheckFactory:     newConfigurationCheck,
+	credentialsCheckFactory:       newCredentialsCheck,
+	vmImageChecksFactory:          newVMImageChecks,
+	storageContainerChecksFactory: newStorageContainerChecks,
 }
 
 type nutanixChecker struct {
@@ -37,6 +38,10 @@ type nutanixChecker struct {
 	vmImageChecksFactory func(
 		cd *checkDependencies,
 	) []preflight.Check
+
+	storageContainerChecksFactory func(
+		cd *checkDependencies,
+	) []preflight.Check
 }
 
 type checkDependencies struct {
@@ -69,6 +74,7 @@ func (n *nutanixChecker) Init(
 	}
 
 	checks = append(checks, n.vmImageChecksFactory(cd)...)
+	checks = append(checks, n.storageContainerChecksFactory(cd)...)
 
 	// Add more checks here as needed.
 
diff --git a/pkg/webhook/preflight/nutanix/checker_test.go b/pkg/webhook/preflight/nutanix/checker_test.go
@@ -33,22 +33,24 @@ func (m *mockCheck) Run(ctx context.Context) preflight.CheckResult {
 
 func TestNutanixChecker_Init(t *testing.T) {
 	tests := []struct {
-		name                    string
-		nutanixConfig           *carenv1.NutanixClusterConfigSpec
-		workerNodeConfigs       map[string]*carenv1.NutanixWorkerNodeConfigSpec
-		expectedCheckCount      int
-		expectedFirstCheckName  string
-		expectedSecondCheckName string
-		vmImageCheckCount       int
+		name                       string
+		nutanixConfig              *carenv1.NutanixClusterConfigSpec
+		workerNodeConfigs          map[string]*carenv1.NutanixWorkerNodeConfigSpec
+		expectedCheckCount         int
+		expectedFirstCheckName     string
+		expectedSecondCheckName    string
+		vmImageCheckCount          int
+		storageContainerCheckCount int
 	}{
 		{
-			name:                    "basic initialization with no configs",
-			nutanixConfig:           nil,
-			workerNodeConfigs:       nil,
-			expectedCheckCount:      2, // config check and credentials check
-			expectedFirstCheckName:  "NutanixConfiguration",
-			expectedSecondCheckName: "NutanixCredentials",
-			vmImageCheckCount:       0,
+			name:                       "basic initialization with no configs",
+			nutanixConfig:              nil,
+			workerNodeConfigs:          nil,
+			expectedCheckCount:         2, // config check and credentials check
+			expectedFirstCheckName:     "NutanixConfiguration",
+			expectedSecondCheckName:    "NutanixCredentials",
+			vmImageCheckCount:          0,
+			storageContainerCheckCount: 0,
 		},
 		{
 			name: "initialization with control plane config",
@@ -57,11 +59,12 @@ func TestNutanixChecker_Init(t *testing.T) {
 					Nutanix: &carenv1.NutanixNodeSpec{},
 				},
 			},
-			workerNodeConfigs:       nil,
-			expectedCheckCount:      3, // config check, credentials check, 1 VM image check
-			expectedFirstCheckName:  "NutanixConfiguration",
-			expectedSecondCheckName: "NutanixCredentials",
-			vmImageCheckCount:       1,
+			workerNodeConfigs:          nil,
+			expectedCheckCount:         4, // config check, credentials check, 1 VM image check, 1 storage container check
+			expectedFirstCheckName:     "NutanixConfiguration",
+			expectedSecondCheckName:    "NutanixCredentials",
+			vmImageCheckCount:          1,
+			storageContainerCheckCount: 1,
 		},
 		{
 			name:          "initialization with worker node configs",
@@ -74,10 +77,11 @@ func TestNutanixChecker_Init(t *testing.T) {
 					Nutanix: &carenv1.NutanixNodeSpec{},
 				},
 			},
-			expectedCheckCount:      4, // config check, credentials check, 2 VM image checks
-			expectedFirstCheckName:  "NutanixConfiguration",
-			expectedSecondCheckName: "NutanixCredentials",
-			vmImageCheckCount:       2,
+			expectedCheckCount:         6, // config check, credentials check, 2 VM image checks, 2 storage container checks
+			expectedFirstCheckName:     "NutanixConfiguration",
+			expectedSecondCheckName:    "NutanixCredentials",
+			vmImageCheckCount:          2,
+			storageContainerCheckCount: 2,
 		},
 		{
 			name: "initialization with both control plane and worker node configs",
@@ -91,10 +95,12 @@ func TestNutanixChecker_Init(t *testing.T) {
 					Nutanix: &carenv1.NutanixNodeSpec{},
 				},
 			},
-			expectedCheckCount:      4, // config check, credentials check, 2 VM image checks (1 CP + 1 worker)
-			expectedFirstCheckName:  "NutanixConfiguration",
-			expectedSecondCheckName: "NutanixCredentials",
-			vmImageCheckCount:       2,
+			// config check, credentials check, 2 VM image checks (1 CP + 1 worker), 2 storage container checks (1 CP + 1 worker)
+			expectedCheckCount:         6,
+			expectedFirstCheckName:     "NutanixConfiguration",
+			expectedSecondCheckName:    "NutanixCredentials",
+			vmImageCheckCount:          2,
+			storageContainerCheckCount: 2,
 		},
 	}
 
@@ -107,6 +113,7 @@ func TestNutanixChecker_Init(t *testing.T) {
 			configCheckCalled := false
 			credsCheckCalled := false
 			vmImageCheckCount := 0
+			storageContainerCheckCount := 0
 
 			checker.configurationCheckFactory = func(cd *checkDependencies) preflight.Check {
 				configCheckCalled = true
@@ -144,6 +151,22 @@ func TestNutanixChecker_Init(t *testing.T) {
 				return checks
 			}
 
+			checker.storageContainerChecksFactory = func(cd *checkDependencies) []preflight.Check {
+				checks := []preflight.Check{}
+				for i := 0; i < tt.storageContainerCheckCount; i++ {
+					storageContainerCheckCount++
+					checks = append(checks,
+						&mockCheck{
+							name: fmt.Sprintf("NutanixStorageContainer-%d", i),
+							result: preflight.CheckResult{
+								Allowed: true,
+							},
+						},
+					)
+				}
+				return checks
+			}
+
 			// Call Init
 			ctx := context.Background()
 			checks := checker.Init(ctx, nil, &clusterv1.Cluster{
@@ -160,6 +183,12 @@ func TestNutanixChecker_Init(t *testing.T) {
 			assert.True(t, configCheckCalled, "initNutanixConfiguration should have been called")
 			assert.True(t, credsCheckCalled, "initCredentialsCheck should have been called")
 			assert.Equal(t, tt.vmImageCheckCount, vmImageCheckCount, "Wrong number of VM image checks")
+			assert.Equal(
+				t,
+				tt.storageContainerCheckCount,
+				storageContainerCheckCount,
+				"Wrong number of storage container checks",
+			)
 
 			// Verify the first two checks when we have results
 			if len(checks) >= 2 {
diff --git a/pkg/webhook/preflight/nutanix/clients.go b/pkg/webhook/preflight/nutanix/clients.go
@@ -7,6 +7,7 @@ import (
 	"context"
 	"fmt"
 
+	clustermgmtv4 "github.com/nutanix/ntnx-api-golang-clients/clustermgmt-go-client/v4/models/clustermgmt/v4/config"
 	vmmv4 "github.com/nutanix/ntnx-api-golang-clients/vmm-go-client/v4/models/vmm/v4/content"
 
 	prismgoclient "github.com/nutanix-cloud-native/prism-go-client"
@@ -29,6 +30,24 @@ type client interface {
 		*vmmv4.ListImagesApiResponse,
 		error,
 	)
+	GetClusterById(id *string) (*clustermgmtv4.GetClusterApiResponse, error)
+	ListClusters(
+		page_ *int,
+		limit_ *int,
+		filter_ *string,
+		orderby_ *string,
+		apply_ *string,
+		select_ *string,
+		args ...map[string]interface{},
+	) (*clustermgmtv4.ListClustersApiResponse, error)
+	ListStorageContainers(
+		page_ *int,
+		limit_ *int,
+		filter_ *string,
+		orderby_ *string,
+		select_ *string,
+		args ...map[string]interface{},
+	) (*clustermgmtv4.ListStorageContainersApiResponse, error)
 }
 
 // clientWrapper implements the client interface and wraps both v3 and v4 clients.
@@ -90,3 +109,57 @@ func (c *clientWrapper) ListImages(page_ *int,
 	}
 	return resp, nil
 }
+
+func (c *clientWrapper) GetClusterById(id *string) (*clustermgmtv4.GetClusterApiResponse, error) {
+	resp, err := c.v4client.ClustersApiInstance.GetClusterById(id)
+	if err != nil {
+		return nil, err
+	}
+	return resp, nil
+}
+
+func (c *clientWrapper) ListClusters(
+	page_ *int,
+	limit_ *int,
+	filter_ *string,
+	orderby_ *string,
+	apply_ *string,
+	select_ *string,
+	args ...map[string]interface{},
+) (*clustermgmtv4.ListClustersApiResponse, error) {
+	resp, err := c.v4client.ClustersApiInstance.ListClusters(
+		page_,
+		limit_,
+		filter_,
+		orderby_,
+		apply_,
+		select_,
+		args...,
+	)
+	if err != nil {
+		return nil, err
+	}
+	return resp, nil
+}
+
+func (c *clientWrapper) ListStorageContainers(
+	page_ *int,
+	limit_ *int,
+	filter_ *string,
+	orderby_ *string,
+	select_ *string,
+	args ...map[string]interface{},
+) (*clustermgmtv4.ListStorageContainersApiResponse, error) {
+	resp, err := c.v4client.StorageContainerAPI.ListStorageContainers(
+		page_,
+		limit_,
+		filter_,
+		orderby_,
+		select_,
+		args...,
+	)
+	if err != nil {
+		return nil, err
+	}
+	return resp, nil
+}
diff --git a/pkg/webhook/preflight/nutanix/clients_test.go b/pkg/webhook/preflight/nutanix/clients_test.go
@@ -6,6 +6,7 @@ package nutanix
 import (
 	"context"
 
+	clustermgmtv4 "github.com/nutanix/ntnx-api-golang-clients/clustermgmt-go-client/v4/models/clustermgmt/v4/config"
 	vmmv4 "github.com/nutanix/ntnx-api-golang-clients/vmm-go-client/v4/models/vmm/v4/content"
 
 	prismv3 "github.com/nutanix-cloud-native/prism-go-client/v3"
@@ -35,6 +36,27 @@ type mocknclient struct {
 		*vmmv4.ListImagesApiResponse,
 		error,
 	)
+
+	getClusterByIdFunc func(id *string) (*clustermgmtv4.GetClusterApiResponse, error)
+
+	listClustersFunc func(
+		page,
+		limit *int,
+		filter,
+		orderby,
+		apply,
+		select_ *string,
+		args ...map[string]interface{},
+	) (*clustermgmtv4.ListClustersApiResponse, error)
+
+	listStorageContainersFunc func(
+		page,
+		limit *int,
+		filter,
+		orderby,
+		select_ *string,
+		args ...map[string]interface{},
+	) (*clustermgmtv4.ListStorageContainersApiResponse, error)
 }
 
 func (m *mocknclient) GetCurrentLoggedInUser(ctx context.Context) (*prismv3.UserIntentResponse, error) {
@@ -52,3 +74,23 @@ func (m *mocknclient) ListImages(
 ) (*vmmv4.ListImagesApiResponse, error) {
 	return m.listImagesFunc(page, limit, filter, orderby, select_)
 }
+
+func (m *mocknclient) GetClusterById(id *string) (*clustermgmtv4.GetClusterApiResponse, error) {
+	return m.getClusterByIdFunc(id)
+}
+
+func (m *mocknclient) ListClusters(
+	page, limit *int,
+	filter, orderby, apply, select_ *string,
+	args ...map[string]interface{},
+) (*clustermgmtv4.ListClustersApiResponse, error) {
+	return m.listClustersFunc(page, limit, filter, orderby, apply, select_, args...)
+}
+
+func (m *mocknclient) ListStorageContainers(
+	page, limit *int,
+	filter, orderby, select_ *string,
+	args ...map[string]interface{},
+) (*clustermgmtv4.ListStorageContainersApiResponse, error) {
+	return m.listStorageContainersFunc(page, limit, filter, orderby, select_, args...)
+}
diff --git a/pkg/webhook/preflight/nutanix/storagecontainer.go b/pkg/webhook/preflight/nutanix/storagecontainer.go
diff --git a/pkg/webhook/preflight/nutanix/storagecontainer_test.go b/pkg/webhook/preflight/nutanix/storagecontainer_test.go
