Overlays on StreamsHub

Metrics

Mon, 01 Jan 0001 00:00:00 +0000

The metrics overlay extends the core stack with Prometheus-based monitoring.

Quick-Start Install #

curl -sL https://raw.githubusercontent.com/streamshub/developer-quickstart/main/install.sh | OVERLAY=metrics bash

Manual Install #

If you prefer step-by-step control, the metrics overlay uses overlays/metrics instead of overlays/core:

# Phase 1 — Operators and CRDs (includes Prometheus Operator)
kubectl create -k 'https://github.com/streamshub/developer-quickstart//overlays/metrics/base?ref=main'

# Optionally, wait for the operators to be ready
kubectl wait --for=condition=Available deployment/prometheus-operator -n monitoring --timeout=120s
kubectl wait --for=condition=Available deployment/strimzi-cluster-operator -n strimzi --timeout=120s
kubectl wait --for=condition=Available deployment/apicurio-registry-operator -n apicurio-registry --timeout=120s
kubectl wait --for=condition=Available deployment/streamshub-console-operator -n streamshub-console --timeout=120s

# Phase 2 — Operands (includes Prometheus instance and monitors)
kubectl apply -k 'https://github.com/streamshub/developer-quickstart//overlays/metrics/stack?ref=main'

Uninstall #

curl -sL https://raw.githubusercontent.com/streamshub/developer-quickstart/main/uninstall.sh | OVERLAY=metrics bash

What Gets Added #

On top of the components provided by the core overlay, the metrics overlay adds:

Developing Overlays

Mon, 01 Jan 0001 00:00:00 +0000

This page covers the requirements for adding or modifying overlays. CI enforces various checks on the overlays automatically on every pull request.

Directory Structure #

Every overlay must have both a directory under overlays/ and a matching documentation page under docs/overlays/. The directory name and the doc filename (without .md) must match exactly.

overlays/<name>/
├── base/ # Phase 1: operators and CRDs
│ └── kustomization.yaml
└── stack/ # Phase 2: operands
 └── kustomization.yaml

docs/overlays/<name>.md # Documentation page with resource totals

CI automatically discovers overlays from the overlays/ directory — there is no manual CI matrix to update. The VerifyDocumentedResources script checks that every overlay directory has a matching doc page.

Core

Mon, 01 Jan 0001 00:00:00 +0000

The core overlay is the default deployment. It installs the base event-streaming stack without any optional extensions.

Quick-Start Install #

curl -sL https://raw.githubusercontent.com/streamshub/developer-quickstart/main/install.sh | bash

No OVERLAY variable is needed — the core overlay is used by default.

Manual Install #

# Phase 1 — Operators and CRDs
kubectl apply -k 'https://github.com/streamshub/developer-quickstart//overlays/core/base?ref=main'

# Optionally, wait for the operators to be ready
kubectl wait --for=condition=Available deployment/strimzi-cluster-operator -n strimzi --timeout=120s
kubectl wait --for=condition=Available deployment/apicurio-registry-operator -n apicurio-registry --timeout=120s
kubectl wait --for=condition=Available deployment/streamshub-console-operator -n streamshub-console --timeout=120s

# Phase 2 — Operands
kubectl apply -k 'https://github.com/streamshub/developer-quickstart//overlays/core/stack?ref=main'

Uninstall #

curl -sL https://raw.githubusercontent.com/streamshub/developer-quickstart/main/uninstall.sh | bash

Components #

Component	Namespace	Description
Strimzi Kafka Operator	`strimzi`	Manages Kafka clusters via CRDs
Apicurio Registry Operator	`apicurio-registry`	Manages schema registry instances
StreamsHub Console Operator	`streamshub-console`	Manages the Console web UI
Kafka cluster	`kafka`	Single-node Kafka cluster (`dev-cluster`)
Apicurio Registry	`apicurio-registry`	Schema registry instance with app and UI
StreamsHub Console	`streamshub-console`	Web UI for managing Kafka clusters

Resource Requirements #

The core overlay requires at least 3 CPU cores and 4.5 GiB of allocatable cluster resources.