Xray Helm Installation

Install Xray on Kubernetes using Helm chart

Follow these steps to install the product:

  1. Add charts.jfrog.io to your Helm client and update the repository.

    helm repo add jfrog https://charts.jfrog.io
    helm repo update
  2. Check the chart versions available if you need to install a specific version, and pass it to the helm install command with --version <chart version>.

    helm search repo jfrog/xray --versions
  3. Choose an installation scenario. Each scenario links to a README.md and a values.yaml you can reference. You can combine settings from multiple examples into your own custom values.yaml and apply it to your installation.

    ScenarioDescriptionExample
    Quick StartA minimal values file for getting Xray up and running quickly.README · values-quick-start.yaml
    OpenShiftDeploy Xray on OpenShift, with security contexts adjusted for OpenShift's restricted SCC defaults.README · values-openshift.yaml
    Secrets & External DatabaseDeploy Xray using pre-created Kubernetes secrets for sensitive values and an external PostgreSQL database.README · values-secrets-and-external-db.yaml
    High AvailabilityDeploy Xray in HA mode with RabbitMQ quorum queues, pre-created secrets, and an external database.README · values-xray-ha.yaml
    Extra System YAMLAdd custom settings to Xray's system.yaml via the extraSystemYaml block.README · values-extra-system-yaml.yaml
    Enable Quorum Queues for RabbitMQSwitch an existing Xray deployment's RabbitMQ to quorum queues.README · values-enable-quorum-queues-for-rabbitmq.yaml
    HA with Catalog and ValkeyDeploy Xray in HA mode with Catalog, Valkey (with Sentinel), RabbitMQ quorum queues, and an external database.README · values-xray-ha-with-catalog-and-valkey.yaml
    HA with Catalog and Valkey (OpenShift)Deploy Xray in HA mode on OpenShift with Catalog, Valkey (with Sentinel), RabbitMQ quorum queues, and an external database.README · values-xray-ha-with-catalog-and-valkey-openshift.yaml

    Important notes

    • Set a valid JFrog URL, join key, and master key — see Manage Keys for details.
    • Use quorum queues — recommended for all fresh installs and upgrades; will become the default in a future release. See Xray RabbitMQ Quorum Upgrade for details.
    • Always apply a sizing file — pass one with a second -f flag, as shown in each README.
    • Change the default credentials
    • Use an external database — for anything beyond a demo environment, use External Database or High Availability example instead of the bundled PostgreSQL.
    • Size your cluster for HA — make sure you have enough Kubernetes nodes to spread pods across nodes. The large sizing file already applies the required affinity settings.

Did this page help you?