mirror of
https://github.com/hashicorp/vault.git
synced 2026-02-03 20:40:45 -05:00
docs/add vault versions that support official community plugins with extracted zip artifact (#31188)
* add vault versions that support official community plugins with extracted zip artifact * fix capitalization * remove repeated line about enterprise plugins requiring zip * more capitalization and replace mentions of artifact with extracted .zip file
This commit is contained in:
parent
5ec122f45a
commit
33a0c7b3ff
5 changed files with 20 additions and 13 deletions
|
|
@ -158,19 +158,19 @@ supplied name.
|
|||
- `version` `(string: "")` - Specifies the semantic version of the plugin. Used as the tag
|
||||
when specifying `oci_image`, but with any leading 'v' trimmed. You can
|
||||
omit version to register a plugin binary, but you must provide an
|
||||
explicit version to register a plugin artifact.
|
||||
explicit version to register an extracted `.zip` file.
|
||||
|
||||
- `sha256` `(string: "")` – The SHA256 sum of a plugin binary or the OCI image.
|
||||
Before Vault runs a plugin, it checks the plugin SHA against `sha256`. If the
|
||||
actual SHA of the plugin binary and the SHA provided in `sha256` do not match,
|
||||
Vault will not run the plugin. You must provide `sha256` to register a plugin
|
||||
binary, but you must leave `sha256` unset to register a plugin artifact.
|
||||
binary, but you must leave `sha256` unset to register an extracted `.zip` file.
|
||||
|
||||
- `command` `(string: "")` - Specifies the command used to execute the
|
||||
plugin. This is relative to the plugin directory. e.g. `"myplugin"`, or if `oci_image`
|
||||
is also specified, it is relative to the image's working directory.
|
||||
You must provide `command` to register a plugin binary. Vault ignores `command`
|
||||
when you register a plugin artifact as it already knows the associated run command.
|
||||
when you register with an extracted `.zip` file as it already knows the associated run command.
|
||||
|
||||
- `args` `(array: [])` – Specifies the arguments used to execute the plugin. If
|
||||
the arguments are provided here, the `command` parameter should only contain
|
||||
|
|
|
|||
|
|
@ -13,7 +13,8 @@ The plugin's type of "auth", "database", or "secret" must be included.
|
|||
|
||||
<Note>
|
||||
|
||||
To register an Enterprise plugin, you must register with the plugin artifact, not the binary.
|
||||
To register an enterprise plugin, you must register with the extracted
|
||||
`.zip` file, not the binary.
|
||||
Refer to the [Enterprise plugins](/vault/docs/plugins/plugin-management#enterprise-plugins) section
|
||||
of the plugin management page for Vault compatibility requirements.
|
||||
|
||||
|
|
@ -30,7 +31,7 @@ $ vault plugin register \
|
|||
Success! Registered plugin: my-custom-plugin
|
||||
```
|
||||
|
||||
Register a plugin artifact:
|
||||
Register an extracted plugin `.zip` file:
|
||||
|
||||
Before registering Key Management secrets engine v0.16.0+ent for the linux/amd64 system that runs Vault Enterprise,
|
||||
`vault-plugin-secrets-keymgmt_v0.16.0+ent_linux_amd64.zip` needs to be downloaded from
|
||||
|
|
@ -54,7 +55,7 @@ $ vault plugin register \
|
|||
auth my-custom-plugin
|
||||
```
|
||||
|
||||
Register a plugin artifact with custom args:
|
||||
Register an extracted plugin `.zip` file with custom args:
|
||||
|
||||
```shell-session
|
||||
$ vault plugin register
|
||||
|
|
@ -91,7 +92,7 @@ flags](/vault/docs/commands) included on all commands.
|
|||
|
||||
- `sha256` `(string: "")` – The SHA256 sum of a plugin binary or the OCI image.
|
||||
You must provide `sha256` to register a plugin binary, but you must leave
|
||||
`sha256` unset to register a plugin artifact.
|
||||
`sha256` unset to register an extracted `.zip` file.
|
||||
|
||||
- `-args` `([]string: [])` - Argument to pass to the plugin when starting. This
|
||||
flag can be specified multiple times to specify multiple args.
|
||||
|
|
@ -99,7 +100,7 @@ flags](/vault/docs/commands) included on all commands.
|
|||
- `-command` `(string: "")` - Specifies the command path used to execute the
|
||||
plugin relative to the plugin directory or OCI image directory. You must
|
||||
provide `command` to register a plugin binary. Vault ignores `command` when
|
||||
you register a plugin artifact as it already knows the associated run command.
|
||||
you register with an extracted `.zip` file as it already knows the associated run command.
|
||||
|
||||
- `-env` `([]string: [])` - Environment variables to set for the plugin when
|
||||
starting. This flag can be specified multiple times to specify multiple
|
||||
|
|
@ -115,7 +116,7 @@ flags](/vault/docs/commands) included on all commands.
|
|||
- `-version` `(string: "")` - Semantic version of the plugin. Used as the tag
|
||||
when specifying `-oci_image`, but any leading 'v' will automatically be trimmed.
|
||||
You can omit version to register a plugin binary, but you must provide
|
||||
an explicit version to register a plugin artifact.
|
||||
an explicit version to register an extracted `.zip` file.
|
||||
|
||||
- `-download` `(bool: false)` - <EnterpriseAlert inline="true" /> **( BETA )**
|
||||
Tells Vault to download the specified plugin from the
|
||||
|
|
|
|||
|
|
@ -26,8 +26,10 @@ for more details.
|
|||
|
||||
## Before you start
|
||||
|
||||
- **To register enterprise plugins, you must have Vault v1.16.21+, 1.17.17+,
|
||||
1.18.10+, 1.19.4+, or 1.20.x+**.
|
||||
- **To register official enterprise plugins, you must have Vault v1.16.21+, 1.17.17+,
|
||||
1.18.10+, 1.19.4+, or 1.20.x+**.
|
||||
- **To register official community plugins with an extracted `.zip` file, you must have
|
||||
Vault v1.16.21+, 1.17.17+, 1.18.10+, 1.19.5+, or 1.20.x+**.
|
||||
|
||||
@include 'plugins/common-requirements.mdx'
|
||||
|
||||
|
|
|
|||
|
|
@ -14,8 +14,10 @@ starting your rollback or downgrade.
|
|||
|
||||
## Before you start
|
||||
|
||||
- **To register and downgrade enterprise plugins, you must have Vault v1.16.21+,
|
||||
- **To register and downgrade official enterprise plugins, you must have Vault v1.16.21+,
|
||||
1.17.17+, 1.18.10+, 1.19.4+, or 1.20.x+**.
|
||||
- **To register and downgrade official community plugins with an extracted `.zip` file, you must have
|
||||
Vault v1.16.21+, 1.17.17+, 1.18.10+, 1.19.5+, or 1.20.x+**.
|
||||
|
||||
@include 'plugins/common-requirements.mdx'
|
||||
|
||||
|
|
|
|||
|
|
@ -22,8 +22,10 @@ unaffected by plugin upgrades.
|
|||
|
||||
## Before you start
|
||||
|
||||
- **To register and upgrade enterprise plugins, you must have Vault v1.16.21+,
|
||||
- **To register and upgrade official enterprise plugins, you must have Vault v1.16.21+,
|
||||
1.17.17+, 1.18.10+, 1.19.4+, or 1.20.x+**.
|
||||
- **To register and upgrade official community plugins with an extracted `.zip` file, you must have
|
||||
Vault v1.16.21+, 1.17.17+, 1.18.10+, 1.19.5+, or 1.20.x+**.
|
||||
|
||||
@include 'plugins/common-requirements.mdx'
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue