openbao-helm/README.md

39 lines
1.6 KiB
Markdown
Raw Normal View History

2018-10-02 21:16:18 +00:00
# Vault Helm Chart
2018-08-18 05:08:03 +00:00
This repository contains the official HashiCorp Helm chart for installing
2018-10-02 21:16:18 +00:00
and configuring Vault on Kubernetes. This chart supports multiple use
cases of Vault on Kubernetes depending on the values provided.
2018-08-18 05:08:03 +00:00
For full documentation on this Helm chart along with all the ways you can
use Vault with Kubernetes, please see the
[Vault and Kubernetes documentation](https://www.vaultproject.io/docs/platform/k8s/index.html).
2018-08-18 05:27:43 +00:00
2018-08-18 05:08:03 +00:00
## Prerequisites
To use the charts here, [Helm](https://helm.sh/) must be installed in your
Kubernetes cluster. Setting up Kubernetes and Helm and is outside the scope
of this README. Please refer to the Kubernetes and Helm documentation.
2018-09-13 21:48:40 +00:00
The versions required are:
* **Helm 2.10+** - This is the earliest version of Helm tested. It is possible
it works with earlier versions but this chart is untested for those versions.
* **Kubernetes 1.9+** - This is the earliest version of Kubernetes tested.
2018-09-13 21:48:40 +00:00
It is possible that this chart works with earlier versions but it is
untested. Other versions verified are Kubernetes 1.10, 1.11.
2018-09-13 21:48:40 +00:00
2018-08-18 05:27:43 +00:00
## Usage
2018-09-13 21:44:08 +00:00
For now, we do not host a chart repository. To use the charts, you must
2018-09-12 15:47:27 +00:00
download this repository and unpack it into a directory. Either
2018-10-02 21:16:18 +00:00
[download a tagged release](https://github.com/hashicorp/vault-helm/releases) or
2018-09-12 15:47:27 +00:00
use `git checkout` to a tagged release.
2018-10-02 21:16:18 +00:00
Assuming this repository was unpacked into the directory `vault-helm`, the chart can
2018-08-18 21:15:37 +00:00
then be installed directly:
2018-08-18 05:27:43 +00:00
2018-10-02 21:16:18 +00:00
helm install ./vault-helm
2018-08-18 05:27:43 +00:00
Please see the many options supported in the `values.yaml`
file. These are also fully documented directly on the
[Vault website](https://www.vaultproject.io/docs/platform/k8s/helm.html).