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> bashTo uninstall, use the same OVERLAY value:
curl -sL https://raw.githubusercontent.com/streamshub/developer-quickstart/main/uninstall.sh | OVERLAY=<name> bashAvailable Overlays #
| Overlay | Description |
|---|---|
| core | The default stack: Strimzi, Kafka, Apicurio Registry, and StreamsHub Console. No OVERLAY variable needed. |
| metrics | Adds Prometheus Operator, a Prometheus instance, and Kafka metrics collection via PodMonitors. Wires the Console to display metrics. |
| mcp | Adds the StreamsHub MCP server, giving AI assistants read-only access to the Strimzi-managed Kafka cluster. |
| mcp-metrics | Combines Prometheus monitoring with the StreamsHub MCP server. The MCP server uses Prometheus as its centralized metrics provider. |
Developing Overlays #
See Developing Overlays for the directory structure, resource limit requirements, and CI checks that apply when adding or modifying overlays.