Merge pull request #25 from IBM/add-labels

ashimagarg27 · web-flow · commit f93458c66452 · 2024-05-16T14:20:29.000+05:30
Add labels in all resources
diff --git a/.secrets.baseline b/.secrets.baseline
@@ -3,7 +3,7 @@
     "files": "go.sum|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2024-05-13T06:55:58Z",
+  "generated_at": "2024-05-15T04:17:59Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
diff --git a/Makefile b/Makefile
@@ -107,7 +107,11 @@ vet: ## Run go vet against code.
 
 .PHONY: test
 test: manifests generate fmt vet envtest ## Run tests.
-	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./... -coverprofile cover.out
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" 
+	go test -coverprofile=coverage.out ./...
+
+coverage: test
+	cat coverage.out | grep -v /controllers/fake/ > cover.out;  go tool cover -html=cover.out
 
 ##@ Build
 
diff --git a/config/crd/kustomization.yaml b/config/crd/kustomization.yaml
@@ -22,3 +22,7 @@ patchesStrategicMerge:
 # the following config is for teaching kustomize how to do kustomization for CRDs.
 configurations:
 - kustomizeconfig.yaml
+
+commonLabels:
+  app.kubernetes.io/part-of: ibm-object-csi-driver-operator
+  app.kubernetes.io/managed-by: kustomize
diff --git a/config/default/kustomization.yaml b/config/default/kustomization.yaml
@@ -70,3 +70,7 @@ vars:
 #    kind: Service
 #    version: v1
 #    name: webhook-service
+
+commonLabels:
+  app.kubernetes.io/part-of: ibm-object-csi-driver-operator
+  app.kubernetes.io/managed-by: kustomize
diff --git a/config/manager/kustomization.yaml b/config/manager/kustomization.yaml
@@ -6,3 +6,6 @@ images:
 - name: controller
   newName: icr.io/ibm/ibm-object-csi-driver-operator
   newTag: v1.0.4-alpha
+commonLabels:
+  app.kubernetes.io/part-of: ibm-object-csi-driver-operator
+  app.kubernetes.io/managed-by: kustomize
diff --git a/config/manager/manager.yaml b/config/manager/manager.yaml
@@ -7,8 +7,6 @@ metadata:
     app.kubernetes.io/instance: system
     app.kubernetes.io/component: manager
     app.kubernetes.io/created-by: ibm-object-csi-driver-operator
-    app.kubernetes.io/part-of: ibm-object-csi-driver-operator
-    app.kubernetes.io/managed-by: kustomize
   name: system
 ---
 apiVersion: apps/v1
@@ -22,8 +20,6 @@ metadata:
     app.kubernetes.io/instance: controller-manager
     app.kubernetes.io/component: manager
     app.kubernetes.io/created-by: ibm-object-csi-driver-operator
-    app.kubernetes.io/part-of: ibm-object-csi-driver-operator
-    app.kubernetes.io/managed-by: kustomize
 spec:
   selector:
     matchLabels:
diff --git a/config/manifests/kustomization.yaml b/config/manifests/kustomization.yaml
@@ -6,6 +6,10 @@ resources:
 - ../samples
 - ../scorecard
 
+commonLabels:
+  app.kubernetes.io/part-of: ibm-object-csi-driver-operator
+  app.kubernetes.io/managed-by: kustomize
+
 # [WEBHOOK] To enable webhooks, uncomment all the sections with [WEBHOOK] prefix.
 # Do NOT uncomment sections with prefix [CERTMANAGER], as OLM does not support cert-manager.
 # These patches remove the unnecessary "cert" volume and its manager container volumeMount.
diff --git a/config/prometheus/kustomization.yaml b/config/prometheus/kustomization.yaml
@@ -1,2 +1,5 @@
 resources:
 - monitor.yaml
+commonLabels:
+  app.kubernetes.io/part-of: ibm-object-csi-driver-operator
+  app.kubernetes.io/managed-by: kustomize
diff --git a/config/prometheus/monitor.yaml b/config/prometheus/monitor.yaml
@@ -9,8 +9,6 @@ metadata:
     app.kubernetes.io/instance: controller-manager-metrics-monitor
     app.kubernetes.io/component: metrics
     app.kubernetes.io/created-by: ibm-object-csi-driver-operator
-    app.kubernetes.io/part-of: ibm-object-csi-driver-operator
-    app.kubernetes.io/managed-by: kustomize
   name: controller-manager-metrics-monitor
   namespace: system
 spec:
diff --git a/config/rbac/auth_proxy_client_clusterrole.yaml b/config/rbac/auth_proxy_client_clusterrole.yaml
@@ -6,8 +6,6 @@ metadata:
     app.kubernetes.io/instance: metrics-reader
     app.kubernetes.io/component: kube-rbac-proxy
     app.kubernetes.io/created-by: ibm-object-csi-driver-operator
-    app.kubernetes.io/part-of: ibm-object-csi-driver-operator
-    app.kubernetes.io/managed-by: kustomize
   name: metrics-reader
 rules:
 - nonResourceURLs:
diff --git a/config/rbac/auth_proxy_role.yaml b/config/rbac/auth_proxy_role.yaml
@@ -6,8 +6,6 @@ metadata:
     app.kubernetes.io/instance: proxy-role
     app.kubernetes.io/component: kube-rbac-proxy
     app.kubernetes.io/created-by: ibm-object-csi-driver-operator
-    app.kubernetes.io/part-of: ibm-object-csi-driver-operator
-    app.kubernetes.io/managed-by: kustomize
   name: proxy-role
 rules:
 - apiGroups:
diff --git a/config/rbac/auth_proxy_role_binding.yaml b/config/rbac/auth_proxy_role_binding.yaml
@@ -6,8 +6,6 @@ metadata:
     app.kubernetes.io/instance: proxy-rolebinding
     app.kubernetes.io/component: kube-rbac-proxy
     app.kubernetes.io/created-by: ibm-object-csi-driver-operator
-    app.kubernetes.io/part-of: ibm-object-csi-driver-operator
-    app.kubernetes.io/managed-by: kustomize
   name: proxy-rolebinding
 roleRef:
   apiGroup: rbac.authorization.k8s.io
diff --git a/config/rbac/auth_proxy_service.yaml b/config/rbac/auth_proxy_service.yaml
@@ -7,8 +7,6 @@ metadata:
     app.kubernetes.io/instance: controller-manager-metrics-service
     app.kubernetes.io/component: kube-rbac-proxy
     app.kubernetes.io/created-by: ibm-object-csi-driver-operator
-    app.kubernetes.io/part-of: ibm-object-csi-driver-operator
-    app.kubernetes.io/managed-by: kustomize
   name: controller-manager-metrics-service
   namespace: system
 spec:
diff --git a/config/rbac/ibmobjectcsi_editor_role.yaml b/config/rbac/ibmobjectcsi_editor_role.yaml
@@ -7,8 +7,6 @@ metadata:
     app.kubernetes.io/instance: ibmobjectcsi-editor-role
     app.kubernetes.io/component: rbac
     app.kubernetes.io/created-by: ibm-object-csi-driver-operator
-    app.kubernetes.io/part-of: ibm-object-csi-driver-operator
-    app.kubernetes.io/managed-by: kustomize
   name: ibmobjectcsi-editor-role
 rules:
 - apiGroups:
diff --git a/config/rbac/ibmobjectcsi_viewer_role.yaml b/config/rbac/ibmobjectcsi_viewer_role.yaml
@@ -7,8 +7,6 @@ metadata:
     app.kubernetes.io/instance: ibmobjectcsi-viewer-role
     app.kubernetes.io/component: rbac
     app.kubernetes.io/created-by: ibm-object-csi-driver-operator
-    app.kubernetes.io/part-of: ibm-object-csi-driver-operator
-    app.kubernetes.io/managed-by: kustomize
   name: ibmobjectcsi-viewer-role
 rules:
 - apiGroups:
diff --git a/config/rbac/kustomization.yaml b/config/rbac/kustomization.yaml
@@ -16,3 +16,7 @@ resources:
 - auth_proxy_role.yaml
 - auth_proxy_role_binding.yaml
 - auth_proxy_client_clusterrole.yaml
+
+commonLabels:
+  app.kubernetes.io/part-of: ibm-object-csi-driver-operator
+  app.kubernetes.io/managed-by: kustomize
diff --git a/config/rbac/leader_election_role.yaml b/config/rbac/leader_election_role.yaml
@@ -7,8 +7,6 @@ metadata:
     app.kubernetes.io/instance: leader-election-role
     app.kubernetes.io/component: rbac
     app.kubernetes.io/created-by: ibm-object-csi-driver-operator
-    app.kubernetes.io/part-of: ibm-object-csi-driver-operator
-    app.kubernetes.io/managed-by: kustomize
   name: leader-election-role
 rules:
 - apiGroups:
diff --git a/config/rbac/leader_election_role_binding.yaml b/config/rbac/leader_election_role_binding.yaml
@@ -6,8 +6,6 @@ metadata:
     app.kubernetes.io/instance: leader-election-rolebinding
     app.kubernetes.io/component: rbac
     app.kubernetes.io/created-by: ibm-object-csi-driver-operator
-    app.kubernetes.io/part-of: ibm-object-csi-driver-operator
-    app.kubernetes.io/managed-by: kustomize
   name: leader-election-rolebinding
 roleRef:
   apiGroup: rbac.authorization.k8s.io
diff --git a/config/rbac/recoverstalevolume_editor_role.yaml b/config/rbac/recoverstalevolume_editor_role.yaml
@@ -7,8 +7,6 @@ metadata:
     app.kubernetes.io/instance: recoverstalevolume-editor-role
     app.kubernetes.io/component: rbac
     app.kubernetes.io/created-by: ibm-object-csi-driver-operator
-    app.kubernetes.io/part-of: ibm-object-csi-driver-operator
-    app.kubernetes.io/managed-by: kustomize
   name: recoverstalevolume-editor-role
 rules:
 - apiGroups:
diff --git a/config/rbac/recoverstalevolume_viewer_role.yaml b/config/rbac/recoverstalevolume_viewer_role.yaml
@@ -7,8 +7,6 @@ metadata:
     app.kubernetes.io/instance: recoverstalevolume-viewer-role
     app.kubernetes.io/component: rbac
     app.kubernetes.io/created-by: ibm-object-csi-driver-operator
-    app.kubernetes.io/part-of: ibm-object-csi-driver-operator
-    app.kubernetes.io/managed-by: kustomize
   name: recoverstalevolume-viewer-role
 rules:
 - apiGroups:
diff --git a/config/rbac/role_binding.yaml b/config/rbac/role_binding.yaml
@@ -6,8 +6,6 @@ metadata:
     app.kubernetes.io/instance: manager-rolebinding
     app.kubernetes.io/component: rbac
     app.kubernetes.io/created-by: ibm-object-csi-driver-operator
-    app.kubernetes.io/part-of: ibm-object-csi-driver-operator
-    app.kubernetes.io/managed-by: kustomize
   name: manager-rolebinding
 roleRef:
   apiGroup: rbac.authorization.k8s.io
diff --git a/config/rbac/service_account.yaml b/config/rbac/service_account.yaml
@@ -6,7 +6,5 @@ metadata:
     app.kubernetes.io/instance: controller-manager
     app.kubernetes.io/component: rbac
     app.kubernetes.io/created-by: ibm-object-csi-driver-operator
-    app.kubernetes.io/part-of: ibm-object-csi-driver-operator
-    app.kubernetes.io/managed-by: kustomize
   name: controller-manager
   namespace: system
diff --git a/config/samples/csi_v1alpha1_ibmobjectcsi.yaml b/config/samples/csi_v1alpha1_ibmobjectcsi.yaml
@@ -6,7 +6,6 @@ metadata:
   labels:
     app.kubernetes.io/name: ibm-object-csi
     app.kubernetes.io/instance: ibm-object-csi
-    app.kubernetes.io/managed-by: ibm-object-csi-operator
     release: v1.0.0
 spec:
   # controller is a deployment with ibm-object-csi-controller container
diff --git a/config/samples/csi_v1alpha1_recoverstalevolume.yaml b/config/samples/csi_v1alpha1_recoverstalevolume.yaml
@@ -4,9 +4,6 @@ metadata:
   labels:
     app.kubernetes.io/name: recoverstalevolume
     app.kubernetes.io/instance: recoverstalevolume-sample
-    app.kubernetes.io/part-of: ibm-object-csi-driver-operator
-    app.kubernetes.io/managed-by: kustomize
-    app.kubernetes.io/created-by: ibm-object-csi-driver-operator
   name: recoverstalevolume-sample
   namespace: ibm-object-csi-operator-system
 spec:
diff --git a/config/samples/kustomization.yaml b/config/samples/kustomization.yaml
@@ -2,4 +2,7 @@
 resources:
 - csi_v1alpha1_ibmobjectcsi.yaml
 - csi_v1alpha1_recoverstalevolume.yaml
+commonLabels:
+  app.kubernetes.io/part-of: ibm-object-csi-driver-operator
+  app.kubernetes.io/managed-by: kustomize
 #+kubebuilder:scaffold:manifestskustomizesamples
diff --git a/config/scorecard/kustomization.yaml b/config/scorecard/kustomization.yaml
@@ -13,4 +13,7 @@ patchesJson6902:
     version: v1alpha3
     kind: Configuration
     name: config
+commonLabels:
+  app.kubernetes.io/part-of: ibm-object-csi-driver-operator
+  app.kubernetes.io/managed-by: kustomize
 #+kubebuilder:scaffold:patchesJson6902
diff --git a/controllers/internal/crutils/ibmobjectcsi.go b/controllers/internal/crutils/ibmobjectcsi.go
@@ -34,7 +34,8 @@ func (c *IBMObjectCSI) GetLabels() labels.Set {
 		"app.kubernetes.io/name":       config.ProductName,
 		"app.kubernetes.io/instance":   c.Name,
 		"app.kubernetes.io/version":    csiversion.Version,
-		"app.kubernetes.io/managed-by": config.Name,
+		"app.kubernetes.io/part-of":    config.CSIDriverName,
+		"app.kubernetes.io/managed-by": config.CSIOperatorName,
 		"product":                      config.ProductName,
 		"release":                      fmt.Sprintf("v%s", csiversion.Version),
 	}
@@ -107,12 +108,10 @@ func (c *IBMObjectCSI) GetCSIControllerImage() string {
 
 // GetCSIControllerResourceRequests ...
 func (c *IBMObjectCSI) GetCSIControllerResourceRequests() *objectdriverv1alpha1.ResourcesSpec {
-	resources := c.Spec.Controller.Resources
-	return &resources
+	return &c.Spec.Controller.Resources
 }
 
 // GetCSINodeResourceRequests ...
 func (c *IBMObjectCSI) GetCSINodeResourceRequests() *objectdriverv1alpha1.ResourcesSpec {
-	resources := c.Spec.Node.Resources
-	return &resources
+	return &c.Spec.Node.Resources
 }
diff --git a/controllers/internal/crutils/static_resource_generator.go b/controllers/internal/crutils/static_resource_generator.go
@@ -16,8 +16,12 @@ func (c *IBMObjectCSI) GenerateCSIDriver() *storagev1.CSIDriver {
 	defaultFSGroupPolicy := storagev1.FileFSGroupPolicy
 	return &storagev1.CSIDriver{
 		ObjectMeta: metav1.ObjectMeta{
-			Name:   config.DriverName,
-			Labels: map[string]string{"app.kubernetes.io/name": "ibm-object-csi"},
+			Name: config.DriverName,
+			Labels: map[string]string{
+				"app.kubernetes.io/name":       "ibm-object-csi",
+				"app.kubernetes.io/part-of":    config.CSIDriverName,
+				"app.kubernetes.io/managed-by": config.CSIOperatorName,
+			},
 		},
 		Spec: storagev1.CSIDriverSpec{
 			AttachRequired: boolptr.False(),
@@ -53,7 +57,8 @@ func getServiceAccount(c *IBMObjectCSI, serviceAccountResourceName config.Resour
 func (c *IBMObjectCSI) GenerateExternalProvisionerClusterRole() *rbacv1.ClusterRole {
 	return &rbacv1.ClusterRole{
 		ObjectMeta: metav1.ObjectMeta{
-			Name: config.GetNameForResource(config.ExternalProvisionerClusterRole, config.DriverPrefix),
+			Name:   config.GetNameForResource(config.ExternalProvisionerClusterRole, config.DriverPrefix),
+			Labels: config.CommonCSIResourceLabels,
 		},
 		Rules: []rbacv1.PolicyRule{
 			{
@@ -99,7 +104,8 @@ func (c *IBMObjectCSI) GenerateExternalProvisionerClusterRole() *rbacv1.ClusterR
 func (c *IBMObjectCSI) GenerateExternalProvisionerClusterRoleBinding() *rbacv1.ClusterRoleBinding {
 	return &rbacv1.ClusterRoleBinding{
 		ObjectMeta: metav1.ObjectMeta{
-			Name: config.GetNameForResource(config.ExternalProvisionerClusterRoleBinding, config.DriverPrefix),
+			Name:   config.GetNameForResource(config.ExternalProvisionerClusterRoleBinding, config.DriverPrefix),
+			Labels: config.CommonCSIResourceLabels,
 		},
 		Subjects: []rbacv1.Subject{
 			{
@@ -120,7 +126,8 @@ func (c *IBMObjectCSI) GenerateExternalProvisionerClusterRoleBinding() *rbacv1.C
 func (c *IBMObjectCSI) GenerateSCCForControllerClusterRole() *rbacv1.ClusterRole {
 	return &rbacv1.ClusterRole{
 		ObjectMeta: metav1.ObjectMeta{
-			Name: config.GetNameForResource(config.CSIControllerSCCClusterRole, config.DriverPrefix),
+			Name:   config.GetNameForResource(config.CSIControllerSCCClusterRole, config.DriverPrefix),
+			Labels: config.CommonCSIResourceLabels,
 		},
 		Rules: []rbacv1.PolicyRule{
 			{
@@ -137,7 +144,8 @@ func (c *IBMObjectCSI) GenerateSCCForControllerClusterRole() *rbacv1.ClusterRole
 func (c *IBMObjectCSI) GenerateSCCForControllerClusterRoleBinding() *rbacv1.ClusterRoleBinding {
 	return &rbacv1.ClusterRoleBinding{
 		ObjectMeta: metav1.ObjectMeta{
-			Name: config.GetNameForResource(config.CSIControllerSCCClusterRoleBinding, config.DriverPrefix),
+			Name:   config.GetNameForResource(config.CSIControllerSCCClusterRoleBinding, config.DriverPrefix),
+			Labels: config.CommonCSIResourceLabels,
 		},
 		Subjects: []rbacv1.Subject{
 			{
@@ -158,7 +166,8 @@ func (c *IBMObjectCSI) GenerateSCCForControllerClusterRoleBinding() *rbacv1.Clus
 func (c *IBMObjectCSI) GenerateSCCForNodeClusterRole() *rbacv1.ClusterRole {
 	return &rbacv1.ClusterRole{
 		ObjectMeta: metav1.ObjectMeta{
-			Name: config.GetNameForResource(config.CSINodeSCCClusterRole, config.DriverPrefix),
+			Name:   config.GetNameForResource(config.CSINodeSCCClusterRole, config.DriverPrefix),
+			Labels: config.CommonCSIResourceLabels,
 		},
 		Rules: []rbacv1.PolicyRule{
 			{
@@ -187,7 +196,8 @@ func (c *IBMObjectCSI) GenerateSCCForNodeClusterRole() *rbacv1.ClusterRole {
 func (c *IBMObjectCSI) GenerateSCCForNodeClusterRoleBinding() *rbacv1.ClusterRoleBinding {
 	return &rbacv1.ClusterRoleBinding{
 		ObjectMeta: metav1.ObjectMeta{
-			Name: config.GetNameForResource(config.CSINodeSCCClusterRoleBinding, config.DriverPrefix),
+			Name:   config.GetNameForResource(config.CSINodeSCCClusterRoleBinding, config.DriverPrefix),
+			Labels: config.CommonCSIResourceLabels,
 		},
 		Subjects: []rbacv1.Subject{
 			{
@@ -208,7 +218,8 @@ func (c *IBMObjectCSI) GenerateSCCForNodeClusterRoleBinding() *rbacv1.ClusterRol
 func (c *IBMObjectCSI) GenerateS3fsSC(storageClassName config.ResourceName, reclaimPolicy corev1.PersistentVolumeReclaimPolicy) *storagev1.StorageClass {
 	return &storagev1.StorageClass{
 		ObjectMeta: metav1.ObjectMeta{
-			Name: storageClassName.String(),
+			Name:   storageClassName.String(),
+			Labels: config.CommonCSIResourceLabels,
 		},
 		Provisioner:   config.DriverName,
 		ReclaimPolicy: &reclaimPolicy,
@@ -235,7 +246,8 @@ func (c *IBMObjectCSI) GenerateS3fsSC(storageClassName config.ResourceName, recl
 func (c *IBMObjectCSI) GenerateRcloneSC(storageClassName config.ResourceName, reclaimPolicy corev1.PersistentVolumeReclaimPolicy) *storagev1.StorageClass {
 	return &storagev1.StorageClass{
 		ObjectMeta: metav1.ObjectMeta{
-			Name: storageClassName.String(),
+			Name:   storageClassName.String(),
+			Labels: config.CommonCSIResourceLabels,
 		},
 		Provisioner:   config.DriverName,
 		ReclaimPolicy: &reclaimPolicy,
diff --git a/pkg/config/constants.go b/pkg/config/constants.go
@@ -3,11 +3,12 @@ package config
 
 // Add a field here if it never changes, if it changes over time, put it to settings.go
 const (
-	APIGroup    = "objectdriver.csi.ibm.com"
-	APIVersion  = "v1"
-	Name        = "ibm-object-csi-operator"
-	DriverName  = "cos.s3.csi.ibm.io"
-	ProductName = "ibm-object-csi-driver"
+	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"
@@ -43,3 +44,8 @@ const (
 	CSIEndpoint                                           = "unix:///var/lib/csi/sockets/pluginproxy/csi.sock"
 	CSINodeEndpoint                                       = "unix:///csi/csi.sock"
 )
+
+var CommonCSIResourceLabels = map[string]string{
+	"app.kubernetes.io/part-of":    CSIDriverName,
+	"app.kubernetes.io/managed-by": CSIOperatorName,
+}

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`"files": "go.sum\|^.secrets.baseline$",`
`4`	`4`	`"lines": null`
`5`	`5`	`},`
`6`		`- "generated_at": "2024-05-13T06:55:58Z",`
	`6`	`+ "generated_at": "2024-05-15T04:17:59Z",`
`7`	`7`	`"plugins_used": [`
`8`	`8`	`{`
`9`	`9`	`"name": "AWSKeyDetector"`