Skip to content

Commit 070355e

Browse files
committed
feature "reload-on-delete" documented in README.md
1 parent 49997ac commit 070355e

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

+11-6
Original file line numberDiff line numberDiff line change
@@ -327,6 +327,7 @@ helm uninstall {{RELEASE_NAME}} -n {{NAMESPACE}}
327327
| `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` |
328328
| `reloader.ignoreConfigMaps` | To ignore configMaps. Valid value are either `true` or `false` | boolean | `false` |
329329
| `reloader.reloadOnCreate` | Enable reload on create events. Valid value are either `true` or `false` | boolean | `false` |
330+
| `reloader.reloadOnDelete` | Enable reload on delete events. Valid value are either `true` or `false` | boolean | `false` |
330331
| `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` |
331332
| `reloader.reloadStrategy` | Strategy to trigger resource restart, set to either `default`, `env-vars` or `annotations` | enumeration | `default` |
332333
| `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}}
385386
- 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
386387
- `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
387388
- `reloadOnCreate` controls how Reloader handles secrets being added to the cache for the first time. If `reloadOnCreate` is set to true:
388-
1. Configmaps/secrets being added to the cache will cause Reloader to perform a rolling update of the associated workload
389-
1. When applications are deployed for the first time, Reloader will perform a rolling update of the associated workload
390-
1. If you are running Reloader in HA mode all workloads will have a rolling update performed when a new leader is elected
389+
1. Configmaps/secrets being added to the cache will cause Reloader to perform a rolling update of the associated workload
390+
1. When applications are deployed for the first time, Reloader will perform a rolling update of the associated workload
391+
1. If you are running Reloader in HA mode all workloads will have a rolling update performed when a new leader is elected
392+
- `reloadOnDelete` controls how Reloader handles secrets being deleted. If `reloadOnDelete` is set to true:
393+
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
391394
- `serviceMonitor` will be removed in future releases of Reloader in favour of Pod monitor
392395
- If `reloadOnCreate` is set to false:
393-
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
394-
1. In the worst case the window in which there can be no leader is 15s as this is the LeaseDuration
395-
- By default, `reloadOnCreate` and `syncAfterRestart` are both set to false. Both need to be enabled explicitly
396+
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
397+
1. In the worst case the window in which there can be no leader is 15s as this is the LeaseDuration
398+
- If `reloadOnDelete` is set to false:
399+
1. Deleting of configmaps/secrets has no effect to pods that references these resources.
400+
- By default, `reloadOnCreate`, `reloadOnDelete` and `syncAfterRestart` are all set to false. All need to be enabled explicitly
396401

397402
## Help
398403

0 commit comments

Comments
 (0)