Skip to content

Commit

Permalink
Using separate chart with subcharts, updated documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
jeroenvermeulen committed Jun 12, 2024
1 parent 757308c commit f20b116
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 17 deletions.
23 changes: 23 additions & 0 deletions charts/open-zaak-postgres-redis/Chart.yaml
Original file line number Diff line number Diff line change
@@ -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
34 changes: 34 additions & 0 deletions charts/open-zaak-postgres-redis/README.md
Original file line number Diff line number Diff line change
@@ -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) |
12 changes: 0 additions & 12 deletions charts/open-zaak/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
11 changes: 6 additions & 5 deletions charts/open-zaak/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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}"
```
Expand Down

0 comments on commit f20b116

Please sign in to comment.