From 1a167f97624d37af07a889045efa298ab8ac0575 Mon Sep 17 00:00:00 2001 From: Michael Gaffney Date: Fri, 30 Aug 2019 15:10:42 -0400 Subject: [PATCH 1/3] Add documentation for seal wrap re-wrap endpoint --- .../source/api/system/sealwrap-rewrap.html.md | 71 +++++++++++++++++++ website/source/layouts/api.erb | 1 + 2 files changed, 72 insertions(+) create mode 100644 website/source/api/system/sealwrap-rewrap.html.md diff --git a/website/source/api/system/sealwrap-rewrap.html.md b/website/source/api/system/sealwrap-rewrap.html.md new file mode 100644 index 000000000000..ad917782b984 --- /dev/null +++ b/website/source/api/system/sealwrap-rewrap.html.md @@ -0,0 +1,71 @@ +--- +layout: "api" +page_title: "/sys/sealwrap/rewrap - HTTP API" +sidebar_title: "/sys/sealwrap/rewrap" +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. + +| 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": "4435a8e9-bc19-480e-c512-ad2031d4fe27", + "lease_id": "", + "renewable": false, + "lease_duration": 0, + "data": { + "is_running": false + }, + "wrap_info": null, + "warnings": null, + "auth": 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 +- `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 +``` diff --git a/website/source/layouts/api.erb b/website/source/layouts/api.erb index ede47330b4a0..5f697d461c5d 100644 --- a/website/source/layouts/api.erb +++ b/website/source/layouts/api.erb @@ -138,6 +138,7 @@ 'rotate', 'seal', 'seal-status', + 'sealwrap-rewrap', 'step-down', { category: 'storage', From 47597e06c5062a1af3d6a4f26ebff89b8d97caa9 Mon Sep 17 00:00:00 2001 From: Michael Gaffney Date: Wed, 16 Oct 2019 13:51:24 -0400 Subject: [PATCH 2/3] Update sample response for seal rewrap status --- website/source/api/system/sealwrap-rewrap.html.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/website/source/api/system/sealwrap-rewrap.html.md b/website/source/api/system/sealwrap-rewrap.html.md index ad917782b984..cda2ef5308fa 100644 --- a/website/source/api/system/sealwrap-rewrap.html.md +++ b/website/source/api/system/sealwrap-rewrap.html.md @@ -33,16 +33,19 @@ $ curl \ ```json { - "request_id": "4435a8e9-bc19-480e-c512-ad2031d4fe27", + "request_id": "a6a51003-2576-be0b-9a43-d3bdfeafc2f7", "lease_id": "", - "renewable": false, "lease_duration": 0, + "renewable": false, "data": { + "entries": { + "failed": 0, + "processed": 30, + "succeeded": 30 + }, "is_running": false }, - "wrap_info": null, - "warnings": null, - "auth": null + "warnings": null } ``` From 725bdfde11ea84a1aeec1b0fce1717386dbddb65 Mon Sep 17 00:00:00 2001 From: Michael Gaffney Date: Wed, 16 Oct 2019 15:44:00 -0400 Subject: [PATCH 3/3] Updates based on feedback from reviewers --- website/source/api/system/sealwrap-rewrap.html.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/website/source/api/system/sealwrap-rewrap.html.md b/website/source/api/system/sealwrap-rewrap.html.md index cda2ef5308fa..780da0cdf3f2 100644 --- a/website/source/api/system/sealwrap-rewrap.html.md +++ b/website/source/api/system/sealwrap-rewrap.html.md @@ -15,7 +15,7 @@ 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. +This endpoint reports whether a seal rewrap process is currently running. | Method | Path | | :------- | :--------------------- | @@ -33,10 +33,6 @@ $ curl \ ```json { - "request_id": "a6a51003-2576-be0b-9a43-d3bdfeafc2f7", - "lease_id": "", - "lease_duration": 0, - "renewable": false, "data": { "entries": { "failed": 0, @@ -44,8 +40,7 @@ $ curl \ "succeeded": 30 }, "is_running": false - }, - "warnings": null + } } ```