Skip to content

Added operand deployment verification to install script #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tomncooper merged 2 commits into from
Jul 24, 2026
Merged

Added operand deployment verification to install script #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46be6d3
Added operand deployment verification to install script
tomncooper Jul 24, 2026
52b0093
Switch to using kubectl wait (which it should have been from the begi…
tomncooper Jul 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ The script:
2. Installs operators and CRDs (Phase 1)
3. Waits for each operator to become ready
4. Deploys Kafka, Registry, and Console instances (Phase 2)
5. Verifies all operands reach their Ready state

### Install with an Overlay

Expand All @@ -32,13 +33,14 @@ See [Overlays](overlays/_index.md) for the list of available overlays and what e

The install script accepts the following environment variables:

| Variable | Default | Description |
|-------------|-----------------------------------|-----------------------------------------------------------------------------|
| `REPO` | `streamshub/developer-quickstart` | GitHub repository path |
| `REF` | `main` | Git ref, branch, or tag |
| `OVERLAY` | *(empty)* | Overlay to apply (e.g. `metrics`) |
| `TIMEOUT` | `120s` | `kubectl wait` timeout (supports `s`, `m`, `h` suffixes) |
| `LOCAL_DIR` | *(empty)* | Use a local directory as the source of install files instead of GitHub URLs |
| Variable | Default | Description |
|---------------|-----------------------------------|-----------------------------------------------------------------------------|
| `REPO` | `streamshub/developer-quickstart` | GitHub repository path |
| `REF` | `main` | Git ref, branch, or tag |
| `OVERLAY` | *(empty)* | Overlay to apply (e.g. `metrics`) |
| `TIMEOUT` | `300s` | Wait timeout for operators and operands (per resource) |
| `SKIP_VERIFY` | *(empty)* | Skip operand readiness verification (set to any value) |
| `LOCAL_DIR` | *(empty)* | Use a local directory as the source of install files instead of GitHub URLs |

**Examples:**

Expand Down Expand Up @@ -100,7 +102,15 @@ LOCAL_DIR=/home/user/repos/developer-quickstart ./install.sh

## Verify the Installation

After installation, confirm all components are running:
The install script automatically verifies that all operands (Kafka, Registry, Console) reach their Ready state before returning. If verification succeeds, it prints access instructions for the Console.

To skip verification (e.g. for CI pipelines with their own checks):

```shell
curl -sL https://raw.githubusercontent.com/streamshub/developer-quickstart/main/install.sh | SKIP_VERIFY=1 bash
```

If verification times out or you skipped it, confirm all components are running manually:

```shell
# Check operators
Expand All @@ -112,7 +122,6 @@ kubectl get deployment -n streamshub-console streamshub-console-operator
kubectl get kafka -n kafka
kubectl get apicurioregistry3 -n apicurio-registry
kubectl get console -n streamshub-console

```

All operator deployments should show `READY 1/1`. Custom resources should reach `Ready` status.
Expand Down
121 changes: 100 additions & 21 deletions install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,12 @@
# curl -sL https://raw.githubusercontent.com/streamshub/developer-quickstart/main/install.sh | OVERLAY=metrics bash
#
# Environment variables:
# LOCAL_DIR - Use local directory instead of GitHub (e.g. LOCAL_DIR=.)
# REPO - GitHub repo path (default: streamshub/developer-quickstart)
# REF - Git ref/branch/tag (default: main)
# OVERLAY - Overlay to apply (e.g. metrics). Empty = base install
# TIMEOUT - kubectl wait timeout (default: 120s)
# LOCAL_DIR - Use local directory instead of GitHub (e.g. LOCAL_DIR=.)
# REPO - GitHub repo path (default: streamshub/developer-quickstart)
# REF - Git ref/branch/tag (default: main)
# OVERLAY - Overlay to apply (e.g. metrics). Empty = base install
# TIMEOUT - Wait timeout for operators and operands (default: 300s)
# SKIP_VERIFY - Skip operand readiness verification (set to any value)
#

set -euo pipefail
Expand All @@ -31,7 +32,8 @@ LOCAL_DIR="${LOCAL_DIR:-}"
REPO="${REPO:-streamshub/developer-quickstart}"
REF="${REF:-main}"
OVERLAY="${OVERLAY:-}"
TIMEOUT="${TIMEOUT:-180s}"
TIMEOUT="${TIMEOUT:-300s}"
SKIP_VERIFY="${SKIP_VERIFY:-}"

# Color output helpers
RED='\033[0;31m'
Expand Down Expand Up @@ -86,11 +88,14 @@ main() {
stack_path="overlays/${OVERLAY}/stack"
fi

# Compute total steps based on overlay
# Compute total steps based on overlay and verification
local total_steps=5
if [ "${OVERLAY}" = "metrics" ]; then
total_steps=6
fi
if [ -z "${SKIP_VERIFY}" ]; then
total_steps=$((total_steps + 1))
fi

echo ""
info "Installing StreamsHub developer quick-start stack"
Expand All @@ -109,6 +114,7 @@ main() {
echo ""

local step=1
local verify_failed=""

# --- Step: Install operators (base layer) ---
local base_url
Expand Down Expand Up @@ -164,9 +170,63 @@ main() {
kubectl apply -k "${stack_url}"
echo ""

# --- Step: Verify operands ---
if [ -z "${SKIP_VERIFY}" ]; then
step=$((step + 1))
info "Step ${step}/${total_steps}: Verifying operands are ready (timeout: ${TIMEOUT})..."

# Kafka must be verified first — Console depends on it
info " Waiting for Kafka cluster 'dev-cluster'..."
if kubectl wait --for=condition=Ready kafka.kafka.strimzi.io/dev-cluster \
-n kafka --timeout="${TIMEOUT}" 2>/dev/null; then
info " Kafka cluster is ready"
else
warn " Kafka cluster did not become ready within ${TIMEOUT}"
verify_failed=true
fi
Comment thread
MikeEdgar marked this conversation as resolved.

info " Waiting for Apicurio Registry..."
if kubectl wait --for=condition=Ready apicurioregistry3.registry.apicur.io/apicurio-registry \
-n apicurio-registry --timeout="${TIMEOUT}" 2>/dev/null; then
info " Apicurio Registry is ready"
else
warn " Apicurio Registry did not become ready within ${TIMEOUT}"
verify_failed=true
fi

info " Waiting for StreamsHub Console..."
if kubectl wait --for=condition=Ready console.console.streamshub.github.com/streamshub-console \
-n streamshub-console --timeout="${TIMEOUT}" 2>/dev/null; then
info " StreamsHub Console is ready"
else
warn " StreamsHub Console did not become ready within ${TIMEOUT}"
verify_failed=true
fi

if [ "${OVERLAY}" = "metrics" ]; then
info " Waiting for Prometheus..."
if kubectl wait --for=condition=Available prometheus.monitoring.coreos.com/prometheus \
-n monitoring --timeout="${TIMEOUT}" 2>/dev/null; then
info " Prometheus is ready"
else
warn " Prometheus did not become ready within ${TIMEOUT}"
verify_failed=true
fi
fi

echo ""
fi

# --- Summary ---
info "Dev stack installation complete!"
if [ -z "${SKIP_VERIFY}" ] && [ "${verify_failed}" != "true" ]; then
info "Dev stack installation complete! All operands are ready."
elif [ -z "${SKIP_VERIFY}" ] && [ "${verify_failed}" = "true" ]; then
warn "Dev stack installation complete, but some operands are not yet ready."
else
info "Dev stack installation complete!"
fi
echo ""

echo "Deployed components:"
echo " - Strimzi operator (namespace: strimzi)"
echo " - Kafka cluster 'dev-cluster' (namespace: kafka)"
Expand All @@ -180,20 +240,39 @@ main() {
echo " - Kafka metrics (PodMonitors) (namespace: monitoring)"
fi
echo ""
echo "Verify with:"
echo " kubectl get deployment -n strimzi strimzi-cluster-operator"
echo " kubectl get kafka -n kafka"
echo " kubectl get deployment -n apicurio-registry apicurio-registry-operator"
echo " kubectl get apicurioregistry3 -n apicurio-registry"
echo " kubectl get deployment -n streamshub-console console-operator"
echo " kubectl get console -n streamshub-console"
if [ "${OVERLAY}" = "metrics" ]; then
echo " kubectl get prometheus -n monitoring"
echo " kubectl get podmonitor -n monitoring"

if [ -z "${SKIP_VERIFY}" ] && [ "${verify_failed}" != "true" ]; then
echo "Access the Console:"
echo " kubectl port-forward -n streamshub-console svc/streamshub-console-console-service 8090:80"
echo " Then open http://localhost:8090"
echo ""
elif [ -z "${SKIP_VERIFY}" ] && [ "${verify_failed}" = "true" ]; then
echo "Check operand status:"
echo " kubectl get kafka -n kafka"
echo " kubectl get apicurioregistry3 -n apicurio-registry"
echo " kubectl get console -n streamshub-console"
if [ "${OVERLAY}" = "metrics" ]; then
echo " kubectl get prometheus -n monitoring"
fi
echo ""
echo "Some resources may still be starting up. Re-check after a few minutes."
echo ""
else
echo "Verify with:"
echo " kubectl get deployment -n strimzi strimzi-cluster-operator"
echo " kubectl get kafka -n kafka"
echo " kubectl get deployment -n apicurio-registry apicurio-registry-operator"
echo " kubectl get apicurioregistry3 -n apicurio-registry"
echo " kubectl get deployment -n streamshub-console console-operator"
echo " kubectl get console -n streamshub-console"
if [ "${OVERLAY}" = "metrics" ]; then
echo " kubectl get prometheus -n monitoring"
echo " kubectl get podmonitor -n monitoring"
fi
echo ""
echo "Note: It may take several minutes for all resources to become ready."
echo ""
fi
echo ""
echo "Note: It may take several minutes for all resources to become ready."
echo ""
}

main
Loading