fix swapped liveness/readiness http paths. (#4541)

* created changelog fragment * fixed scaffold template for the manager resource (ansible/helm) * fixed testdata (ansible/helm) Signed-off-by: Florin Hillebrand <flozzone@gmail.com>
operator-framework · Feb 17, 2021 · d27c46d · d27c46d
1 parent 7dc62b5
commit d27c46d
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 12 deletions.
diff --git a/changelog/fragments/swap-readiness-liveness-paths-4541.yaml b/changelog/fragments/swap-readiness-liveness-paths-4541.yaml
@@ -0,0 +1,29 @@
+# issue #4541
+entries:
+  - description: >
+      For Ansible/Helm-based operators, fix swapped readinessProbe/livenessProbe in manager
+    kind: "bugfix"
+    breaking: false
+    migration:
+      header: For Ansible/Helm-based operators, swap the paths of the probes in config/manager/manager.yaml.
+      body: >
+        If the project structure has been scaffolded with operator-sdk >= v1.4.0, then the
+        HTTP paths for the `readinessProbe` and `livenessProbe` in the manager resource are wrong.
+
+        To fix this, swap both HTTP paths `config/manager/manager.yaml`. At the end you should have the
+        following probes in the deployment resource for the manager:
+
+        ```
+          livenessProbe:
+            httpGet:
+              path: /healthz
+              port: 6789
+            initialDelaySeconds: 15
+            periodSeconds: 20
+          readinessProbe:
+            httpGet:
+              path: /readyz
+              port: 6789
+            initialDelaySeconds: 5
+            periodSeconds: 10
+        ```
diff --git a/internal/plugins/ansible/v1/scaffolds/internal/templates/config/manager/manager.go b/internal/plugins/ansible/v1/scaffolds/internal/templates/config/manager/manager.go
@@ -80,13 +80,13 @@ spec:
           image: {{ .Image }}
           livenessProbe:
             httpGet:
-              path: /readyz
+              path: /healthz
               port: 6789
             initialDelaySeconds: 15
             periodSeconds: 20
           readinessProbe:
             httpGet:
-              path: /healthz
+              path: /readyz
               port: 6789
             initialDelaySeconds: 5
             periodSeconds: 10

diff --git a/internal/plugins/helm/v1/scaffolds/internal/templates/config/manager/manager.go b/internal/plugins/helm/v1/scaffolds/internal/templates/config/manager/manager.go
@@ -77,13 +77,13 @@ spec:
         name: manager
         livenessProbe:
           httpGet:
-            path: /readyz
+            path: /healthz
             port: 8081
           initialDelaySeconds: 15
           periodSeconds: 20
         readinessProbe:
           httpGet:
-            path: /healthz
+            path: /readyz
             port: 8081
           initialDelaySeconds: 5
           periodSeconds: 10

diff --git a/...ansible/memcached-operator/bundle/manifests/memcached-operator.clusterserviceversion.yaml b/...ansible/memcached-operator/bundle/manifests/memcached-operator.clusterserviceversion.yaml
@@ -126,14 +126,14 @@ spec:
                 image: quay.io/example/memcached-operator:v0.0.1
                 livenessProbe:
                   httpGet:
-                    path: /readyz
+                    path: /healthz
                     port: 6789
                   initialDelaySeconds: 15
                   periodSeconds: 20
                 name: manager
                 readinessProbe:
                   httpGet:
-                    path: /healthz
+                    path: /readyz
                     port: 6789
                   initialDelaySeconds: 5
                   periodSeconds: 10

diff --git a/testdata/ansible/memcached-operator/config/manager/manager.yaml b/testdata/ansible/memcached-operator/config/manager/manager.yaml
@@ -33,13 +33,13 @@ spec:
           image: controller:latest
           livenessProbe:
             httpGet:
-              path: /readyz
+              path: /healthz
               port: 6789
             initialDelaySeconds: 15
             periodSeconds: 20
           readinessProbe:
             httpGet:
-              path: /healthz
+              path: /readyz
               port: 6789
             initialDelaySeconds: 5
             periodSeconds: 10

diff --git a/...ta/helm/memcached-operator/bundle/manifests/memcached-operator.clusterserviceversion.yaml b/...ta/helm/memcached-operator/bundle/manifests/memcached-operator.clusterserviceversion.yaml
@@ -211,14 +211,14 @@ spec:
                 image: quay.io/example/memcached-operator:v0.0.1
                 livenessProbe:
                   httpGet:
-                    path: /readyz
+                    path: /healthz
                     port: 8081
                   initialDelaySeconds: 15
                   periodSeconds: 20
                 name: manager
                 readinessProbe:
                   httpGet:
-                    path: /healthz
+                    path: /readyz
                     port: 8081
                   initialDelaySeconds: 5
                   periodSeconds: 10

diff --git a/testdata/helm/memcached-operator/config/manager/manager.yaml b/testdata/helm/memcached-operator/config/manager/manager.yaml
@@ -30,13 +30,13 @@ spec:
         name: manager
         livenessProbe:
           httpGet:
-            path: /readyz
+            path: /healthz
             port: 8081
           initialDelaySeconds: 15
           periodSeconds: 20
         readinessProbe:
           httpGet:
-            path: /healthz
+            path: /readyz
             port: 8081
           initialDelaySeconds: 5
           periodSeconds: 10