Prerequisites

Make sure these are in place before you deploy with Helm.

Cluster and tooling

  • Kubernetes 1.20+.

  • kubectl access to the cluster.

  • Helm v3.

Resources

Use the sizing guidance in Deployment overview.

If you use the bundled PostgreSQL, ensure you have a default StorageClass for PVC provisioning.

Ingress and DNS

  • An Ingress controller.

    • It must support regex in path rules (commonly NGINX).

  • A DNS name that resolves to the Ingress / load balancer.

  • TLS termination (Ingress + cert-manager or a TLS secret).

Permissions

  • Permissions to create namespaces, secrets, and deployments.

  • Cluster permissions to install CRDs (Ray / KubeRay).

Registry access

  • Registry credentials for pulling Syntho images.

  • Outbound network access from cluster nodes to the registry.

Secrets and configuration

circle-exclamation

Common files contain secrets:

  • Docker Compose: .env

  • Kubernetes/Helm: values.yaml

Do not commit these files to Git.

Prefer one of these approaches:

  • Inject values via your CI/CD secret store.

  • Use Kubernetes Secrets (manualSecretName) or an external secrets operator.

Last updated

Was this helpful?