-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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.
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
Add document for sealwrap/rewrap endpoint #7676
Merged
Merged
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
1a167f9
Add documentation for seal wrap re-wrap endpoint
mgaffney 47597e0
Update sample response for seal rewrap status
mgaffney 1f318c0
Merge branch 'master' into mgaffney/doc-re-sealwrap
mgaffney 725bdfd
Updates based on feedback from reviewers
mgaffney 8bb3c1a
Merge branch 'master' into mgaffney/doc-re-sealwrap
mgaffney File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
--- | ||
layout: "api" | ||
page_title: "/sys/sealwrap/rewrap - HTTP API" | ||
sidebar_title: "<code>/sys/sealwrap/rewrap</code>" | ||
sidebar_current: "api-http-system-sealwrap-rewrap" | ||
description: |- | ||
The `/sys/sealwrap/rewrap` endpoint is used to rewrap all seal wrapped entries. | ||
--- | ||
|
||
# `/sys/sealwrap/rewrap` | ||
|
||
~> **Enterprise Only** – These endpoints require Vault Enterprise. | ||
|
||
The `/sys/sealwrap/rewrap` endpoint is used to rewrap all seal wrapped entries. | ||
|
||
## Read Rewrap Status | ||
|
||
This endpoint retrieves if a seal rewrap process is currently running. | ||
mgaffney marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
| Method | Path | | ||
| :------- | :--------------------- | | ||
| `GET` | `/sys/sealwrap/rewrap` | | ||
|
||
### Sample Request | ||
|
||
``` | ||
$ curl \ | ||
--header "X-Vault-Token: ..." \ | ||
http://127.0.0.1:8200/v1/sys/sealwrap/rewrap | ||
``` | ||
|
||
### Sample Response | ||
|
||
```json | ||
{ | ||
"request_id": "a6a51003-2576-be0b-9a43-d3bdfeafc2f7", | ||
"lease_id": "", | ||
"lease_duration": 0, | ||
"renewable": false, | ||
"data": { | ||
mgaffney marked this conversation as resolved.
Show resolved
Hide resolved
|
||
"entries": { | ||
"failed": 0, | ||
"processed": 30, | ||
"succeeded": 30 | ||
}, | ||
"is_running": false | ||
}, | ||
"warnings": null | ||
} | ||
``` | ||
|
||
## Start a Seal Rewrap Process | ||
|
||
This endpoint starts a seal rewrap process if one is not currently running. | ||
The process will run in the background. Check the vault server logs for status | ||
and progress updates. | ||
|
||
| Method | Path | | ||
| :------- | :--------------------- | | ||
| `POST` | `/sys/sealwrap/rewrap` | | ||
|
||
The default status codes are: | ||
|
||
- `200` if a seal rewrap process is already running | ||
mgaffney marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- `204` if a seal rewrap process was started | ||
|
||
### Sample Request | ||
|
||
``` | ||
$ curl \ | ||
--header "X-Vault-Token: ..." \ | ||
--request POST \ | ||
http://127.0.0.1:8200/v1/sys/sealwrap/rewrap | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -141,6 +141,7 @@ | |
'rotate', | ||
'seal', | ||
'seal-status', | ||
'sealwrap-rewrap', | ||
'step-down', | ||
{ | ||
category: 'storage', | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would be nice to include why someone might want to use a rewrap. e.g. after a seal migration, if you rotate the remote keyring and want to upgrade entries
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added in #7689