Distribution HA Helm Installation

Install Distribution HA on Kubernetes using Helm with multi-node cluster, external PostgreSQL, and shared filestore.

📘

Important

Currently, it is not possible to connect a JFrog product (e.g., Distribution) that is within a Kubernetes cluster with another JFrog product (e.g., Artifactory) that is outside of the cluster, as this is considered a separate network. Therefore, JFrog products cannot be joined together if one of them is in a cluster.

  1. Add the https://charts.jfrog.io to your Helm client.

    helm repo add jfrog https://charts.jfrog.io
  2. Update the repository.

    helm repo update
  3. Start installation by providing a join key and JFrog URL as parameters to the Distribution chart installation.

    helm upgrade --install distribution --set distribution.joinKey=<YOUR_PREVIOUSLY_RETIREVED_JOIN_KEY> \
                 --set distribution.jfrogUrl=<YOUR_PREVIOUSLY_RETIREVED_BASE_URL> --namespace distribution jfrog/distribution

    Alternatively, you can create a secret containing the join key manually and pass it to the template during install/upgrade.

    # Create a secret containing the key. The key in the secret must be named join-key
    kubectl create secret generic my-secret --from-literal=join-key=<YOUR_PREVIOUSLY_RETIREVED_JOIN_KEY>
     
    # Pass the created secret to helm
    helm upgrade --install distribution --set replicaCount=3 --set distribution.joinKeySecretName=my-secret --namespace distribution jfrog/distribution
📘

Note

In either case, pass the same join key on all future helm install and helm upgrade calls. For the first case, always pass --set distribution.joinKey=<YOUR_PREVIOUSLY_RETRIEVED_JOIN_KEY>. For the second case, always pass --set distribution.joinKeySecretName=my-secret and verify the secret contents remain unchanged.

  1. Customize the product configuration (optional) including database, Java Opts, and filestore.
📘

Note

Unlike other installations, Helm Chart configurations are made to the values.yaml and are then applied to the system.yaml.

Follow these steps to apply the configuration changes.

  1. Make the changes to values.yaml.

  2. Run the command.

helm upgrade --install distribution --namespace distribution -f values.yaml
  1. Access Distribution from your browser at:http://<jfrogUrl>/ui/: go to the Dashboard tab in the Application module in the UI.

  2. Check the status of your deployed Helm releases.

    helm status distribution
📘

Note

For advanced installation options, see Helm Charts Installers for Advanced Users.