2017-07-26 20:47:41 +00:00
|
|
|
|
---
|
|
|
|
|
layout: "api"
|
|
|
|
|
page_title: "/sys/replication - HTTP API"
|
2018-10-29 19:58:37 +00:00
|
|
|
|
sidebar_title: "<code>/sys/replication/performance</code>"
|
New Docs Website (#5535)
* conversion stage 1
* correct image paths
* add sidebar title to frontmatter
* docs/concepts and docs/internals
* configuration docs and multi-level nav corrections
* commands docs, index file corrections, small item nav correction
* secrets converted
* auth
* add enterprise and agent docs
* add extra dividers
* secret section, wip
* correct sidebar nav title in front matter for apu section, start working on api items
* auth and backend, a couple directory structure fixes
* remove old docs
* intro side nav converted
* reset sidebar styles, add hashi-global-styles
* basic styling for nav sidebar
* folder collapse functionality
* patch up border length on last list item
* wip restructure for content component
* taking middleman hacking to the extreme, but its working
* small css fix
* add new mega nav
* fix a small mistake from the rebase
* fix a content resolution issue with middleman
* title a couple missing docs pages
* update deps, remove temporary markup
* community page
* footer to layout, community page css adjustments
* wip downloads page
* deps updated, downloads page ready
* fix community page
* homepage progress
* add components, adjust spacing
* docs and api landing pages
* a bunch of fixes, add docs and api landing pages
* update deps, add deploy scripts
* add readme note
* update deploy command
* overview page, index title
* Update doc fields
Note this still requires the link fields to be populated -- this is solely related to copy on the description fields
* Update api_basic_categories.yml
Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages.
* Add bottom hero, adjust CSS, responsive friendly
* Add mega nav title
* homepage adjustments, asset boosts
* small fixes
* docs page styling fixes
* meganav title
* some category link corrections
* Update API categories page
updated to reflect the second level headings for api categories
* Update docs_detailed_categories.yml
Updated to represent the existing docs structure
* Update docs_detailed_categories.yml
* docs page data fix, extra operator page remove
* api data fix
* fix makefile
* update deps, add product subnav to docs and api landing pages
* Rearrange non-hands-on guides to _docs_
Since there is no place for these on learn.hashicorp, we'll put them
under _docs_.
* WIP Redirects for guides to docs
* content and component updates
* font weight hotfix, redirects
* fix guides and intro sidenavs
* fix some redirects
* small style tweaks
* Redirects to learn and internally to docs
* Remove redirect to `/vault`
* Remove `.html` from destination on redirects
* fix incorrect index redirect
* final touchups
* address feedback from michell for makefile and product downloads
2018-10-19 15:40:11 +00:00
|
|
|
|
sidebar_current: "api-http-system-replication-performance"
|
2017-07-26 20:47:41 +00:00
|
|
|
|
description: |-
|
|
|
|
|
The '/sys/replication/performance' endpoint focuses on managing general operations in Vault Enterprise Performance Replication
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# `/sys/replication/performance`
|
|
|
|
|
|
|
|
|
|
~> **Enterprise Only** – These endpoints require Vault Enterprise.
|
|
|
|
|
|
|
|
|
|
## Check Performance Status
|
|
|
|
|
|
|
|
|
|
This endpoint prints information about the status of replication (mode,
|
|
|
|
|
sync progress, etc).
|
|
|
|
|
|
|
|
|
|
This is an authenticated endpoint.
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
|
|
|
|
| `GET` | `/sys/replication/performance/status` | `200 application/json` |
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/replication/performance/status
|
2017-07-26 20:47:41 +00:00
|
|
|
|
```
|
|
|
|
|
|
2018-06-13 23:43:39 +00:00
|
|
|
|
### Sample Response from Primary
|
2017-07-26 20:47:41 +00:00
|
|
|
|
|
|
|
|
|
The printed status of the replication environment. As an example, for a
|
|
|
|
|
primary, it will look something like:
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"data": {
|
|
|
|
|
"cluster_id": "d4095d41-3aee-8791-c421-9bc7f88f7c3e",
|
2018-06-13 23:43:39 +00:00
|
|
|
|
"known_secondaries": [
|
|
|
|
|
"2"
|
|
|
|
|
],
|
|
|
|
|
"last_wal": 87,
|
|
|
|
|
"merkle_root": "c31e40f6ff02f32c37b70e6a4d58732ac812abf0",
|
2017-07-26 20:47:41 +00:00
|
|
|
|
"mode": "primary"
|
|
|
|
|
},
|
2018-06-13 23:43:39 +00:00
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Response from Secondary
|
|
|
|
|
|
|
|
|
|
The printed status of the replication environment. As an example, for a
|
|
|
|
|
secondary, it will look something like:
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"data": {
|
|
|
|
|
"cluster_id": "d4095d41-3aee-8791-c421-9bc7f88f7c3e",
|
|
|
|
|
"known_primary_cluster_addrs": [
|
|
|
|
|
"https://127.0.0.1:8201"
|
|
|
|
|
],
|
|
|
|
|
"last_remote_wal": 87,
|
|
|
|
|
"merkle_root": "c31e40f6ff02f32c37b70e6a4d58732ac812abf0",
|
|
|
|
|
"mode": "secondary",
|
|
|
|
|
"primary_cluster_addr": "https://127.0.0.1:8201",
|
|
|
|
|
"secondary_id": "2",
|
|
|
|
|
"state": "stream-wals"
|
|
|
|
|
},
|
2017-07-26 20:47:41 +00:00
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Enable Performance Primary Replication
|
|
|
|
|
|
|
|
|
|
This endpoint enables replication in primary mode. This is used when replication
|
|
|
|
|
is currently disabled on the cluster (if the cluster is already a secondary, it
|
|
|
|
|
must be promoted).
|
|
|
|
|
|
|
|
|
|
!> Only one primary should be active at a given time. Multiple primaries may
|
|
|
|
|
result in data loss!
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
|
|
|
|
| `POST` | `/sys/replication/performance/primary/enable` | `204 (empty body)` |
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `primary_cluster_addr` `(string: "")` – Specifies the cluster address that the
|
|
|
|
|
primary gives to secondary nodes. Useful if the primary's cluster address is
|
|
|
|
|
not directly accessible and must be accessed via an alternate path/address,
|
|
|
|
|
such as through a TCP-based load balancer. If not set, uses vault's configured
|
|
|
|
|
cluster address.
|
|
|
|
|
|
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request POST \
|
|
|
|
|
--data @payload.json \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/replication/performance/primary/enable
|
2017-07-26 20:47:41 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Demote Performance Primary
|
|
|
|
|
|
2017-08-25 13:51:33 +00:00
|
|
|
|
This endpoint demotes a performance primary cluster to a performance secondary.
|
|
|
|
|
This secondary cluster will not attempt to connect to a primary (see the update-primary call),
|
2017-07-26 20:47:41 +00:00
|
|
|
|
but will maintain knowledge of its cluster ID and can be reconnected to the same
|
|
|
|
|
replication set without wiping local storage.
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
|
|
|
|
| `POST` | `/sys/replication/performance/primary/demote` | `204 (empty body)` |
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request POST \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/replication/performance/primary/demote
|
2017-07-26 20:47:41 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Disable Performance Primary
|
|
|
|
|
|
|
|
|
|
This endpoint disables performance replication entirely on the cluster. Any
|
|
|
|
|
performance secondaries will no longer be able to connect. Caution: re-enabling
|
|
|
|
|
this node as a primary or secondary will change its cluster ID; in the secondary
|
|
|
|
|
case this means a wipe of the underlying storage when connected to a primary,
|
|
|
|
|
and in the primary case, secondaries connecting back to the cluster (even if
|
|
|
|
|
they have connected before) will require a wipe of the underlying storage.
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
|
|
|
|
| `POST` | `/sys/replication/performance/primary/disable` | `204 (empty body)` |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request POST \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/replication/performance/primary/disable
|
2017-07-26 20:47:41 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Generate Performance Secondary Token
|
|
|
|
|
|
|
|
|
|
This endpoint generates a performance secondary activation token for the
|
|
|
|
|
cluster with the given opaque identifier, which must be unique. This
|
|
|
|
|
identifier can later be used to revoke a secondary's access.
|
|
|
|
|
|
|
|
|
|
**This endpoint requires 'sudo' capability.**
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
2017-07-27 13:28:52 +00:00
|
|
|
|
| `POST` | `/sys/replication/performance/primary/secondary-token` | `200 application/json` |
|
2017-07-26 20:47:41 +00:00
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `id` `(string: <required>)` – Specifies an opaque identifier, e.g. 'us-east'
|
|
|
|
|
|
|
|
|
|
- `ttl` `(string: "30m")` – Specifies the TTL for the secondary activation
|
|
|
|
|
token.
|
|
|
|
|
|
2017-07-27 13:28:52 +00:00
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"id": "us-east-1"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2017-07-26 20:47:41 +00:00
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
2017-07-27 13:28:52 +00:00
|
|
|
|
--request POST \
|
|
|
|
|
--data @payload.json \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/replication/performance/primary/secondary-token
|
2017-07-26 20:47:41 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"request_id": "",
|
|
|
|
|
"lease_id": "",
|
|
|
|
|
"lease_duration": 0,
|
|
|
|
|
"renewable": false,
|
|
|
|
|
"data": null,
|
|
|
|
|
"warnings": null,
|
|
|
|
|
"wrap_info": {
|
|
|
|
|
"token": "fb79b9d3-d94e-9eb6-4919-c559311133d6",
|
|
|
|
|
"ttl": 300,
|
|
|
|
|
"creation_time": "2016-09-28T14:41:00.56961496-04:00",
|
|
|
|
|
"wrapped_accessor": ""
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Revoke Performance Secondary Token
|
|
|
|
|
|
|
|
|
|
This endpoint revokes a performance secondary's ability to connect to the
|
|
|
|
|
performance primary cluster; the secondary will immediately be disconnected and
|
|
|
|
|
will not be allowed to connect again unless given a new activation token.
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
|
|
|
|
| `POST` | `/sys/replication/performance/primary/revoke-secondary` | `204 (empty body)` |
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `id` `(string: <required>)` – Specifies an opaque identifier, e.g. 'us-east'
|
|
|
|
|
|
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"id": "us-east"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request POST \
|
|
|
|
|
--data @payload.json \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/replication/performance/primary/revoke-secondary
|
2017-07-26 20:47:41 +00:00
|
|
|
|
```
|
|
|
|
|
|
2017-07-27 13:28:52 +00:00
|
|
|
|
## Create Mounts Filter
|
|
|
|
|
|
|
|
|
|
This endpoint is used to modify the mounts that are filtered to a secondary.
|
2017-08-25 13:51:33 +00:00
|
|
|
|
Filtering can be specified in whitelist mode or blacklist mode. In whitelist
|
|
|
|
|
mode the secret and auth mounts that are specified are included to the
|
|
|
|
|
selected secondary. In blacklist mode, the mount paths are excluded.
|
2017-07-27 13:28:52 +00:00
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| :------- | :------------------------------------------------------- | :--------------------- |
|
|
|
|
|
| `POST` | `/sys/replication/performance/primary/mount-filter/:id` | `204 (empty body)` |
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `id` `(string: <required>)` – Specifies an opaque identifier, e.g. 'us-east'
|
|
|
|
|
|
|
|
|
|
- `mode` `(string: "whitelist")` – Specifies the filtering mode. Available values
|
|
|
|
|
are "whitelist" and blacklist".
|
|
|
|
|
|
|
|
|
|
- `paths` `(array: [])` – The list of mount paths that are filtered.
|
|
|
|
|
|
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"mode": "whitelist",
|
|
|
|
|
"paths": ["secret/"]
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request POST \
|
|
|
|
|
--data @payload.json \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/replication/performance/primary/mount-filter/us-east-1
|
2017-07-27 13:28:52 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Read Mounts Filter
|
|
|
|
|
|
|
|
|
|
This endpoint is used to read the mode and the mount paths that are filtered
|
|
|
|
|
for a secondary.
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| :------- | :------------------------------------------------------- | :--------------------- |
|
|
|
|
|
| `GET` | `/sys/replication/performance/primary/mount-filter/:id` | `200 (empty body)` |
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `id` `(string: <required>)` – Specifies an opaque identifier, e.g. 'us-east'
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/replication/performance/primary/mount-filter/us-east-1
|
2017-07-27 13:28:52 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"mode": "whitelist",
|
|
|
|
|
"paths": ["secret/"]
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Delete Mounts Filter
|
|
|
|
|
|
|
|
|
|
This endpoint is used to delete the mount filters for a secondary.
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| :------- | :------------------------------------------------------- | :--------------------- |
|
|
|
|
|
| `DELETE` | `/sys/replication/performance/primary/mount-filter/:id` | `204 (empty body)` |
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `id` `(string: <required>)` – Specifies an opaque identifier, e.g. 'us-east'
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request DELETE \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/replication/performance/primary/mount-filter/us-east-1
|
2017-07-27 13:28:52 +00:00
|
|
|
|
```
|
|
|
|
|
|
2017-07-26 20:47:41 +00:00
|
|
|
|
## Enable Performance Secondary
|
|
|
|
|
|
|
|
|
|
This endpoint enables performance replication on a secondary using a secondary activation
|
|
|
|
|
token.
|
|
|
|
|
|
|
|
|
|
!> This will immediately clear all data in the secondary cluster!
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
|
|
|
|
| `POST` | `/sys/replication/performance/secondary/enable` | `204 (empty body)` |
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `token` `(string: <required>)` – Specifies the secondary activation token fetched from the primary.
|
|
|
|
|
|
|
|
|
|
- `primary_api_addr` `(string: "")` – Set this to the API address (normal Vault
|
|
|
|
|
address) to override the value embedded in the token. This can be useful if
|
|
|
|
|
the primary's redirect address is not accessible directly from this cluster
|
|
|
|
|
(e.g. through a load balancer).
|
|
|
|
|
|
|
|
|
|
- `ca_file` `(string: "")` – Specifies the path to a CA root file (PEM format)
|
|
|
|
|
that the secondary can use when unwrapping the token from the primary. If this
|
|
|
|
|
and ca_path are not given, defaults to system CA roots.
|
|
|
|
|
|
|
|
|
|
- `ca_path` `(string: "")` – Specifies the path to a CA root directory
|
|
|
|
|
containing PEM-format files that the secondary can use when unwrapping the
|
|
|
|
|
token from the primary. If this and ca_file are not given, defaults to system
|
|
|
|
|
CA roots.
|
|
|
|
|
|
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"token": "..."
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request POST \
|
|
|
|
|
--data @payload.json \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/replication/performance/secondary/enable
|
2017-07-26 20:47:41 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Promote Performance Secondary
|
|
|
|
|
|
|
|
|
|
This endpoint promotes the performance secondary cluster to performance primary.
|
|
|
|
|
For data safety and security reasons, new secondary tokens will need to be
|
2017-08-25 13:51:33 +00:00
|
|
|
|
issued to other secondaries, and there should never be more than one performance
|
2017-07-26 20:47:41 +00:00
|
|
|
|
primary at a time.
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
|
|
|
|
| `POST` | `/sys/replication/performance/secondary/promote` | `204 (empty body)` |
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `primary_cluster_addr` `(string: "")` – Specifies the cluster address that the
|
|
|
|
|
primary gives to secondary nodes. Useful if the primary's cluster address is
|
|
|
|
|
not directly accessible and must be accessed via an alternate path/address
|
|
|
|
|
(e.g. through a load balancer).
|
2018-10-01 19:52:44 +00:00
|
|
|
|
- `force` `(bool: false)` - If true the cluster will be promoted even if it fails
|
2018-10-01 20:59:50 +00:00
|
|
|
|
certain safety checks. Caution: Forcing promotion could result in data loss if
|
|
|
|
|
data isn't fully replicated.
|
2017-07-26 20:47:41 +00:00
|
|
|
|
|
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request POST \
|
|
|
|
|
--data @payload.json \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/replication/performance/secondary/promote
|
2017-07-26 20:47:41 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Disable Performance Secondary
|
|
|
|
|
|
|
|
|
|
This endpoint disables performance replication entirely on the cluster. The cluster will no
|
|
|
|
|
longer be able to connect to the performance primary.
|
|
|
|
|
|
|
|
|
|
!> Re-enabling this node as a performance primary or secondary will change its cluster ID;
|
|
|
|
|
in the secondary case this means a wipe of the underlying storage when connected
|
|
|
|
|
to a primary, and in the primary case, secondaries connecting back to the
|
|
|
|
|
cluster (even if they have connected before) will require a wipe of the
|
|
|
|
|
underlying storage.
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
|
|
|
|
| `POST` | `/sys/replication/performance/secondary/disable` | `204 (empty body)` |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request POST \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/replication/performance/secondary/disable
|
2017-07-26 20:47:41 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Update Performance Secondary's Primary
|
|
|
|
|
|
|
|
|
|
This endpoint changes a performance secondary cluster's assigned primary cluster using a
|
|
|
|
|
secondary activation token. This does not wipe all data in the cluster.
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
|
|
|
|
| `POST` | `/sys/replication/performance/secondary/update-primary` | `204 (empty body)` |
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `token` `(string: <required>)` – Specifies the secondary activation token
|
|
|
|
|
fetched from the primary. If you set this to a blank string, the cluster will
|
|
|
|
|
stay a secondary but clear its knowledge of any past primary (and thus not
|
|
|
|
|
attempt to connect to the previous primary). This can be useful if the primary
|
|
|
|
|
is down to stop the secondary from trying to reconnect to it.
|
|
|
|
|
|
|
|
|
|
- `primary_api_addr` `(string: )` – Specifies the API address (normal Vault
|
|
|
|
|
address) to override the value embedded in the token. This can be useful if
|
|
|
|
|
the primary's redirect address is not accessible directly from this cluster.
|
|
|
|
|
|
|
|
|
|
- `ca_file` `(string: "")` – Specifies the path to a CA root file (PEM format)
|
|
|
|
|
that the secondary can use when unwrapping the token from the primary. If this
|
|
|
|
|
and ca_path are not given, defaults to system CA roots.
|
|
|
|
|
|
|
|
|
|
- `ca_path` `string: ()` – Specifies the path to a CA root directory containing
|
|
|
|
|
PEM-format files that the secondary can use when unwrapping the token from the
|
|
|
|
|
primary. If this and ca_file are not given, defaults to system CA roots.
|
|
|
|
|
|
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"token": "..."
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request POST \
|
|
|
|
|
--data @payload.json \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/replication/performance/secondary/update-primary
|
2017-07-26 20:47:41 +00:00
|
|
|
|
```
|