vikunja
/
helm-chart
2
2
Fork 5
Code Issues 6 Pull Requests Packages Projects Releases 1 Wiki Activity

WIP: main Update default values.yaml to make persistence work + update readme for secrets usage #16

Closed
hugosxm wants to merge 2 commits from hugosxm/helm-chart:main into main
pull from: hugosxm/helm-chart:main
merge into: vikunja:main
Conversation 3 Commits 2 Files Changed 2 +30 -4
hugosxm commented 2023-11-16 14:43:07 +00:00
First-time contributor
Copy Link
No description provided.
hugosxm added 2 commits 2023-11-16 14:43:08 +00:00
9bb51e1666
Fix wrong mountPath for default PVC in value.yaml 
Signed-off-by: CAMPION Hugo <h.campion@geco-it.fr>
continuous-integration/drone/pr Build is passing Details
1583ce39c8
Update README: add instructions for the use of secrets 
Signed-off-by: CAMPION Hugo <h.campion@geco-it.fr>
perfectra1n requested changes 2023-11-17 16:01:32 +00:00
README.md
@ -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`
perfectra1n commented 2023-11-17 15:56:23 +00:00
Contributor
Copy Link

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":

api:
  env:
    VIKUNJA_DATABASE_PASSWORD:
      valueFrom:
        secretKeyRef:
          name: vikunja-env
          key: VIKUNJA_DATABASE_PASSWORD
    VIKUNJA_DATABASE_USERNAME: "db-user"

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):

api:
  envFrom:
    - secretRef:
      name: vikunja-secret-env
  env:
    VIKUNJA_DATABASE_USERNAME: "db-user"

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!

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`": ```yaml api: env: VIKUNJA_DATABASE_PASSWORD: valueFrom: secretKeyRef: name: vikunja-env key: VIKUNJA_DATABASE_PASSWORD VIKUNJA_DATABASE_USERNAME: "db-user" ``` 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](https://github.com/bjw-s/helm-charts/blob/a081de53024d8328d1ae9ff7e4f6bc500b0f3a29/charts/library/common/values.yaml#L155)): ```yaml api: envFrom: - secretRef: name: vikunja-secret-env env: VIKUNJA_DATABASE_USERNAME: "db-user" ``` 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!
README.md
@ -88,0 +101,4 @@
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 2023-11-17 15:48:00 +00:00
Contributor
Copy Link

Instead of:

  persistence:
    config:
      enabled: true
      type: secret
      mountPath: /etc/vikunja/config.yml

You could do the following:

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.

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).
perfectra1n commented 2023-11-19 23:51:15 +00:00
Contributor
Copy Link

Created #17 so that the issue could at least be resolved, and so that more documentation could be available.

Created #17 so that the issue could at least be resolved, and so that more documentation could be available.
perfectra1n commented 2023-11-20 21:34:49 +00:00
Contributor
Copy Link

@hugosxm I believe that my PR #17 should've resolved the issues you brought up previously, as well as increasing the documentation around the use cases that you provided. Let me know if there's anything else that you would like to see, I believe this PR can be closed out otherwise though.

Again, feel free to reach out, and thanks for your contribution and help!

@hugosxm I believe that my PR #17 should've resolved the issues you brought up previously, as well as increasing the documentation around the use cases that you provided. Let me know if there's anything else that you would like to see, I believe this PR can be closed out otherwise though. Again, feel free to reach out, and thanks for your contribution and help!
hugosxm commented 2023-12-08 11:01:51 +00:00
Author
First-time contributor
Copy Link

Closing this, #17 is merged

Closing this, https://kolaente.dev/vikunja/helm-chart/pulls/17 is merged
hugosxm closed this pull request 2023-12-08 11:01:51 +00:00
All checks were successful
continuous-integration/drone/pr Build is passing
Required
Details

Pull request closed

Please reopen this pull request to perform a merge.
Sign in to join this conversation.
Reviewers
No reviewers
perfectra1n
Labels
Clear labels   
bug

Something is not working

  
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
help wanted

Need some help

  
invalid

Something is wrong

  
question

More information is needed

  
wontfix

This won't be fixed

No Label
bug
duplicate
enhancement
help wanted
invalid
question
wontfix
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: vikunja/helm-chart#16
No description provided.
Delete Branch "hugosxm/helm-chart:main"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?