You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+25-28
Original file line number
Diff line number
Diff line change
@@ -189,7 +189,7 @@ By default, Reloader gets deployed in `default` namespace and watches changes `s
189
189
Reloader can be configured to ignore the resources `secrets` and `configmaps` by passing the following arguments (`spec.template.spec.containers.args`) to its container :
| --resources-to-ignore=configMaps | To ignore configMaps |
194
194
| --resources-to-ignore=secrets | To ignore secrets |
195
195
@@ -199,7 +199,7 @@ Reloader can be configured to only watch secrets/configmaps with one or more lab
199
199
200
200
**Note:** The old `:` delimited key value mappings are deprecated and if provided will be translated to `key=value`. Likewise, if a wildcard value is provided (e.g. `key:*`) it will be translated to the standalone `key` which checks for key existence.
201
201
202
-
These selectors can be combined together, for example with:
202
+
These selectors can be combined, for example with:
203
203
204
204
```yaml
205
205
--resource-label-selector=reloader=enabled,key-exists,another-label in (value1,value2,value3)
@@ -211,20 +211,17 @@ Only configmaps or secrets labeled like the following will be watched:
211
211
kind: ConfigMap
212
212
apiVersion: v1
213
213
metadata:
214
-
...
215
214
labels:
216
215
reloader: enabled
217
216
key-exists: yes
218
217
another-label: value1
219
-
220
-
...
221
218
```
222
219
223
220
Reloader can be configured to only watch namespaces labeled with one or more labels using the `--namespace-selector` parameter. Supported operators are `!, in, notin, ==, =, !=`, if no operator is found the 'exists' operator is inferred (i.e. key only). Additional examples of these selectors can be found in the [Kubernetes Docs](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors).
224
221
225
222
**Note:** The old `:` delimited key value mappings are deprecated and if provided will be translated to `key=value`. Likewise, if a wildcard value is provided (e.g. `key:*`) it will be translated to the standalone `key` which checks for key existence.
226
223
227
-
These selectors can be combined together, for example with:
224
+
These selectors can be combined, for example with:
228
225
229
226
```yaml
230
227
--namespace-selector=reloader=enabled,test=true
@@ -236,11 +233,9 @@ Only namespaces labeled as below would be watched and eligible for reloads:
236
233
kind: Namespace
237
234
apiVersion: v1
238
235
metadata:
239
-
...
240
236
labels:
241
237
reloader: enabled
242
238
test: true
243
-
...
244
239
```
245
240
246
241
### Vanilla Kustomize
@@ -261,7 +256,7 @@ You can write your own `kustomization.yaml` using ours as a 'base' and write pat
| resourceLabelSelector | list of comma separated label selectors, if multiple are provided they are combined with the AND operator | string | "" |
308
303
309
304
**Note:** Both `namespaceSelector` & `resourceLabelSelector` can be used together. If they are then both conditions must be met for the configmap or secret to be eligible to trigger reload events. (e.g. If a configMap matches `resourceLabelSelector` but `namespaceSelector` does not match the namespace the configmap is in, it will be ignored).
310
305
@@ -314,25 +309,27 @@ You can enable to scrape Reloader's Prometheus metrics by setting `serviceMonito
314
309
315
310
**Note:** 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. This can be done by changing the following parameters:
| isOpenshift | Enable OpenShift DeploymentConfigs. Valid value are either `true` or `false` | boolean |
320
-
| isArgoRollouts | Enable Argo `Rollouts`. Valid value are either `true` or `false` | boolean |
321
-
| reloadOnCreate | Enable reload on create events. Valid value are either `true` or `false` | boolean |
322
-
| syncAfterRestart | Enable sync after Reloader restarts for **Add** events, works only when reloadOnCreate is `true`. Valid value are either `true` or `false` | boolean |
| isOpenshift | Enable OpenShift DeploymentConfigs. Valid value are either `true` or `false` | boolean | false |
315
+
| isArgoRollouts | Enable Argo `Rollouts`. Valid value are either `true` or `false` | boolean | false |
316
+
| reloadOnCreate | Enable reload on create events. Valid value are either `true` or `false` | boolean | false |
317
+
| syncAfterRestart | Enable sync after Reloader restarts for **Add** events, works only when reloadOnCreate is `true`. Valid value are either `true` or `false` | boolean | false |
323
318
324
319
**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.
325
320
326
-
**ReloadOnCreate** reloadOnCreate controls how Reloader handles secrets being added to the cache for the first time. If reloadOnCreate is set to true:
321
+
**reloadOnCreate** controls how Reloader handles secrets being added to the cache for the first time. If reloadOnCreate is set to true:
327
322
328
323
- Configmaps/secrets being added to the cache will cause Reloader to perform a rolling update of the associated workload.
329
324
- When applications are deployed for the first time, Reloader will perform a rolling update of the associated workload.
330
325
- If you are running Reloader in HA mode all workloads will have a rolling update performed when a new leader is elected.
331
326
332
-
If ReloadOnCreate is set to false:
327
+
If reloadOnCreate is set to false:
333
328
334
329
- 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. In the worst case the window in which there can be no leader is 15s as this is the LeaseDuration.
335
330
331
+
**Note:** By default, **reloadOnCreate** and **syncAfterRestart** are both set to false. Both need to be enabled explicitly.
332
+
336
333
## Help
337
334
338
335
### Documentation
@@ -360,7 +357,7 @@ Please use the [issue tracker](https://github.com/stakater/Reloader/issues) to r
360
357
361
358
1. Deploy Reloader.
362
359
1. Run `okteto up` to activate your development container.
363
-
1. `make build`.
360
+
1. `make build`
364
361
1. `./Reloader`
365
362
366
363
PRs are welcome. In general, we follow the "fork-and-pull" Git workflow.
0 commit comments