An open API service indexing awesome lists of open source software.

https://github.com/conduktor/conduktor-public-charts

Conduktor Helm Chart Repository
https://github.com/conduktor/conduktor-public-charts

conduktor helm kubernetes

Last synced: 4 months ago
JSON representation

Conduktor Helm Chart Repository

Awesome Lists containing this project

README

          





Official repository for Conduktor Helm Charts


Explore the docs »




Report Bug
·
Request Feature
·
Contact support



License




Console Chart Version
/

Console Application Version




Gateway Chart Version
/

Gateway Application Version




Provisioner Chart Version
/

Conduktor CLI Version




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

## Prerequisites

- Kubernetes 1.19+
- [Helm](https://helm.sh/docs/intro/install/) 3.6.0+

## Charts

- console ([doc](charts/console/README.md), [values](charts/console/values.yaml))
- conduktor-gateway ([doc](charts/gateway/README.md), [values](charts/gateway/gateway/values.yaml))
- provisioner ([doc](https://github.com/conduktor/conduktor-public-charts/blob/main/charts/provisioner/README.md), [values](https://github.com/conduktor/conduktor-public-charts/blob/main/charts/provisioner/values.yaml))

## 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

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

For guides and advanced help, please refer to our
[documentation](https://docs.conduktor.io/platform/installation/get-started/kubernetes),
or to our charts `README`.

(back to top)

## Development setup

**Requirements**:
- [k3d](https://k3d.io/v5.6.0/#installation)
- [kubectl](https://kubernetes.io/docs/tasks/tools/)
- [helm](https://helm.sh/docs/intro/install/) 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.

```shell
# 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:*

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

### Install charts in local K3D cluster

```shell
# Install Conduktor Gateway chart
helm install gateway charts/gateway \
--namespace conduktor \
--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 \
--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

```shell
make k3d-down
```

### Setup git hooks
Pre-commit git hook require to have npm or bitnami [`readme-generator`](https://github.com/bitnami/readme-generator-for-helm) installed.

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

```shell
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`](https://github.com/bitnami/readme-generator-for-helm) directly using :

```shell
$ make generate-readme
```

### Run chart tests
You need to have [chart-testing](https://github.com/helm/chart-testing) installed and a running kubernetes cluster.

```shell
# 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)