Overview
xpander.ai can be deployed on your own infrastructure using Helm charts, giving you full control over your AI agent platform. This guide walks you through setting up a self-hosted xpander.ai deployment on Kubernetes.Before starting, you’ll need to create an environment in the xpander.ai Console to get your Organization ID and Environment ID.
Prerequisites
- Kubernetes 1.20 or later
- Helm 3.12 or later
- Ingress Controller (e.g., NGINX Ingress Controller)
- Storage Class for persistent volumes
- TLS certificates (manual or cert-manager)
Network Security & Traffic Flow
Important: xpander.ai self-hosted deployment only makes outbound connections. There is no incoming traffic from xpander.ai to your cluster.
Traffic Direction
- ✅ Outbound Only: Your self-hosted deployment connects out to xpander.ai services
- ❌ No Inbound: xpander.ai never initiates connections to your cluster
- 🔒 Your Control: All data stays within your infrastructure
Required Outbound Access
Your cluster needs outbound (egress) access to these xpander.ai IP addresses:- Protocol: HTTPS (port 443)
- Direction: Outbound/Egress only
- Source: Your Kubernetes cluster
- Destination: The IP addresses above
Environment Setup
1. Create Environment
First, create a new self-hosted environment in the xpander.ai Console:- Go to https://app.xpander.ai/environments
- Click “Add Environment”
-
Enter your environment details:
- Name: e.g., “Production”
- URL: Your server’s FQDN (e.g.,
xpander.my-company.com
)
- Note down the Organization ID and Environment ID - you’ll need these for installation.
2. Get Installation Commands
The platform will automatically generate the complete Helm installation commands for you with all the required keys and configuration. You don’t need to manually obtain or configure these values.Installation
The platform will provide you with the exact Helm installation commands tailored to your environment. The examples below show the format and available options for reference.
Quick Start
Production Installation
For production deployments, configure AI service API keys and custom settings:Architecture
The Helm chart deploys the following components:Generated Hostnames
When you set adomain
, these hostnames are automatically created:
agent-controller.{domain}
- Main API endpointai-gateway.{domain}
- AI service gatewaymcp.{domain}
- MCP (Model Context Protocol) service
Configuration Options
Required Parameters
Parameter | Description | Example |
---|---|---|
global.organizationId | Your xpander.ai organization ID | 6aedc41e-9771-4660-b46e-af51c66d2ea8 |
global.environmentId | Your xpander.ai environment ID | 0e308480-f02c-44a9-97ce-e15bb39d94e8 |
secrets.static.deploymentManagerApiKey | Deployment manager API key | 6120718c-ef9b-42e8-93a8-18203d0700a9 |
Optional Parameters
Parameter | Description | Default |
---|---|---|
domain | Base domain for ingress hosts | "" (ingress disabled) |
ingress.enabled | Enable external access via ingress | false |
agent-worker.env.AGENTS_OPENAI_API_KEY | OpenAI API key for GPT models | "" |
agent-worker.env.ANTHROPIC_API_KEY | Anthropic API key for Claude models | "" |
AI Service Configuration
OpenAI Integration
To use OpenAI models (GPT-3.5, GPT-4, etc.):Anthropic Integration
To use Claude models:Using Kubernetes Secrets (Recommended)
For production, store API keys in Kubernetes secrets:Verification
After installation, verify your deployment:Check Pod Status
Test Health Endpoints
Connecting Your Environment
Once deployed, connect your environment in the xpander.ai Console:- Go to https://app.xpander.ai/environments
- Find your environment and click “Complete setup”
- The status should change to “Connected” when the deployment is healthy
Troubleshooting
Common Issues
Pods stuck in Pending state
Pods stuck in Pending state
Cause: Storage class or PVC issuesSolution: Check storage configuration
Ingress not accessible
Ingress not accessible
Cause: Ingress controller or DNS issuesSolution: Verify ingress configuration
Health checks failing
Health checks failing
Cause: Application startup issuesSolution: Check application logs
API key configuration issues
API key configuration issues
Cause: Missing or invalid AI service API keysSolution: Verify API key configuration
Debug Commands
Upgrading
Regular Updates
Update with New Configuration
Uninstalling
Next Steps
- Configure Agents: Set up your AI agents using the Quick Start Guide
- Connect Slack: Integrate with Slack using the Slack Integration Guide
- Add Connectors: Connect to external services with AI Connectors
- Monitor Deployment: Set up monitoring and observability for your production deployment
Support
- Community Slack: Join our Slack
- GitHub Issues: Report issues and contribute
- Discord: Developer Discord