feat: Separate business status from module status

.github/actions/deploy-template-operator/action.yaml

@@ -48,7 +48,7 @@ runs:
         kubectl apply -f tests/moduletemplates/moduletemplate_template_operator_v2_fast.yaml
     - name: Create Template Operator Module with final state and final deletion state as `Warning` and apply
       working-directory: template-operator
-      if: ${{ matrix.e2e-test == 'module-status-propagation'}}
+      if: ${{ matrix.e2e-test == 'module-status-decoupling'}}
       shell: bash
       run: |
         pushd config/default
@@ -66,6 +66,23 @@ runs:
         sed -i 's/localhost:5111/k3d-kcp-registry.localhost:5000/g' ./template.yaml
         kubectl get crds
         kubectl apply -f template.yaml
+    - name: Create Template Operator Module with non-working image and apply
+      working-directory: template-operator
+      if: ${{ matrix.e2e-test == 'module-status-decoupling'}}
+      shell: bash
+      run: |
+        pushd config/default
+        echo \
+        "- op: replace
+          path: /spec/template/spec/containers/0/image
+          value: non-working-path" >> image_patch.yaml
+        cat image_patch.yaml
+        kustomize edit add patch --path image_patch.yaml --kind Deployment
+        popd
+        kyma alpha create module --kubebuilder-project  --channel=regular --name kyma.project.io/module/template-operator-misconfigured --version 1.1.1 --path . --registry localhost:5111 --insecure --module-archive-version-overwrite
+        sed -i 's/localhost:5111/k3d-kcp-registry.localhost:5000/g' ./template.yaml
+        kubectl get crds
+        kubectl apply -f template.yaml
     - name: Create Template Operator Module without default CR and apply
       working-directory: template-operator
       if: ${{ matrix.e2e-test == 'module-without-default-cr' }}

.github/workflows/test-e2e.yaml

@@ -29,7 +29,7 @@ jobs:
           - watcher-enqueue
           - kyma-deprovision-with-foreground-propagation
           - kyma-deprovision-with-background-propagation
-          - module-status-propagation
+          - module-status-decoupling
           - kyma-metrics
           - module-without-default-cr
           - module-consistency

docs/technical-reference/api/manifest-cr.md

@@ -87,7 +87,14 @@ The resource is the default data that should be initialized for the module and i
 
 ### **.status**
 
-The Manifest CR status is an unmodified version of the [declarative status](../../../internal/declarative/README.md#resource-tracking), so the tracking process of the library applies. There is no custom API for this.
+The Manifest CR status is set based on the following logic, managed by the manifest reconciler: 
+
+- If the Module defined in the Manifest CR is successfully applied and the deployed Module is up and running, the status of the Manifest CR is set to `Ready`.
+- While the Manifest is being applied and the Deployment is still starting, the status of the Manifest CR is set to `Processing`.
+- If the Deployment is unable to start (for example, due to an `ImagePullBackOff` error) or if the application of the Manifest fails, the status of the Manifest CR is set to `Error`.
+- If the Manifest CR is marked for deletion, the status of the Manifest CR is set to `Deleting`.
+
+This status provides a reliable way to track the state of the Manifest CR and the associated Module, offering insights into the deployment process and any potential issues, while being decoupled of the Module business logic.
 
 ### **.metadata.labels**
 

internal/controller/manifest/controller.go

@@ -26,7 +26,7 @@ func NewReconciler(mgr manager.Manager,
 		declarativev2.WithSpecResolver(
 			manifest.NewSpecResolver(kcp, extractor),
 		),
-		declarativev2.WithCustomReadyCheck(manifest.NewCustomResourceReadyCheck()),
+		declarativev2.WithCustomReadyCheck(manifest.NewDeploymentReadyCheck()),
 		declarativev2.WithRemoteTargetCluster(lookup.ConfigResolver),
 		manifest.WithClientCacheKey(),
 		declarativev2.WithPostRun{manifest.PostRunCreateCR},

internal/declarative/v2/ready_check.go

@@ -19,7 +19,7 @@ type StateInfo struct {
 }
 
 type ReadyCheck interface {
-	Run(ctx context.Context, clnt Client, obj Object, resources []*resource.Info) (StateInfo, error)
+	Run(ctx context.Context, clnt Client, resources []*resource.Info) (StateInfo, error)
 }
 
 func NewExistsReadyCheck() *ExistsReadyCheck {
@@ -31,7 +31,6 @@ type ExistsReadyCheck struct{}
 func (c *ExistsReadyCheck) Run(
 	ctx context.Context,
 	clnt Client,
-	_ Object,
 	resources []*resource.Info,
 ) (StateInfo, error) {
 	for i := range resources {

internal/declarative/v2/reconciler.go

@@ -363,7 +363,12 @@ func (r *Reconciler) syncResources(ctx context.Context, clnt Client, obj Object,
 		}
 	}
 
-	return r.checkTargetReadiness(ctx, clnt, obj, target)
+	deploymentState, err := r.checkDeploymentState(ctx, clnt, obj, target)
+	if err != nil {
+		obj.SetStatus(status.WithState(shared.StateError).WithErr(err))
+		return err
+	}
+	return r.setManifestState(obj, deploymentState)
 }
 
 func hasDiff(oldResources []shared.Resource, newResources []shared.Resource) bool {
@@ -387,31 +392,47 @@ func hasDiff(oldResources []shared.Resource, newResources []shared.Resource) boo
 	return false
 }
 
-func (r *Reconciler) checkTargetReadiness(
-	ctx context.Context, clnt Client, manifest Object, target []*resource.Info,
-) error {
-	status := manifest.GetStatus()
-
+func (r *Reconciler) checkDeploymentState(
+	ctx context.Context, clnt Client, obj Object, target []*resource.Info,
+) (shared.State, error) {
 	resourceReadyCheck := r.CustomReadyCheck
 
-	crStateInfo, err := resourceReadyCheck.Run(ctx, clnt, manifest, target)
+	deploymentStateInfo, err := resourceReadyCheck.Run(ctx, clnt, target)
 	if err != nil {
-		manifest.SetStatus(status.WithState(shared.StateError).WithErr(err))
-		return err
+		return shared.StateError, err
+	}
+
+	if deploymentStateInfo.State == shared.StateProcessing {
+		return shared.StateProcessing, nil
 	}
 
-	if crStateInfo.State == shared.StateProcessing {
-		waitingMsg := "waiting for resources to become ready: " + crStateInfo.Info
+	if !obj.GetDeletionTimestamp().IsZero() {
+		return shared.StateDeleting, nil
+	}
+
+	return deploymentStateInfo.State, nil
+}
+
+func (r *Reconciler) setManifestState(manifest Object, state shared.State) error {
+	status := manifest.GetStatus()
+
+	if state == shared.StateProcessing {
+		waitingMsg := "waiting for resources to become ready"
 		manifest.SetStatus(status.WithState(shared.StateProcessing).WithOperation(waitingMsg))
 		return ErrInstallationConditionRequiresUpdate
 	}
 
+	if !manifest.GetDeletionTimestamp().IsZero() {
+		state = shared.StateDeleting
+	}
+
 	installationCondition := newInstallationCondition(manifest)
-	if !meta.IsStatusConditionTrue(status.Conditions, installationCondition.Type) || status.State != crStateInfo.State {
+	if !meta.IsStatusConditionTrue(status.Conditions,
+		installationCondition.Type) || status.State != state {
 		installationCondition.Status = apimetav1.ConditionTrue
 		meta.SetStatusCondition(&status.Conditions, installationCondition)
-		manifest.SetStatus(status.WithState(crStateInfo.State).
-			WithOperation(generateOperationMessage(installationCondition, crStateInfo)))
+		manifest.SetStatus(status.WithState(state).
+			WithOperation(generateOperationMessage(installationCondition, StateInfo{State: state})))
 		return ErrInstallationConditionRequiresUpdate
 	}