Skip to main content

Helm chart

warning

Important Note: This chart is not compatible with Helm 2. Please use Helm 3.6+ with this chart.

The OpenBao Helm chart is the recommended way to install and configure OpenBao on Kubernetes. In addition to running OpenBao itself, the Helm chart is the primary method for installing and configuring OpenBao to integrate with other services such as Consul for High Availability (HA) deployments.

This page assumes general knowledge of Helm and how to use it. Using Helm to install OpenBao requires that Helm is properly installed and configured with your Kubernetes cluster.

Supported kubernetes versions​

The following Kubernetes minor releases are currently supported. The latest version is tested against each Kubernetes version. It may work with other versions of Kubernetes, but those are not supported.

  • = 1.27

Using the helm chart​

Helm must be installed and configured on your machine. Please refer to the Helm documentation for more information.

To use the Helm chart, add the Hashicorp helm repository and check that you have access to the chart:

$ helm repo add openbao https://openbao.github.io/openbao-helm
"openbao" has been added to your repositories

$ helm search repo openbao/openbao
NAME            CHART VERSION   APP VERSION             DESCRIPTION
openbao/openbao 0.4.0           v2.0.0-alpha20240329    Official OpenBao Chart
info

Important: The Helm chart is new and under significant development. Please always run Helm with --dry-run before any install or upgrade to verify changes.

Example chart usage:

Installing the latest release of the OpenBao Helm chart with pods prefixed with the name openbao.

$ helm install openbao openbao/openbao

Installing a specific version of the chart.

# List the available releases
$ helm search repo openbao/openbao -l
NAME            CHART VERSION   APP VERSION             DESCRIPTION
openbao/openbao 0.4.0           v2.0.0-alpha20240329    Official OpenBao Chart
openbao/openbao 0.3.0           v2.0.0-alpha20240329    Official OpenBao Chart
openbao/openbao 0.2.0           v2.0.0-alpha20240329    Official OpenBao Chart
...

# Install version 0.4.0
$ helm install openbao openbao/openbao --version 0.4.0
warning

Security Warning: By default, the chart runs in standalone mode. This mode uses a single OpenBao server with a file storage backend. This is a less secure and less resilient installation that is NOT appropriate for a production setup. It is highly recommended to use a properly secured Kubernetes cluster, learn the available configuration options, and read the production deployment checklist.