refactor constants in operator (#421)

Signed-off-by: Zhiwei Yin <zyin@redhat.com>
open-cluster-management-io · Apr 15, 2024 · f413220 · f413220
1 parent ebfa38e
commit f413220
Show file tree

Hide file tree

Showing 37 changed files with 382 additions and 199 deletions.
diff --git a/...-manager/config/crds/0000_01_operator.open-cluster-management.io_clustermanagers.crd.yaml b/...-manager/config/crds/0000_01_operator.open-cluster-management.io_clustermanagers.crd.yaml
@@ -323,6 +323,8 @@ spec:
                     type: string
                 type: object
               workConfiguration:
+                default:
+                  workDriver: kube
                 description: WorkConfiguration contains the configuration of work
                 properties:
                   featureGates:
@@ -356,6 +358,22 @@ spec:
                       - feature
                       type: object
                     type: array
+                  workDriver:
+                    default: kube
+                    description: "WorkDriver represents the type of work driver. Possible
+                      values are \"kube\", \"mqtt\", or \"grpc\". If not provided,
+                      the default value is \"kube\". If set to non-\"kube\" drivers,
+                      the klusterlet need to use the same driver. and the driver configuration
+                      must be provided in a secret named \"work-driver-config\" in
+                      the namespace where the cluster manager is running, adhering
+                      to the following structure: config.yaml: | <driver-config-in-yaml>
+                      \n For detailed driver configuration, please refer to the sdk-go
+                      documentation: https://github.com/open-cluster-management-io/sdk-go/blob/main/pkg/cloudevents/README.md#supported-protocols-and-drivers"
+                    enum:
+                    - kube
+                    - mqtt
+                    - grpc
+                    type: string
                 type: object
               workImagePullSpec:
                 default: quay.io/open-cluster-management/work

diff --git a/...ger/olm-catalog/latest/manifests/operator.open-cluster-management.io_clustermanagers.yaml b/...ger/olm-catalog/latest/manifests/operator.open-cluster-management.io_clustermanagers.yaml
@@ -323,6 +323,8 @@ spec:
                     type: string
                 type: object
               workConfiguration:
+                default:
+                  workDriver: kube
                 description: WorkConfiguration contains the configuration of work
                 properties:
                   featureGates:
@@ -356,6 +358,22 @@ spec:
                       - feature
                       type: object
                     type: array
+                  workDriver:
+                    default: kube
+                    description: "WorkDriver represents the type of work driver. Possible
+                      values are \"kube\", \"mqtt\", or \"grpc\". If not provided,
+                      the default value is \"kube\". If set to non-\"kube\" drivers,
+                      the klusterlet need to use the same driver. and the driver configuration
+                      must be provided in a secret named \"work-driver-config\" in
+                      the namespace where the cluster manager is running, adhering
+                      to the following structure: config.yaml: | <driver-config-in-yaml>
+                      \n For detailed driver configuration, please refer to the sdk-go
+                      documentation: https://github.com/open-cluster-management-io/sdk-go/blob/main/pkg/cloudevents/README.md#supported-protocols-and-drivers"
+                    enum:
+                    - kube
+                    - mqtt
+                    - grpc
+                    type: string
                 type: object
               workImagePullSpec:
                 default: quay.io/open-cluster-management/work

diff --git a/go.mod b/go.mod
@@ -35,7 +35,7 @@ require (
 	k8s.io/kube-aggregator v0.29.3
 	k8s.io/utils v0.0.0-20240310230437-4693a0247e57
 	open-cluster-management.io/addon-framework v0.9.1
-	open-cluster-management.io/api v0.13.0
+	open-cluster-management.io/api v0.13.1-0.20240411131856-8f6aa25f111c
 	open-cluster-management.io/sdk-go v0.13.1-0.20240313075541-00a94671ced1
 	sigs.k8s.io/controller-runtime v0.17.2
 	sigs.k8s.io/kube-storage-version-migrator v0.0.6-0.20230721195810-5c8923c5ff96

diff --git a/go.sum b/go.sum
@@ -425,8 +425,8 @@ k8s.io/utils v0.0.0-20240310230437-4693a0247e57 h1:gbqbevonBh57eILzModw6mrkbwM0g
 k8s.io/utils v0.0.0-20240310230437-4693a0247e57/go.mod h1:OLgZIPagt7ERELqWJFomSt595RzquPNLL48iOWgYOg0=
 open-cluster-management.io/addon-framework v0.9.1 h1:m6n/W29G/4KzMx+8mgC9P/ybuiyNHVy+O6AHEaWbfQg=
 open-cluster-management.io/addon-framework v0.9.1/go.mod h1:OEIFCEXhZKO/Grv08CB0T+TGzS0bLshw4G9u7Vw8dw0=
-open-cluster-management.io/api v0.13.0 h1:dlcJEZlNlE0DmSDctK2s7iWKg9l+Tgb0V78Z040nMuk=
-open-cluster-management.io/api v0.13.0/go.mod h1:CuCPEzXDvOyxBB0H1d1eSeajbHqaeGEKq9c63vQc63w=
+open-cluster-management.io/api v0.13.1-0.20240411131856-8f6aa25f111c h1:/iUoY6/PqBmcBq3v0+UBFvIcI39k/QPRGqpOv9XtDIc=
+open-cluster-management.io/api v0.13.1-0.20240411131856-8f6aa25f111c/go.mod h1:CuCPEzXDvOyxBB0H1d1eSeajbHqaeGEKq9c63vQc63w=
 open-cluster-management.io/sdk-go v0.13.1-0.20240313075541-00a94671ced1 h1:s3dJdi1eol+/8ek6JQuaEuoGPkK/wRyM9zowqzKHPDY=
 open-cluster-management.io/sdk-go v0.13.1-0.20240313075541-00a94671ced1/go.mod h1:sq+amR9Ls9JzMP5dypvlCx4jIGfDg45gicS67Z/MnlI=
 sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.28.0 h1:TgtAeesdhpm2SGwkQasmbeqDo8th5wOBA5h/AjTKA4I=

diff --git a/pkg/operator/helpers/helpers.go b/pkg/operator/helpers/helpers.go
@@ -3,6 +3,7 @@ package helpers
 import (
 	"context"
 	"fmt"
+	"os"
 	"reflect"
 	"strings"
 
@@ -37,6 +38,7 @@ import (
 	apiregistrationv1 "k8s.io/kube-aggregator/pkg/apis/apiregistration/v1"
 	apiregistrationclient "k8s.io/kube-aggregator/pkg/client/clientset_generated/clientset/typed/apiregistration/v1"
 
+	"open-cluster-management.io/api/feature"
 	operatorapiv1 "open-cluster-management.io/api/operator/v1"
 )
 
@@ -49,16 +51,24 @@ const (
 	FeatureGatesReasonInvalidExisting = "InvalidFeatureGatesExisting"
 )
 
+const (
+	// ImagePullSecret is the image pull secret for operator components, which is synced from the operator ns to hub/spoke/addon ns.
+	ImagePullSecret = "open-cluster-management-image-pull-credentials"
+
+	// DefaultComponentNamespace is the default namespace in which the operator is deployed
+	DefaultComponentNamespace = "open-cluster-management"
+)
+
 var (
 	genericScheme = runtime.NewScheme()
 	genericCodecs = serializer.NewCodecFactory(genericScheme)
 	genericCodec  = genericCodecs.UniversalDeserializer()
 
 	DefaultHubRegistrationFeatureGates = []operatorapiv1.FeatureGate{
-		{Feature: "DefaultClusterSet", Mode: operatorapiv1.FeatureGateModeTypeEnable},
+		{Feature: string(feature.DefaultClusterSet), Mode: operatorapiv1.FeatureGateModeTypeEnable},
 	}
 	DefaultSpokeRegistrationFeatureGates = []operatorapiv1.FeatureGate{
-		{Feature: "AddonManagement", Mode: operatorapiv1.FeatureGateModeTypeEnable},
+		{Feature: string(feature.AddonManagement), Mode: operatorapiv1.FeatureGateModeTypeEnable},
 	}
 )
 
@@ -795,3 +805,12 @@ func IsSingleton(mode operatorapiv1.InstallMode) bool {
 func IsHosted(mode operatorapiv1.InstallMode) bool {
 	return mode == operatorapiv1.InstallModeHosted || mode == operatorapiv1.InstallModeSingletonHosted
 }
+
+func GetOperatorNamespace() string {
+	operatorNamespace := DefaultComponentNamespace
+	nsBytes, err := os.ReadFile("/var/run/secrets/kubernetes.io/serviceaccount/namespace")
+	if err == nil {
+		operatorNamespace = string(nsBytes)
+	}
+	return operatorNamespace
+}
diff --git a/...perators/clustermanager/controllers/clustermanagercontroller/clustermanager_controller.go b/...perators/clustermanager/controllers/clustermanagercontroller/clustermanager_controller.go
@@ -38,9 +38,7 @@ import (
 )
 
 const (
-	clusterManagerFinalizer   = "operator.open-cluster-management.io/cluster-manager-cleanup"
-	clusterManagerApplied     = "Applied"
-	clusterManagerProgressing = "Progressing"
+	clusterManagerFinalizer = "operator.open-cluster-management.io/cluster-manager-cleanup"
 
 	defaultWebhookPort       = int32(9443)
 	clusterManagerReSyncTime = 5 * time.Second
@@ -267,9 +265,9 @@ func (n *clusterManagerController) sync(ctx context.Context, controllerContext f
 	clusterManager.Status.ObservedGeneration = clusterManager.Generation
 	if len(errs) == 0 {
 		meta.SetStatusCondition(&clusterManager.Status.Conditions, metav1.Condition{
-			Type:    clusterManagerApplied,
+			Type:    operatorapiv1.ConditionClusterManagerApplied,
 			Status:  metav1.ConditionTrue,
-			Reason:  "ClusterManagerApplied",
+			Reason:  operatorapiv1.ReasonClusterManagerApplied,
 			Message: "Components of cluster manager are applied",
 		})
 	} else {

diff --git a/...ators/clustermanager/controllers/clustermanagercontroller/clustermanager_crd_reconcile.go b/...ators/clustermanager/controllers/clustermanagercontroller/clustermanager_crd_reconcile.go
@@ -80,9 +80,9 @@ func (c *crdReconcile) reconcile(ctx context.Context, cm *operatorapiv1.ClusterM
 		},
 		hubCRDResourceFiles...); err != nil {
 		meta.SetStatusCondition(&cm.Status.Conditions, metav1.Condition{
-			Type:    clusterManagerApplied,
+			Type:    operatorapiv1.ConditionClusterManagerApplied,
 			Status:  metav1.ConditionFalse,
-			Reason:  "CRDApplyFaild",
+			Reason:  operatorapiv1.ReasonClusterManagerCRDApplyFailed,
 			Message: fmt.Sprintf("Failed to apply crd: %v", err),
 		})
 		return cm, reconcileStop, err

diff --git a/...ators/clustermanager/controllers/clustermanagercontroller/clustermanager_hub_reconcile.go b/...ators/clustermanager/controllers/clustermanagercontroller/clustermanager_hub_reconcile.go
@@ -129,7 +129,7 @@ func (c *hubReoncile) reconcile(ctx context.Context, cm *operatorapiv1.ClusterMa
 
 	if len(appliedErrs) > 0 {
 		meta.SetStatusCondition(&cm.Status.Conditions, metav1.Condition{
-			Type:    clusterManagerApplied,
+			Type:    operatorapiv1.ConditionClusterManagerApplied,
 			Status:  metav1.ConditionFalse,
 			Reason:  "HubResourceApplyFailed",
 			Message: fmt.Sprintf("Failed to apply hub resources: %v", utilerrors.NewAggregate(appliedErrs)),

diff --git a/...s/clustermanager/controllers/clustermanagercontroller/clustermanager_runtime_reconcile.go b/...s/clustermanager/controllers/clustermanagercontroller/clustermanager_runtime_reconcile.go
@@ -83,9 +83,9 @@ func (c *runtimeReconcile) reconcile(ctx context.Context, cm *operatorapiv1.Clus
 			config.MWReplicaSetEnabled, config.AddOnManagerEnabled)
 		if err != nil {
 			meta.SetStatusCondition(&cm.Status.Conditions, metav1.Condition{
-				Type:    clusterManagerApplied,
+				Type:    operatorapiv1.ConditionClusterManagerApplied,
 				Status:  metav1.ConditionFalse,
-				Reason:  "ServiceAccountSyncFailed",
+				Reason:  operatorapiv1.ReasonServiceAccountSyncFailed,
 				Message: fmt.Sprintf("Failed to sync service account: %v", err),
 			})
 			return cm, reconcileStop, err
@@ -158,25 +158,25 @@ func (c *runtimeReconcile) reconcile(ctx context.Context, cm *operatorapiv1.Clus
 
 	if len(progressingDeployments) > 0 {
 		meta.SetStatusCondition(&cm.Status.Conditions, metav1.Condition{
-			Type:    clusterManagerProgressing,
+			Type:    operatorapiv1.ConditionProgressing,
 			Status:  metav1.ConditionTrue,
-			Reason:  "ClusterManagerDeploymentRolling",
+			Reason:  operatorapiv1.ReasonDeploymentRolling,
 			Message: fmt.Sprintf("Deployments %s is still rolling", strings.Join(progressingDeployments, ",")),
 		})
 	} else {
 		meta.SetStatusCondition(&cm.Status.Conditions, metav1.Condition{
-			Type:    clusterManagerProgressing,
+			Type:    operatorapiv1.ConditionProgressing,
 			Status:  metav1.ConditionFalse,
-			Reason:  "ClusterManagerUpToDate",
+			Reason:  operatorapiv1.ReasonUpToDate,
 			Message: "Components of cluster manager are up to date",
 		})
 	}
 
 	if len(appliedErrs) > 0 {
 		meta.SetStatusCondition(&cm.Status.Conditions, metav1.Condition{
-			Type:    clusterManagerApplied,
+			Type:    operatorapiv1.ConditionClusterManagerApplied,
 			Status:  metav1.ConditionFalse,
-			Reason:  "RuntimeResourceApplyFailed",
+			Reason:  operatorapiv1.ReasonRuntimeResourceApplyFailed,
 			Message: fmt.Sprintf("Failed to apply runtime resources: %v", utilerrors.NewAggregate(appliedErrs)),
 		})
 		return cm, reconcileStop, utilerrors.NewAggregate(appliedErrs)

diff --git a/...s/clustermanager/controllers/clustermanagercontroller/clustermanager_webhook_reconcile.go b/...s/clustermanager/controllers/clustermanagercontroller/clustermanager_webhook_reconcile.go
@@ -48,7 +48,7 @@ func (c *webhookReconcile) reconcile(ctx context.Context, cm *operatorapiv1.Clus
 	config manifests.HubConfig) (*operatorapiv1.ClusterManager, reconcileState, error) {
 	var appliedErrs []error
 
-	if !meta.IsStatusConditionFalse(cm.Status.Conditions, clusterManagerProgressing) {
+	if !meta.IsStatusConditionFalse(cm.Status.Conditions, operatorapiv1.ConditionProgressing) {
 		return cm, reconcileStop, commonhelpers.NewRequeueError("Deployment is not ready", clusterManagerReSyncTime)
 	}
 
@@ -81,9 +81,9 @@ func (c *webhookReconcile) reconcile(ctx context.Context, cm *operatorapiv1.Clus
 
 	if len(appliedErrs) > 0 {
 		meta.SetStatusCondition(&cm.Status.Conditions, metav1.Condition{
-			Type:    clusterManagerApplied,
+			Type:    operatorapiv1.ConditionClusterManagerApplied,
 			Status:  metav1.ConditionFalse,
-			Reason:  "WebhookApplyFailed",
+			Reason:  operatorapiv1.ReasonWebhookApplyFailed,
 			Message: fmt.Sprintf("Failed to apply webhook resources: %v", utilerrors.NewAggregate(appliedErrs)),
 		})
 		return cm, reconcileStop, utilerrors.NewAggregate(appliedErrs)

diff --git a/...perator/operators/clustermanager/controllers/crdstatuccontroller/crd_status_controller.go b/...perator/operators/clustermanager/controllers/crdstatuccontroller/crd_status_controller.go
@@ -20,10 +20,10 @@ import (
 
 	operatorinformer "open-cluster-management.io/api/client/operator/informers/externalversions/operator/v1"
 	operatorlister "open-cluster-management.io/api/client/operator/listers/operator/v1"
+	operatorapiv1 "open-cluster-management.io/api/operator/v1"
 
 	"open-cluster-management.io/ocm/pkg/common/queue"
 	"open-cluster-management.io/ocm/pkg/operator/helpers"
-	"open-cluster-management.io/ocm/pkg/operator/operators/clustermanager/controllers/migrationcontroller"
 )
 
 var (
@@ -78,7 +78,7 @@ func (c *crdStatusController) sync(ctx context.Context, controllerContext factor
 	}
 
 	// need to wait storage version migrations succeed.
-	if succeeded := meta.IsStatusConditionTrue(clusterManager.Status.Conditions, migrationcontroller.MigrationSucceeded); !succeeded {
+	if succeeded := meta.IsStatusConditionTrue(clusterManager.Status.Conditions, operatorapiv1.ConditionMigrationSucceeded); !succeeded {
 		controllerContext.Queue().AddRateLimited(clusterManagerName)
 		klog.V(4).Info("Wait storage version migration succeed.")
 		return nil

diff --git a/...or/operators/clustermanager/controllers/crdstatuccontroller/crd_status_controller_test.go b/...or/operators/clustermanager/controllers/crdstatuccontroller/crd_status_controller_test.go
@@ -21,15 +21,14 @@ import (
 	operatorapiv1 "open-cluster-management.io/api/operator/v1"
 
 	testingcommon "open-cluster-management.io/ocm/pkg/common/testing"
-	"open-cluster-management.io/ocm/pkg/operator/operators/clustermanager/controllers/migrationcontroller"
 )
 
 func TestSync(t *testing.T) {
 	clusterManager := newClusterManager("testhub")
 	tc := newTestController(t, clusterManager)
 
 	syncContext := testingcommon.NewFakeSyncContext(t, "testhub")
-	//Do not support migration
+	// Do not support migration
 	err := tc.sync(context.Background(), syncContext)
 	if err != nil {
 		t.Fatalf("Expected no error when sync, %v", err)
@@ -38,7 +37,7 @@ func TestSync(t *testing.T) {
 	// migration succeed
 	clusterManager.Status.Conditions = []metav1.Condition{
 		{
-			Type:   migrationcontroller.MigrationSucceeded,
+			Type:   operatorapiv1.ConditionMigrationSucceeded,
 			Status: metav1.ConditionTrue,
 		},
 	}