Skip to main content
This guide takes a cluster that meets the requirements to an active your organization can deploy agents to. Every step has a CLI form and a dashboard form; the cluster-side commands are the same either way.
The region commands require pipecatcloud or later. Check with pipecat cloud --version and upgrade with uv tool upgrade pipecat-ai --with pipecatcloud if needed.

Before you begin

Pick a region key: a short, DNS-safe identifier such as acme-us-east. Region keys are unique across all of Pipecat Cloud, so include your organization or company name. You will use the same key for the life of the region, including across cluster rebuilds. Decide on the workloads namespace where your agents will run. The default, pipecat-agents, is fine unless you have a naming convention to follow. The namespace is created by the install and is yours: it survives uninstalls, and you can pre-create it yourself if a GitOps pipeline owns your namespaces.
1

Mint a registry key

A registry key is a pull-only credential that lets helm on your workstation fetch the region package. It is shown exactly once.
The command prints the key and the matching helm registry login command. Run it, supplying the key on stdin rather than the command line:
In the dashboard, mint registry keys from the Keys page under your organization’s settings.
This is a workstation credential only. Your cluster’s own credential for pulling platform images is delivered automatically during enrollment — you never create an image pull secret for the platform components.
2

Register the region

Registration creates the region record in your organization: its key, a display name, the workloads namespace, the CPU architectures its nodes provide, and — if you plan to run WebSocket or telephony agents — the public WebSocket endpoint you will expose.
Only declare architectures your cluster can actually schedule; deploys are validated against this list. Omit --ws-public-endpoint if the region will not expose a WebSocket endpoint — you can add it later.Registering is an upsert: re-running the command with different options updates the record, and options you leave out keep their stored values. Use it whenever something about the region changes, such as a new WebSocket hostname.In the dashboard, open Settings → Regions and choose Register Region.
3

Mint an enrollment token and stage it in the cluster

Enrollment is how your cluster proves it is the region you registered and receives its certificates. It is bootstrapped by a one-time token that must be present in the cluster before you install the package.
The command prints the token together with the kubectl command that stages it. Create the system namespace first, then run the printed command:
In the dashboard, open the region on Settings → Regions and choose Mint Enrollment Token.
The token is single-use, expires after one hour, and cannot be retrieved again. If it expires before you install, mint a new one — nothing else needs to change.
4

Write your values file

Create a values file for the region. It should contain only what the package cannot know about your cluster — your broker, your log store if you use one, your WebSocket exposure — and never image references or versions. See Configuration for the reference; a minimal production file looks like this:
Any Secrets your values reference (such as broker-auth above) must exist in pipecat-system before you install.
5

Install the region package

Use the latest published version ( or later). The package carries its own control-plane configuration and every platform image at that version, so --set global.regionKey and your values file are the entire configuration.During the install, an enrollment job runs first: it exchanges your one-time token for the region’s certificates, receives the cluster’s image pull credential, and writes both into the cluster. The remaining components then start and the region agent opens its connection to Pipecat Cloud.--wait returning cleanly is the acceptance test: enrollment completed and every component is ready. If it times out, see Diagnostics — the most common cause on a fresh cluster is nodes too small for the platform components’ requests.
6

Verify

From your workstation:
The enrollment status should read active, with an intermediate certificate expiry about a year out. In the dashboard, the region appears on Settings → Regions with its status and certificate expiry, and in every region picker.In the cluster, all pods in pipecat-system should be Running and the enrollment job Completed:
The install also prints two ready-to-run diagnostic commands; re-read them any time with helm get notes pipecat -n pipecat-system.

Next steps

Reference your secrets

Create Secrets in your workloads namespace and reference them as secret sets.

Deploy an agent

pipecat cloud deploy --region acme-us-east, exactly as for any other region.

Size your agents

Explicit CPU and memory, your own profiles, and architecture targeting.

Expose WebSockets

Telephony and WebSocket sessions connect directly to your region.