mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-22 23:21:08 +02:00
abac619e0a
* cli: only set default command parameter to plugin name if sha256 is provided * api: write warnings to RegisterPluginResponse, propagate up to cli * api: filter out 'Endpoint replaced the value of these parameters' warning before returning in RegisterPluginWithContext * docs * add TODO on filtering that links to api type parameter deprecation ticket * fix tests * allocate filteredWarning slice only if there are warnings * improve deferred resp close and early error return conditionals in RegisterPluginWithContext * refer to sha256 as cli option -sha256 in command cli usage * break up ui error lines for sha256 and version flag check * consolidate if statements for sha256 and command, oci_image check in cli * consolidate if statements for sha256 and command, oci_image check in api * new RegisterPluginV2 and RegisterPluginWithContextV2 api client functions for backward compatibility * add changelog * more descriptive changelog * rename RegisterPluginV2 to RegisterPluginDetailed and RegisterPluginWithContextV2 to RegisterPluginWithContextDetailed * return nil, nil if no warnings to preserve status code * fix eof from decoding (check if no content before decoding) * doc for RegisterPluginResponse * only validate plugin.Command in plugin catalog set for downloaded and binary plugins, which rely on plugin.Command input; extracted artifact plugins don't rely on plugin.Command input * Update website/content/api-docs/system/plugins-catalog.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/api-docs/system/plugins-catalog.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/api-docs/system/plugins-catalog.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/docs/commands/plugin/register.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/docs/commands/plugin/register.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/docs/commands/plugin/register.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update website/content/docs/commands/plugin/register.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * move up enterprise note on plugin register command doc * [DOCS] Editorial suggestions for PR #30811 (#31111) * suggestions * move common reqs to a partial * fix typo * tweak reqs * Update website/content/partials/plugins/prepare-plugin.mdx Co-authored-by: helenfufu <25168806+helenfufu@users.noreply.github.com> * Update website/content/partials/plugins/prepare-plugin.mdx Co-authored-by: helenfufu <25168806+helenfufu@users.noreply.github.com> * Update website/content/partials/plugins/prepare-plugin.mdx Co-authored-by: helenfufu <25168806+helenfufu@users.noreply.github.com> * tweak feedback * remove deprecation * Update website/content/partials/plugins/common-requirements.mdx Co-authored-by: helenfufu <25168806+helenfufu@users.noreply.github.com> * save * Update website/content/docs/plugins/rollback.mdx Co-authored-by: helenfufu <25168806+helenfufu@users.noreply.github.com> * Update website/content/docs/plugins/upgrade.mdx Co-authored-by: helenfufu <25168806+helenfufu@users.noreply.github.com> * fix formatting --------- Co-authored-by: helenfufu <25168806+helenfufu@users.noreply.github.com> --------- Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
48 lines
1.2 KiB
Plaintext
48 lines
1.2 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Rollback plugins
|
|
description: >-
|
|
Rollback or downgrade Vault plugins.
|
|
---
|
|
|
|
# Rollback or downgrade Vault plugins
|
|
|
|
Downgrading a plugin in the catalog affects all uses of that plugin version.
|
|
Always check the plugin release notes for unsupported transitions before
|
|
starting your rollback or downgrade.
|
|
|
|
|
|
## Before you start
|
|
|
|
- **To register and downgrade enterprise plugins, you must have Vault v1.16.21+,
|
|
1.17.17+, 1.18.10+, 1.19.4+, or 1.20.x+**.
|
|
|
|
@include 'plugins/common-requirements.mdx'
|
|
|
|
|
|
## Step 1: Prepare the plugin
|
|
|
|
@include 'plugins/prepare-plugin.mdx'
|
|
|
|
|
|
## Step 2: Update the plugin catalog
|
|
|
|
Register the replacement plugin binary or zip file with the old version number
|
|
under the same plugin type and name as the existing plugin version.
|
|
|
|
@include 'plugins/register.mdx'
|
|
|
|
|
|
## Step 3: Pin and reload the plugin
|
|
|
|
Until you reload the plugin, Vault continues running the current plugin version
|
|
on the mount path. When you trigger a reload, Vault kills the active plugin
|
|
process and start a new plugin process with the pinned version of that plugin.
|
|
|
|
@include 'plugins/pin-and-reload.mdx'
|
|
|
|
|
|
## Step 4: Verify the plugin status
|
|
|
|
@include 'plugins/verify-status.mdx'
|