Merge pull request #28 from IBM/minor-changes

Move Constants At one place, optimisation and removal of duplicates

Author: Bhagyashreek8

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "go.sum|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2024-05-15T04:17:59Z",
+  "generated_at": "2024-06-03T09:31:24Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"

pkg/config/constants.go renamed to controllers/constants/constants.go

@@ -1,20 +1,21 @@
-// Package config ...
-package config
+// Package constants ...
+package constants
+
+import "fmt"
 
-// Add a field here if it never changes, if it changes over time, put it to settings.go
 const (
-	APIGroup        = "objectdriver.csi.ibm.com"
+	APIGroup = "objectdriver.csi.ibm.com"
+
 	APIVersion      = "v1"
 	CSIOperatorName = "ibm-object-csi-driver-operator"
 	CSIDriverName   = "ibm-object-csi-driver"
 	DriverName      = "cos.s3.csi.ibm.io"
-	ProductName     = "ibm-object-csi-driver"
 
 	RbacAuthorizationAPIGroup = "rbac.authorization.k8s.io"
 	SecurityOpenshiftAPIGroup = "security.openshift.io"
 	StorageAPIGroup           = "storage.k8s.io"
 
-	CsiNodesResource                   = "csinodes"
+	CSINodesResource                   = "csinodes"
 	SecretsResource                    = "secrets"
 	SecurityContextConstraintsResource = "securitycontextconstraints"
 	StorageClassesResource             = "storageclasses"
@@ -43,9 +44,43 @@ const (
 	NodeRegistrarSocketPath                               = "/var/lib/kubelet/plugins/cos.s3.csi.ibm.io/csi.sock"
 	CSIEndpoint                                           = "unix:///var/lib/csi/sockets/pluginproxy/csi.sock"
 	CSINodeEndpoint                                       = "unix:///csi/csi.sock"
+	RegistrationVolumeMountPath                           = "/registration"
+
+	NodeContainerName       = "ibm-object-csi-node"
+	ControllerContainerName = "ibm-object-csi-controller"
+
+	RegistrationVolumeName = "registration-dir"
+	PluginVolumeName       = "plugin-dir"
+	SocketVolumeName       = "socket-dir"
+
+	HealthPortName   = "healthz"
+	HealthPortNumber = 9808
+
+	DriverPrefix = "ibm-object-csi"
+
+	CSIController                         = "controller"
+	CSINode                               = "node"
+	CSIControllerServiceAccount           = "controller-sa"
+	CSINodeServiceAccount                 = "node-sa"
+	ExternalProvisionerClusterRole        = "external-provisioner-clusterrole"
+	ExternalProvisionerClusterRoleBinding = "external-provisioner-clusterrolebinding"
+	CSIControllerSCCClusterRole           = "controller-scc-clusterrole"
+	CSIControllerSCCClusterRoleBinding    = "controller-scc-clusterrolebinding"
+	CSINodeSCCClusterRole                 = "node-scc-clusterrole"
+	CSINodeSCCClusterRoleBinding          = "node-scc-clusterrolebinding"
+
+	RcloneRetainStorageClass = "ibm-object-storage-rclone-retain-sc"
+	RcloneStorageClass       = "ibm-object-storage-rclone-sc"
+	S3fsRetainStorageClass   = "ibm-object-storage-s3fs-retain-sc"
+	S3fsStorageClass         = "ibm-object-storage-s3fs-sc"
 )
 
 var CommonCSIResourceLabels = map[string]string{
 	"app.kubernetes.io/part-of":    CSIDriverName,
 	"app.kubernetes.io/managed-by": CSIOperatorName,
 }
+
+// GetResourceName returns the name of a resource for a CSI driver
+func GetResourceName(name string) string {
+	return fmt.Sprintf("%s-%s", DriverPrefix, name)
+}

controllers/ibmobjectcsi_controller.go

@@ -25,10 +25,10 @@ import (
 	"time"
 
 	objectdriverv1alpha1 "github.com/IBM/ibm-object-csi-driver-operator/api/v1alpha1"
+	"github.com/IBM/ibm-object-csi-driver-operator/controllers/constants"
 	crutils "github.com/IBM/ibm-object-csi-driver-operator/controllers/internal/crutils"
 	clustersyncer "github.com/IBM/ibm-object-csi-driver-operator/controllers/syncer"
 	"github.com/IBM/ibm-object-csi-driver-operator/controllers/util/common"
-	oconfig "github.com/IBM/ibm-object-csi-driver-operator/pkg/config"
 	oversion "github.com/IBM/ibm-object-csi-driver-operator/version"
 	"github.com/go-logr/logr"
 	"github.com/presslabs/controller-util/pkg/syncer"
@@ -48,9 +48,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 )
 
-// ReconcileTime is the delay between reconciliations
-const ReconcileTime = 30 * time.Second
-
 type reconciler func(instance *crutils.IBMObjectCSI) error
 
 var csiLog = logf.Log.WithName("ibmobjectcsi_controller")
@@ -282,7 +279,7 @@ func (r *IBMObjectCSIReconciler) isNodeReady(node *appsv1.DaemonSet) bool {
 func (r *IBMObjectCSIReconciler) getNodeDaemonSet(instance *crutils.IBMObjectCSI) (*appsv1.DaemonSet, error) {
 	node := &appsv1.DaemonSet{}
 	err := r.Get(context.TODO(), types.NamespacedName{
-		Name:      oconfig.GetNameForResource(oconfig.CSINode, oconfig.DriverPrefix),
+		Name:      constants.GetResourceName(constants.CSINode),
 		Namespace: instance.Namespace,
 	}, node)
 	return node, err
@@ -291,7 +288,7 @@ func (r *IBMObjectCSIReconciler) getNodeDaemonSet(instance *crutils.IBMObjectCSI
 func (r *IBMObjectCSIReconciler) getControllerDeployment(instance *crutils.IBMObjectCSI) (*appsv1.Deployment, error) {
 	controllerDeployment := &appsv1.Deployment{}
 	err := r.Get(context.TODO(), types.NamespacedName{
-		Name:      oconfig.GetNameForResource(oconfig.CSIController, oconfig.DriverPrefix),
+		Name:      constants.GetResourceName(constants.CSIController),
 		Namespace: instance.Namespace,
 	}, controllerDeployment)
 	return controllerDeployment, err
@@ -318,8 +315,8 @@ func (r *IBMObjectCSIReconciler) reconcileServiceAccount(instance *crutils.IBMOb
 	controller := instance.GenerateControllerServiceAccount()
 	node := instance.GenerateNodeServiceAccount()
 
-	controllerServiceAccountName := oconfig.GetNameForResource(oconfig.CSIControllerServiceAccount, oconfig.DriverPrefix)
-	nodeServiceAccountName := oconfig.GetNameForResource(oconfig.CSINodeServiceAccount, oconfig.DriverPrefix)
+	controllerServiceAccountName := constants.GetResourceName(constants.CSIControllerServiceAccount)
+	nodeServiceAccountName := constants.GetResourceName(constants.CSINodeServiceAccount)
 
 	for _, sa := range []*corev1.ServiceAccount{
 		controller,
@@ -373,7 +370,7 @@ func (r *IBMObjectCSIReconciler) reconcileServiceAccount(instance *crutils.IBMOb
 }
 
 func (r *IBMObjectCSIReconciler) rolloutRestartNode(node *appsv1.DaemonSet) error {
-	restartedAt := fmt.Sprintf("%s/restartedAt", oconfig.APIGroup)
+	restartedAt := fmt.Sprintf("%s/restartedAt", constants.APIGroup)
 	timestamp := time.Now().String()
 	node.Spec.Template.ObjectMeta.Annotations[restartedAt] = timestamp
 	return r.Update(context.TODO(), node)
@@ -472,11 +469,11 @@ func (r *IBMObjectCSIReconciler) getClusterRoleBindings(instance *crutils.IBMObj
 }
 
 func (r *IBMObjectCSIReconciler) getStorageClasses(instance *crutils.IBMObjectCSI) []*storagev1.StorageClass {
-	rcloneRetainSC := instance.GenerateRcloneSC(oconfig.RcloneRetainStorageClass, corev1.PersistentVolumeReclaimRetain)
-	rcloneSC := instance.GenerateRcloneSC(oconfig.RcloneStorageClass, corev1.PersistentVolumeReclaimDelete)
+	rcloneRetainSC := instance.GenerateRcloneSC(constants.RcloneRetainStorageClass, corev1.PersistentVolumeReclaimRetain)
+	rcloneSC := instance.GenerateRcloneSC(constants.RcloneStorageClass, corev1.PersistentVolumeReclaimDelete)
 
-	s3fsRetainSC := instance.GenerateS3fsSC(oconfig.S3fsRetainStorageClass, corev1.PersistentVolumeReclaimRetain)
-	s3fsSC := instance.GenerateS3fsSC(oconfig.S3fsStorageClass, corev1.PersistentVolumeReclaimDelete)
+	s3fsRetainSC := instance.GenerateS3fsSC(constants.S3fsRetainStorageClass, corev1.PersistentVolumeReclaimRetain)
+	s3fsSC := instance.GenerateS3fsSC(constants.S3fsStorageClass, corev1.PersistentVolumeReclaimDelete)
 
 	return []*storagev1.StorageClass{
 		rcloneRetainSC,