luxolus/open-vault
2
0
Fork 0
Code Issues 1 Pull requests Releases Activity
open-vault/website/content/api-docs/system/replication/replication-performance.mdx
Bryce Kalow b76a56d40c
feat(website): migrates nav data format and updates docs pages (#11242) 
* migrates nav data format and updates docs pages

* removes sidebar_title from content files
2021-04-06 13:49:04 -04:00

681 lines
20 KiB
Plaintext
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
layout: api
page_title: /sys/replication - HTTP API
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 |
| :----- | :------------------------------------ |
| `GET` | `/sys/replication/performance/status` |
### Sample Request
```shell-session
$ curl \
http://127.0.0.1:8200/v1/sys/replication/performance/status
```
### Sample Response from Primary
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",
"known_secondaries": ["2"],
"last_wal": 87,
"merkle_root": "c31e40f6ff02f32c37b70e6a4d58732ac812abf0",
"mode": "primary",
"secondaries": [
{
"api_address": "https://127.0.0.1:49264",
"cluster_address": "https://127.0.0.1:49267",
"connection_status": "connected",
"last_heartbeat": "2020-06-10T15:40:47-07:00",
"node_id": "2"
}
]
}
}
```
### 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",
"primaries": [
{
"api_address": "https://127.0.0.1:49244",
"cluster_address": "https://127.0.0.1:8201",
"connection_status": "connected",
"last_heartbeat": "2020-06-10T15:40:46-07:00"
}
],
"primary_cluster_addr": "https://127.0.0.1:8201",
"secondary_id": "2",
"state": "stream-wals"
}
}
```
## 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 |
| :----- | :-------------------------------------------- |
| `POST` | `/sys/replication/performance/primary/enable` |
### 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
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/sys/replication/performance/primary/enable
```
## Demote Performance Primary
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),
but will maintain knowledge of its cluster ID and can be reconnected to the same
replication set without wiping local storage.
| Method | Path |
| :----- | :-------------------------------------------- |
| `POST` | `/sys/replication/performance/primary/demote` |
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
http://127.0.0.1:8200/v1/sys/replication/performance/primary/demote
```
## 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 |
| :----- | :--------------------------------------------- |
| `POST` | `/sys/replication/performance/primary/disable` |
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
http://127.0.0.1:8200/v1/sys/replication/performance/primary/disable
```
## 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 |
| :----- | :----------------------------------------------------- |
| `POST` | `/sys/replication/performance/primary/secondary-token` |
### Parameters
- `id` `(string: <required>)` – Specifies an opaque identifier, e.g. 'us-east'
- `ttl` `(string: "30m")` – Specifies the TTL for the secondary activation
token.
- `secondary_public_key` `(string: "")` – Specifies the secondary's generated
public key, if using encryption rather than response wrapping to protect the
secondary credentials. (Vault 1.3+)
### Sample Payload
```json
{
"id": "us-east-1"
}
```
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/sys/replication/performance/primary/secondary-token
```
### 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 |
| :----- | :------------------------------------------------------ |
| `POST` | `/sys/replication/performance/primary/revoke-secondary` |
### Parameters
- `id` `(string: <required>)` – Specifies an opaque identifier, e.g. 'us-east'
### Sample Payload
```json
{
"id": "us-east"
}
```
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/sys/replication/performance/primary/revoke-secondary
```
## Create Paths Filter
This endpoint is used to modify the mounts and namespaces that are filtered to a secondary.
Filtering can be specified in allow mode or deny mode. In allow
mode the secret and auth mounts that are specified are included to the
selected secondary. In deny mode, the mount and namespace paths are excluded.
| Method | Path |
| :----- | :------------------------------------------------------ |
| `POST` | `/sys/replication/performance/primary/paths-filter/:id` |
### Parameters
- `id` `(string: <required>)` – Specifies the unique performance secondary identifier.
- `mode` `(string: "allow")` – Specifies the filtering mode. Available values
are "allow" and "deny".
- `paths` `(array: [])` – The list of mount and namespace paths that are filtered.
### Sample Payload
```json
{
"mode": "allow",
"paths": ["secret/", "ns1/"]
}
```
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/sys/replication/performance/primary/paths-filter/mySecondaryID
```
## Read Paths Filter
This endpoint is used to read the mode and the mount/namespace paths that are filtered
for a secondary.
| Method | Path |
| :----- | :------------------------------------------------------ | ------------------ |
| `GET` | `/sys/replication/performance/primary/paths-filter/:id` | `200 (empty body)` |
### Parameters
- `id` `(string: <required>)` – Specifies the unique performance secondary identifier.
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
http://127.0.0.1:8200/v1/sys/replication/performance/primary/paths-filter/mySecondaryID
```
### Sample Response
```json
{
"mode": "allow",
"paths": ["secret/", "ns1/"]
}
```
## Delete Paths Filter
This endpoint is used to delete the mount and namespace filters for a secondary.
| Method | Path |
| :------- | :------------------------------------------------------ |
| `DELETE` | `/sys/replication/performance/primary/paths-filter/:id` |
### Parameters
- `id` `(string: <required>)` – Specifies the unique performance secondary identifier.
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request DELETE \
http://127.0.0.1:8200/v1/sys/replication/performance/primary/paths-filter/mySecondaryID
```
## Read Dynamically Generated Filter (PRIMARY)
This endpoint is used to read the namespace and the mount paths that are dynamically
filtered for a secondary on the primary.
| Method | Path |
| :----- | :-------------------------------------------------------- | ------------------ |
| `GET` | `/sys/replication/performance/primary/dynamic-filter/:id` | `200 (empty body)` |
### Parameters
- `id` `(string: <required>)` – Specifies the unique performance secondary identifier.
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
http://127.0.0.1:8200/v1/sys/replication/performance/primary/dynamic-filter/mySecondaryID
```
### Sample Response
```json
{
"dynamic_filtered_mounts": ["ns1/ns2/secret/", "ns1/kv/"],
"dynamic_filtered_namespaces": ["ns1/", "ns1/ns2/"]
}
```
## Read Dynamically Generated Filter (SECONDARY)
This endpoint is used to read the namespace and the mount paths that are dynamically
filtered for a secondary on the secondary.
| Method | Path |
| :----- | :---------------------------------------------------------- | ------------------ |
| `GET` | `/sys/replication/performance/secondary/dynamic-filter/:id` | `200 (empty body)` |
### Parameters
- `id` `(string: <required>)` – Specifies the unique performance secondary identifier.
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
http://127.0.0.1:8200/v1/sys/replication/performance/secondary/dynamic-filter/mySecondaryID
```
### Sample Response
```json
{
"dynamic_filtered_mounts": ["ns1/ns2/secret/", "ns1/kv/"],
"dynamic_filtered_namespaces": ["ns1/", "ns1/ns2/"]
}
```
## Create Mounts Filter (DEPRECATED)
~> This API is deprecated and will be removed in a future version of Vault.
Please use Paths Filter instead.
This endpoint is used to modify the mounts that are filtered to a secondary.
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.
| Method | Path |
| :----- | :------------------------------------------------------ |
| `POST` | `/sys/replication/performance/primary/mount-filter/:id` |
### 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
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/sys/replication/performance/primary/mount-filter/us-east-1
```
## Read Mounts Filter (DEPRECATED)
~> This API is deprecated and will be removed in a future version of Vault.
Please use Paths Filter instead.
This endpoint is used to read the mode and the mount paths that are filtered
for a secondary.
| Method | Path |
| :----- | :------------------------------------------------------ | ------------------ |
| `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
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
http://127.0.0.1:8200/v1/sys/replication/performance/primary/mount-filter/us-east-1
```
### Sample Response
```json
{
"mode": "whitelist",
"paths": ["secret/"]
}
```
## Delete Mounts Filter (DEPRECATED)
~> This API is deprecated and will be removed in a future version of Vault.
Please use Paths Filter instead.
This endpoint is used to delete the mount filters for a secondary.
| Method | Path |
| :------- | :------------------------------------------------------ |
| `DELETE` | `/sys/replication/performance/primary/mount-filter/:id` |
### Parameters
- `id` `(string: <required>)` – Specifies an opaque identifier, e.g. 'us-east'
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request DELETE \
http://127.0.0.1:8200/v1/sys/replication/performance/primary/mount-filter/us-east-1
```
## Fetch Performance Secondary Public Key
(Vault 1.3+)
This endpoint allows fetching a public key that is used to encrypt the returned
credential information (instead of using a response wrapped token). This avoids
needing to make an API call to the primary during activation.
| Method | Path |
| :----- | :----------------------------------------------------------- |
| `POST` | `/sys/replication/performance/secondary/generate-public-key` |
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
http://127.0.0.1:8200/v1/sys/replication/performance/secondary/generate-public-key
```
## 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 |
| :----- | :---------------------------------------------- |
| `POST` | `/sys/replication/performance/secondary/enable` |
### 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
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/sys/replication/performance/secondary/enable
```
## 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
issued to other secondaries, and there should never be more than one performance
primary at a time.
| Method | Path |
| :----- | :----------------------------------------------- |
| `POST` | `/sys/replication/performance/secondary/promote` |
### 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).
- `force` `(bool: false)` - If true the cluster will be promoted even if it fails
certain safety checks. Caution: Forcing promotion could result in data loss if
data isn't fully replicated.
### Sample Payload
```json
{}
```
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/sys/replication/performance/secondary/promote
```
## 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 |
| :----- | :----------------------------------------------- |
| `POST` | `/sys/replication/performance/secondary/disable` |
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
http://127.0.0.1:8200/v1/sys/replication/performance/secondary/disable
```
## 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 |
| :----- | :------------------------------------------------------ |
| `POST` | `/sys/replication/performance/secondary/update-primary` |
### 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
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/sys/replication/performance/secondary/update-primary
```
Reference in a new issue View git blame Copy permalink