From 0113b21af952968c35748a1758e0359db874ee6d Mon Sep 17 00:00:00 2001 From: Markus Pesch Date: Sun, 30 Nov 2025 11:54:50 +0100 Subject: [PATCH] docs(README): adapt stakaters reloader example --- README.md | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index aaaa0b6..e43ec0e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# athens-proxy-charts +# Athens - A Go module datastore and proxy [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/volker-raschek)](https://artifacthub.io/packages/search?repo=volker-raschek) @@ -120,18 +120,13 @@ before expiring. Until the exporter does not support rotating TLS certificate a workaround can be applied. For example stakater's [reloader](https://github.com/stakater/Reloader) controller can be used to trigger a rolling update. The following -annotation must be added to instruct the reloader controller to trigger a rolling update, when the mounted configMaps -and secrets have been changed. +annotation must be added to instruct the reloader controller to trigger a rolling update, when the mounted secret has +been changed. -```yaml -deployment: - annotations: - reloader.stakater.com/auto: "true" -``` - -Instead of triggering a rolling update for configMap and secret resources, this action can also be defined for -individual items. For example, when the secret named `athens-proxy-tls` is mounted and the reloader controller should -only listen for changes of this secret: +> [!IMPORTANT] +> The Helm chart already adds annotations to trigger a rolling release. Helm describes this approach under +> [Automatically Roll Deployments](https://helm.sh/docs/howto/charts_tips_and_tricks/#automatically-roll-deployments). +> For this reason, **only external** configMaps or secrets need to be monitored by reloader. ```yaml deployment: @@ -149,8 +144,8 @@ stakater's reloader. ```diff deployment: annotations: - reloader.stakater.com/auto: "true" + reloader.stakater.com/rollout-strategy: "restart" + secret.reloader.stakater.com/reload: "athens-proxy-tls" ``` #### Network policies