a3dfde5cec
* 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
4.2 KiB
| layout | page_title | sidebar_title | sidebar_current | description |
|---|---|---|---|---|
| docs | Path Help | path-help | docs-commands-path-help | The Vault CLI has a built-in help system that can be used to get help for not only the CLI itself, but also any paths that the CLI can be used with within Vault. |
Help
In addition to standard CLI help using the -h or -help flag for
commands, Vault has a built-in path-help command that can be used to get
help for specific paths within Vault. These paths are used with the
API or read, write, delete commands in order to interact with Vault.
The help system is the easiest way to learn how to use the various systems in Vault, and also allows you to discover new paths.
-> Important! The help system is incredibly important in day-to-day use of Vault. As a beginner or experienced user of Vault, you'll be using the help command a lot to remember how to use different components of Vault. Note that the Vault Server must be running and the client configured properly to execute this command to look up paths.
Discovering Paths
Before using path-help, it is important to understand "paths" within Vault.
Paths are the parameters used for vault read, vault write, etc. An
example path is secret/foo, or aws/config/root. The paths available
depend on the enabled secrets engines. Because of this, the interactive
help is an indispensable tool to finding what paths are supported.
To discover what paths are supported, use vault path-help <mount point>.
For example, if you mounted the AWS secrets engine, you can use
vault path-help aws to find the paths supported by that backend. The paths
will be shown with regular expressions, which can make them hard to
parse, but they're also extremely exact.
You can try it right away with any Vault with vault path-help secret, since
secret is always mounted initially. The output from this command is shown
below and contains both a description of what that backend is for, along with
the paths it supports.
$ vault path-help secret
## DESCRIPTION
The key/value backend reads and writes arbitrary secrets to the backend.
The secrets are encrypted/decrypted by Vault: they are never stored
unencrypted in the backend and the backend never has an opportunity to
see the unencrypted value.
Leases can be set on a per-secret basis. These leases will be sent down
when that secret is read, and it is assumed that some outside process will
revoke and/or replace the secret at that path.
## PATHS
The following paths are supported by this backend. To view help for
any of the paths below, use the help command with any route matching
the path pattern. Note that depending on the policy of your auth token,
you may or may not be able to access certain paths.
^.*$
Pass-through secret storage to the storage backend, allowing you to
read/write arbitrary data into secret storage.
Single Path
Once you've found a path you like, you can learn more about it by
using vault path-help <path> where "path" is a path that matches one of the
regular expressions from the backend help.
Or, if you saw an example online with vault write or some similar
command, you can plug that directly into vault path-help to learn about it
(assuming you have the proper backends mounted!).
For example, below we get the help for a single secret in the secret/
mount point. The help shows the operations that that path supports, the
parameters it takes (for write), and a description of that specific path.
$ vault path-help secret/password
Request: password
Matching Route: ^.*$
Pass-through secret storage to the storage backend, allowing you to
read/write arbitrary data into secret storage.
## PARAMETERS
lease (string)
Lease time for this key when read. Ex: 1h
## DESCRIPTION
The pass-through backend reads and writes arbitrary data into secret storage,
encrypting it along the way.
A lease can be specified when writing with the "lease" field. If given, then
when the secret is read, Vault will report a lease with that duration. It
is expected that the consumer of this backend properly writes renewed keys
before the lease is up. In addition, revocation must be handled by the
user of this backend.