luxolus/open-vault
2
0
Fork 0
Code Issues 1 Pull requests Releases Activity
open-vault/website/content/docs/platform/k8s/helm/index.mdx

64 lines
2.2 KiB
Plaintext
Raw Normal View History

Split helm docs to multiple pages under Helm Chart (#8011) * Split helm docs to multiple pages under Helm Chart - Fixed some minor formatting typos - Added a note at the beginning of most of the pages indicating incompatibility with helm 3 * Remove duplicate examples
2019-12-13 19:09:34 +00:00
---
New Website! (#8154) * new documentation website * ci job adjustment * update to latest version on downloads page * remove transition-period scripts * add netlify toml file * fix docs patch * fix ci config? * revert go.mod changes * a couple last markdown formatting fixes
2020-01-18 00:18:09 +00:00
layout: docs
page_title: Helm - Kubernetes
description: >-
The Vault Helm chart is the recommended way to install and configure Vault on
Kubernetes.
Split helm docs to multiple pages under Helm Chart (#8011) * Split helm docs to multiple pages under Helm Chart - Fixed some minor formatting typos - Added a note at the beginning of most of the pages indicating incompatibility with helm 3 * Remove duplicate examples
2019-12-13 19:09:34 +00:00
---
# Helm Chart
docs/vault-helm: updates for the v0.21.0 release (#16731) Also added a partial for the helm version note.
2022-08-16 21:56:30 +00:00
@include 'helm/version.mdx'
Split helm docs to multiple pages under Helm Chart (#8011) * Split helm docs to multiple pages under Helm Chart - Fixed some minor formatting typos - Added a note at the beginning of most of the pages indicating incompatibility with helm 3 * Remove duplicate examples
2019-12-13 19:09:34 +00:00
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
Updates the k8s helm platform docs (#8632) * 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>
2020-03-30 21:35:08 +00:00
services such as Consul for High Availability (HA) deployments.
Split helm docs to multiple pages under Helm Chart (#8011) * Split helm docs to multiple pages under Helm Chart - Fixed some minor formatting typos - Added a note at the beginning of most of the pages indicating incompatibility with helm 3 * Remove duplicate examples
2019-12-13 19:09:34 +00:00
docs: vault-helm 0.4.0 updates (#8318) Updated docs for vault-helm 0.4.0 configuration changes, and helm 3 support (dropping helm 2). Also some spelling changes, and shortened page titles for the k8s helm examples.
2020-02-21 20:10:38 +00:00
This page assumes general knowledge of [Helm](https://helm.sh/) and
Updates the k8s helm platform docs (#8632) * 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>
2020-03-30 21:35:08 +00:00
how to use it. Using Helm to install Vault requires that Helm is
Split helm docs to multiple pages under Helm Chart (#8011) * Split helm docs to multiple pages under Helm Chart - Fixed some minor formatting typos - Added a note at the beginning of most of the pages indicating incompatibility with helm 3 * Remove duplicate examples
2019-12-13 19:09:34 +00:00
properly installed and configured with your Kubernetes cluster.
## Using the Helm Chart
Updates the k8s helm platform docs (#8632) * 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>
2020-03-30 21:35:08 +00:00
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
website: content updates for developer (#17035) * Chore (dev portal): update learn nav data links (#15515) * Update docs-nav-data.json * Update docs-nav-data.json * website: fixes internal redirects (#15750) * chore: remove duplicate overview item (#15805) * Use `badge` for `<sup>` tags in nav data JSON files (#15928) * Replacing <sup> tags with badge * Adding type and color to badges * fix broken links in vault docs (#15976) * website: Update old learn links to redirect locations (#16047) * update previews to render developer UI * update redirects * adjust content so it is backwards compat Co-authored-by: HashiBot <62622282+hashibot-web@users.noreply.github.com> Co-authored-by: Kendall Strautman <36613477+kendallstrautman@users.noreply.github.com> Co-authored-by: Ashlee M Boyer <43934258+ashleemboyer@users.noreply.github.com>
2022-09-22 15:11:04 +00:00
Helm](https://learn.hashicorp.com/tutorials/vault/kubernetes-minikube-consul) tutorial.
Updates the k8s helm platform docs (#8632) * 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>
2020-03-30 21:35:08 +00:00
Update vault helm docs with new helm repo (#8931) * Update the k8s injector docs for the new helm repo * Update vault helm docs with new helm repo
2020-05-08 17:55:56 +00:00
To use the Helm chart, add the Hashicorp helm repository and check that you have
access to the chart:
docs/k8s: Updates for vault-k8s 0.14.2 and vault-helm 0.19.0 (#13748) Updated vault and chart versions, and some formatting from the pre-commit hook. Also updated chart values.
2022-01-24 23:25:52 +00:00
@include 'helm/repo.mdx'
Split helm docs to multiple pages under Helm Chart (#8011) * Split helm docs to multiple pages under Helm Chart - Fixed some minor formatting typos - Added a note at the beginning of most of the pages indicating incompatibility with helm 3 * Remove duplicate examples
2019-12-13 19:09:34 +00:00
Updates the k8s helm platform docs (#8632) * 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>
2020-03-30 21:35:08 +00:00
-> **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.
Split helm docs to multiple pages under Helm Chart (#8011) * Split helm docs to multiple pages under Helm Chart - Fixed some minor formatting typos - Added a note at the beginning of most of the pages indicating incompatibility with helm 3 * Remove duplicate examples
2019-12-13 19:09:34 +00:00
Example chart usage:
Update vault helm docs with new helm repo (#8931) * Update the k8s injector docs for the new helm repo * Update vault helm docs with new helm repo
2020-05-08 17:55:56 +00:00
Installing the latest release of the Vault Helm chart with pods prefixed with
the name `vault`.
Updates the k8s helm platform docs (#8632) * 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>
2020-03-30 21:35:08 +00:00
🌷 Docs Website Maintenance (#8985) * website maintenance round * improve docs, revert bug workaround as it was fixed * boost memory * remove unnecessary code
2020-05-21 17:18:17 +00:00
```shell-session
Update vault helm docs with new helm repo (#8931) * Update the k8s injector docs for the new helm repo * Update vault helm docs with new helm repo
2020-05-08 17:55:56 +00:00
$ helm install vault hashicorp/vault
Updates the k8s helm platform docs (#8632) * 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>
2020-03-30 21:35:08 +00:00
```
Update vault helm docs with new helm repo (#8931) * Update the k8s injector docs for the new helm repo * Update vault helm docs with new helm repo
2020-05-08 17:55:56 +00:00
Installing a specific version of the chart.
Updates the k8s helm platform docs (#8632) * 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>
2020-03-30 21:35:08 +00:00
docs/k8s: Updates for vault-k8s 0.14.2 and vault-helm 0.19.0 (#13748) Updated vault and chart versions, and some formatting from the pre-commit hook. Also updated chart values.
2022-01-24 23:25:52 +00:00
@include 'helm/install.mdx'
Updates the k8s helm platform docs (#8632) * 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>
2020-03-30 21:35:08 +00:00
~> **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
Update vault helm docs with new helm repo (#8931) * Update the k8s injector docs for the new helm repo * Update vault helm docs with new helm repo
2020-05-08 17:55:56 +00:00
secure and less resilient installation that is **NOT** appropriate for a
Updates the k8s helm platform docs (#8632) * 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>
2020-03-30 21:35:08 +00:00
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).
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 20:37:38 +00:00
## Tutorial
Updates the k8s helm platform docs (#8632) * 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>
2020-03-30 21:35:08 +00:00
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 20:37:38 +00:00
Refer to the [Kubernetes](https://learn.hashicorp.com/collections/vault/kubernetes)
tutorials series to learn how to run Vault on Kubernetes.
Reference in a new issue Copy permalink