Official repository for Conduktor Helm Charts

Explore the docs »

Report Bug · Request Feature · Contact support



/
/
/

· ·

Prerequisites

• Kubernetes 1.19+
• Helm 3.6.0+

Charts

• console (doc, values)
• conduktor-gateway (doc, values)
• provisioner (doc, values)

Chart dependencies

All charts within this repository have one dependency which is bitnami-common. You can find the chart here: https://github.com/bitnami/charts/tree/main/bitnami/common

Usage

$ helm repo add conduktor https://helm.conduktor.io
$ helm repo update

For guides and advanced help, please refer to our documentation, or to our charts README.

(back to top)

Development setup

Requirements:

• k3d
• kubectl
• helm 3.6.0+

You can have a working cluster on your local machine with docker and k3d, use the Makefile target k3d-up to start a cluster with nginx and a postgresql database running.

# Update helm dependencies
make helm-deps

# Create local K3D cluster for test and local dev (require k3d, helm and kubectl)
make k3d-up

# Install dependencies like a Postgresql, Minio, Monitoring stack, and Kafka.
make install-dev-deps

Postgresql credentials:

host: postgresql.conduktor
port: 5432
username: postgres
password: conduktor
name: conduktor

Install charts in local K3D cluster

 # Install Conduktor Gateway chart
helm install gateway charts/gateway \
  --namespace conduktor \
  --dependency-update \
  --set gateway.licenseKey="<your conduktor license key>" \
  --set gateway.env.KAFKA_BOOTSTRAP_SERVERS="kafka-local-dev.conduktor.svc.cluster.local:9092"

# Install Conduktor Console chart
helm install console charts/console \
  --namespace conduktor \
  --dependency-update \
  --set config.organization.name=test \
  --set config.admin.email=test@test.io \
  --set config.admin.password=testP4ss! \
  --set config.database.password=conduktor \
  --set config.database.username=postgres \
  --set 'config.database.hosts[0].host=postgresql.conduktor.svc.cluster.local' \
  --set config.database.name=conduktor

Cleanup local K3D cluster

make k3d-down

Setup git hooks

Pre-commit git hook require to have npm or bitnami readme-generator installed.

Note: If readme-generator not installed, hook will try to install if globally using npm

make setup-hooks

Now every time you commit to the project, pre-commit hook will run the readme-generator tool to synchronize changes between charts values.yaml and README.md as well as checking for secrets and linting the charts.

Re-generate chart README

You can also run readme-generator directly using :

$ make generate-readme

Run chart tests

Requires a running Kubernetes cluster (k3d recommended) and Python 3.10+.

# Install test dependencies
pip install -r test/requirements.txt

# Create local K3D cluster
make k3d-up

# Run tests for a specific chart
make test-run CHART=console

# Run a specific scenario
make test-run CHART=console SCENARIO=01-basic

# Run tests for all changed charts (vs main branch)
make test-changed

# Run all chart tests
make test-charts

Available options:

• SKIP_UPGRADE=1 - Skip upgrade path testing (fresh install only)
• PAUSE_ON_FAILURE=1 - Pause before cleanup on failure for debugging
• TIMEOUT=900s - Override helm timeout (default from test-config.yaml)
• VERBOSE=1 - Enable verbose output

Local development/debugging:

# Install a scenario without cleanup (for debugging)
make test-install CHART=console SCENARIO=01-basic

# Cleanup when done
make test-uninstall CHART=console SCENARIO=01-basic

(back to top)