Superstream Engine deployment for environments with a local container registry
How to deploy a Superstream Engine in a fully air-gapped environment with a private container registry.
This guide focuses on three critical applications managed by Superstream Helm Chart: NATS, Telegraf, and Superstream. We will cover each application's specific Docker images that are managed by the helm chart, ensuring you have the information to deploy Superstream in your environment.
Prerequisites
1. Container images
Please store the following images in your container registry:
NATS: An open-source messaging system renowned for its high performance and scalability.
Helm version: 1.1.11
Containers:
natsio/prometheus-nats-exporter:0.15.0
natsio/nats-server-config-reloader:0.14.2
Nats:2.10.16-alpine
Telegraf: As a versatile agent for collecting, processing, and writing metrics, Telegraf is pivotal in monitoring and observability.
Helm version: 1.8.48
Container:
Superstream: The engine itself.
Helm version: Releases
Helm Chart URL: https://k8s.superstream.ai/
Containers:
superstreamlabs/superstream-data-plane-be:latest
curlimages/curl:8.6.0
linuxserver/syslog-ng:4.5.0
To ensure that your private repositories use the correct Docker images, follow these steps to pull images from public repositories and tag them for your private repository. Below are command examples for the related Docker images you might use:
Prometheus NATS Exporter (natsio/prometheus-nats-exporter:0.15.0):
NATS Server Config Reloader (natsio/nats-server-config-reloader:0.14.2):
NATS Server (nats:2.10.14-alpine):
Telegraf (docker.io/library/telegraf:1.30-alpine):
Curl (curlimages/curl:8.6.0):
Superstream Engine (superstreamlabs/superstream-data-plane-be:latest):
Syslog (linuxserver/syslog-ng:4.5.0):
Getting started
1. Download Helm Chart
Download the Superstream Helm chart from the official source as described above.
2. Publish to Private Environments
Once downloaded, publish the chart to your private Helm chart repositories. This step ensures that you maintain control over the versions and configurations of the chart used in your deployments.
Docker Image Names: You must change the Docker image names within the Helmfile to reflect those stored in your private Docker registries. This customization is crucial for ensuring that your deployments reference the correct resources within your secure environment:
3. Configure All Services to Use a Private Docker Repository and Private PullSecret
For easiness create/use custom_values.yaml
file and add global.image
section values, an example can be found here:
4. Deploy
To apply the Helmfile configurations and deploy your Kubernetes resources:
Apply Helmfile: Run the following command to apply the Helmfile configuration. This will sync your Helm releases to match the state declared in your helmfile.yaml
:
Last updated