Skip to content
Snippets Groups Projects
README.md 1.81 KiB
Newer Older
Clint Shryock's avatar
Clint Shryock committed
# Vault Helm Chart

> :warning: **Please note**: We take Vault's security and our users' trust very seriously. If 
you believe you have found a security issue in Vault Helm, _please responsibly disclose_ 
by contacting us at [security@hashicorp.com](mailto:security@hashicorp.com).

Mitchell Hashimoto's avatar
Mitchell Hashimoto committed
This repository contains the official HashiCorp Helm chart for installing
Clint Shryock's avatar
Clint Shryock committed
and configuring Vault on Kubernetes. This chart supports multiple use
cases of Vault on Kubernetes depending on the values provided.
Mitchell Hashimoto's avatar
Mitchell Hashimoto committed

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/).
Mitchell Hashimoto's avatar
Mitchell Hashimoto committed

Mitchell Hashimoto's avatar
Mitchell Hashimoto committed
## Prerequisites

To use the charts here, [Helm](https://helm.sh/) must be configured for your
Kubernetes cluster. Setting up Kubernetes and Helm and is outside the scope of
this README. Please refer to the Kubernetes and Helm documentation.
Mitchell Hashimoto's avatar
Mitchell Hashimoto committed

Mitchell Hashimoto's avatar
Mitchell Hashimoto committed
The versions required are:

Theron Voran's avatar
Theron Voran committed
  * **Helm 3.0+** - This is the earliest version of Helm tested. It is possible
Mitchell Hashimoto's avatar
Mitchell Hashimoto committed
    it works with earlier versions but this chart is untested for those versions.
  * **Kubernetes 1.9+** - This is the earliest version of Kubernetes tested.
Mitchell Hashimoto's avatar
Mitchell Hashimoto committed
    It is possible that this chart works with earlier versions but it is
    untested. Other versions verified are Kubernetes 1.10, 1.11.
Mitchell Hashimoto's avatar
Mitchell Hashimoto committed

Mitchell Hashimoto's avatar
Mitchell Hashimoto committed
## Usage

To install the latest version of this chart, add the Hashicorp helm repository
and run `helm install`:
Mitchell Hashimoto's avatar
Mitchell Hashimoto committed

```console
$ helm repo add hashicorp https://helm.releases.hashicorp.com
"hashicorp" has been added to your repositories
Mitchell Hashimoto's avatar
Mitchell Hashimoto committed

$ helm install vault hashicorp/vault
```

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) along with more
detailed installation instructions.