Skip to main content

Overview

Conduktor provides a Helm repository containing a chart that will deploy Conduktor Platform on your Kubernetes cluster. We don’t provide any relational database dependency, you will have to provide your own database. See the production requirements for details. For a full reference of our recommended Conduktor platform deployment architecture, see our sample GitHub repository . Check out the snippets section for more examples.

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

Compatibility matrix

Find out which versions of Conduktor Platform work on which version of our Conduktor Platform Helm chart.
We recommend you use the version of Platform that comes pre-configured with the Helm chart. You can adjust the version in your values property according to the supported Platform version, if required.
Notes column only lists chart-level changes. See release notes to determine whether there are breaking changes within the artifacts.

Helm chart compatibility

Breaking changes: 🟡 - Breaks additional services (e.g. Grafana dashboard changes) 🔴 - Breaks overall deployment of the product (e.g. renaming variables in .values, major product releases)

General requirements

Production requirements

Mandatory for production environments:
  • set up an external PostgreSQL (13+) database with an appropriate backup policy
  • set up an external S3 Bucket
  • allow enough resources to run Conduktor with the recommended configuration

A note on TLS and URL forwarding

For production environments, we recommend to run with TLS enabled from your ingress controller and terminating on Platform. This creates a more secure connection, while also telling Platform that it should use TLS when forwarding on any URL requests (e.g. requests to SSO providers). Without TLS terminating on Platform itself, requests between the ingress controller and Platform will be in plain text, as will URL forwarding to your SSO provider which can lead to rejection of the request for not being secure.

1. Set up Helm repository

2. Install the Console chart

Configure Console with the following values:
values.yaml
Install the chart on your cluster:
Once deployed, you will be able to access Conduktor on localhost:8080 by using a port-forward. You can also configure an ingress to make Platform available externally, check out snippets.

3. Configure Console

Fresh install

You can configure Platform by inserting it into the config section of the values.yaml file.

Based on a Docker configuration

If you’re already using a config file within Docker,you can use it by giving it to the Helm chart with the following command:
values.yaml

Configure with an enterprise license

values.yaml

Examples

Find sample code on our GitHub .

Deploy Console with a context path

Console v1.41.0 introduces the option to configure an ingress with a context path, such as mycompany.com/conduktor. To configure this, set the CDK_PLATFORM_EXTERNAL_URL environment variable or the config.platform.external.url property to include the full URL with the context path. Here’s an example using /conduktor as the context path with an nginx ingress controller:
values.yaml
Check the requirements of your ingress controller - you may need to add specific annotations and patterns to the path. As shown in the example above, your ingress controller has to also remove the context path when redirecting requests to Console.

Secure metric endpoints with basic auth

Starting with Console v1.42.0, you can protect the metric scraping endpoints (/api/monitoring/metrics and /monitoring/metrics/) with basic auth credentials.
values.yaml
When configured, your monitoring backend (Prometheus, Cortex, etc.) has to provide these credentials when scraping Console metrics. Learn more about configuring your monitoring backend.
Basic auth is optional in Console v1.42.0 and no configuration changes are required for existing deployments.