Skip to content

Setting up ESS Pro Helm Chart in Air-gapped environments

Prerequisites

  • An airgapped Kubernetes cluster.
    • If you want to setup ESS Pro in a single node k3s cluster like suggested in the Setup Guide, you can follow the k3s Airgap instructions using the Private Registry Method.
    • If you have your own Kubernetes airgapped cluster, you need upload access to a private registry that can be used to host the ESS Pro images.
  • You need to install skopeo and yq on the computer used to upload the images.

  • You need to login against the registry if it requires credentials

    skopeo login --username <username> <registry url>

Instructions

  • You need to reach out to your account manager to get access to the airgapped bundles built by Element.
  • The airgapped bundles are available on the Element On-Premise Downloads page
  • Download the bundle named ess-pro-airgapped-<version>.tar.gz, where <version> is the version of the ESS Pro matrix-stack chart you want to install.
  • Copy the bundle over to your airgapped network, with access to the private registry.

  • Extract the contents of the bundle to a directory on your airgapped network

    tar --extract --file ess-pro-airgapped-<version>.tar.gz

  • In the extracted directory, extract the archive of the chart

    tar --extract --file charts/matrix-stack/matrix-stack-<version>.tgz

  • Call the upload script against the extracted airgapped images. If your registry does not support HTTPS, you need to use the --no-tls flag.

    bash matrix-stack/import_airgapped_bundle_into_registry.sh \
    --airgapped-bundle airgapped/ \
    --registry <registry url>

  • The script will upload the images missing from the private registry, and generate a values file overriding the default container images in images_uploaded.values.yaml.

  • If you have Element Call (SFU) enabled (default option), you need to configure it's networking. See Configuring MatrixRTC - SFU Networking to see the available options. You will either need to pass STUN servers that are reachable from the SFU, or manually pass the IP that the SFU will advertise to the clients.
  • Use the values file with your other ess config values when setting up the ESS Pro Helm chart.