Overlays

Developer Quick-Start

Overlays

The developer quick-start uses Kustomize overlays to provide optional extensions on top of the core stack. Each overlay adds components that integrate with the base deployment.

To install with an overlay, set the OVERLAY environment variable:

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

To uninstall, use the same OVERLAY value:

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

Available Overlays #

OverlayDescription
coreThe default stack: Strimzi, Kafka, Apicurio Registry, and StreamsHub Console. No OVERLAY variable needed.
metricsAdds Prometheus Operator, a Prometheus instance, and Kafka metrics collection via PodMonitors. Wires the Console to display metrics.