open-vault/website/content/docs/platform/k8s/helm/index.mdx
Loann Le 95555b9dd4
Vault documentation: changing references from learn to tutorial (#14844)
* changed learn to tutorial references

* changed learn to tutorial

* Update website/content/docs/plugins/plugin-portal.mdx

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>

* Update website/content/docs/platform/aws/run.mdx

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
2022-04-01 13:37:38 -07:00

64 lines
2.3 KiB
Plaintext

---
layout: docs
page_title: Helm - Kubernetes
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/tutorials/vault/kubernetes-minikube) tutorial.
To use the Helm chart, add the Hashicorp helm repository and check that you have
access to the chart:
@include 'helm/repo.mdx'
-> **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.
@include 'helm/install.mdx'
~> **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).
## Tutorial
Refer to the [Kubernetes](https://learn.hashicorp.com/collections/vault/kubernetes)
tutorials series to learn how to run Vault on Kubernetes.