Skip to content

Commit cea0f2b

Browse files
committed
docs: add -download ent command option for plugin register
1 parent 0ee8d99 commit cea0f2b

2 files changed

Lines changed: 27 additions & 0 deletions

File tree

website/content/docs/commands/plugin/index.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,16 @@ $ vault plugin register \
3434
Success! Registered plugin: my-custom-plugin
3535
```
3636

37+
Register a plugin with download <EnterpriseAlert inline="true"/>:
38+
39+
```shell-session
40+
$ vault plugin register
41+
-download \
42+
-version=0.16.0+ent \
43+
secret \
44+
vault-plugin-secrets-keymgmt
45+
```
46+
3747
Get information about a plugin in the catalog:
3848

3949
```shell-session

website/content/docs/commands/plugin/register.mdx

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,16 @@ $ vault plugin register
6464
vault-plugin-secrets-keymgmt # name must match the plugin name on the releases page
6565
```
6666

67+
Register a plugin with download:
68+
69+
```shell-session
70+
$ vault plugin register
71+
-download \ # download the plugin from the HashiCorp releases page
72+
-version=0.16.0+ent \ # version must match the plugin version on the releases page
73+
secret \
74+
vault-plugin-secrets-keymgmt # name must match the plugin name on the releases page
75+
```
76+
6777
## Usage
6878

6979
The following flags are available in addition to the [standard set of
@@ -105,3 +115,10 @@ flags](/vault/docs/commands) included on all commands.
105115
You can omit version to register a plugin binary, but you must provide
106116
an explicit version to register a plugin artifact.
107117

118+
- `-download` `(bool: false)` - <EnterpriseAlert inline="true" /> **( BETA )**
119+
Tells Vault to download the specified plugin from the
120+
[HashiCorp releases page](https://releases.hashicorp.com/). Automatic
121+
downloads only support secret and auth plugins with artifacts containing
122+
`metadata.json` and `metadata.json.sig`. To use automatic downloads, your
123+
network must permit HTTPS and TCP port 443 between all
124+
Vault cluster nodes and `releases.hashicorp.com`.

0 commit comments

Comments
 (0)