luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity

docs: add plugin definitions to the glossary (#14795) 

* docs: add plugin definitions to the glossary

* clarify multiplexed plugin glossary

* Update website/content/docs/glossary.mdx

Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com>

Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com>
This commit is contained in:
John-Michael Faircloth 2022-04-01 10:37:34 -05:00 committed by GitHub
parent 8f6a97b81b
commit 43e5d12ed0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 28 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
website/content/docs/glossary.mdx
View File

@ -15,6 +15,7 @@ documentation for Vault.
- [Auth Method](#auth-method)
- [Barrier](#barrier)
- [Client Token](#client-token)
- [Plugin](#plugin)
- [Secret](#secret)
- [Secrets Engine](#secrets-engine)
- [Server](#server)
@ -49,6 +50,32 @@ returns a client token which is used for future requests. The token is used by
Vault to verify the identity of the client and to enforce the applicable ACL
policies. This token is passed via HTTP headers.
### Plugin
Plugins are a feature of Vault that can be enabled, disabled, and customized to
some degree. All Vault [auth methods](/docs/auth) and [secrets engines](/docs/secrets)
are considered plugins.
#### Built-in Plugin
Built-in plugins are shipped with Vault, often for commonly used
implementations, and require no additional operator intervention to run.
Built-in plugins are just like any other backend code inside Vault.
#### External Plugin
External plugins are not shipped with Vault and require additional operator
intervention to run. Vault's external plugins are completely separate,
standalone applications that Vault executes and communicates with over RPC.
Each time a Vault secret engine or auth method is mounted, a new process is
spawned.
#### External Multiplexed Plugin
An external plugin may make use of [plugin multiplexing](/docs/plugins/plugin-architecture#plugin-multiplexing).
A multiplexed plugin allows a single plugin process to be used for multiple
mounts of the same type.
### Secret
A secret is the term for anything returned by Vault which

2
website/content/docs/plugins/plugin-architecture.mdx
View File

@ -161,7 +161,7 @@ opt-out capability for plugins that implement multiplexing. To use a
non-multiplexed plugin, run an older version of the plugin, i.e., the
plugin calls the `dbplugin.Serve` function. More details
on implementing plugin multiplexing can be found in
[Upgrading Vault Plugins](/docs/secrets/databases/custom#serving-a-plugin-with-multiplexing).
[Serving a Multiplexed Plugin](/docs/secrets/databases/custom#serving-a-plugin-with-multiplexing).
## Troubleshooting