Run the Gateway in Your Own Network with the Edge Gateway

• An edge instance registered in Cloptima
• The edge gateway running in your Kubernetes cluster or on a Docker host
• An Edge BYOK credential whose key stays on your side
• A virtual key and policy that govern edge traffic

You need an owner or admin role and a place to run containers inside your network.

1. 1

   Open Edge Instances

   Go to AI → Credentials & Keys and find the Edge Instances card.

2. 2

   Choose + Register Edge

   Enter an Instance Name such as prod-vpc-eu, a Region, and an Environment.

3. 3

   Copy the edge token

   It is shown once. Store it in your secret manager.

helm upgrade --install cloptima-edge oci://ghcr.io/cloptima/charts/cloptima-edge-gateway \
  --namespace cloptima --create-namespace \
  --set edge.pat="$CLOPTIMA_EDGE_PAT" \
  --set edge.controlPlaneUrl="https://api.cloptima.ai" \
  --set redis.embedded.enabled=true

• edge.pat takes the token, or use edge.patSecret.name to read it from a Kubernetes secret
• redis.embedded.enabled bundles the storage the edge needs; use redis.url to bring your own
• semanticCache.enabled adds the optional local semantic cache

curl -fsSL https://api.cloptima.ai/v1/edge/docker-compose.yml -o docker-compose.yml
cat > .env << 'EOF'
CLOPTIMA_EDGE_PAT=<your-edge-token>
CLOPTIMA_EDGE_CONTROL_PLANE_URL=https://api.cloptima.ai
EOF
docker compose up -d

The compose file starts the edge gateway and the storage it needs. If you run the processes yourself, the console's deploy assistant lists the environment variables to set.

1. 1

   Watch the deploy assistant

   It waits for the first heartbeat after you deploy.

2. 2

   Read the Heartbeat column

   The Edge Instances card shows the status and the last heartbeat time.

3. 3

   Use Check Now

   If nothing arrives, confirm the container is running and can reach the control plane URL.

1. 1

   Choose + Add Credential

   On the Provider Credentials card.

2. 2

   Choose Storage Mode: Edge BYOK (Stay in Your VPC)

   Pick the Edge Instance it belongs to.

3. 3

   Enter a Key Reference ID

   A short name such as my-openai-prod.

4. 4

   Save

   Cloptima stores the record with no secret.

5. 5

   Set the key on the edge host

   Set CLOPTIMA_KEY_ followed by the reference id, in capitals, to the key. For Bedrock, set CLOPTIMA_BASE_ with the same suffix to the secret access key.

# Reference ID: my-openai-prod
export CLOPTIMA_KEY_MY_OPENAI_PROD=<your-api-key>

• Create a virtual key and send requests to your edge gateway's address instead of the cloud address
• Bind a policy to the key, or to its team, app, and environment
• Budgets, rate limits, tool rules, guardrails, and caches apply on the edge
• Usage reaches your reports through the edge's uploads

Policy changes reach the edge in about a second.

Turn on semanticCache.enabled in the Helm chart, or use the semantic profile in the compose file. Without it, the exact cache still works.