mirror of
https://github.com/hashicorp/vault.git
synced 2025-11-20 10:11:34 +01:00
* website maintenance round * improve docs, revert bug workaround as it was fixed * boost memory * remove unnecessary code
82 lines
2.9 KiB
Plaintext
82 lines
2.9 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Helm - Kubernetes
|
|
sidebar_title: Helm Chart
|
|
description: >-
|
|
The Vault Helm chart is the recommended way to install and configure Vault on
|
|
Kubernetes.
|
|
---
|
|
|
|
# Helm Chart
|
|
|
|
~> **Important Note:** This chart is not compatible with Helm 2. Please use Helm 3 with this chart.
|
|
|
|
The [Vault Helm chart](https://github.com/hashicorp/vault-helm)
|
|
is the recommended way to install and configure Vault on Kubernetes.
|
|
In addition to running Vault itself, the Helm chart is the primary
|
|
method for installing and configuring Vault to integrate with other
|
|
services such as Consul for High Availability (HA) deployments.
|
|
|
|
This page assumes general knowledge of [Helm](https://helm.sh/) and
|
|
how to use it. Using Helm to install Vault requires that Helm is
|
|
properly installed and configured with your Kubernetes cluster.
|
|
|
|
## Using the Helm Chart
|
|
|
|
Helm must be installed and configured on your machine. Please refer to the [Helm
|
|
documentation](https://helm.sh/) or the [Vault Installation to Minikube via
|
|
Helm](https://learn.hashicorp.com/vault/getting-started-k8s/minikube) guide.
|
|
|
|
To use the Helm chart, add the Hashicorp helm repository and check that you have
|
|
access to the chart:
|
|
|
|
```shell-session
|
|
$ helm repo add hashicorp https://helm.releases.hashicorp.com
|
|
"hashicorp" has been added to your repositories
|
|
|
|
$ helm search repo hashicorp/vault
|
|
NAME CHART VERSION APP VERSION DESCRIPTION
|
|
hashicorp/vault 0.5.0 Install and configure Vault on Kubernetes.
|
|
```
|
|
|
|
-> **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 Vault Helm chart with pods prefixed with
|
|
the name `vault`.
|
|
|
|
```shell-session
|
|
$ helm install vault hashicorp/vault
|
|
```
|
|
|
|
Installing a specific version of the chart.
|
|
|
|
```sh
|
|
# List the available releases
|
|
$ helm search repo hashicorp/vault -l
|
|
NAME CHART VERSION APP VERSION DESCRIPTION
|
|
hashicorp/vault 0.5.0 Install and configure Vault on Kubernetes.
|
|
hashicorp/vault 0.4.0 Install and configure Vault on Kubernetes.
|
|
|
|
# Install version 0.4.0
|
|
$ helm install vault hashicorp/vault --version 0.4.0
|
|
```
|
|
|
|
~> **Security Warning:** By default, the chart runs in standalone mode. This
|
|
mode uses a single Vault 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](https://kubernetes.io/docs/tasks/administer-cluster/securing-a-cluster/),
|
|
[learn the available configuration
|
|
options](/docs/platform/k8s/helm/configuration), and read the [production deployment
|
|
checklist](/docs/platform/k8s/helm/run#architecture).
|
|
|
|
## Learn
|
|
|
|
Refer to the [Run Vault on
|
|
Kubernetes](https://learn.hashicorp.com/vault?track=getting-started-k8s#getting-started-k8s)
|
|
guides for step-by-step tutorials.
|