Installing Synapse using the Helm chart

You need a valid licence key to obtain the Synapse Helm chart and container image.

  • Log in to the Cerbos distribution repository

    $ docker login CERBOS_DISTRIBUTION_REPO --username=YOUR_LICENCE_USER --password=YOUR_LICENCE_KEY

  • Inspect the chart and create a values file to suit your requirements (optional)

    $ helm show values oci://CERBOS_DISTRIBUTION_REPO/synapse/cerbos-synapse:VERSION

  • Install the chart

    $ helm install \
  --set=licence.user=YOUR_LICENCE_USER \
  --set=licence.key=YOUR_LICENCE_KEY \
  cerbos-synapse \
  oci://CERBOS_DISTRIBUTION_REPO/synapse/cerbos-synapse:VERSION

Convert existing Cerbos PDP Helm values to Synapse values

You can deploy Synapse as a gateway in front of an existing Cerbos PDP fleet by configuring the pdp.external configuration key (see Configuration). However, if you prefer to replace PDPs with Synapse instances, the container ships with a utility to convert the existing PDP Helm values file into the values file format for Synapse.

Please note that this is a best-effort translation using a set of rules that cover common deployments. You should carefully review the changes and test the chart installation in a development environment to ensure that it works as intended.

Assuming that your existing values file is named cerbos-pdp.yaml in the current directory, the following command will print out the equivalent Synapse Helm values file.

$ docker run -it -v $(pwd):/work CERBOS_DISTRIBUTION_REPO/synapse/synapse -- helm migrate /work/cerbos-pdp.yaml