ZITADEL

A Better Identity and Access Management Solution

ZITADEL combines the best of Auth0 and Keycloak. It is built for the serverless era.

Learn more about ZITADEL by checking out the source repository on GitHub

What's in the Chart

By default, this chart installs a highly available ZITADEL deployment.

Install the Chart

Follow the guide for deploying ZITADEL on Kubernetes.

Upgrading from v3

:::Note Apart from breaking changes in this chart, v4 also update the default ZITADEL version to v2.14.2. For upgrading ZITADEL, please refer to the ZITADEL release notes.

This section is only relevant for existing releases with the values property cockroachdb.enabled not set to false.

In v4, the cockroachdb chart dependency is removed. We decided to go this way because:

• Maintaining two separate releases is easier, especially in production.
• We can use Helm hooks specific to ZITADEL.
• ZITADEL doesn't only support CockroachDB.

If you have cockroachdb.enabled=true in your values.yaml, you need to make sure, that the cockroachdb chart is not managed by the zitadel release anymore. The following example for doing so uninstalls your entire zitadel release, reinstalls cockroach using a dedicated release, and then installs the new zitadel chart version. The new cockroach release will take over the PersistentVolumeClaims from the uninstalled chart, so no data migration is needed. Nevertheless, we highly recommend making and testing a backup before upgrading. Also note, that you will have downtime when following the example while zitadel is uninstalled.

helm repo add cockroachdb https://charts.cockroachdb.com/
helm repo update cockroachdb zitadel
helm uninstall my-zitadel
helm install crdb cockroachdb/cockroachdb --version 8.1.8 --set fullnameOverride=crdb
helm install my-zitadel zitadel/zitadel --values ./my-zitadel-values.yaml

Uninstalling the Chart

The ZITADEL chart uses Helm hooks, which are not garbage collected by helm uninstall, yet. Therefore, to also remove hooks installed by the ZITADEL Helm chart, delete them manually:

helm uninstall my-zitadel
for k8sresourcetype in job configmap secret rolebinding role serviceaccount; do
    kubectl delete $k8sresourcetype --selector app.kubernetes.io/name=zitadel,app.kubernetes.io/managed-by=Helm
done

Contributing

Lint the chart:

docker run -it --network host --workdir=/data --rm --volume $(pwd):/data quay.io/helmpack/chart-testing:v3.5.0 ct lint --charts charts/zitadel --target-branch main

Test the chart:

# Create a local Kubernetes cluster
kind create cluster --image kindest/node:v1.25.2

# Test the chart
go test -tags integration ./...

Watch the Kubernetes resources if you want to see progress.

Contributors