WIP: main Update default values.yaml to make persistence work + update readme for secrets usage #16
33
README.md
33
README.md
|
@ -5,7 +5,7 @@ This Helm Chart deploys both the Vikunja [frontend](https://hub.docker.com/r/vik
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- Kubernetes >= 1.19
|
- Kubernetes >= 1.19
|
||||||
- Helm >= 3
|
- Helm >= 3
|
||||||
|
|
||||||
## Quickstart
|
## Quickstart
|
||||||
|
@ -31,7 +31,7 @@ api:
|
||||||
To have the chart create one on your behalf:
|
To have the chart create one on your behalf:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# You can find the default values
|
# You can find the default values
|
||||||
api:
|
api:
|
||||||
enabled: true
|
enabled: true
|
||||||
persistence:
|
persistence:
|
||||||
|
@ -52,7 +52,7 @@ For example, if you wished to create a `serviceAccount` as can be seen [here](ht
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
api:
|
api:
|
||||||
serviceAccount:
|
serviceAccount:
|
||||||
create: true
|
create: true
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -62,7 +62,7 @@ Then, (for some reason), if you wished to deploy the `frontend` as a `DaemonSet`
|
||||||
frontend:
|
frontend:
|
||||||
controller:
|
controller:
|
||||||
type: daemonset
|
type: daemonset
|
||||||
```
|
```
|
||||||
|
|
||||||
### Another Example of Modifying `config.yml` (Enabling Registration)
|
### 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>
|
./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:
|
||||||
perfectra1n
commented
Instead of:
You could do the following:
Since the config is already enabled by default. Also this way you can provide the name of the secret, and you don't have to provide the Instead of:
```yaml
persistence:
config:
enabled: true
type: secret
mountPath: /etc/vikunja/config.yml
```
You could do the following:
```yaml
api:
persistence:
config:
type: secret
name: asdf-my-custom-secret1
```
Since the config is already enabled by default.
Also this way you can provide the name of the secret, and you don't have to provide the `mountPath` again since it's already part of the template [here](https://kolaente.dev/vikunja/helm-chart/src/commit/62112e8df085b4868bb934f64c0debccee3d1545/templates/api.yaml#L22).
|
|||||||
|
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
|
## Publishing
|
||||||
|
|
||||||
The following steps are automatically performed when a git tag for a new version is pushed to the repository.
|
The following steps are automatically performed when a git tag for a new version is pushed to the repository.
|
||||||
|
|
|
@ -25,6 +25,7 @@ api:
|
||||||
# existingClaim: # your-claim
|
# existingClaim: # your-claim
|
||||||
accessMode: ReadWriteOnce
|
accessMode: ReadWriteOnce
|
||||||
size: 10Gi
|
size: 10Gi
|
||||||
|
mountPath: /app/vikunja/files
|
||||||
# storageClass: storage-class
|
# storageClass: storage-class
|
||||||
ingress:
|
ingress:
|
||||||
main:
|
main:
|
||||||
|
|
Loading…
Reference in New Issue
Block a user
Maybe we could change this header to be:
"Utilizing environment variables from Kubernetes secrets"?
"Each environment variable within the pod can be sourced from a secret in your
values.yaml
":Alternatively, instead of defining each and every key, if the keys within the secret are the names of environment variables, you could also do the following (example here):
This way we can show in the example that you can both use environment variables from secrets, how to use
envFrom
, etc.I should've included this already in the README.md, so I'm thankful that you brought it up!