Signalen Helm charts

Signalen helps cities receive, manage and solve nuisance reports. The software is open source and therefore free for others to use. This repository contains Helm charts to easily install the Signalen stack on a Kubernetes cluster.

External authentication

The Signalen backoffice relies on an external OpenID Connect identity provider for authentication of users. If no instance is available, Dex could be used with a static user as follows:

helm repo add dex https://charts.dexidp.io
helm upgrade --install \
  dex dex/dex \
  --create-namespace \
  --namespace dex \
  --set "config.issuer=https://dex.signalen.example.com" \
  --set "config.staticPasswords[0].email=signals.admin@example.com" \
  --set "config.staticPasswords[0].hash=$2a$10$2b2cU8CPhOTaGrs1HRQuAueS7JTT5ZHsHSzYiFPm1leZck7Mc8T4W" \
  --set "config.staticPasswords[0].username=admin" \
  --set "config.staticClients[0].id=signals" \
  --set "config.staticClients[0].name=Signalen" \
  --set "config.staticClients[0].secret=somethingsecret" \
  --set "config.staticClients[0].redirectURIs[0]=https://signalen.example.com/manage/incidents" \
  --set "config.oauth2.responseTypes={token,id_token}" \
  --set "ingress.enabled=true" \
  --set "ingress.hosts[0].host=dex.signals.example.com" \
  --set "ingress.hosts[0].paths[0].path=/" \
  --set "ingress.hosts[0].paths[0].pathType=ImplementationSpecific"

This command will install Dex in the dex namespace and exposes an Ingress on dex.signalen.example.com. It creates the following static user:

• E-mail: signalen.admin@example.com
• Password: password

Dex has a lot of benefits when connected to an Identity Provider using connectors. It provides out-of-the box support for LDAP, SAML2.0, GitHub, GitLab and more.

Install the charts

First configure the Helm repository:

helm repo add signalen https://signalen.github.io/helm-charts/
helm repo update

Then install the backend chart:

helm upgrade --install \
  signalen-backend signalen/backend \
  --create-namespace \
  --namespace signalen \
  --set "settings.allowedHosts=api.signals.example.com" \
  --set "settings.defaultPdokMunicipalities=Amsterdam" \
  --set "settings.jwksUrl=https://dex.signals.example.com" \
  --set "settings.userIdField=email" \
  --set "settings.classificationEndpoint=https://classification.signals.example.com/signals_mltool" \
  --set "ingress.enabled=true" \
  --set "ingress.hosts[0].host=api.signals.example.com" \
  --set "ingress.hosts[0].paths[0].path=/" \
  --set "ingress.hosts[0].paths[0].pathType=ImplementationSpecific"

And install the frontend chart:

helm upgrade --install \
  signalen-frontend signalen/frontend \
  --create-namespace \
  --namespace signalen \
  --set "oidc.authEndpoint=https://dex.signals.example.com/auth" \
  --set "config.apiBaseUrl=https://api.signals.example.com/signals" \
  --set "ingress.enabled=true" \
  --set "ingress.hosts[0].host=signals.example.com" \
  --set "ingress.hosts[0].paths[0].path=/" \
  --set "ingress.hosts[0].paths[0].pathType=ImplementationSpecific"

And install the classification chart:

helm upgrade --install \
  signalen-classification signalen/classification \
  --create-namespace \
  --namespace signalen \
  --set "signalsCategoryUrl=https://api.signals.example.com/signals/v1/public/terms" \
  --set "ingress.enabled=true" \
  --set "ingress.hosts[0].host=classification.signals.example.com" \
  --set "ingress.hosts[0].paths[0].path=/" \
  --set "ingress.hosts[0].paths[0].pathType=ImplementationSpecific"

Uninstall the charts

To delete the charts:

helm delete --namespace signalen signalen-frontend
helm delete --namespace signalen signalen-backend
helm delete --namespace signalen signalen-classification

And finally remove the namespace:

kubectl delete namespace signalen

Configuration

Consult the documentation of the specific charts for an overview of all configuration options:

• backend
• frontend
• classification
• mapserver