From aaab4497584daddcd96f138969a057ee88dbfe0e Mon Sep 17 00:00:00 2001
From: Tim Campbell <timetinytim@gmail.com>
Date: Tue, 9 Jul 2024 15:51:10 +0200
Subject: [PATCH] Added additional comments preparing for sidekiq readiness
 probes

---
 templates/deployment-sidekiq.yaml | 15 ++++++++++++++-
 values.yaml                       |  5 ++++-
 2 files changed, 18 insertions(+), 2 deletions(-)

diff --git a/templates/deployment-sidekiq.yaml b/templates/deployment-sidekiq.yaml
index e998a3c..b10573c 100644
--- a/templates/deployment-sidekiq.yaml
+++ b/templates/deployment-sidekiq.yaml
@@ -201,7 +201,20 @@ spec:
           {{- with $context.Values.volumeMounts }}
             {{- toYaml . | nindent 12 }}
           {{- end }}
-          resources:
+          # NOTE: Readiness probe will only work on versions of Mastodon built after 2024-07-10.
+          # Will be un-commented once this is in an official release.
+          #
+          #readinessProbe:
+          #  failureThreshold: 10
+          #  exec:
+          #    command:
+          #    - cat
+          #    - /var/www/tmp/sidekiq_process_has_started_and_will_begin_processing_jobs
+          #  initialDelaySeconds: 10
+          #  periodSeconds: 2
+          #  successThreshold: 2
+          #  timeoutSeconds: 1
+          #resources:
             {{- toYaml (default (default $context.Values.resources $context.Values.mastodon.sidekiq.resources) .resources) | nindent 12 }}
       {{- include "mastodon.statsdExporterContainer" $ | indent 8 }}
       {{- with $context.Values.nodeSelector }}
diff --git a/values.yaml b/values.yaml
index cd047ec..827190c 100644
--- a/values.yaml
+++ b/values.yaml
@@ -138,7 +138,10 @@ mastodon:
     resources: {}
     # -- Affinity for all Sidekiq Deployments unless overwritten, overwrites .Values.affinity
     affinity: {}
-    # Rollout strategy to use when updating pods
+    # Rollout strategy to use when updating pods.
+    # Recreate is recommended for sidekiq pods for now because of possible data
+    # error between old/new versions. Please only use RollingUpdate if you are
+    # running a Mastodon version built after 2024-07-10.
     # ref: https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#strategy
     updateStrategy:
       type: Recreate