Skip to content

Upgrade from ESS Community to ESS Pro

Upgrading from ESS Community to ESS Pro is a simple 2 step process. It involves adding your ESS credentials to your values file, and then running the helm upgrade command targetting the ESS Pro Helm chart.

Prerequisites

  • You have a working ESS Community deployment

Configure your values

Upgrading from ESS Community to ESS Pro requires you to configure your access to element registry. You can either add your ESS credentials to your values file, or configure a docker pull secret manually.

Option 1: Add ESS credentials to your values file

Write the following to ~/ess-config-values/ess-credentials.yaml.

essCredentials:
  username: <ESS_USERNAME>
  password: <ESS_PASSWORD>

Option 2: Configure a docker pull secret

Create a docker pull secret and configure its name in your values file with:

pullSecrets:
- name: <your docker pull secret>

Upgrade to pro

Run the following command against your ESS Community deployment. The following example assumes you are using the ess namespace, and you are using the release name ess.

helm upgrade --install --namespace "ess" ess \
    oci://registry.element.io/matrix-stack \
    --values ~/ess-config-values/ess-credentials.yaml \
    --values ~/ess-config-values/hostnames.yaml \
    --values ~/ess-config-values/tls.yaml \
    --values <optional additional values files to pass> \
    --wait

Next steps

Convert Community Synapse and Matrix Authentication Service configuration to ESS Pro Authentication values

ESS Pro provides high-level values to configure Synapse, Matrix Authentication Service and Advanced Identity Management through the same shared values authentication section.

Migrating to this configuration also helps in running the syn2mas process as ESS Pro will be able to do the conversion from Synapse configuration to Matrix Authentication Service configuration.

The chart comes with a script to run the conversion from live in-cluster configuration. See below to get the script:

helm pull oci://registry.element.io/matrix-stack --untar -d charts
./charts/matrix-stack/scripts/pro_values_from_community.py <namespace> <release-name> > ~/ess-config-values/authentication-values.yaml

You can now remove the oidc_providers, password_providers from Synapse additional configuration, and upstream_oauth2 from Matrix Authentication Service configuration.