philomory commented 2 years ago

If any clusters are offline/unavailable, the status of Bundles that get deployed to those clusters can get stuck with misleading/confusing error messages.

Steps to reproduce:

Create a fleet workspace, and add at least two clusters. Make one cluster an e.g. single-node k3s cluster, so that it is easy to start/stop the cluster. We'll call that cluster "A".
Create a ClusterGroup that contains at least two of your clusters, including cluster A. We'll call this group "G".

Create a git repository containing the following code:

# test-bundle/fleet.yaml
defaultNamespace: test-bundle
helm:
  chart: ./chart
  releaseName: test-bundle

# test-bundle/chart/Chart.yaml
apiVersion: v2
name: test-bundle
version: 0.0.1

# test-bundle/chart/templates/deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: test
spec:
  selector:
    matchLabels:
      app: test
  template:
    metadata:
      labels:
        app: test
    spec:
      containers:
        - name: test
          image: paulbouwer/hello-kubernetes:1.10.1
          lifecycle:
            preStop:
              exec:
                command: ["sleep", "1"]

Create a GitRepo object pointing to this repository that applies to ClusterGroup "G". We'll call this GitRepo "R".
Let Fleet deploy the bundle from R to all clusters in G. Wait for them all to be Ready.

Push the following change (which introduces an error) to the git repository R:

--- a/test-bundle/chart/templates/deployment.yaml
+++ b/test-bundle/chart/templates/deployment.yaml
@@ -20,6 +20,6 @@ spec:
         - name: test
           image: paulbouwer/hello-kubernetes:1.10.1
           lifecycle:
-            preStop:
+            preStart:
               exec:
                 command: ["sleep", "2"]

Wait for Fleet to attempt to deploy this change. The GitRepo, Bundle, and all relevant BundleDeployments should end up in the state ErrApplied, with an error message similar to error validating "": error validating data: ValidationError(Deployment.spec.template.spec.containers[0].lifecycle): unknown field "preStart" in io.k8s.api.core.v1.Lifecycle'.
Shut off cluster A (stop the only node in the cluster).
Wait until Cluster A shows as offline under Cluster Management in Rancher.

Push the following change (which neither fixes the error nor introduces new errors) to GitRepo G:

--- a/test-bundle/chart/templates/deployment.yaml
+++ b/test-bundle/chart/templates/deployment.yaml
@@ -18,7 +18,7 @@ spec:
     spec:
       containers:
         - name: test
-          image: paulbouwer/hello-kubernetes:1.10.1
+          image: paulbouwer/hello-kubernetes:1.10
           lifecycle:
             preStart:
               exec:

Wait until the GitRepo UI in Fleet shows that it has picked up the new commit. The GitRepo, Bundle, and all relevant BundleDeployments will still be in the same error state as before.

Push the following change (which fixes the initial error) to GitRepo G:

--- a/test-bundle/chart/templates/deployment.yaml
+++ b/test-bundle/chart/templates/deployment.yaml
@@ -20,6 +20,6 @@ spec:
         - name: test
           image: paulbouwer/hello-kubernetes:1.10
           lifecycle:
-            preStart:
+            preStop:
               exec:
                 command: ["sleep", "2"]

Wait for the GitRepo UI in Fleet to show that it has picked up the new commit. Shortly, all BundleDeployments except that belonging to A will update to show that they are in a "Ready" state. However, the BundleDeployment for A will remain in the original error state, as will the Bundle and GitRepo.
Observe that, in Fleet's UI, GitRepo R still displays an error message similar to Error validating "": error validating data: ValidationError(Deployment.spec.template.spec.containers[0].lifecycle): unknown field "preStart" in io.k8s.api.core.v1.Lifecycle, even though the actual repository no longer contains any reference to a preStart field.

It is worth noting that, if step 10 is skipped - so that the commit in step 12 (which fixes the error) is the first commit to the repo after cluster A goes offline - then in step 12 the BundleDeployment for A will go to a "Wait Applied" state rather than being stuck in the error state.

strowi commented 1 year ago

Looks like we are running into this error 2years later with rancher 2.7.1. Having 1 downed Cluster block the whole process is what we were trying to circumvent with fleet. Any idea or timeline? Currently i have to change a selector to remove the cluster from the group.

manno commented 1 year ago

This might be related to default values in the rollout strategy. The defaults are documented in the fleet.yaml reference.

manno commented 3 weeks ago

Let's test if this still happens on 2.9.1

mmartin24 commented 3 weeks ago

It seems to still be happening on 2.9.1-rc3.

Adding some notes about how is it observed on this version:

On step 7 state is either Not Ready or Modified. Nevertheless, an error message is displayed: Error log:

Modified(3) [Bundle repo-r-test-bundle]; deployment.apps test-bundle/test modified {"spec":{"template":{"spec":{"containers":[{"image":"paulbouwer/hello-kubernetes:1.10.1","imagePullPolicy":"IfNotPresent","lifecycle":{"preStart":{"exec":{"command":["sleep","2"]}}},"name":"test","resources":{},"terminationMessagePath":"/dev/termination-log","terminationMessagePolicy":"File"}]}}}}

After step 10 State is Wait Applied directly:

After 'fix' from step 12 state of Git Repo is Wait Applied, yet, similar result to the originally described happens:

Error:

WaitApplied(1) [Bundle repo-r-test-bundle]; deployment.apps test-bundle/test modified {"spec":{"template":{"spec":{"containers":[{"image":"paulbouwer/hello-kubernetes:1.10.1","imagePullPolicy":"IfNotPresent","lifecycle":{"preStart":{"exec":{"command":["sleep","2"]}}},"name":"test","resources":{},"terminationMessagePath":"/dev/termination-log","terminationMessagePolicy":"File"}]}}}}

manno commented 4 days ago

When working on this we should

[ ] document how state fields are propagated between resources, like we do for resource counts

rancher / fleet

If any clusters are offline, bundle status can get stuck #594

Steps to reproduce: