Skip to main content

diagrid region deploy

Deploy a Catalyst region to a Kubernetes cluster

Description​

Deploy a Catalyst region to a Kubernetes cluster and register it with Diagrid.

This command installs the Catalyst Helm chart on the target cluster, configures the region's gateway, and registers the region so it is ready to serve apps. Re-running it against the same cluster performs an in-place upgrade.

It works with any Kubernetes cluster — a local Kind cluster for development or a managed cluster on EKS, AKS, or GKE. The provider is auto-detected and the gateway configured accordingly; on cloud providers with LoadBalancer support the public ingress address is resolved automatically after install.

When run in an interactive terminal, you will be prompted to pick a cluster if no targeting flags are supplied. The generated defaults are opinionated toward testing and POCs (managed domains, self-hosted Postgres and Kafka) — use --values-file to layer your own Helm values on top for custom setups. See the Catalyst chart reference for the full set of customization options: https://github.com/diagridio/charts/blob/main/charts/catalyst/README.md

diagrid region deploy [regionid] [flags]

Examples​


  # Deploy to the current kubectl context (interactive cluster selection if TTY)
  diagrid region deploy my-region

  # Deploy to a specific kubecontext
  diagrid region deploy my-region --context my-eks-cluster

  # Deploy using a specific kubeconfig file
  diagrid region deploy my-region --kubeconfig /path/to/kubeconfig

  # Create a local Kind cluster and deploy
  diagrid region deploy my-region --create-cluster

  # Create a Kind cluster with a custom name
  diagrid region deploy my-region --create-cluster --cluster-name my-cluster

  # Override auto-detected provider
  diagrid region deploy my-region --provider eks

  # Deploy a specific Catalyst version
  diagrid region deploy my-region --version v1.2.3

  # Deploy with additional custom Helm values
  diagrid region deploy my-region --values-file ./custom-values.yaml

Options​

      --version string          Catalyst chart version to install (e.g., v1.2.3). Defaults to the latest release from https://gallery.ecr.aws/diagrid/catalyst.
      --helm-chart string       OCI reference of the Catalyst Helm chart to install from. (default "oci://public.ecr.aws/diagrid/catalyst")
      --wait-timeout duration   How long to wait for the region to become ready before giving up. (default 5m0s)
      --kubeconfig string       Path to the kubeconfig file to use when targeting an existing cluster.
      --context string          Name of the kubecontext to deploy to. Defaults to your current context.
      --create-cluster          Spin up a new local Kind cluster for this deployment — ideal for a quick local trial.
      --cluster-name string     Name for the Kind cluster being created. Auto-generated from the region name when omitted. Requires --create-cluster.
      --provider string         Force a specific cluster provider instead of auto-detecting (kind, eks, aks, gke, generic).
      --values-file string      Additional Helm values file to merge on top of the generated defaults. See https://github.com/diagridio/charts/blob/main/charts/catalyst/README.md for available options.
  -h, --help                    help for deploy

Options inherited from parent commands​

      --api-key string   Diagrid Cloud API key

SEE ALSO​

Last updated on