github/Reloader
1
0
Fork 0
mirror of https://github.com/stakater/Reloader.git synced 2026-08-23 22:16:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update wording in readme (#730)

Browse Source 
* docs: update wording in readme

Signed-off-by: deggja <danieldagfinrud@gmail.com>

* docs: add part about default annotation

Signed-off-by: deggja <danieldagfinrud@gmail.com>

---------

Signed-off-by: deggja <danieldagfinrud@gmail.com>
This commit is contained in:
Daniel R. Dagfinrud
2024-08-22 22:59:16 +02:00
committed by GitHub
parent c06ecd1788
commit 6b856c84f1
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -1
View File
@@ -35,11 +35,14 @@ Reloader is compatible with Kubernetes >= 1.19
## How to use Reloader
For a `Deployment` called `foo` have a `ConfigMap` called `foo-configmap` or `Secret` called `foo-secret` or both. Then add your annotation (by default `reloader.stakater.com/auto`) to main metadata of your `Deployment`
You have a `Deployment` called `foo` and a `ConfigMap` and/or a `Secret` either mounted as a volume or defined as a environment variable. The `ConfigMap` and `Secret` can be named whatever, but for the sake of this example, lets refer to the `ConfigMap` as `foo-configmap` and the secret as `foo-secret`.
Add the annotation to the main metadata of your `Deployment`. By default this would be `reloader.stakater.com/auto`.
```yaml
kind: Deployment
metadata:
name: foo
annotations:
reloader.stakater.com/auto: "true"
spec: