scottk/vault
1
0
Fork 0
mirror of https://github.com/optim-enterprises-bv/vault.git synced 2025-11-03 12:07:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

First draft of Seal HA documentation (#23252)

Browse Source 
* wip

* Initial draft of Seal HA docs

* nav data

* Fix env var name

* title

* Note partially wrapped values and disabled seal participation

* Update website/data/docs-nav-data.json

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>

* correct initial upgrade limitation

* Add note about shamir seals and migration

* fix nav json

* snapshot note

* availability note

* seal-backend-status

* Add a couple more clarifying statements

* header typo

* correct initial upgrade wording

* Update website/content/docs/configuration/seal/seal-ha.mdx

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>

* Update website/content/docs/concepts/seal.mdx

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>

---------

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>
This commit is contained in:
Scott Miller
2023-09-22 13:18:48 -05:00
committed by GitHub
parent 8924f9592d
commit 036cbcebd9
8 changed files with 245 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
website/content/api-docs/system/seal-backend-status.mdx Normal file
View File

@@ -0,0 +1,47 @@
---
layout: api
page_title: /sys/seal-backend-status - HTTP API
description: The `/sys/seal-backend-status` endpoint is used to check the status of each seal backend.
---
# `/sys/seal-backend-status`
The `/sys/seal-backend-status` endpoint is used to display the status of
each backing seal, namely whether each backend is healthy.
## Seal Backend Status
This endpoint returns the seal status of the Vault. This is an unauthenticated
endpoint.
| Method | Path |
| :----- | :------------------------- |
| `GET` | `/sys/seal-backend-status` |
### Sample request
```shell-session
$ curl \
http://127.0.0.1:8200/v1/sys/seal-backend-status
```
### Sample response
```json
{
"healthy": false,
"unhealthy_since": "2023-09-22T08:34:11Z",
"backends": [
{
"name": "hsm",
"healthy": true
},
{
"name": "transit",
"healthy": false,
"unhealthy_since": "2023-09-22T08:34:11Z"
}
]
}
```