Skip to content

Latest commit

 

History

History
117 lines (92 loc) · 4.05 KB

README.md

File metadata and controls

117 lines (92 loc) · 4.05 KB
Raw

Official repository for Conduktor Helm Charts

Explore the docs »

Report Bug · Request Feature · Contact support

Gateway Release · Console Release · License

Scale Data Streaming With Security and Control · X (formerly Twitter) Follow · Slack

Prerequisites

  • Kubernetes 1.19+
  • Helm 3.2.0+

Charts

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:

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.

$ make helm-deps
$ make k3d-up
$ make install-dev-deps

Postgresql credentials:

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

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 install-githooks

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.

Re-generate chart README

You can also run readme-generator directly using :

$ make generate-readme

Run chart tests

You need to have chart-testing installed and a running kubernetes cluster.

# Update helm dependencies
make helm-deps
# Create local K3D cluster for test and local dev (require k3d, helm and kubectl)
make k3d-up
# Run Chart-testing tests on chart that contain changes (require chart-testing and helm)
make test-chart
# Delete K3D cluster
make k3d-down

(back to top)