Skip to main content

Install with Helm

This page deploys DAGZ to a Kubernetes cluster using the official Helm chart. After completing it the console is reachable at your chosen hostname; SSO is then configured from the console.

Prerequisites​

  • A Kubernetes cluster, ideally the same one your CI runners use. Network proximity to runners reduces collector latency.
  • cert-manager installed in the cluster. DAGZ uses it for internal TLS.
  • The user namespace — the namespace your CI pods run in. DAGZ creates a TLS certificate and secret in this namespace.
  • A DNS hostname for the DAGZ web console.
  • The DAGZ product key file (provided by DAGZ during onboarding).

Resource budget for the DAGZ pods:

  • CPU: negligible.
  • Memory: 4 GB.
  • Disk: 300 GB (200 GB ClickHouse + 100 GB history blob store).

1. Set the product key path​

export DAGZ_PRODUCT_KEY=path/to/dagz-key.json

2. Authenticate Helm against the registry​

cat "$DAGZ_PRODUCT_KEY" | helm registry login \
    -u _json_key \
    --password-stdin https://us-east1-docker.pkg.dev/autodag

Optional: edit $HOME/.config/helm/registry/config.json and scope the credentials to the /autodag path:

{
  "auths": {
    "us-east1-docker.pkg.dev/autodag": {
      "auth": "<your imported product key>"
    }
  }
}

3. Download the values file​

helm show values \
    oci://us-east1-docker.pkg.dev/autodag/docker-stable/autodag \
    > dagz_values.yaml

4. Edit the values file​

In dagz_values.yaml, set at minimum:

  • userNamespace: the namespace your CI pods run in. DAGZ deploys the plugin TLS secret here.
  • ingress.hostname: the DNS name for the console.

Optional: adjust nodeSelector, tolerations, nodeAffinity, and the ingress class and annotations to match your cluster.

5. Select the target cluster​

If you manage multiple clusters, switch kubectl to the one DAGZ should run in.

kubectl config use-context <CI_CLUSTER_CONTEXT>

6. Verify cert-manager is running​

kubectl get all -n cert-manager

You should see the cert-manager pods in a Running state.

7. Install the chart​

helm install \
    oci://us-east1-docker.pkg.dev/autodag/docker-stable/autodag \
    --values dagz_values.yaml \
    --set-file "serviceAccountKey=$DAGZ_PRODUCT_KEY"

The chart pulls the DAGZ container images and starts the services. Once the pods are ready, the console is reachable at the hostname you set in ingress.hostname.

8. Configure SSO​

Open the console URL in a browser. On first load it prompts you to choose an SSO provider and upload its configuration.

See SSO with Microsoft Entra ID for the walkthrough.