
Step 1: Agent Deployment
Superstream BYOC lets you run agents inside your own cloud—ideal when Kafka clusters can’t be exposed externally.
Deploy one or more agents, distributing clusters however you prefer.
Ensure your Docker or Kubernetes environment has network access to the target Kafka clusters.
Once the agent is running, you're ready for the next step.
🔑 Retrieve required info
In the Superstream console (under your user profile):
Account ID – copy from console
Activation Token – copy from console
Agent Name – choose a unique name (max 32 chars, lowercase only). Allowed:
a-z
,0-9
,-
,_
Not allowed:.

🐳 Deploy via Docker
Run the following command to download and start the Superstream agent via Docker Compose:
ACCOUNT_ID=<account id> AGENT_NAME=<name> ACTIVATION_TOKEN=<token> bash -c 'curl -o docker-compose.yaml https://raw.githubusercontent.com/superstreamlabs/helm-charts/master/docker/docker-compose.yaml && docker compose up -d'
☸️ Deploy via Kubernetes
Superstream provides a Helm chart to deploy the agent.
1. Create and configure custom_values.yaml
. Define required values like account ID, activation token, and agent name → View example.
global:
agentName: "" # Define the superstream agent name within 32 characters, excluding '.', and using only lowercase letters, numbers, '-', and '_'.
superstreamAccountId: ""
superstreamActivationToken: ""
2. Navigate to the directory containing your custom_values.yaml
file and run:
helm repo add superstream-agent https://superstream-agent.k8s.superstream.ai/ --force-update && helm upgrade --install superstream superstream-agent/superstream-agent -f custom_values.yaml --create-namespace --namespace superstream --wait
Deployment verification:
helm list
📦 What Gets Deployed
Whether using Docker or Kubernetes, the Superstream agent setup includes the following components:
superstream-data-plane
Core service that connects to your Kafka clusters, collects metadata, and generates insights.superstream-auto-scaler
(optional) Automatically scales AWS MSK and Aiven Kafka clusters when enabled.superstream-telegraf
Monitors internal agent components for health and metrics.
Appendixes
Appendix A - Superstream Update
Retrieve the most recent version of the Superstream Helm chart
helm repo add superstream-agent https://superstream-agent.k8s.superstream.ai/ --force-update
Make sure to use the same values:
helm get values superstream --namespace superstream
Run the upgrade command:
helm upgrade --install superstream superstream-agent/superstream-agent -f custom_values.yaml --namespace superstream --wait
Appendix B - Uninstall
helm delete superstream -n <NAMESPACE>
Appendix C - Deploy Superstream Agent using labels, tolerations, nodeSelector and etc'
To inject custom labels into all services deployed by Superstream, utilize the
global.labels
variable.
global:
agentName: "" # Define the superstream agent name within 32 characters, excluding '.', and using only lowercase letters, numbers, '-', and '_'.
superstreamAccountId: "" # Provide the account ID associated with the deployment, which could be used for identifying resources or configurations tied to a specific account.
superstreamActivationToken: "" # Enter the activation token required for services or resources that need an initial token for activation or authentication.
labels:
tests: ok
To configure tolerations, nodeSelector, and affinity settings for each deployed service, the adjustments in the following example need to be done:
global:
agentName: "" # Define the superstream agent name within 32 characters, excluding '.', and using only lowercase letters, numbers, '-', and '_'.
superstreamAccountId: "" # Provide the account ID associated with the deployment, which could be used for identifying resources or configurations tied to a specific account.
superstreamActivationToken: "" # Enter the activation token required for services or resources that need an initial token for activation or authentication.
superstreamAgent:
tolerations:
- key: "app"
value: "connectors"
effect: "NoExecute"
autoScaler:
tolerations:
- key: "app"
value: "connectors"
effect: "NoExecute"
telegraf:
tolerations:
- key: "app"
value: "connectors"
effect: "NoExecute"
Appendix D - Deploy Superstream from local registry
To deploy Superstream from local registry, override default values using
global.image
variable incustom.values
file:
global:
agentName: "" # Define the superstream agent name within 32 characters, excluding '.', and using only lowercase letters, numbers, '-', and '_'.
superstreamAccountId: "" # Provide the account ID associated with the deployment, which could be used for identifying resources or configurations tied to a specific account.
superstreamActivationToken: "" # Enter the activation token required for services or resources that need an initial token for activation or authentication.
image:
# Global image pull policy to use for all container images in the chart
# can be overridden by individual image pullPolicy
pullPolicy:
# Global list of secret names to use as image pull secrets for all pod specs in the chart
# secrets must exist in the same namespace
# https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
pullSecretNames: []
# Global registry to use for all container images in the chart
# can be overridden by individual image registry
registry:
Last updated
Was this helpful?