OpenBao Helm Chart
:warning: Please note: We take OpenBao's security and our users' trust very seriously. If
you believe you have found a security issue in OpenBao Helm, please responsibly disclose
by contacting us at openbao-security@lists.openssf.org.
This repository contains the OpenBao Helm chart for installing
and configuring OpenBao on Kubernetes. This chart supports multiple use
cases of OpenBao on Kubernetes depending on the values provided.
Prerequisites
To use the charts here, Helm must be configured for your
Kubernetes cluster. Setting up Kubernetes and Helm is outside the scope of
this README. Please refer to the Kubernetes and Helm documentation.
The versions required are:
- Helm 3.12+ - Earliest version tested
- Kubernetes 1.30+ - This is the earliest version of Kubernetes tested.
It is possible that this chart works with earlier versions but it is
untested.
In general, the latest versions of widely adopted Kubernetes distributions such
as SUSE Rancher or Red Hat OpenShift are supported.
Usage
To install the latest version of this chart, add the OpenBao helm repository and run helm install:
helm repo add openbao https://openbao.github.io/openbao-helm
helm install openbao openbao/openbao
Alternatively you can use the OCI based helm chart as well:
helm install oci://ghcr.io/openbao/charts/openbao
Please see the many options supported in the values.yaml file. These are also fully documented directly in the openbao README along with more detailed installation instructions.
Verifying Chart Provenance and Integrity
OpenBao Helm charts are signed so that provenance and integrity can be verified. See the instructions below to verify artifact signatures for your chosen installation method.
Verification Using GPG
Both the standard Helm chart and the Helm OCI image can be verified using GPG. When using GPG to verify Helm chart signatures, ensure the required public key has been imported.
curl -sSL https://openbao.org/assets/openbao-gpg-pub-20240618.asc | gpg --import
To verify the OpenBao chart when using the standard Helm repository.
helm install --verify openbao openbao/openbao
To verify the OpenBao chart when using the OCI registry.
helm install openbao --verify oci://ghcr.io/openbao/charts/openbao:${version}
Verification Using Cosign
Cosign can be used as an alterative to GPG to verify the chart provided from the OCI registry.
cosign verify \
--certificate-identity='https://github.com/openbao/openbao-helm/.github/workflows/release-chart.yml@refs/heads/main' \
--certificate-oidc-issuer='https://token.actions.githubusercontent.com' \
ghcr.io/openbao/charts/openbao:${version}