From 6b9b53e59ed845245b26c25ac1e86cf7dbf0f5fd Mon Sep 17 00:00:00 2001 From: Jeroen Vermeulen Date: Wed, 19 Jun 2024 15:52:02 +0200 Subject: [PATCH] TLDR example --- README.md | 35 +++++++++++++++++++++++++++++++ examples/notificaties_values.yaml | 19 +++++++++++++++++ examples/openzaak_values.yaml | 16 ++++++++++++++ 3 files changed, 70 insertions(+) create mode 100644 examples/notificaties_values.yaml create mode 100644 examples/openzaak_values.yaml diff --git a/README.md b/README.md index baa18a9..cf25db1 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,38 @@ View the detailed installation instructions and configuration here: - [Open Zaak](./charts/open-zaak/README.md) - [Open Notificaties](./charts/open-notificaties/README.md) + +## TLDR Example +### Installation +Add the Helm repository, update it, get example values files. +```bash +helm repo add fundaments-open-zaak https://fundaments.github.io/open-zaak-charts/ +helm repo update +wget https://raw.githubusercontent.com/fundaments/open-zaak-charts/main/examples/openzaak_values.yaml +wget https://raw.githubusercontent.com/fundaments/open-zaak-charts/main/examples/notificaties_values.yaml +``` +Update the values files with your own values. +You may need to add `ingress.className`. + +Install the charts: +```bash +helm install --debug --wait --namespace open-notificaties --create-namespace --values notificaties_values.yaml open-notificaties fundaments-open-zaak/open-notificaties +helm install --debug --wait --namespace open-zaak --create-namespace --values openzaak_values.yaml open-zaak fundaments-open-zaak/open-zaak +``` +Check if the configuration is correct: +- https://open-notificaties.example.com/view-config/ +- https://open-zaak.example.com/view-config/ + +Check if you can login to the admin interface (username: `admin`, password from values files): +- https://open-zaak.example.com/admin/ +- https://open-notificaties.example.com/admin/ + +### Uninstallation +```bash +helm uninstall --namespace open-zaak open-zaak +kubectl delete --namespace=open-zaak pvc -l app.kubernetes.io/instance=open-zaak +kubectl delete namespace open-zaak +helm uninstall --namespace open-notificaties open-notificaties +kubectl delete --namespace=open-notificaties pvc -l app.kubernetes.io/instance=open-notificaties +kubectl delete namespace open-notificaties +``` diff --git a/examples/notificaties_values.yaml b/examples/notificaties_values.yaml new file mode 100644 index 0000000..0b068b9 --- /dev/null +++ b/examples/notificaties_values.yaml @@ -0,0 +1,19 @@ +# https://github.com/fundaments/open-zaak-charts/blob/main/charts/open-notificaties/values.yaml +# flower: +# enabled: false +ingress: + enabled: true + annotations: + cert-manager.io/cluster-issuer: letsencrypt-prod + hosts: + - open-notificaties.example.com + tls: + - hosts: + - open-notificaties.example.com + secretName: open-notificaties-ingress-tls +settings: + allowedHosts: open-notificaties.example.com + envVars: + DJANGO_SUPERUSER_PASSWORD: appelmoes + OPENNOTIFICATIES_DOMAIN: open-notificaties.example.com + AUTORISATIES_API_ROOT: http://open-zaak.open-zaak.svc.cluster.local/autorisaties/api/v1/ diff --git a/examples/openzaak_values.yaml b/examples/openzaak_values.yaml new file mode 100644 index 0000000..3dcb59b --- /dev/null +++ b/examples/openzaak_values.yaml @@ -0,0 +1,16 @@ +ingress: + enabled: true + annotations: + cert-manager.io/cluster-issuer: letsencrypt-prod + hosts: + - open-zaak.example.com + tls: + - hosts: + - open-zaak.example.com + secretName: open-zaak-ingress-tls +settings: + allowedHosts: open-zaak.example.com + envVars: + DJANGO_SUPERUSER_PASSWORD: appelmoes + OPENZAAK_DOMAIN: open-zaak.example.com + NOTIF_API_ROOT: http://open-notificaties.open-notificaties.svc.cluster.local/api/v1/