From 8d9e01f599d5d461f3286bc4cfaf97c960526880 Mon Sep 17 00:00:00 2001
From: Niclas Schad <niclas.schad@gmail.com>
Date: Mon, 1 Jul 2024 08:39:55 +0200
Subject: [PATCH] remove default livenessProbe for compactor and
 storage-gateway

Signed-off-by: Niclas Schad <niclas.schad@gmail.com>
---
 CHANGELOG.md                                         |  2 ++
 README.md                                            |  8 ++------
 templates/compactor/compactor-statefulset.yaml       |  2 ++
 .../store-gateway/store-gateway-statefulset.yaml     |  2 ++
 values.yaml                                          | 12 ++----------
 5 files changed, 10 insertions(+), 16 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 5bc028cc..985757dc 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## master / unreleased
 
+* [CHANGE] Removed the default `livenessProbe` for store-gateway and compactor. You can still use a `livenessProbe` but we advise against it #502
+
 ## 2.2.0 / 2024-01-16
 
 * [CHANGE] Removed `config.storage.engine` and any reference of it #488
diff --git a/README.md b/README.md
index a3c1d335..24302b9b 100644
--- a/README.md
+++ b/README.md
@@ -179,9 +179,7 @@ Kubernetes: `^1.19.0-0`
 | compactor.&ZeroWidthSpace;extraVolumeMounts | list | `[]` |  |
 | compactor.&ZeroWidthSpace;extraVolumes | list | `[]` |  |
 | compactor.&ZeroWidthSpace;initContainers | list | `[]` |  |
-| compactor.&ZeroWidthSpace;livenessProbe.&ZeroWidthSpace;httpGet.&ZeroWidthSpace;path | string | `"/ready"` |  |
-| compactor.&ZeroWidthSpace;livenessProbe.&ZeroWidthSpace;httpGet.&ZeroWidthSpace;port | string | `"http-metrics"` |  |
-| compactor.&ZeroWidthSpace;livenessProbe.&ZeroWidthSpace;httpGet.&ZeroWidthSpace;scheme | string | `"HTTP"` |  |
+| compactor.&ZeroWidthSpace;livenessProbe | list | `[]` |  |
 | compactor.&ZeroWidthSpace;nodeSelector | object | `{}` |  |
 | compactor.&ZeroWidthSpace;persistentVolume.&ZeroWidthSpace;accessModes | list | `["ReadWriteOnce"]` | compactor data Persistent Volume access modes Must match those of existing PV or dynamic provisioner Ref: http://kubernetes.io/docs/user-guide/persistent-volumes/ |
 | compactor.&ZeroWidthSpace;persistentVolume.&ZeroWidthSpace;annotations | object | `{}` | compactor data Persistent Volume Claim annotations |
@@ -810,9 +808,7 @@ Kubernetes: `^1.19.0-0`
 | store_gateway.&ZeroWidthSpace;extraVolumeMounts | list | `[]` |  |
 | store_gateway.&ZeroWidthSpace;extraVolumes | list | `[]` |  |
 | store_gateway.&ZeroWidthSpace;initContainers | list | `[]` |  |
-| store_gateway.&ZeroWidthSpace;livenessProbe.&ZeroWidthSpace;httpGet.&ZeroWidthSpace;path | string | `"/ready"` |  |
-| store_gateway.&ZeroWidthSpace;livenessProbe.&ZeroWidthSpace;httpGet.&ZeroWidthSpace;port | string | `"http-metrics"` |  |
-| store_gateway.&ZeroWidthSpace;livenessProbe.&ZeroWidthSpace;httpGet.&ZeroWidthSpace;scheme | string | `"HTTP"` |  |
+| store_gateway.&ZeroWidthSpace;livenessProbe | list | `[]` |  |
 | store_gateway.&ZeroWidthSpace;nodeSelector | object | `{}` |  |
 | store_gateway.&ZeroWidthSpace;persistentVolume.&ZeroWidthSpace;accessModes | list | `["ReadWriteOnce"]` | Store-gateway data Persistent Volume access modes Must match those of existing PV or dynamic provisioner Ref: http://kubernetes.io/docs/user-guide/persistent-volumes/ |
 | store_gateway.&ZeroWidthSpace;persistentVolume.&ZeroWidthSpace;annotations | object | `{}` | Store-gateway data Persistent Volume Claim annotations |
diff --git a/templates/compactor/compactor-statefulset.yaml b/templates/compactor/compactor-statefulset.yaml
index c051e69c..12578172 100644
--- a/templates/compactor/compactor-statefulset.yaml
+++ b/templates/compactor/compactor-statefulset.yaml
@@ -127,8 +127,10 @@ spec:
               protocol: TCP
           startupProbe:
             {{- toYaml .Values.compactor.startupProbe | nindent 12 }}
+          {{- if .Values.compactor.livenessProbe }}
           livenessProbe:
             {{- toYaml .Values.compactor.livenessProbe | nindent 12 }}
+          {{- end }}
           readinessProbe:
             {{- toYaml .Values.compactor.readinessProbe | nindent 12 }}
           resources:
diff --git a/templates/store-gateway/store-gateway-statefulset.yaml b/templates/store-gateway/store-gateway-statefulset.yaml
index ad97f7aa..e29f519b 100644
--- a/templates/store-gateway/store-gateway-statefulset.yaml
+++ b/templates/store-gateway/store-gateway-statefulset.yaml
@@ -133,8 +133,10 @@ spec:
               protocol: TCP
           startupProbe:
             {{- toYaml .Values.store_gateway.startupProbe | nindent 12 }}
+          {{- if .Values.store_gateway.livenessProbe }}
           livenessProbe:
             {{- toYaml .Values.store_gateway.livenessProbe | nindent 12 }}
+          {{- end }}
           readinessProbe:
             {{- toYaml .Values.store_gateway.readinessProbe | nindent 12 }}
           resources:
diff --git a/values.yaml b/values.yaml
index 908b4cf4..1ba76ce1 100644
--- a/values.yaml
+++ b/values.yaml
@@ -1406,11 +1406,7 @@ store_gateway:
       path: /ready
       port: http-metrics
       scheme: HTTP
-  livenessProbe:
-    httpGet:
-      path: /ready
-      port: http-metrics
-      scheme: HTTP
+  livenessProbe: []
   readinessProbe:
     httpGet:
       path: /ready
@@ -1526,11 +1522,7 @@ compactor:
       path: /ready
       port: http-metrics
       scheme: HTTP
-  livenessProbe:
-    httpGet:
-      path: /ready
-      port: http-metrics
-      scheme: HTTP
+  livenessProbe: []
   readinessProbe:
     httpGet:
       path: /ready