Deployment

2 min read

The Archestra Platform can be deployed using Docker for development and testing, or Helm for production environments. Both deployment methods provide access to the Admin UI on port 3000 and the API on port 9000.

Docker Deployment

Docker deployment provides the fastest way to get started with Archestra Platform, ideal for development and testing purposes.

Docker Prerequisites

Basic Deployment

Run the platform with a single command:

docker run -p 9000:9000 -p 3000:3000 archestra/platform

This will start the platform with:

Using External PostgreSQL

To use an external PostgreSQL database, pass the DATABASE_URL environment variable:

docker run -p 9000:9000 -p 3000:3000 \
  -e DATABASE_URL=postgresql://user:password@host:5432/database \
  archestra/platform

⚠️ Important: If you don't specify DATABASE_URL, PostgreSQL will run inside the container for you. This approach is meant for development and tinkering purposes only and is not intended for production, as the data is not persisted when the container stops.

Helm deployment is our recommended approach for deploying Archestra Platform to production environments.

Helm Prerequisites

  • Kubernetes cluster - A running Kubernetes cluster
  • Helm 3+ - Package manager for Kubernetes (Install Helm)
  • kubectl - Kubernetes CLI (Install kubectl)

Installation

Install Archestra Platform using the Helm chart from our OCI registry:

helm upgrade archestra-platform \
  oci://europe-west1-docker.pkg.dev/friendly-path-465518-r6/archestra-public/helm-charts/archestra-platform \
  --install \
  --namespace archestra \
  --create-namespace \
  --wait

This command will:

  • Install or upgrade the release named archestra-platform
  • Create the namespace archestra if it doesn't exist
  • Wait for all resources to be ready

Database Configuration

To use an external PostgreSQL database, configure the postgresql.external_database_url value:

helm upgrade archestra-platform \
  oci://europe-west1-docker.pkg.dev/friendly-path-465518-r6/archestra-public/helm-charts/archestra-platform \
  --install \
  --namespace archestra \
  --create-namespace \
  --set postgresql.external_database_url=postgresql://user:password@host:5432/database \
  --wait

Managed PostgreSQL (Default)

If you don't specify postgresql.external_database_url, the Helm chart will automatically create and manage a PostgreSQL instance for you within your Kubernetes cluster.

Accessing the Platform

After installation, access the platform using port forwarding:

# Forward the Admin UI (port 3000)
kubectl --namespace archestra port-forward svc/archestra-platform 3000:3000

# In a separate terminal, forward the API (port 9000)
kubectl --namespace archestra port-forward svc/archestra-platform 9000:9000

Then visit: