» Running Vault on Kubernetes
Vault can run directly on Kubernetes in various modes:
For pure-Kubernetes workloads, this enables Vault to also exist purely
This page starts with a large how-to section for various specific tasks.
IMPORTANT NOTE: Vault Enterprise is currently not supported. We are actively working a version for Vault Enterprise and it will be available in the future.
» Helm Chart
The Vault Helm chart 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 deployments.
While the Helm chart exposes dozens of useful configurations and automatically sets up complex resources, it does not automatically operate Vault. You are still responsible for learning how to monitor, backup, upgrade, etc. the Vault cluster.
The Helm chart has no required configuration and will install a Vault cluster with sane defaults out of the box. Prior to going to production, it is highly recommended that you learn about the configuration options.
Security Warning: By default, the chart will install an insecure configuration of Vault. This provides a less complicated out-of-box experience for new users, but is not appropriate for a production setup. It is highly recommended to use a properly secured Kubernetes cluster. See the architecture reference for a production deployment checklist.
» Installing Vault
To install Vault, clone the vault-helm repository, checkout the latest release, and install
Vault. You can run
helm install with the
--dry-run flag to see the
resources it would configure. In a production environment, you should always
--dry-run flag prior to making any changes to the Vault cluster
via Helm. See the chart configuration values
for additional configuration options.
# Clone the chart repo $ git clone https://github.com/hashicorp/vault-helm.git $ cd vault-helm # Checkout a tagged version $ git checkout v0.1.1 # Run Helm $ helm install --name vault ./ ...
That's it. The Helm chart does everything to setup a Vault-on-Kubernetes deployment.
» Viewing the Vault UI
The Vault UI is enabled by default when using the Helm chart.
For security reasons, it isn't exposed via a Service by default so you must
kubectl port-forward to visit the UI. Once the port is forwarded as
shown below, navigate your browser to
$ kubectl port-forward vault-0 8200:8200 ...
The UI can also be exposed via a Kubernetes Service. To do this, configure
ui.service chart values.
» Upgrading Vault on Kubernetes
To upgrade Vault on Kubernetes, we follow the same pattern as generally upgrading Vault, except we can use the Helm chart to update the Vault server Statefulset. It is important to understand how to generally upgrade Vault before reading this section.
The Vault Statefulset uses
OnDelete update strategy. It is critical to use
RollingUpdate because standbys must be updated before the active primary. A
failover to an older version of Vault must always be avoided.
IMPORTANT NOTE: Always back up your data before upgrading! Vault does not make backward-compatibility guarantees for its data store. Simply replacing the newly-installed Vault binary with the previous version will not cleanly downgrade Vault, as upgrades may perform changes to the underlying data structure that make the data incompatible with a downgrade. If you need to roll back to a previous version of Vault, you should roll back your data store as well.
» Upgrading Vault Servers
To initiate the upgrade, change the
global.image value to the
desired Vault version. For illustrative purposes, the example below will
global: image: "vault:123.456"
Next, run the upgrade. You should run this with
--dry-run first to verify
the changes that will be sent to the Kubernetes cluster.
$ helm upgrade vault ./ ...
This should cause no changes (although the resource will be updated). If
everything is stable,
helm upgrade can be run.
helm upgrade command should have updated the Statefulset template for
the Vault servers, however, no pods have been deleted. The pods must be manually
deleted to upgrade. Deleting the pods will not delete any persisted data.
If Vault is not deployed using
ha mode, the single Vault server may be deleted by
$ kubectl delete pod <name of Vault pod>
If Vault is deployed using
ha mode, the standby pods must be upgraded first.
To identify which pod is currently the active primary, run the following commad
on each Vault pod:
$ kubectl exec -ti <name of pod> -- vault status | grep "HA Mode"
Next, delete every pod that is not the active primary:
$ kubectl delete pod <name of Vault pods>
If auto-unseal is not being used, the newly scheduled Vault standby pods will need to be unsealed:
$ kubectl exec -ti <name of pod> -- vault operator unseal
Finally, once the standby nodes have been updated and unsealed, delete the active primary:
$ kubectl delete pod <name of Vault primary>
Similar to the standby nodes, the former primary will also need to be unsealed:
$ kubectl exec -ti <name of pod> -- vault operator unseal
After a few moments the Vault cluster should elect a new active primary. The Vault cluster is now upgraded!
We recommend running Vault on Kubernetes with the same general architecture as running it anywhere else. There are some benefits Kubernetes can provide that eases operating a Vault cluster and we document those below. The standard production deployment guide is still an important read even if running Vault within Kubernetes.
» Production Deployment Checklist
End-to-End TLS. Vault should always be used with TLS in production. If intermediate load balancers or reverse proxies are used to front Vault, they should not terminate TLS. This way traffic is always encrypted in transit to Vault and minimizes risks introduced by intermediate layers. See the official documentation for example on configuring Vault Helm to use TLS.
Single Tenancy. Vault should be the only main process running on a machine.
This reduces the risk that another process running on the same machine is
compromised and can interact with Vault. This can be accomplished by using Vault
affinity configurable. See the
for example on configuring Vault Helm to use affinity rules.
Enable Auditing. Vault supports several auditing backends. Enabling auditing
provides a history of all operations performed by Vault and provides a forensics
trail in the case of misuse or compromise. Audit logs securely hash any sensitive
data, but access should still be restricted to prevent any unintended disclosures.
Vault Helm includes a configurable
auditStorage option that will provision a persistent
volume to store audit logs. See the
for an example on configuring Vault Helm to use auditing.
Immutable Upgrades. Vault relies on an external storage backend for persistence, and this decoupling allows the servers running Vault to be managed immutably. When upgrading to new versions, new servers with the upgraded version of Vault are brought online. They are attached to the same shared storage backend and unsealed. Then the old servers are destroyed. This reduces the need for remote access and upgrade orchestration which may introduce security gaps. See the upgrade section for instructions on upgrading Vault on Kubernetes.
Upgrade Frequently. Vault is actively developed, and updating frequently is important to incorporate security fixes and any changes in default settings such as key lengths or cipher suites. Subscribe to the Vault mailing list and GitHub CHANGELOG for updates.
Restrict Storage Access. Vault encrypts all data at rest, regardless of which storage backend is used. Although the data is encrypted, an attacker with arbitrary control can cause data corruption or loss by modifying or deleting keys. Access to the storage backend should be restricted to only Vault to avoid unauthorized access or operations.