2015-03-13 17:34:29 +00:00
|
|
|
---
|
New Docs Website (#5535)
* conversion stage 1
* correct image paths
* add sidebar title to frontmatter
* docs/concepts and docs/internals
* configuration docs and multi-level nav corrections
* commands docs, index file corrections, small item nav correction
* secrets converted
* auth
* add enterprise and agent docs
* add extra dividers
* secret section, wip
* correct sidebar nav title in front matter for apu section, start working on api items
* auth and backend, a couple directory structure fixes
* remove old docs
* intro side nav converted
* reset sidebar styles, add hashi-global-styles
* basic styling for nav sidebar
* folder collapse functionality
* patch up border length on last list item
* wip restructure for content component
* taking middleman hacking to the extreme, but its working
* small css fix
* add new mega nav
* fix a small mistake from the rebase
* fix a content resolution issue with middleman
* title a couple missing docs pages
* update deps, remove temporary markup
* community page
* footer to layout, community page css adjustments
* wip downloads page
* deps updated, downloads page ready
* fix community page
* homepage progress
* add components, adjust spacing
* docs and api landing pages
* a bunch of fixes, add docs and api landing pages
* update deps, add deploy scripts
* add readme note
* update deploy command
* overview page, index title
* Update doc fields
Note this still requires the link fields to be populated -- this is solely related to copy on the description fields
* Update api_basic_categories.yml
Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages.
* Add bottom hero, adjust CSS, responsive friendly
* Add mega nav title
* homepage adjustments, asset boosts
* small fixes
* docs page styling fixes
* meganav title
* some category link corrections
* Update API categories page
updated to reflect the second level headings for api categories
* Update docs_detailed_categories.yml
Updated to represent the existing docs structure
* Update docs_detailed_categories.yml
* docs page data fix, extra operator page remove
* api data fix
* fix makefile
* update deps, add product subnav to docs and api landing pages
* Rearrange non-hands-on guides to _docs_
Since there is no place for these on learn.hashicorp, we'll put them
under _docs_.
* WIP Redirects for guides to docs
* content and component updates
* font weight hotfix, redirects
* fix guides and intro sidenavs
* fix some redirects
* small style tweaks
* Redirects to learn and internally to docs
* Remove redirect to `/vault`
* Remove `.html` from destination on redirects
* fix incorrect index redirect
* final touchups
* address feedback from michell for makefile and product downloads
2018-10-19 15:40:11 +00:00
|
|
|
layout: "docs"
|
2015-03-13 17:34:29 +00:00
|
|
|
page_title: "Use Cases"
|
New Docs Website (#5535)
* conversion stage 1
* correct image paths
* add sidebar title to frontmatter
* docs/concepts and docs/internals
* configuration docs and multi-level nav corrections
* commands docs, index file corrections, small item nav correction
* secrets converted
* auth
* add enterprise and agent docs
* add extra dividers
* secret section, wip
* correct sidebar nav title in front matter for apu section, start working on api items
* auth and backend, a couple directory structure fixes
* remove old docs
* intro side nav converted
* reset sidebar styles, add hashi-global-styles
* basic styling for nav sidebar
* folder collapse functionality
* patch up border length on last list item
* wip restructure for content component
* taking middleman hacking to the extreme, but its working
* small css fix
* add new mega nav
* fix a small mistake from the rebase
* fix a content resolution issue with middleman
* title a couple missing docs pages
* update deps, remove temporary markup
* community page
* footer to layout, community page css adjustments
* wip downloads page
* deps updated, downloads page ready
* fix community page
* homepage progress
* add components, adjust spacing
* docs and api landing pages
* a bunch of fixes, add docs and api landing pages
* update deps, add deploy scripts
* add readme note
* update deploy command
* overview page, index title
* Update doc fields
Note this still requires the link fields to be populated -- this is solely related to copy on the description fields
* Update api_basic_categories.yml
Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages.
* Add bottom hero, adjust CSS, responsive friendly
* Add mega nav title
* homepage adjustments, asset boosts
* small fixes
* docs page styling fixes
* meganav title
* some category link corrections
* Update API categories page
updated to reflect the second level headings for api categories
* Update docs_detailed_categories.yml
Updated to represent the existing docs structure
* Update docs_detailed_categories.yml
* docs page data fix, extra operator page remove
* api data fix
* fix makefile
* update deps, add product subnav to docs and api landing pages
* Rearrange non-hands-on guides to _docs_
Since there is no place for these on learn.hashicorp, we'll put them
under _docs_.
* WIP Redirects for guides to docs
* content and component updates
* font weight hotfix, redirects
* fix guides and intro sidenavs
* fix some redirects
* small style tweaks
* Redirects to learn and internally to docs
* Remove redirect to `/vault`
* Remove `.html` from destination on redirects
* fix incorrect index redirect
* final touchups
* address feedback from michell for makefile and product downloads
2018-10-19 15:40:11 +00:00
|
|
|
sidebar_title: "Use Cases"
|
2015-03-13 17:34:29 +00:00
|
|
|
sidebar_current: "use-cases"
|
|
|
|
description: |-
|
2015-04-07 01:35:00 +00:00
|
|
|
This page lists some concrete use cases for Vault, but the possible use cases are much broader than what we cover.
|
2015-03-13 17:34:29 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
# Use Cases
|
|
|
|
|
|
|
|
Before understanding use cases, it's useful to know [what Vault is](/intro/index.html).
|
|
|
|
This page lists some concrete use cases for Vault, but the possible use cases are
|
2015-04-07 01:35:00 +00:00
|
|
|
much broader than what we cover.
|
2015-03-13 17:34:29 +00:00
|
|
|
|
2015-04-07 01:35:00 +00:00
|
|
|
#### General Secret Storage
|
2015-03-13 17:34:29 +00:00
|
|
|
|
2015-04-07 01:35:00 +00:00
|
|
|
At a bare minimum, Vault can be used for the storage of any secrets. For
|
|
|
|
example, Vault would be a fantastic way to store sensitive environment variables,
|
|
|
|
database credentials, API keys, etc.
|
2015-03-13 17:34:29 +00:00
|
|
|
|
2015-04-07 01:35:00 +00:00
|
|
|
Compare this with the current way to store these which might be
|
|
|
|
plaintext in files, configuration management, a database, etc. It would be
|
|
|
|
much safer to query these using `vault read` or the API. This protects
|
|
|
|
the plaintext version of these secrets as well as records access in the Vault
|
|
|
|
audit log.
|
2015-03-13 17:34:29 +00:00
|
|
|
|
2015-04-07 01:35:00 +00:00
|
|
|
#### Employee Credential Storage
|
2015-03-13 17:34:29 +00:00
|
|
|
|
2015-04-07 01:35:00 +00:00
|
|
|
While this overlaps with "General Secret Storage", Vault is a good mechanism
|
|
|
|
for storing credentials that employees share to access web services. The
|
|
|
|
audit log mechanism lets you know what secrets an employee accessed and
|
|
|
|
when an employee leaves, it is easier to roll keys and understand which keys
|
|
|
|
have and haven't been rolled.
|
2015-03-13 17:34:29 +00:00
|
|
|
|
2015-04-07 01:35:00 +00:00
|
|
|
#### API Key Generation for Scripts
|
2015-03-13 17:34:29 +00:00
|
|
|
|
2015-04-07 01:35:00 +00:00
|
|
|
The "dynamic secrets" feature of Vault is ideal for scripts: an AWS
|
|
|
|
access key can be generated for the duration of a script, then revoked.
|
|
|
|
The keypair will not exist before or after the script runs, and the
|
|
|
|
creation of the keys are completely logged.
|
2015-03-13 17:34:29 +00:00
|
|
|
|
2015-04-07 01:35:00 +00:00
|
|
|
This is an improvement over using something like Amazon IAM but still
|
|
|
|
effectively hardcoding limited-access access tokens in various places.
|
2015-04-17 19:01:20 +00:00
|
|
|
|
|
|
|
#### Data Encryption
|
|
|
|
|
|
|
|
In addition to being able to store secrets, Vault can be used to
|
|
|
|
encrypt/decrypt data that is stored elsewhere. The primary use of this is
|
|
|
|
to allow applications to encrypt their data while still storing it in the
|
|
|
|
primary data store.
|
|
|
|
|
|
|
|
The benefit of this is that developers do not need to worry about how to
|
|
|
|
properly encrypt data. The responsibility of encryption is on Vault
|
|
|
|
and the security team managing it, and developers just encrypt/decrypt
|
|
|
|
data as needed.
|