Use Helm to deploy the BeeAI Platform on Kubernetes, creating a centralized environment where your team can quickly test, share, and iterate on agents.
Intended Use: BeeAI Platform is designed for internal team deployments behind VPNs or firewalls. Basic authentication protects administrative operations (agent management, secrets, model configuration), but authenticated users can freely use agents, upload files, and create vector stores without per-user limits. Deploy only in trusted environments where you control who has access. Public internet deployments are not recommended.
Requirements
- BeeAI installed for post-deployment configuration
- Kubernetes 1.24+ with admin access
- kubectl configured to access your cluster
- Helm 3.8+
- Persistent storage (20GB+ for PostgreSQL)
- LLM provider API access (OpenAI, Anthropic, etc.)
Get Started
Step 1: Create Configuration File
Create a config.yaml file with your desired configuration:
# If you want to include agents from the default catalog (change release/tag accordingly):
externalRegistries:
public_github: "https://github.com/i-am-bee/beeai-platform@v0.3.5#path=agent-registry.yaml"
# Your custom agents as docker images
providers:
# e.g.
# - location: ghcr.io/i-am-bee/beeai-platform-agent-starter/my-agent:latest
- location: <docker-image-id>
# Generate the encryption key:
# - using UV (https://docs.astral.sh/uv/getting-started/installation/)
# $ uv run --with cryptography python3 -c 'from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())'
# - using python3 directly
# $ python3 -m pip install cryptography # (or use your preferred way to install the cryptography package)
# $ python3 -c 'from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())'
encryptionKey: "encryption-key-from-command"
# this requires passing an admin password to certain endpoints, you can disable auth for insecure deployments
auth:
enabled: true
jwtSecretKey: "my-secret-key"
basic:
enabled: true
adminPassword: "my-secret-password"
Step 2: Install the Chart
Then install the chart using:
helm upgrade --install beeai -f config.yaml oci://ghcr.io/i-am-bee/beeai-platform/beeai-platform-chart/beeai-platform:0.3.5
It will take a few minutes for the pods to start.
Step 3: Port-Forwarding
By default, ingress is not configured. You can port-forward the service to access the platform. In a separate terminal, run:
kubectl port-forward svc/beeai-platform-svc 8333:8333 &
Step 4: Setup LLM
After the platform becomes ready, it’s time to set up your model provider:
BEEAI__ADMIN_PASSWORD="my-secret-password" beeai model setup
Step 5: Test the Deployment
BEEAI__ADMIN_PASSWORD="my-secret-password" beeai list
BEEAI__ADMIN_PASSWORD="my-secret-password" beeai run chat hi
Configuration Options
Security Settings
The current authentication model is basic and intended for development use.
For any deployment beyond local testing, carefully consider your security
requirements and network access controls.
For local testing environments without authentication:
# config.yaml - INSECURE, for testing only
auth:
enabled: false
Agent Configuration
Include specific agents in your deployment:
# config.yaml
providers:
# Official agents
- location: ghcr.io/i-am-bee/beeai-platform/agents/chat:0.3.4
- location: ghcr.io/i-am-bee/beeai-platform/agents/rag:0.3.4
- location: ghcr.io/i-am-bee/beeai-platform/agents/form:0.3.4
# Your custom agents
- location: your-registry.com/your-team/custom-agent:v1.0.0
External Agent Registry
Use the default agent registry instead of specifying individual agents:
# config.yaml
externalRegistries:
public_github: "https://github.com/i-am-bee/beeai-platform@v0.3.5#path=agent-registry.yaml"
# Omit the 'providers' section to use only registry agents
Management Commands
Upgrading
To upgrade to a newer version of the beeai platform, use:
helm upgrade --install beeai -f config.yaml oci://ghcr.io/i-am-bee/beeai-platform/beeai-platform-chart/beeai-platform:<newer-version>
View Current Configuration
Check Deployment Status
helm status beeai
kubectl get pods
kubectl logs deployment/beeai-platform
Uninstall
Troubleshooting
Common Issues
Platform not starting:
# Check pod logs
kubectl logs deployment/beeai-platform
# Check events
kubectl get events --sort-by=.lastTimestamp
Can’t access agents:
# Verify LLM configuration
kubectl logs deployment/beeai-platform | grep -i llm
Authentication issues:
# Check if authentication is properly configured
kubectl get secret beeai-platform-secret -o yaml