apache / apache/devlake-helm-chart

Add ENCODE_KEY helm values inputs

Open
#133 2 comments 1 reaction 0 assignees View on GitHub
Dominant language
Go Template
Stars
52
Forks
72
Avg merge
21h 4m
Merged PRs (30d)
1

Description

We recently found out the hard way about the `encKey` used to encrypt things in the database. It would be helpful for users deploying on kubernetes if the default values file contained references to this feature so that it is more obvious that it can be set (rather than generated by a container that may not persist).

My suggestion is to add inputs in the values file like:
```yaml
# This is the string used to encrypt sensitive things like PATs in the database.
# Alternatively, you may supply this value to the `lake` container directly as environment variable `ENCODE_KEY`
# If unset, a key will be created dynamically, in which case you should retrieve it and store it somewhere secure and persistent
encodeKey:
secretName: "" # the name of the Secret containing this encryption key
secretKey: "" # the name of the key within that Secret which contains the encryption key as its value
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.