forked from vikunja/helm-chart
Link artifacthub in readme
This commit is contained in:
parent
450db45e43
commit
5762408832
15
README.md
15
README.md
|
@ -3,10 +3,7 @@ Vikunja Helm Chart
|
|||
|
||||
This Helm Chart deploys both the Vikunja [frontend](https://hub.docker.com/r/vikunja/frontend) and Vikunja [api](https://hub.docker.com/r/vikunja/api) containers, in addition to other Kubernetes resources so that you'll have a fully functioning Vikunja deployment quickly. Also, you can deploy Bitnami's [PostgreSQL](https://github.com/bitnami/charts/tree/main/bitnami/postgresql) and [Redis](https://github.com/bitnami/charts/tree/main/bitnami/redis) as subcharts if you want, as Vikunja can utilize them as its database and caching mechanism (respectively).
|
||||
|
||||
## Requirements
|
||||
|
||||
- Kubernetes >= 1.19
|
||||
- Helm >= 3
|
||||
See https://artifacthub.io/packages/helm/vikunja/vikunja for version information and installation instructions.
|
||||
|
||||
## Quickstart
|
||||
|
||||
|
@ -40,8 +37,7 @@ To effectively run multiple replicas of the API,
|
|||
make sure to set up the redis cache as well
|
||||
by setting `api.configMaps.config.data.config.yml.keyvalue.type` to `redis`,
|
||||
configuring the redis subchart (see [values.yaml](./values.yaml#L119))
|
||||
and the connection to Vikunja:
|
||||
https://vikunja.io/docs/config-options/#redis
|
||||
and the connection [in Vikunja](https://vikunja.io/docs/config-options/#redis)
|
||||
|
||||
### Use an existing file volume claim
|
||||
|
||||
|
@ -140,9 +136,10 @@ stringData:
|
|||
|
||||
### Modifying Deployed 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](https://github.com/bjw-s/helm-charts/blob/a081de53024d8328d1ae9ff7e4f6bc500b0f3a29/charts/library/common/values.yaml), including the top-level keys, can be added and subtracted from this chart's `values.yaml`, underneath the `api`, `frontend`, and (optionally) `typesense` key.
|
||||
Oftentimes, modifications need to be made to a Helm chart to allow it to operate in your Kubernetes cluster.
|
||||
Anything you see [in bjw-s' `common` library](https://github.com/bjw-s/helm-charts/blob/a081de53024d8328d1ae9ff7e4f6bc500b0f3a29/charts/library/common/values.yaml),
|
||||
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](https://github.com/bjw-s/helm-charts/blob/a081de53024d8328d1ae9ff7e4f6bc500b0f3a29/charts/library/common/values.yaml#L85-L87) for the `api` pod:
|
||||
|
||||
|
|
Loading…
Reference in New Issue