Implement Trident resource monitor for auto configuring backends

Author: Utkarshjh

frontend/csi/controller_helpers/kubernetes/config.go

@@ -70,9 +70,11 @@ const (
 	AnnLUKSEncryption           = prefix + "/luksEncryption" // import only
 	AnnSkipRecoveryQueue        = prefix + "/skipRecoveryQueue"
 	AnnSelector                 = prefix + "/selector"
+	AnnAdditionalStoragePools   = prefix + "/additionalStoragePools"
 	AnnSMBShareAdUserPermission = prefix + "/smbShareAdUserPermission"
 	AnnSMBShareAdUser           = prefix + "/smbShareAdUser"
 	AnnSMBShareAccessControl    = prefix + "/smbShareAccessControl"
+	AnnConfiguratorStatus       = prefix + "/configuratorStatus"
 
 	// Pod remediation policy annotation and values
 	AnnPodRemediationPolicyAnnotation = prefix + "/podRemediationPolicy"

frontend/csi/controller_helpers/kubernetes/plugin.go

@@ -1006,6 +1006,14 @@ func (h *helper) processStorageClass(ctx context.Context, sc *k8sstoragev1.Stora
 	scConfig.Name = sc.Name
 	scConfig.Attributes = make(map[string]storageattribute.Request)
 
+	// Check if configuratorStatus annotation is present. It suggests the SC is managed by a TridentConfigurator.
+	// We might encounter initial unknown parameters errors but once we see the configuratorStatus annotation,
+	// we know the SC is managed by a TridentConfigurator and we can ignore the unknown parameters.
+	ignoreUnknownParamErrors := false
+	if _, exists := sc.ObjectMeta.Annotations[AnnConfiguratorStatus]; exists {
+		ignoreUnknownParamErrors = true
+	}
+
 	// Populate storage class config attributes and backend storage pools
 	for k, v := range sc.Parameters {
 
@@ -1048,6 +1056,9 @@ func (h *helper) processStorageClass(ctx context.Context, sc *k8sstoragev1.Stora
 			// format:  attribute: "value"
 			req, err := storageattribute.CreateAttributeRequestFromAttributeValue(newKey, v)
 			if err != nil {
+				if ignoreUnknownParamErrors {
+					continue
+				}
 				Logc(ctx).WithFields(logFields).WithError(err).Errorf(
 					"K8S helper could not process the storage class attribute %s", newKey)
 				return
@@ -1057,6 +1068,7 @@ func (h *helper) processStorageClass(ctx context.Context, sc *k8sstoragev1.Stora
 	}
 
 	// To allow for atomic selector updates, replace selector with an annotation if it exists
+	// Also allow additionalStoragePools to be overridden via annotation
 	for k, v := range sc.ObjectMeta.Annotations {
 		if k == AnnSelector {
 			req, err := storageattribute.CreateAttributeRequestFromAttributeValue("selector", v)
@@ -1067,6 +1079,18 @@ func (h *helper) processStorageClass(ctx context.Context, sc *k8sstoragev1.Stora
 			}
 			scConfig.Attributes["selector"] = req
 		}
+		if k == AnnAdditionalStoragePools {
+			// Override additionalStoragePools parameter with annotation value
+			additionalPools, err := storageattribute.CreateBackendStoragePoolsMapFromEncodedString(v)
+			if err != nil {
+				Logc(ctx).WithFields(logFields).WithField(k, v).WithError(err).Errorf(
+					"K8S helper could not process the storage class annotation %s.", k)
+				continue
+			}
+			scConfig.AdditionalPools = additionalPools
+			Logc(ctx).WithFields(logFields).WithField("additionalStoragePools", v).
+				Debug("Using additionalStoragePools from annotation to override parameter")
+		}
 	}
 
 	if update {

mocks/mock_operator/mock_clients/mock_api.go

@@ -66,3 +66,10 @@ func (oc *OperatorCRDClient) UpdateTridentConfiguratorStatus(
 
 	return newTconfCR, true, nil
 }
+
+// UpdateTridentConfigurator updates the TridentConfigurator CR (metadata/spec, not status)
+func (oc *OperatorCRDClient) UpdateTridentConfigurator(tconfCR *operatorV1.TridentConfigurator) error {
+	_, err := oc.client.TridentV1().TridentConfigurators().Update(ctx, tconfCR, updateOpts)
+
+	return err
+}

mocks/mock_operator/mock_controllers/mock_configurator/mock_clients/mock_api.go

@@ -45,3 +45,23 @@ func (tc *TridentCRDClient) DeleteTridentBackendConfig(name, namespace string) e
 func (tc *TridentCRDClient) ListTridentBackend(namespace string) (*tridentV1.TridentBackendList, error) {
 	return tc.client.TridentV1().TridentBackends(namespace).List(ctx, listOpts)
 }
+
+// ListTridentBackendsByLabel lists TridentBackendConfigs with a specific label.
+// It is useful for cleaning up associated backends when a TridentConfigurator is deleted.
+func (tc *TridentCRDClient) ListTridentBackendsByLabel(namespace, labelKey, labelValue string) ([]*tridentV1.TridentBackendConfig, error) {
+	labelSelector := metav1.LabelSelector{
+		MatchLabels: map[string]string{
+			labelKey: labelValue,
+		},
+	}
+	listOptions := metav1.ListOptions{
+		LabelSelector: metav1.FormatLabelSelector(&labelSelector),
+	}
+
+	backendList, err := tc.client.TridentV1().TridentBackendConfigs(namespace).List(ctx, listOptions)
+	if err != nil {
+		return nil, err
+	}
+
+	return backendList.Items, nil
+}

operator/clients/operator_crd.go

@@ -33,12 +33,14 @@ type OperatorCRDClientInterface interface {
 	UpdateTridentConfiguratorStatus(
 		tconfCR *operatorV1.TridentConfigurator, newStatus operatorV1.TridentConfiguratorStatus,
 	) (*operatorV1.TridentConfigurator, bool, error)
+	UpdateTridentConfigurator(tconfCR *operatorV1.TridentConfigurator) error
 }
 
 type TridentCRDClientInterface interface {
 	CheckTridentBackendConfigExists(name, namespace string) (bool, error)
 	GetTridentBackendConfig(name, namespace string) (*tridentV1.TridentBackendConfig, error)
 	ListTridentBackend(namespace string) (*tridentV1.TridentBackendList, error)
+	ListTridentBackendsByLabel(namespace, labelKey, labelValue string) ([]*tridentV1.TridentBackendConfig, error)
 	PatchTridentBackendConfig(name, namespace string, patchBytes []byte, patchType types.PatchType) error
 	DeleteTridentBackendConfig(name, namespace string) error
 }

operator/clients/trident_crd.go

@@ -229,3 +229,27 @@ func (c *ConfiguratorClient) GetANFSecrets(secretName string) (string, string, e
 
 	return clientID, clientSecret, nil
 }
+
+// UpdateTridentConfigurator updates the TridentConfigurator CR
+func (c *ConfiguratorClient) UpdateTridentConfigurator(tconfCR *operatorV1.TridentConfigurator) error {
+	return c.oClient.UpdateTridentConfigurator(tconfCR)
+}
+
+// ListTridentBackendsByLabel lists TridentBackends with a specific label
+func (c *ConfiguratorClient) ListTridentBackendsByLabel(namespace, labelKey, labelValue string) ([]*tridentV1.TridentBackendConfig, error) {
+	return c.tClient.ListTridentBackendsByLabel(namespace, labelKey, labelValue)
+}
+
+// ListStorageClassesByLabel lists StorageClasses with a specific label
+func (c *ConfiguratorClient) ListStorageClassesByLabel(labelKey, labelValue string) ([]string, error) {
+	scList, err := c.kClient.ListStorageClassesByLabel(labelKey, labelValue)
+	if err != nil {
+		return nil, err
+	}
+
+	names := make([]string, 0, len(scList.Items))
+	for _, sc := range scList.Items {
+		names = append(names, sc.Name)
+	}
+	return names, nil
+}

operator/clients/types.go

@@ -69,3 +69,10 @@ func (kc *K8sClient) PatchStorageClass(name string, patchBytes []byte, patchType
 func (kc *K8sClient) DeleteStorageClass(name string) error {
 	return kc.KubeClient.StorageV1().StorageClasses().Delete(ctx, name, deleteOpts)
 }
+
+func (kc *K8sClient) ListStorageClassesByLabel(labelKey, labelValue string) (*v1.StorageClassList, error) {
+	labelSelector := fmt.Sprintf("%s=%s", labelKey, labelValue)
+	return kc.KubeClient.StorageV1().StorageClasses().List(ctx, metav1.ListOptions{
+		LabelSelector: labelSelector,
+	})
+}

operator/controllers/configurator/clients/configurator.go

@@ -12,6 +12,7 @@ import (
 
 	k8sclient "github.com/netapp/trident/cli/k8s_client"
 	operatorV1 "github.com/netapp/trident/operator/crd/apis/netapp/v1"
+	tridentV1 "github.com/netapp/trident/persistent_store/crd/apis/netapp/v1"
 )
 
 //go:generate mockgen -destination=../../../../mocks/mock_operator/mock_controllers/mock_configurator/mock_clients/mock_api.go github.com/netapp/trident/operator/controllers/configurator/clients ConfiguratorClientInterface,ExtendedK8sClientInterface
@@ -44,11 +45,14 @@ type ConfiguratorClientInterface interface {
 	UpdateTridentConfiguratorStatus(
 		tconfCR *operatorV1.TridentConfigurator, newStatus operatorV1.TridentConfiguratorStatus,
 	) (*operatorV1.TridentConfigurator, bool, error)
+	UpdateTridentConfigurator(tconfCR *operatorV1.TridentConfigurator) error
 	GetControllingTorcCR() (*operatorV1.TridentOrchestrator, error)
 	GetTconfCR(name string) (*operatorV1.TridentConfigurator, error)
 	GetANFSecrets(secretName string) (string, string, error)
 	DeleteObject(objType ObjectType, objName, objNamespace string) error
 	ListObjects(objType ObjectType, objNamespace string) (interface{}, error)
+	ListTridentBackendsByLabel(namespace, labelKey, labelValue string) ([]*tridentV1.TridentBackendConfig, error)
+	ListStorageClassesByLabel(labelKey, labelValue string) ([]string, error)
 }
 
 type ExtendedK8sClientInterface interface {
@@ -58,4 +62,5 @@ type ExtendedK8sClientInterface interface {
 	GetStorageClass(name string) (*v1.StorageClass, error)
 	PatchStorageClass(name string, patchBytes []byte, patchType types.PatchType) error
 	DeleteStorageClass(name string) error
+	ListStorageClassesByLabel(labelKey, labelValue string) (*v1.StorageClassList, error)
 }