|
||
---|---|---|
templates | ||
.drone.yml | ||
.gitignore | ||
.helmignore | ||
Chart.lock | ||
Chart.yaml | ||
icon.png | ||
LICENSE | ||
README.md | ||
values.yaml |
Vikunja Helm Chart
Deployes both frontend and api. Also, you can deploy bitnami's PostgreSQL and Redis as subcharts if you want.
Requirements
- Kubernetes >= 1.19
- Helm >= 3
Quickstart
The majority of default values defined in values.yaml
should be compatible for your deployment. Additionally, if you utilize an Ingress for both the API and Frontend, you will be able to access the frontend out of the box. However, it won't have any default credentials, you will need to either enable registration, or execute /bin/sh
on the API container and run the following command:
./vikunja user create --email <user@email.com> --user <user1> --password <password123>
If you do not wish to execute the above command in order to create a new user, you'll need to enable registration by appending
api:
configMaps:
config:
enabled: true
data:
config.yml:
service:
enableregistration: true
Once you've registered your user, feel free to disable registration if you don't wish for other users to register.
Modifying Resources
Often times, modifications need to be made to a Helm chart to allow it to operate in your Kubernetes cluster. By utilizing bjw-s's common
library, there are quite a few options that can be easily modified.
Anything you see here, including the top-level keys, can be added and subtracted from this chart's values.yaml
, underneath the api
, frontend
, and (optionally) typesense
key.
For example, if you wished to create a serviceAccount
as can be seen here for the api
pod:
api:
serviceAccount:
create: true
Then, (for some reason), if you wished to deploy the frontend
as a DaemonSet
(as can be seen here), you could do the following:
frontend:
controller:
type: daemonset
Use an existing file volume claim
In the values.yaml
file, you can either define your own existing Persistent Volume Claim (PVC) or have the chart create one on your behalf.
To have the chart use your pre-existing PVC:
api:
persistence:
data:
enabled: true
existingClaim: <your-claim>
To have the chart create one on your behalf:
# You can find the default values
api:
enabled: true
persistence:
data:
enabled: true
accessMode: ReadWriteOnce
size: 10Gi
storageClass: storage-class
Publishing
The following steps are automatically performed when a git tag for a new version is pushed to the repository. They are only listed here for reference.
- Pull all dependencies before packaging.
helm dependency update
- In order to publish the chart, you have to either use curl or helm cm-push.
helm package .
curl --user '<username>:<password>' -X POST --upload-file './<archive>.tgz' https://kolaente.dev/api/packages/vikunja/helm/api/charts
helm package .
helm repo add --username '<username>' --password '<password>' vikunja https://kolaente.dev/api/packages/vikunja/helm
helm cm-push './<archive>.tgz' vikunja
As you can see, you do not have to specify the name of the repository, just the name of the organization.