From ce56e07518e9187f2f406a80c94dc8fddca53a87 Mon Sep 17 00:00:00 2001 From: perf3ct Date: Thu, 2 Nov 2023 12:34:45 -0700 Subject: [PATCH] Move README.md components around --- README.md | 86 +++++++++++++++++++++++++++---------------------------- 1 file changed, 43 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 681ba97..8e8ebc0 100644 --- a/README.md +++ b/README.md @@ -14,49 +14,6 @@ The majority of default values defined in `values.yaml` should be compatible for That should be it! -### Registration (creating users) - -You can disable registration (if you do not with to allow others to register on your Vikunja), by providing the following values in your `values.yaml`: - -```yaml -api: - configMaps: - config: - enabled: true - data: - config.yml: - service: - enableregistration: false -``` - -If you need to create another user, you could opt to execute the following command on the `api` container: - -```bash -./vikunja user create --email --user --password -``` - -### 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. - -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: - -```yaml -api: - serviceAccount: - create: true -``` - -Then, (for some reason), if you wished to deploy the `frontend` as a `DaemonSet` ([as can be seen here](https://github.com/bjw-s/helm-charts/blob/a081de53024d8328d1ae9ff7e4f6bc500b0f3a29/charts/library/common/values.yaml#L12-L17)), you could do the following: - -```yaml -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. @@ -85,6 +42,49 @@ api: storageClass: storage-class ``` +### 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. + +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: + +```yaml +api: + serviceAccount: + create: true +``` + +Then, (for some reason), if you wished to deploy the `frontend` as a `DaemonSet` ([as can be seen here](https://github.com/bjw-s/helm-charts/blob/a081de53024d8328d1ae9ff7e4f6bc500b0f3a29/charts/library/common/values.yaml#L12-L17)), you could do the following: + +```yaml +frontend: + controller: + type: daemonset +``` + +### Another Example of Modifying `config.yml` (Enabling Registration) + +You can disable registration (if you do not with to allow others to register on your Vikunja), by providing the following values in your `values.yaml`: + +```yaml +api: + configMaps: + config: + enabled: true + data: + config.yml: + service: + enableregistration: false +``` + +If you need to create another user, you could opt to execute the following command on the `api` container: + +```bash +./vikunja user create --email --user --password +``` + ## Publishing The following steps are automatically performed when a git tag for a new version is pushed to the repository.