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
50 lines
1.9 KiB
Markdown
50 lines
1.9 KiB
Markdown
---
|
|
layout: "docs"
|
|
page_title: "Custom Plugin Backends"
|
|
sidebar_title: "Plugin Backends"
|
|
sidebar_current: "docs-plugin"
|
|
description: |-
|
|
Plugin backends are mountable backends that are implemented unsing Vault's plugin system.
|
|
---
|
|
|
|
# Custom Plugin Backends
|
|
|
|
Plugin backends are the components in Vault that can be implemented separately from Vault's
|
|
builtin backends. These backends can be either authentication or secrets engines.
|
|
|
|
The [`api_addr`][api_addr] must be set in order for the plugin process to establish
|
|
communication with the Vault server during mount time. If the storage backend
|
|
has HA enabled and supports automatic host address detection (e.g. Consul),
|
|
Vault will automatically attempt to determine the `api_addr` as well.
|
|
|
|
Detailed information regarding the plugin system can be found in the
|
|
[internals documentation](https://www.vaultproject.io/docs/internals/plugins.html).
|
|
|
|
# Enabling/Disabling Plugin Backends
|
|
|
|
Before a plugin backend can be mounted, it needs to be registered via the
|
|
[plugin catalog](https://www.vaultproject.io/docs/internals/plugins.html#plugin-catalog). After
|
|
the plugin is registered, it can be mounted by specifying the registered plugin name:
|
|
|
|
```text
|
|
$ vault secrets enable -path=my-secrets -plugin-name=passthrough-plugin plugin
|
|
Successfully mounted plugin 'passthrough-plugin' at 'my-secrets'!
|
|
```
|
|
|
|
Listing secrets engines will display secrets engines that are mounted as
|
|
plugins:
|
|
|
|
```text
|
|
$ vault secrets list
|
|
Path Type Accessor Plugin Default TTL Max TTL Force No Cache Replication Behavior Description
|
|
my-secrets/ plugin plugin_deb84140 passthrough-plugin system system false replicated
|
|
```
|
|
|
|
Disabling a plugin backend is the identical to disabling internal secrets engines:
|
|
|
|
```text
|
|
$ vault secrets disable my-secrets
|
|
```
|
|
|
|
[api_addr]: /docs/configuration/index.html#api_addr
|