From 070355e79dfaefe58e62826f3b86a9412e16b689 Mon Sep 17 00:00:00 2001 From: DESCHMIH Date: Mon, 8 Jul 2024 09:47:54 +0200 Subject: [PATCH 1/2] feature "reload-on-delete" documented in README.md --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3f6f9d3fd..aa55a4040 100644 --- a/README.md +++ b/README.md @@ -327,6 +327,7 @@ helm uninstall {{RELEASE_NAME}} -n {{NAMESPACE}} | `reloader.ignoreSecrets` | To ignore secrets. Valid value are either `true` or `false`. Either `ignoreSecrets` or `ignoreConfigMaps` can be ignored, not both at the same time | boolean | `false` | | `reloader.ignoreConfigMaps` | To ignore configMaps. Valid value are either `true` or `false` | boolean | `false` | | `reloader.reloadOnCreate` | Enable reload on create events. Valid value are either `true` or `false` | boolean | `false` | +| `reloader.reloadOnDelete` | Enable reload on delete events. Valid value are either `true` or `false` | boolean | `false` | | `reloader.syncAfterRestart` | Enable sync after Reloader restarts for **Add** events, works only when reloadOnCreate is `true`. Valid value are either `true` or `false` | boolean | `false` | | `reloader.reloadStrategy` | Strategy to trigger resource restart, set to either `default`, `env-vars` or `annotations` | enumeration | `default` | | `reloader.ignoreNamespaces` | List of comma separated namespaces to ignore, if multiple are provided, they are combined with the AND operator | string | `""` | @@ -385,14 +386,18 @@ helm uninstall {{RELEASE_NAME}} -n {{NAMESPACE}} - Reloading of OpenShift (DeploymentConfig) and/or Argo `Rollouts` has to be enabled explicitly because it might not be always possible to use it on a cluster with restricted permissions - `isOpenShift` Recent versions of OpenShift (tested on 4.13.3) require the specified user to be in an `uid` range which is dynamically assigned by the namespace. The solution is to unset the runAsUser variable via ``deployment.securityContext.runAsUser=null`` and let OpenShift assign it at install - `reloadOnCreate` controls how Reloader handles secrets being added to the cache for the first time. If `reloadOnCreate` is set to true: - 1. Configmaps/secrets being added to the cache will cause Reloader to perform a rolling update of the associated workload - 1. When applications are deployed for the first time, Reloader will perform a rolling update of the associated workload - 1. If you are running Reloader in HA mode all workloads will have a rolling update performed when a new leader is elected + 1. Configmaps/secrets being added to the cache will cause Reloader to perform a rolling update of the associated workload + 1. When applications are deployed for the first time, Reloader will perform a rolling update of the associated workload + 1. If you are running Reloader in HA mode all workloads will have a rolling update performed when a new leader is elected +- `reloadOnDelete` controls how Reloader handles secrets being deleted. If `reloadOnDelete` is set to true: + 1. Configmaps/secrets being deleted will cause Reloader to perform a rolling update of the associated workload- `serviceMonitor` will be removed in future releases of Reloader in favour of Pod monitor - `serviceMonitor` will be removed in future releases of Reloader in favour of Pod monitor - If `reloadOnCreate` is set to false: - 1. Updates to configmaps/secrets that occur while there is no leader will not be picked up by the new leader until a subsequent update of the configmap/secret occurs - 1. In the worst case the window in which there can be no leader is 15s as this is the LeaseDuration -- By default, `reloadOnCreate` and `syncAfterRestart` are both set to false. Both need to be enabled explicitly + 1. Updates to configmaps/secrets that occur while there is no leader will not be picked up by the new leader until a subsequent update of the configmap/secret occurs + 1. In the worst case the window in which there can be no leader is 15s as this is the LeaseDuration +- If `reloadOnDelete` is set to false: + 1. Deleting of configmaps/secrets has no effect to pods that references these resources. +- By default, `reloadOnCreate`, `reloadOnDelete` and `syncAfterRestart` are all set to false. All need to be enabled explicitly ## Help From 3f49abebb9ee63fb1bfd23d6f79f023218390bd4 Mon Sep 17 00:00:00 2001 From: DESCHMIH Date: Mon, 8 Jul 2024 09:47:54 +0200 Subject: [PATCH 2/2] feature "reload-on-delete" documented in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index aa55a4040..f9c5a9487 100644 --- a/README.md +++ b/README.md @@ -390,7 +390,7 @@ helm uninstall {{RELEASE_NAME}} -n {{NAMESPACE}} 1. When applications are deployed for the first time, Reloader will perform a rolling update of the associated workload 1. If you are running Reloader in HA mode all workloads will have a rolling update performed when a new leader is elected - `reloadOnDelete` controls how Reloader handles secrets being deleted. If `reloadOnDelete` is set to true: - 1. Configmaps/secrets being deleted will cause Reloader to perform a rolling update of the associated workload- `serviceMonitor` will be removed in future releases of Reloader in favour of Pod monitor + 1. Configmaps/secrets being deleted will cause Reloader to perform a rolling update of the associated workload - `serviceMonitor` will be removed in future releases of Reloader in favour of Pod monitor - If `reloadOnCreate` is set to false: 1. Updates to configmaps/secrets that occur while there is no leader will not be picked up by the new leader until a subsequent update of the configmap/secret occurs