Skip to main content

​
Overview

CrewAI Platform is distributed as a Helm chart via OCI registry through the Replicated platform. This guide covers installation, preflight validation, and post-installation configuration.

​
Step 1: Registry Authentication

Access your registry credentials via the CrewAI enterprise customer portal at https://enterprise.crewai.com/crewai.
Replace customer@company.com with your actual customer email and [YOUR_SECRET_TOKEN] with the token provided in the customer portal.
# Export your authentication token
export AUTH_TOKEN=[YOUR_SECRET_TOKEN]

# Log in to the Replicated registry
helm registry login registry.crewai.com \
  --username customer@company.com \
  --password $AUTH_TOKEN

​
Step 2: Install Required Plugins

Install the preflight and support-bundle kubectl plugins for cluster validation and diagnostics: 
# Install Krew plugin manager
curl https://krew.sh | bash

# Insall preflight and support-bundle plugins
kubectl krew install preflight support-bundle

# Verify installation
kubectl preflight --version
kubectl support-bundle --version

​
Step 2.5: Provision Infrastructure (Terraform Option)

If you want to provision cloud infrastructure before chart installation, use one of these Terraform feature guides:
Request the Terraform files from the CrewAI Factory Engineering team before starting Terraform provisioning.
Each guide covers infrastructure provisioning and how to map Terraform outputs into your Helm values.

​
Step 3: Create Configuration File

Create a my-values.yaml file with your deployment configuration. See the Configuration Guide for detailed examples.
Crew automation deployments require a writable image registry. Set envVars.CREW_IMAGE_REGISTRY_OVERRIDE and validate write requirements in the Requirements Guide.
Minimum Production Configuration:
my-values.yaml
postgres:
  enabled: false  # Use external database

minio:
  enabled: false  # Use external S3

envVars:
  APPLICATION_HOST: "crewai.company.com"
  DB_HOST: "crewai-prod.cluster-xyz.us-west-2.rds.amazonaws.com"
  DB_PORT: "5432"
  DB_USER: "crewai"
  POSTGRES_DB: "crewai_plus_production"
  POSTGRES_CABLE_DB: "crewai_plus_cable_production"

  STORAGE_SERVICE: "amazon"
  AWS_REGION: "us-west-2"
  AWS_BUCKET: "crewai-prod-storage"
  CREW_IMAGE_REGISTRY_OVERRIDE: "123456789012.dkr.ecr.us-west-2.amazonaws.com"

  AUTH_PROVIDER: "entra_id"

secrets:
  DB_PASSWORD: "your-db-password"
  AWS_ACCESS_KEY_ID: "your-aws-key"
  AWS_SECRET_ACCESS_KEY: "your-aws-secret"
  ENTRA_ID_CLIENT_ID: "your-client-id"
  ENTRA_ID_TENANT_ID: "your-tenant-id"
  ENTRA_ID_CLIENT_SECRET: "your-client-secret"

web:
  replicaCount: 2
  ingress:
    enabled: true
    className: nginx
    host: "crewai.company.com"
    nginx:
      tls:
        enabled: true
        secretName: "crewai-tls"
Never commit secrets to version control. Store my-values.yaml securely and use CI/CD secret management or external secret stores for production.

​
Step 4: Run Preflight Checks

Validate your Kubernetes cluster meets all requirements before installation: 
# Run preflight checks against your cluster
helm template oci://registry.crewai.com/crewai/stable/crewai-platform \
  --values my-values.yaml \
  | kubectl preflight -
Preflight checks validate cluster resources, storage classes, RBAC permissions, and other requirements. Address any failures before proceeding with installation. CrewAI Platform supports AMD64 (x86_64) Kubernetes worker nodes. ARM64 (aarch64) worker nodes are not currently supported. See the Requirements Guide for details. Ensure your envVars.CREW_IMAGE_REGISTRY_OVERRIDE target registry is reachable and writable (push/pull) for crew automation builds.

​
Common Preflight Issues

Missing Default Storage Class: 
# Set gp2 (EKS) as default storage class
kubectl patch storageclass gp2 -p '{"metadata": {"annotations":{"storageclass.kubernetes.io/is-default-class":"true"}}}'

# Or for GKE standard storage
kubectl patch storageclass standard -p '{"metadata": {"annotations":{"storageclass.kubernetes.io/is-default-class":"true"}}}'
Insufficient Resources:
  • Ensure cluster has sufficient CPU and memory capacity
  • Review node resources: kubectl top nodes
  • Scale cluster if needed before installation

​
Step 5: Install the Chart

# Install with your configuration
helm install crewai-platform \
  oci://registry.crewai.com/crewai/stable/crewai-platform \
  --values my-values.yaml

# Monitor installation progress
kubectl get pods -w
After installation completes, Helm displays important information including:
  • Chart version and app image tag
  • Link to complete documentation
  • Configuration warnings (if any)
If you see a warning about RAILS_MASTER_KEY in the installation output, remove this configuration from your values file. The chart automatically manages this key and manual configuration is not needed.

​
Verify Installation

# Check all pods are running
kubectl get pods

# Check services
kubectl get svc

# View installation logs
kubectl logs -l app.kubernetes.io/name=crewai-platform --tail=50

​
Step 6: Complete Post-Installation Setup

After successful installation, complete the required post-installation configuration steps. See the Post-Installation Guide for detailed instructions on:
  • Initializing the internal organization
  • Setting up default permissions
  • Enabling Studio V2 features (optional)
  • Accessing the application via port forwarding, ingress, or LoadBalancer

​
Troubleshooting Installation

​
Pods Not Starting

# Check pod status and events
kubectl describe pod <POD_NAME>

# View pod logs
kubectl logs <POD_NAME>

# Check for image pull issues
kubectl get events --sort-by='.lastTimestamp'

​
Generate Support Bundle

For comprehensive diagnostics, you can generate a support bundle that collects logs, resource status, and configuration information.

​
Install the support-bundle Plugin

# Using Krew (recommended)
kubectl krew install support-bundle

​
Generate the Support Bundle

# Automatically detect support bundle specs from cluster
kubectl support-bundle --load-cluster-specs
The support bundle will be saved as a .tar.gz file that can be shared with CrewAI support for troubleshooting.

​
Next Steps

​
Additional Resources

  • Customer Portal: https://enterprise.crewai.com/crewai
  • Release History: https://enterprise.crewai.com/crewai/release-history