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

Utilize bjw-s's common Helm library. #13

Merged
konrad merged 41 commits from :new-helm-chart into main 2023-11-07 14:47:24 +00:00
Conversation 14 Commits 41 Files Changed 24 +43 -43
1 changed files with 43 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit ce56e07518 - Show all commits

86
README.md
View File

@ -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@email.com> --user <user1> --password <password123>
```
### 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.
konrad commented 2023-10-31 20:02:44 +00:00
Outdated
Review
Copy Link

I don't think this should belong here as it's not specific for the helm deployment.

I don't think this should belong here as it's not specific for the helm deployment.
perfectra1n commented 2023-11-01 04:57:20 +00:00
Outdated
Review
Copy Link

Understood - it was meant to be more of an example of how you can utilize the values of the Helm deployment to create the config.yml and make changes. Would it be adequate to perhaps rename the section to "Example of how to create config.yml" and move it to the bottom of the README.md?

Understood - it was meant to be more of an example of how you can utilize the `values` of the Helm deployment to create the `config.yml` and make changes. Would it be adequate to perhaps rename the section to "Example of how to create `config.yml`" and move it to the bottom of the README.md?
perfectra1n commented 2023-11-02 19:36:11 +00:00
Outdated
Review
Copy Link

Renamed the section, and bumped the "modification" examples to the bottom of the README.md in order to highlight how to use a pre-existing PVC. Let me know if you find that to be adequate!

ce56e07518

Renamed the section, and bumped the "modification" examples to the bottom of the README.md in order to highlight how to use a pre-existing PVC. Let me know if you find that to be adequate! https://kolaente.dev/vikunja/helm-chart/commit/ce56e07518e9187f2f406a80c94dc8fddca53a87
👍 1
konrad commented 2023-11-07 14:45:25 +00:00
Outdated
Review
Copy Link

Renaming is great!

Renaming is great!
@ -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@email.com> --user <user1> --password <password123>
```
## Publishing
The following steps are automatically performed when a git tag for a new version is pushed to the repository.