Skip to content

Helm Charts#

Defining your extensions as Helm charts is one of two methods you can use to run k0s with your preferred extensions (the other being through the use of Manifest Deployer).

k0s supports two methods for deploying applications using Helm charts:

  • Use Helm command in runtime to install applications. Refer to the Helm Quickstart Guide for more information.
  • Insert Helm charts directly into the k0s configuration file, k0s.yaml. This method does not require a separate install of helm tool and the charts automatically deploy at the k0s bootstrap phase.

Helm charts in k0s configuration#

Adding Helm charts into the k0s configuration file gives you a declarative way in which to configure the cluster. k0s controller manages the setup of Helm charts that are defined as extensions in the k0s configuration file.

Wait for install#

Each chart is processed the same way CLI tool does with following options:

  • --wait
  • --wait-for-jobs

It is possible to customize the timeout by using the `timeout' field.

Repository configuration#

Field Default value Description
name (required) The repository name
url (required) The repository URL
insecure true Whether to skip TLS certificate checks when connecting to the repository
caFile - CA bundle file to use when verifying HTTPS-enabled servers
certFile - The TLS certificate file to use for HTTPS client authentication
keyfile - The TLS key file to use for HTTPS client authentication
username - Username for Basic HTTP authentication
password - Password for Basic HTTP authentication

Chart configuration#

Field Default value Description
name - Release name
chartname - chartname in form "repository/chartname" or path to tgz file
version - version to install
timeout - timeout to wait for release install
values - yaml as a string, custom chart values
namespace - namespace to install chart into
order 0 order to apply manifest. For equal values, alphanum ordering is used


In the example, Prometheus is configured from "stable" Helms chart repository. Add the following to k0s.yaml and restart k0s, after which Prometheus should start automatically with k0s.

      concurrencyLevel: 5
      - name: stable
      - name: prometheus-community
      - name: helm-repo-with-auth
        username: access-token-name-as-username
        password: access-token-value-as-password
      - name: prometheus-stack
        chartname: prometheus-community/prometheus
        version: "14.6.1"
        timeout: 20m
        order: 1
        values: |
              enabled: false
              enabled: false
        namespace: default
      # We don't need to specify the repo in the repositories section for OCI charts
      - name: oci-chart
        chartname: oci://registry:8080/chart
        version: "0.0.1"
        order: 2
        values: ""
        namespace: default
      # Other way is to use local tgz file with chart
      # the file must exist on all controller nodes
      - name: tgz-chart
        chartname: /tmp/chart.tgz
        version: "0.0.1"
        order: 2 
        values: ""
        namespace: default

Example extensions that you can use with Helm charts include:

Helm debug logging#

Running k0s controller with --debug=true enables helm debug logging.