From f20b1168e08c870aa9d307f042e0d673012de797 Mon Sep 17 00:00:00 2001 From: Jeroen Vermeulen Date: Wed, 12 Jun 2024 17:11:17 +0200 Subject: [PATCH] Using separate chart with subcharts, updated documentation. Fixes #33 --- charts/open-zaak-postgres-redis/Chart.yaml | 23 +++++++++++++++ charts/open-zaak-postgres-redis/README.md | 34 ++++++++++++++++++++++ charts/open-zaak/Chart.yaml | 12 -------- charts/open-zaak/README.md | 11 +++---- 4 files changed, 63 insertions(+), 17 deletions(-) create mode 100644 charts/open-zaak-postgres-redis/Chart.yaml create mode 100644 charts/open-zaak-postgres-redis/README.md diff --git a/charts/open-zaak-postgres-redis/Chart.yaml b/charts/open-zaak-postgres-redis/Chart.yaml new file mode 100644 index 0000000..bbdf6fa --- /dev/null +++ b/charts/open-zaak-postgres-redis/Chart.yaml @@ -0,0 +1,23 @@ +apiVersion: v2 +name: open-zaak-postgres-redis +description: Productiewaardige API's voor Zaakgericht Werken + +type: application +version: 0.8.1 + +dependencies: + - name: open-zaak + version: ~0.8.1 + repository: file://../open-zaak + tags: + - open-zaak + - name: postgresql + version: ~15.5.5 + repository: https://charts.bitnami.com/bitnami + tags: + - postgresql + - name: redis + version: ~19.5.2 + repository: https://charts.bitnami.com/bitnami + tags: + - redis diff --git a/charts/open-zaak-postgres-redis/README.md b/charts/open-zaak-postgres-redis/README.md new file mode 100644 index 0000000..d6186e3 --- /dev/null +++ b/charts/open-zaak-postgres-redis/README.md @@ -0,0 +1,34 @@ +# Open Zaak chart including PostgreSQL and Redis + +The Helm chart installs Open Zaak and by the following dependencies using subcharts: + +- [PostgreSQL](https://github.com/bitnami/charts/tree/master/bitnami/postgresql) +- [Redis](https://github.com/bitnami/charts/tree/master/bitnami/redis) + +## Installation + +First configure the Helm repository: + +```bash +helm repo add open-zaak https://open-zaak.github.io/charts/ +helm repo update +``` + +Install the Helm chart with: + +```bash +helm install open-zaak open-zaak/open-zaak-postgres-redis \ + --set "open-zaak.settings.allowedHosts=open-zaak.gemeente.nl" \ + --set "open-zaak.ingress.enabled=true" \ + --set "open-zaak.ingress.hosts={open-zaak.gemeente.nl}" +``` + +:warning: The default settings are unsafe for production usage. Configure proper secrets, enable persistency and consider High Availability (HA) for the database and the application. + +**Because we are using these charts as dependencies, all values need to be prefixed with the name of the chart.** + +| Chart | Values | More Information | +|------------|-------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| +| open-zaak | [values.yaml](https://github.com/open-zaak/charts/blob/main/charts/open-zaak/values.yaml) | [Chart](https://github.com/open-zaak/charts/tree/main/charts/open-zaak) | +| postgresql | [values.yaml](https://github.com/bitnami/charts/blob/main/bitnami/postgresql/values.yaml) | [Artifact Hub](https://artifacthub.io/packages/helm/bitnami/postgresql) | +| redis | [values.yaml](https://github.com/bitnami/charts/blob/main/bitnami/redis/values.yaml) | [Artifact Hub](https://artifacthub.io/packages/helm/bitnami/redis) | diff --git a/charts/open-zaak/Chart.yaml b/charts/open-zaak/Chart.yaml index 9b0f13d..b042805 100644 --- a/charts/open-zaak/Chart.yaml +++ b/charts/open-zaak/Chart.yaml @@ -5,15 +5,3 @@ description: Productiewaardige API's voor Zaakgericht Werken type: application version: 0.8.1 appVersion: "1.7.1" - -# dependencies: -# - name: postgresql -# version: ~10.12.0 -# repository: https://charts.bitnami.com/bitnami -# tags: -# - postgresql -# - name: redis -# version: ~13.0.0 -# repository: https://charts.bitnami.com/bitnami -# tags: -# - redis diff --git a/charts/open-zaak/README.md b/charts/open-zaak/README.md index 0555fc0..2cf92f6 100644 --- a/charts/open-zaak/README.md +++ b/charts/open-zaak/README.md @@ -1,12 +1,10 @@ # Open Zaak chart -The Helm chart installs Open Zaak and by default the following dependencies using subcharts: - -- [PostgreSQL](https://github.com/bitnami/charts/tree/master/bitnami/postgresql) -- [Redis](https://github.com/bitnami/charts/tree/master/bitnami/redis) - ## Installation +This chart only installs Open Zaak. +If you would like to install PostgreSQL and Redis in one go, use the [open-zaak-postgres-redis](../open-zaak-postgres-redis/) chart and follow the instructions there. + First configure the Helm repository: ```bash @@ -19,6 +17,9 @@ Install the Helm chart with: ```bash helm install open-zaak open-zaak/open-zaak \ --set "settings.allowedHosts=open-zaak.gemeente.nl" \ + --set "settings.database.host=postgres.gemeente.nl" \ + --set "settings.cache.default=redis.gemeente.nl:6379/0" \ + --set "settings.cache.axes=redis.gemeente.nl:6379/0" \ --set "ingress.enabled=true" \ --set "ingress.hosts={open-zaak.gemeente.nl}" ```