Skip to content

docs: add -download ent command option for plugin register #31196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maithyton merged 3 commits into from
Jul 3, 2025
Merged

docs: add -download ent command option for plugin register #31196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cea0f2b
docs: add -download ent command option for plugin register
maithyton Jul 3, 2025
7914a7e
Update website/content/docs/commands/plugin/register.mdx
maithyton Jul 3, 2025
e78bdb8
remove comments in shell-session
maithyton Jul 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions website/content/docs/commands/plugin/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,16 @@ $ vault plugin register \
Success! Registered plugin: my-custom-plugin
```

Register a plugin with `-download` <EnterpriseAlert inline="true"/>:

```shell-session
$ vault plugin register
-download \
-version=0.16.0+ent \
secret \
vault-plugin-secrets-keymgmt
```

Get information about a plugin in the catalog:

```shell-session
Expand Down
19 changes: 19 additions & 0 deletions website/content/docs/commands/plugin/register.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,18 @@ $ vault plugin register
vault-plugin-secrets-keymgmt # name must match the plugin name on the releases page
```

Use the `-download` flag with the full version and plugin
name to download and register an official plugin from
[HashiCorp releases page](https://releases.hashicorp.com/):

```shell-session
$ vault plugin register

@schavis schavis Jul 3, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We generally try to avoid using comments in example code to explain what's happening in the command. We should move the information to the intro sentence for the example. I added a suggestion to that effect.

@maithyton maithyton Jul 3, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in e78bdb8

-download \
-version=0.16.0+ent \
secret \
vault-plugin-secrets-keymgmt
```

## Usage

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

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