Update README: add instructions for the use of secrets
continuous-integration/drone/pr Build is passing Details

Signed-off-by: CAMPION Hugo <h.campion@geco-it.fr>
This commit is contained in:
CAMPION Hugo 2023-11-16 15:38:11 +01:00
parent 9bb51e1666
commit 1583ce39c8
No known key found for this signature in database
GPG Key ID: 27899678213F98CF
1 changed files with 29 additions and 4 deletions

View File

@ -5,7 +5,7 @@ This Helm Chart deploys both the Vikunja [frontend](https://hub.docker.com/r/vik
## Requirements
- Kubernetes >= 1.19
- Kubernetes >= 1.19
- Helm >= 3
## Quickstart
@ -31,7 +31,7 @@ api:
To have the chart create one on your behalf:
```yaml
# You can find the default values
# You can find the default values
api:
enabled: true
persistence:
@ -52,7 +52,7 @@ For example, if you wished to create a `serviceAccount` as can be seen [here](ht
```yaml
api:
serviceAccount:
serviceAccount:
create: true
```
@ -62,7 +62,7 @@ Then, (for some reason), if you wished to deploy the `frontend` as a `DaemonSet`
frontend:
controller:
type: daemonset
```
```
### Another Example of Modifying `config.yml` (Enabling Registration)
@ -85,6 +85,31 @@ If you need to create another user, you could opt to execute the following comma
./vikunja user create --email <user@email.com> --user <user1> --password <password123>
```
### Utilizing secrets for `env` and `config.yml`
Each env in the stack can be sourced from a secret in your `values.yaml`:
```yaml
api:
env:
VIKUNJA_DATABASE_PASSWORD:
valueFrom:
secretKeyRef:
name: vikunja-env
key: VIKUNJA_DATABASE_PASSWORD
```
If your vikunja config needs to contain sensible data, like oauth config, you can source it from a secret in your `values.yaml`:
```yaml
api:
persistence:
config:
enabled: true
type: secret
mountPath: /etc/vikunja/config.yml
# Warning, you can not choose the secret name here, it will search for {{ Release.Name }}-api-config ! So please create your secret accordingly !
```
## Publishing
The following steps are automatically performed when a git tag for a new version is pushed to the repository.