🐛 Fix lint and bugs

Fixing bug that diff of old clusteraddons and new clusteraddons was
calculated wrongly due to issues with pointers and for loops.

Fixing the linting for the multi-stage cluster addons feature.

Fix the extension hooks that didn't work properly until now. They should
only update the clusteraddon once.

Add hook server to localmode config.

Update to yaml3 package.

Allow missing values prefix in overwrite.yaml.

Signed-off-by: janiskemper <[email protected]>

Author: janiskemper

.yamllint.yaml

@@ -29,3 +29,6 @@ ignore:
   - config/webhook/**/*.yaml
   - test/releases/**
   - test/cluster-stacks/**
+  - .release/**
+  - .cluster.yaml
+  - .clusterstack.yaml

api/v1alpha1/clusteraddon_types.go

@@ -28,25 +28,35 @@ const (
 	ClusterAddonFinalizer = "clusteraddon.clusterstack.x-k8s.io"
 )
 
+// StageAnnotation is the annotation name and key for the stage annotation.
 const StageAnnotation = "ClusterAddonStage"
 
+// StageAnnotationValue is the value of the stage annotation.
 type StageAnnotationValue string
 
 const (
-	StageCreated  = StageAnnotationValue("created")
-	StageUpgraded = StageAnnotationValue("upgraded")
+	// StageAnnotationValueCreated signifies the stage annotation created.
+	StageAnnotationValueCreated = StageAnnotationValue("created")
+	// StageAnnotationValueUpgraded signifies the stage annotation upgraded.
+	StageAnnotationValueUpgraded = StageAnnotationValue("upgraded")
 )
 
 // StagePhase defines the status of helm chart in the cluster addon.
 type StagePhase string
 
 var (
-	None                    = StagePhase("")
-	Pending                 = StagePhase("Pending")
-	WaitingForPreCondition  = StagePhase("waitingForPreCondition")
-	ApplyingOrDeleting      = StagePhase("applyingOrDeleting")
-	WaitingForPostCondition = StagePhase("waitingForPostCondition")
-	Done                    = StagePhase("done")
+	// StagePhaseNone signifies the empty stage phase.
+	StagePhaseNone = StagePhase("")
+	// StagePhasePending signifies the stage phase 'pending'.
+	StagePhasePending = StagePhase("Pending")
+	// StagePhaseWaitingForPreCondition signifies the stage phase 'waitingForPreCondition'.
+	StagePhaseWaitingForPreCondition = StagePhase("waitingForPreCondition")
+	// StagePhaseApplyingOrDeleting signifies the stage phase 'applyingOrDeleting'.
+	StagePhaseApplyingOrDeleting = StagePhase("applyingOrDeleting")
+	// StagePhaseWaitingForPostCondition signifies the stage phase 'waitingForPostCondition'.
+	StagePhaseWaitingForPostCondition = StagePhase("waitingForPostCondition")
+	// StagePhaseDone signifies the stage phase 'done'.
+	StagePhaseDone = StagePhase("done")
 )
 
 // StageStatus represents the helm charts of the hook and it's phases.
@@ -131,18 +141,19 @@ func (r *ClusterAddon) GetStagePhase(helmChartName string, action clusteraddon.A
 	}
 
 	// This cannot occur as we populate phase value with "pending".
-	return None
+	return StagePhaseNone
 }
 
 // SetStagePhase sets the helm chart status phase.
 func (r *ClusterAddon) SetStagePhase(helmChartName string, action clusteraddon.Action, phase StagePhase) {
-	for i, _ := range r.Status.Stages {
+	for i := range r.Status.Stages {
 		if r.Status.Stages[i].Name == helmChartName && r.Status.Stages[i].Action == action {
 			r.Status.Stages[i].Phase = phase
 		}
 	}
 }
 
+// SetStageAnnotations sets the annotation whether the cluster got created or upgraded.
 func (r *ClusterAddon) SetStageAnnotations(value StageAnnotationValue) {
 	if r.Annotations == nil {
 		r.Annotations = make(map[string]string, 0)
@@ -153,7 +164,7 @@ func (r *ClusterAddon) SetStageAnnotations(value StageAnnotationValue) {
 	}
 }
 
-// HasAnnotation returns a bool if passed in annotation exists.
+// HasStageAnnotation returns whether the stage annotation exists with a certain value.
 func (r *ClusterAddon) HasStageAnnotation(value StageAnnotationValue) bool {
 	val, found := r.Annotations[StageAnnotation]
 	if found && val == string(value) {

api/v1alpha1/conditions_const.go

@@ -60,7 +60,7 @@ const (
 	// HelmChartDeletedCondition reports on whether the relevant helm chart has been applied.
 	HelmChartDeletedCondition clusterv1.ConditionType = "HelmChartDeleted"
 
-	// FailedToApplyObjectsReason is used when some objects have been failed to delete.
+	// FailedToDeleteObjectsReason is used when some objects have been failed to delete.
 	FailedToDeleteObjectsReason = "FailedToDeleteObjects"
 )
 

cmd/main.go

@@ -26,7 +26,7 @@ import (
 
 	//+kubebuilder:scaffold:imports
 	csov1alpha1 "github.com/SovereignCloudStack/cluster-stack-operator/api/v1alpha1"
-	"github.com/SovereignCloudStack/cluster-stack-operator/extension/handlers"
+	"github.com/SovereignCloudStack/cluster-stack-operator/extension"
 	"github.com/SovereignCloudStack/cluster-stack-operator/internal/controller"
 	"github.com/SovereignCloudStack/cluster-stack-operator/pkg/assetsclient"
 	"github.com/SovereignCloudStack/cluster-stack-operator/pkg/assetsclient/fake"
@@ -237,7 +237,7 @@ func main() {
 	restConfig.UserAgent = remote.DefaultClusterAPIUserAgent("cluster-stack-operator-extension-manager")
 
 	// Create the ExtensionHandlers for the lifecycle hooks
-	lifecycleExtensionHandlers := handlers.NewExtensionHandlers(mgr.GetClient(), scheme)
+	lifecycleExtensionHandlers := extension.NewHandler(mgr.GetClient())
 
 	setupLog.Info("Add extension handlers")
 	if err := hookServer.AddExtensionHandler(server.ExtensionHandler{

config/crd/bases/clusterstack.x-k8s.io_clusteraddons.yaml

@@ -216,6 +216,7 @@ spec:
                     action:
                       description: Action is the action of the helm chart. e.g. -
                         apply and delete.
+                      type: string
                     helmChartName:
                       description: Name represent name of the helm chart
                       type: string

config/localmode/kustomization.yaml

@@ -9,12 +9,14 @@ resources:
   - ../crd
   - ../rbac
   - ../manager
+  - ../hookserver
   - ../webhook
   - ../certmanager
 
 patchesStrategicMerge:
   - manager_config_patch.yaml
   - manager_webhook_patch.yaml
+  - manager_hookserver_patch.yaml
   - webhookcainjection_patch.yaml
   - manager_pull_policy.yaml
 vars:
@@ -26,21 +28,49 @@ vars:
       name: serving-cert # this name should match the one in certificate.yaml
     fieldref:
       fieldpath: metadata.namespace
+  - name: HOOK_SERVER_CERTIFICATE_NAMESPACE  # namespace of the certificate CR
+    objref:
+      kind: Certificate
+      group: cert-manager.io
+      version: v1
+      name: hook-server-server-cert  # this name should match the one in certificate.yaml
+    fieldref:
+      fieldpath: metadata.namespace
   - name: CERTIFICATE_NAME
+    objref:
+      group: cert-manager.io
+      kind: Certificate
+      name: serving-cert
+      version: v1
+    fieldref: {}
+  - name: HOOK_SERVER_CERTIFICATE_NAME
     objref:
       kind: Certificate
       group: cert-manager.io
       version: v1
-      name: serving-cert # this name should match the one in certificate.yaml
+      name: hook-server-server-cert  # this name should match the one in certificate.yaml
   - name: SERVICE_NAMESPACE # namespace of the service
     objref:
       kind: Service
       version: v1
       name: webhook-service
     fieldref:
       fieldpath: metadata.namespace
+  - name: HOOK_SERVER_SERVICE_NAMESPACE  # namespace of the service
+    objref:
+      kind: Service
+      version: v1
+      name: hook-server-svc
+    fieldref:
+      fieldpath: metadata.namespace
   - name: SERVICE_NAME
     objref:
       kind: Service
       version: v1
       name: webhook-service
+    fieldref: {}
+  - name: HOOK_SERVER_SERVICE_NAME
+    objref:
+      kind: Service
+      version: v1
+      name: hook-server-svc

config/localmode/manager_hookserver_patch.yaml

@@ -0,0 +1,23 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: controller-manager
+  namespace: system
+spec:
+  template:
+    spec:
+      containers:
+      - name: manager
+        ports:
+        - containerPort: 9442
+          name: hook-server-svc
+          protocol: TCP
+        volumeMounts:
+        - mountPath: /tmp/k8s-hook-server/serving-certs
+          name: hook-server-cert
+          readOnly: true
+      volumes:
+      - name: hook-server-cert
+        secret:
+          defaultMode: 420
+          secretName: cso-hook-server-server-cert