Skip to main content
The Hybrid edition: your data and agents run in your cluster, control plane in xpander cloud. All execution, runtime data, credentials, and model keys stay inside your VPC; xpander cloud manages agent definitions, identity, and the connector catalog. This page is the complete guide — from architecture review to a running, connected location.
Self-hosted locations are unlocked per account — contact our team if the option isn’t available on yours.
Comparing editions first? See the Self-Hosted overview. The full-platform edition with no internet access is Air-Gapped.

Architecture

Hybrid follows the control plane / data plane separation pattern — the same model used by AWS EKS, Datadog, and other infrastructure platforms:
  • Control plane (xpander Cloud) — manages environment metadata, agent registration, connector definitions, and event logging. AI engineers use the Agent Workbench to define agents, configure connectors, and validate tasks. The control plane never touches runtime data.
  • Data plane (your VPC) — runs all task execution, agent memory, connector credentials, model API keys, and user-facing services. The user’s browser connects directly to the data plane. Chat threads, activity views, and task results are served from the cluster — nothing passes through the cloud.
The data plane connects outbound only to the control plane over port 443 for metadata sync and heartbeats. The control plane never initiates connections into your cluster. MCP and external-system calls run from your cluster, and agent workspaces — the agents’ computers — run there too.

What Gets Deployed

How It Works

Clients — Slack, the web UI, MCP clients, the SDK and API — connect directly to the cluster in your VPC. When using app.xpander.ai, the cloud UI handles authentication and tells the client which self-hosted cluster to connect to; all data then flows client-to-cluster. Inside the cluster, the Agent Controller schedules tasks and Agent Workers execute them — calling LLMs, persisting messages in PostgreSQL, and reaching external tools exclusively through the AI Gateway. The only connection to xpander Cloud is the deployment manager sync: the Agent Controller authenticates with organization_id + environment_id + api_key, reports heartbeats, and pulls agent, connector, and MCP configuration.

What Talks to What

The egress surface — the answers a security review needs. Inbound from xpander cloud: none; connections are outbound-only. Outbound connectivity options to the control plane:

Data Residency

Data at rest stays in PostgreSQL and Redis inside your VPC; credentials and API keys are Kubernetes secrets; the control plane sync carries metadata and heartbeats only — user payloads never leave the VPC.

Requirements & Sizing

Minimum footprint (the installer shows the same numbers, published at charts.xpander.ai/requirements.json):
xpander container images are amd64 only. Do not use ARM/Graviton instances (t4g, m7g, c7g, etc.).
Need a cluster? Follow the EKS Cluster Setup guide.

Example Estimates

Agents are autonomous — tasks come from schedules, webhooks, the SDK and API, and other agents, not only chat (in xpander cloud production, only ~5% of executions are interactive chat). Size for the number of tasks running concurrently at peak, whatever triggers them. Capacity figures include ~50% headroom over pod resource requests for burst load, Kubernetes system pods, and node upgrades. Use the calculator below to size for your exact numbers.

Sizing Calculator

The calculator applies the same model we use to size xpander cloud:
  1. Concurrent tasks is the primary driver. A task is any agent execution, from any source: chat, API/SDK calls, schedules, webhooks, MCP clients, Slack, or another agent. If you don’t know your peak concurrency yet, assume one concurrent task per agent - that covers most production organizations we measured. In practice most teams peak at just a few concurrent tasks (typically under 5), and even the busiest organization peaks around 30.
  2. Agent Workers = concurrent tasks ÷ 4 (each worker replica processes 4 tasks by default, configurable with MAX_CONCURRENT_EXECUTIONS). Each replica requests 2 vCPU / 2.5 GiB.
  3. Agent Controllers: 1 replica up to ~8 concurrent tasks, 2 up to ~20, 3 beyond. Each requests 1 vCPU / 2 GiB.
  4. Active workspaces = concurrent tasks × workspace share, capped at the agent count. Budget ~0.5 vCPU / 1 GiB per active workspace (measured typical load; each can burst to its 2 vCPU / 3 GiB limit).
  5. Fixed base (~2 vCPU / 6 GiB): AI Gateway, MCP, Chat, Code Runner, AWS Operator, API, Redis, PostgreSQL, container registry, metrics-server at one replica each.
  6. Cluster capacity = requests × 1.5 for burst, DaemonSets, and safe node drains. Storage = 48 GiB of chart volumes + 5 GiB per agent (each agent that uses a workspace keeps a persistent volume) + image cache per node.
Per-replica values. Defaults are what the Helm chart applies out of the box; recommended raises the values we found low against measured production usage.Override any of these in your Helm values (keys are camelCase):
Horizontal Pod Autoscaling is available for Agent Controller, AI Gateway, Agent Worker, and MCP via the chart’s autoscaling values. The chart installs metrics-server by default to support it.
Each agent that uses workspace tools gets a dedicated pod, created on demand and reclaimed when idle. Size the cluster for the number of concurrently active workspaces, not total agents.Idle workspaces consume almost nothing (~50 Mi observed); an active workspace typically uses ~0.5-1 vCPU and up to 1 GiB, bursting to its limits for heavy work. The workspace volume persists after the pod is reclaimed, so a returning agent keeps its files - plan 5 GiB of storage per workspace-using agent, not per pod.
The workspace image is ~1 GiB. The first workspace start on each node pulls it; subsequent starts on that node are fast. Budget ~2 GiB of node disk for image cache.
The chart deploys single-replica Redis and PostgreSQL StatefulSets and a container registry alongside the platform:Baseline storage: 48 GiB of persistent volumes, plus 5 GiB per workspace-using agent (see above). All volumes use your cluster’s default StorageClass unless overridden.Production checklist:
  • Node types: x86_64 only. General-purpose instances with a 1:4 vCPU:GiB ratio (m5, m6i) fit the workload profile; t3 burstable instances are fine for evaluation, not for production.
  • Raise the low defaults: API memory (table above) before real load.
  • Enable autoscaling for Agent Worker once concurrency grows beyond a couple of replicas.
  • Keep headroom: pod requests should stay under ~65% of cluster capacity so node upgrades and bursts don’t evict workloads.
  • Storage class: SSD-backed volumes for Redis and PostgreSQL.

Install

1. Get Your One-Liner from the Console

  1. Go to app.xpander.ai/admin_settings#locations
  2. Click “Add Location”
  3. Choose the Hybrid edition. The dialog shows the minimum footprint for the edition you picked.
  4. Optionally set a URL (your server’s FQDN, e.g. xpander.my-company.com) and the hostname style (dash-based subdomains if your DNS can’t do wildcards)
  5. Copy the generated one-liner
The one-liner carries your identity — --org, --env, and --dm-api-key (plus --domain when you set a URL). That is how the cluster authenticates to the xpander control plane:
The one-liner deliberately carries no LLM provider credentials — the wizard prompts for those interactively (input hidden), or you pass them as flags. Secrets are written to a temporary values file (mode 600, removed on exit) and never appear on the helm command line.

2. Run the Installer

Run it from a terminal with kubectl access to the target cluster. The command downloads the installer from charts.xpander.ai and runs an interactive wizard — preflight checks, configuration, Helm install, then the connection back to xpander. Run bare (curl -fsSL https://charts.xpander.ai/install.sh | bash), it is the zero-knowledge entry point: the first question is which edition you are installing. The wizard walks through, in order:
1

Edition & requirements

If --edition wasn’t given, it asks. It then prints the minimum footprint for that edition (the same numbers as charts.xpander.ai/requirements.json) and asks you to confirm your cluster meets it — stopping cleanly if not.
2

Identity

Organization ID, Environment ID, and the Deployment Manager API key (input hidden) — all from the console’s install card, all skipped if passed as flags.
3

Ingress domain (optional)

Press Enter to skip — services then keep cluster-internal Services only, which is fine for a first install (port-forward reaches them; add ingress later). With a domain, it asks how to build hostnames: subdomain style (agent-controller.xpander.<DOMAIN>, needs wildcard DNS) or dash style (agent-controller-xpander.<DOMAIN>, individual A records).
4

Control plane reachability

Public internet (https://deployment-manager.xpander.ai), AWS PrivateLink (https://deployment-manager-privatelink.xpander.ai), or Staging. The installer auto-detects staging/local environments (a .stg. or local domain, or a kind/k3d/minikube/docker-desktop kube context) and leads with that option; any of --staging, --privatelink, or --dm-url overrides detection.
5

LLM providers (all optional)

OpenAI, Anthropic, Google/Gemini, Amazon Bedrock, then optionally Fireworks, Nebius, Helicone, and OpenRouter. Press Enter to skip any — the platform installs and starts without keys, and model calls light up as soon as you add a provider key in the UI or with a helm upgrade.For Bedrock it asks how to authenticate: an API key / bearer token (AWS_BEARER_TOKEN_BEDROCK), or keyless IAM role / EKS pod identity. See the caveat below before choosing IAM.
6

Namespace, context confirmation, summary

Namespace (default xpander, created if missing), an explicit confirmation of the kubectl context it is about to install into, and a masked configuration summary before anything changes.

Install Phases

The Hybrid install runs six phases, each announced as a stable [N/6] name: ... progress line (the same shape scripts can grep — see Automation & CI):
Every failure prints a FIX: line naming the action that repairs it and a RERUN: line with your personalized non-interactive one-liner (secrets typed at prompts are placeholdered, never echoed). Fix the condition and paste the rerun line — the installer is idempotent.

Amazon Bedrock: key vs IAM

--bedrock-auth key (default when --bedrock-key is given) stores the bearer token; --bedrock-auth iam is keyless and reads the pod’s own AWS credential chain.
Keyless IAM Bedrock requires the updated xpander SDK release. On older SDK versions, chats work but task executions fail — the SDK sets an empty bearer token unconditionally. On EKS it also needs IRSA or pod identity wired to a role with Bedrock access. If in doubt, use the bearer-token mode.

3. Verify the Connection

When the install completes, a summary box prints the release, control-plane URL, ingress state, and configured providers. Your cluster registers with the control plane and the xpander console flips to “Connection established” in a minute or two.
Expect one Running, 1/1-ready pod per application service (agent-controller, agent-worker, ai-gateway, api, aws-operator, chat, code-runner, mcp) plus the postgres and redis StatefulSets — and, at defaults, docker-registry and metrics-server. Test locally without ingress:
In the console (admin_settings#locations), the location shows as “Self-deploy”; the Components tab shows heartbeat status per service, and the Configuration panel toggles Cloud Controls (Chat, Streaming, Scheduler).
Your cluster must reach the xpander deployment manager. Two options: If public works for you, skip this section entirely: your cluster nodes just need outbound HTTPS (via NAT Gateway if in private subnets). If your security policy requires traffic to stay within the AWS network, set up PrivateLink, then tell the installer with --privatelink (or pick AWS PrivateLink at the wizard’s reachability question). --privatelink, --staging, and --dm-url are mutually exclusive — pass exactly one, or none for the public endpoint. AWS PrivateLink is a two-sided connection. xpander exposes the deployment manager as a VPC Endpoint Service (provider). You create a VPC Endpoint (consumer) in your VPC, which provisions a private ENI with a 10.x.x.x IP address. Your pods connect to this private IP — traffic goes over the AWS backbone, never the internet.
Contact xpander to have your AWS account ID added as an allowed principal before creating the VPC endpoint.

Set It Up

1

Create the VPC endpoint

The xpander endpoint service is in us-west-2. If your cluster is in a different region, you must include the --service-region us-west-2 flag — this is the most common mistake (see Troubleshooting).
Save from the output: VpcEndpointId, Groups[0].GroupId (the security group), DnsEntries[0].DnsName, and DnsEntries[0].HostedZoneId.
If your cluster is in us-west-2 (same region as the service), you can omit --service-region.
2

Allow HTTPS on the endpoint security group

The VPC endpoint is created with the VPC’s default security group, which only allows inbound traffic from itself. Allow HTTPS from your VPC CIDR:
3

Wait for the endpoint to become available

The endpoint transitions from pending to available in 1-3 minutes (auto-accepted):
4

Create private DNS

Create a private hosted zone so deployment-manager-privatelink.xpander.ai resolves to the endpoint ENI inside your VPC:
Save the HostedZone.Id from the output, then create the alias record:
5

Verify connectivity

A timeout or 000? See Troubleshooting below.

External Access & DNS

The xpander services communicate with each other internally via Kubernetes Services — no ingress is needed for that. You only need external access so that users can reach the chat UI, API, and other endpoints from their browser or client.
Already have an ingress controller? Give the installer a --domain (or set ingress.enabled=true in Helm values) and skip to DNS records.

Option A: VPN / Corporate Network Access

If your organization has a VPN that routes into the VPC, users can access xpander services directly — no ingress controller, NLB, ACM certificate, or public DNS needed. Point internal DNS records to the Kubernetes services:
When installing, skip the domain prompt (ingress stays disabled, the default).

Option B: Public Access via Ingress + NLB

For public or internet-facing access, set up an ACM certificate, nginx ingress controller, and NLB.

SSL Certificate

Request an ACM certificate for your domain.
The certificate must include a wildcard for *.chat.<DOMAIN> because the xpander chat UI generates per-thread subdomains (e.g., moccasin-prawn.chat.<DOMAIN>). Standard wildcards only match one level, so *.<DOMAIN> does not cover these. If you omit *.chat.<DOMAIN>, the chat UI will show SSL certificate errors for thread URLs.
Add the DNS validation CNAME records to your Route 53 hosted zone. There will be two unique validation records — one for <DOMAIN> / *.<DOMAIN> (shared) and one for *.chat.<DOMAIN>:
Wait for validation:

Ingress Controller

Install the nginx ingress controller with AWS NLB and ACM SSL termination:
Get the NLB hostname (you’ll need it for the DNS records):

DNS Records

Create wildcard CNAME records pointing *.<DOMAIN> and *.chat.<DOMAIN> to the NLB hostname. Both are required — the chat UI generates per-thread subdomains under chat.<DOMAIN>.
This creates the following endpoints: Test it:

Managing LLM API Keys

Use helm upgrade with --reuse-values to add or change API keys without affecting existing configuration:
After the upgrade, pods that use the updated secrets will automatically restart. Verify with kubectl get pods -n xpander.
The xpander-static secret has a Helm resource keep policy — helm upgrade may not update it on subsequent installs. If your API key isn’t being picked up after a helm upgrade, set it directly in the secret:
Secret field name mapping:

Using the SDK with Self-Hosted

Configure the xpander SDK to point to your Agent Controller endpoint.
When using self-hosted deployment, use the Agent Controller API key generated during installation, not your xpander.ai cloud API key.

Using with Agno Framework

Make sure your base_url points to the Agent Controller endpoint (e.g., https://agent-controller.{your-domain}), not the root domain.For more SDK examples, see the Self-Hosted SDK Configuration.

Upgrading

Upgrades work like the Datadog agent flow: watch the xpander releases feed (Releases page / Atom feed), then run the upgrade subcommand:
install.sh upgrade:
  • finds the release (default xpander in namespace xpander; override with --release / --namespace),
  • infers its edition from the installed chart — you never pass --edition to an upgrade,
  • reuses the values the release was installed with (helm get values), plus anything extra you pass (--set, --values),
  • shows current → target version with a link to the release notes, and asks before changing anything,
  • always runs with --atomic: a failed upgrade (including a failed hook) rolls back automatically and the previous revision keeps serving.
Manual-Helm equivalent:

Installer Flags Reference

Identity (Hybrid identifies with the three console values; required non-interactively): LLM providers (all optional — the wizard asks for these): Hybrid connectivity & ingress: Chart and release: Other: Air-gap-only flags (license, mirroring, image tags, data tier, base domain, code execution): Air-Gapped edition.

Automation & CI

The installer is built to be driven by scripts, CI pipelines, and coding agents:
  • Every prompt has a flag. With --non-interactive nothing is read from the terminal, even when one exists: missing required values exit 2 with the usage and a completed rerun line rather than blocking. It implies --yes.
  • Stable progress output. Progress is one line per transition in a grep-friendly shape — [3/6] chart-source: ok — and --quiet reduces output to phase lines and the outcome only. Color is emitted only when stdout is a terminal.
  • status is the poll target. A read-only health report: edition, chart, release status, hook jobs, workload readiness, and URLs. --json emits one JSON object.
Exit codes: Hybrid, end to end, no terminal:
Poll until healthy:
When a scripted run fails, the exit code plus the last FIX:/RERUN: lines tell you what to repair — see Troubleshooting.

Advanced: Review-First / Manual Install

For teams that review before they run — everything the installer does can be inspected first, reproduced by hand, or both.

Read the installer before running it

  • The versioned URL is immutableinstall-v<version>.sh is published once per release and never rewritten in place, so pin it in runbooks and CI (bash install.sh --version prints the version you’re holding).
  • The script is shellcheck-clean, enforced by CI on every push.
  • Secrets never touch the helm command line: they are written to a temporary values file (mode 600, removed on exit), so they don’t land in shell history or process listings.
  • Nothing runs against a cluster before the kube-context confirmation — the installer names the context and cluster it is about to install into and waits for your yes.

Do it yourself

The installer is a wrapper around helm upgrade --install; everything it does can be done by hand. The cleanest middle path is --values-out:
Or fully by hand. Add the repository:
Set the deployment manager URL based on your connectivity choice — public https://deployment-manager.xpander.ai, or https://deployment-manager-privatelink.xpander.ai with PrivateLink — and install:
LLM provider keys are secrets.static.* values — the full list is in the key mapping table. Common optional parameters:For production, use a values file instead of --set flags:
xpander-values.yaml
See Requirements & Sizing for recommended resource values per service.

Troubleshooting

Every installer failure prints two lines: FIX: — the action that repairs the condition — and RERUN: — your personalized non-interactive one-liner (secrets typed at prompts are shown as placeholders). The installer is idempotent: fix the condition, paste the rerun line, and it picks up where the failure left off. A secret-scrubbed session log is kept under ~/.xpander/logs/ (latest.log points at the most recent run). For scripted runs, the exit code names the failure class (Automation & CI), and bash install.sh status gives a read-only health verdict.

Installer

install.sh upgrade requires the release to be in deployed status — operating on a stuck release (pending-install, pending-upgrade, pending-rollback, failed, uninstalling) would strand it. Recover first:
Then paste your RERUN: line. A pending-install status usually means a first install was interrupted (Ctrl-C, lost connection) or timed out — helm uninstall is the right recovery for it.
The two editions share nothing and cannot be upgraded into each other. If the release name in the namespace already runs the other chart, the installer stops with the collision. Install under a different release or namespace (--release / --namespace), or remove the existing release first (helm uninstall xpander -n xpander).
Piping the installer into bash leaves no stdin to prompt on, so a piped run is non-interactive (the same contract as --non-interactive): Hybrid requires --org, --env, and --dm-api-key. Missing flags exit with code 2 and a completed rerun line. Copy the personalized one-liner from the xpander console — it carries the identity flags — or download the script and run bash install.sh for the interactive wizard.

Cluster and Pods

The init containers wait for agent-controller to be ready. Check its logs:
Common cause: Cannot reach the deployment manager. If using PrivateLink, verify the DNS and security groups are configured correctly — see PrivateLink.
Cause: Storage class or PVC issues.
Check that a default StorageClass exists and the EBS CSI driver is running:
If using EKS, ensure the node role has AmazonEBSCSIDriverPolicy attached.
You are running on ARM/Graviton nodes. xpander images are amd64 only. Switch to x86 instance types (t3, m5, c5, etc.).
The agent-worker pod requests 2 CPU by default. Options:
  • Add more nodes or use larger instances
  • For non-production environments only:
Check application logs:

Ingress and Networking

Verify ingress configuration:
Check that the NLB was provisioned and DNS CNAME records point to it:
Symptom: the ingress controller’s Service stays <pending>. Check its events (kubectl -n ingress-nginx describe svc ingress-nginx-controller):
  • could not find any suitable subnets for creating the ELB — the VPC’s subnets are missing the ELB role tags. Tag public subnets kubernetes.io/role/elb=1 for an internet-facing NLB; for an internal one, tag the private subnets kubernetes.io/role/internal-elb=1 and annotate the Service service.beta.kubernetes.io/aws-load-balancer-internal: "true".
  • On EKS Auto Mode, ensure the cluster role trust policy includes sts:TagSession:
The ACM certificate must include *.chat.<DOMAIN> as a subject alternative name. The chat UI generates per-thread subdomains (e.g., moccasin-prawn.chat.<DOMAIN>) that are not covered by *.<DOMAIN>.Request a new certificate with:

API Keys

The xpander-static secret has a Helm resource keep policy. Set the key directly:
See the secret field name mapping for all key names.
Verify the keys are reaching the agent-worker pod:
If missing, re-run the upgrade with the key set (--set secrets.static.<key>=...), or check that your secret is correctly mounted through envFromSecretKeys — see Managing LLM API Keys.

Debug Commands


Uninstalling