mirror of
https://github.com/hashicorp/vault.git
synced 2025-11-22 11:11:26 +01:00
bbe4a0af8b
* Updates the k8s helm platform docs - Updates to talk about the external mode - Updates the helm install overview to show that the releases can also be the way to install - Rewrites the how-to to include showing how to start in each mode - Each mode that has a guide links off to a guide - Re-organizes the Unseal and Init to a section and places all the various other unseals underneath it - Moves updating below the unseal and init - Shows some basic usage of the helm CLI with a value and file override * Adds learn links for k8s index pages * Adds helm dev and external vault examples While the dev one may seem obvious I think that it's incredibly useful to cover our bases if this is to be reference documentation. I thought maybe the example could have ingress support for UI but do not have the experience to recommend it. * Adds helm docs example dev and external - places the development first as it feels like the starting point for some. - places the external after HA Co-authored-by: Vishal Nayak <vishalnayak@users.noreply.github.com>
80 lines
2.9 KiB
Plaintext
80 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, you can target a specific [release published to
|
|
GitHub](https://github.com/hashicorp/vault-helm/releases) or download/clone the
|
|
[vault-helm GitHub repository](https://github.com/hashicorp/vault-helm). In the
|
|
future, we plan publishing to a public Helm repository.
|
|
|
|
-> **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 Vault Helm chart version 0.4.0 with pods prefixed with the name
|
|
`vault`.
|
|
|
|
```sh
|
|
$ helm install vault https://github.com/hashicorp/vault-helm/archive/v0.4.0.tar.gz
|
|
```
|
|
|
|
Cloning the Vault Helm chart, checking out tagged version v0.4.0, and installing
|
|
the Vault Helm chart from the filesystem.
|
|
|
|
~> **NOTE:** We highly recommend you checkout a specific tagged release
|
|
of the chart to avoid any instabilities from master.
|
|
|
|
```sh
|
|
# Clone the chart repo
|
|
$ git clone https://github.com/hashicorp/vault-helm.git
|
|
$ cd vault-helm
|
|
|
|
# Checkout a tagged version
|
|
$ git checkout v0.4.0
|
|
|
|
# Run Helm
|
|
$ helm install vault ./
|
|
```
|
|
|
|
~> **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 resilent 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.
|