Netzgrafik Editor Helm Charts

This repository provides all-in-one Helm Charts for deployment on a Kubernetes (k8s) cluster of Netzgrafik Editor (frontend, backend, DB for backend).

It is based on the published images from the ghcr (GitHub container registry) at SchweizerischeBundesbahnen. No local dev setup (mvn, npm etc.) beyond docker and docker-compose are required.

If you just want to spin up on a local machine (without a Kubernetes cluster), then you can use the docker compose setup at

• https://github.com/flatland-association/netzgrafik-editor-docker-compose

For local dev setup, please refer to:

• netzgrafik-editor-frontend
• netzgrafik-editor-backend

Architecture

The following diagram shows the network wiring of the different components:

The following diagram shows the k8s resources deployed by the Helm charts and how they refer to each other:

Prerequisites

• k8s cluster
• DB service running (we use a cloud service)
• Keycloak running (we use a separate Helm deployment)

TL;DR;

1. Edit config to your needs:

cp values.yaml.template values.yaml
cp secret-values.yaml.template secret-values.yaml
vi values.yaml
vi secret-values.yaml

2. Install Helm Release in default namespace:

helm install nge -f values.yaml -f secret-values.yaml .

3. Update Release in default namespace:

helm upgrade nge -f values.yaml -f secret-values.yaml .

Warning

A container using a ConfigMap as a subPath volume mount will not receive ConfigMap updates. https://kubernetes.io/docs/concepts/storage/volumes/#secret

Preview k8s definitions

helm template -f values.yaml -f secret-values.yaml .