2018-08-28 19:48:02 +00:00
|
|
|
---
|
2020-01-18 00:18:09 +00:00
|
|
|
layout: docs
|
|
|
|
page_title: Performance Standby Nodes - Vault Enterprise
|
|
|
|
description: Performance Standby Nodes - Vault Enterprise
|
2018-08-28 19:48:02 +00:00
|
|
|
---
|
|
|
|
|
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
|
|
|
# Performance Standby Nodes
|
2018-08-28 19:48:02 +00:00
|
|
|
|
2021-09-09 21:36:15 +00:00
|
|
|
-> **Note**: This feature requires [Vault Enterprise Premium](https://www.hashicorp.com/products/vault/).
|
2020-01-25 00:18:22 +00:00
|
|
|
|
2018-08-28 19:48:02 +00:00
|
|
|
Vault supports a multi-server mode for high availability. This mode protects
|
|
|
|
against outages by running multiple Vault servers. High availability mode
|
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
|
|
|
is automatically enabled when using a data store that supports it. You can
|
2020-01-22 20:05:41 +00:00
|
|
|
learn more about HA mode on the [Concepts](/docs/concepts/ha) page.
|
2018-08-28 19:48:02 +00:00
|
|
|
|
|
|
|
Vault Enterprise offers additional features that allow HA nodes to service
|
|
|
|
read-only requests on the local standby node. Read-only requests are requests
|
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
|
|
|
that do not modify Vault's storage.
|
2018-08-28 19:48:02 +00:00
|
|
|
|
|
|
|
## Server-to-Server Communication
|
|
|
|
|
|
|
|
Performance Standbys require the request forwarding method described in the [HA
|
2020-01-22 20:05:41 +00:00
|
|
|
Server-to-Server](/docs/concepts/ha#server-to-server-communication) docs.
|
2018-08-28 19:48:02 +00:00
|
|
|
|
|
|
|
A performance standby will connect to the active node over the existing request
|
|
|
|
forwarding connection. If selected by the active node to be promoted to a
|
|
|
|
performance standby it will be handed a newly-generated private key and certificate
|
|
|
|
for use in creating a new mutually-authenticated TLS connection to the cluster
|
|
|
|
port. This connection will be used to send updates from the active node to the
|
|
|
|
standby.
|
|
|
|
|
|
|
|
## Request Forwarding
|
|
|
|
|
|
|
|
A Performance Standby will attempt to process requests that come in. If a
|
|
|
|
storage write is detected the standby will forward the request over the cluster
|
|
|
|
port connection to the active node. If the request is read-only the Performance
|
|
|
|
Standby will handle the requests locally.
|
|
|
|
|
2018-10-06 05:53:09 +00:00
|
|
|
Sending requests to Performance Standbys that result in forwarded writes will be
|
2018-08-28 19:48:02 +00:00
|
|
|
slightly slower than going directly to the active node. A client that has
|
|
|
|
advanced knowledge of the behavior of the call can choose to point the request
|
|
|
|
to the appropriate node.
|
|
|
|
|
|
|
|
### Direct Access
|
|
|
|
|
|
|
|
A Performance Standby will tag itself as such in consul if service registration
|
|
|
|
is enabled. To access the set of Performance Standbys the `performance-standby`
|
2018-10-06 05:53:09 +00:00
|
|
|
tag can be used. For example to send requests to only the performance standbys
|
2018-08-28 19:48:02 +00:00
|
|
|
`https://performance-standby.vault.dc1.consul` could be used (host name may vary
|
|
|
|
based on consul configuration).
|
|
|
|
|
|
|
|
### Behind Load Balancers
|
|
|
|
|
|
|
|
Additionally, if you wish to point your load balancers at performance standby
|
|
|
|
nodes, the `sys/health` endpoint can be used to determine if a node is a
|
2022-03-18 01:14:48 +00:00
|
|
|
performance standby. See the [sys/health API](/api-docs/system/health) docs for
|
2018-08-28 19:48:02 +00:00
|
|
|
more info.
|
|
|
|
|
|
|
|
## Disabling Performance Standbys
|
|
|
|
|
|
|
|
To disable performance standbys the `disable_performance_standby` flag should be
|
|
|
|
set to true in the Vault config file. This will both tell a standby not to
|
|
|
|
attempt to enable performance mode and an active node to not allow any
|
|
|
|
performance standby connections.
|
|
|
|
|
|
|
|
This setting should be synced across all nodes in the cluster.
|
|
|
|
|
|
|
|
## Monitoring Performance Standbys
|
|
|
|
|
|
|
|
To verify your node is a performance standby the `vault status` command can be
|
|
|
|
used:
|
|
|
|
|
2020-05-21 17:18:17 +00:00
|
|
|
```shell-session
|
2018-08-28 19:48:02 +00:00
|
|
|
$ vault status
|
|
|
|
Key Value
|
|
|
|
--- -----
|
|
|
|
Seal Type shamir
|
|
|
|
Sealed false
|
|
|
|
Total Shares 1
|
|
|
|
Threshold 1
|
|
|
|
Version 0.11.0+prem
|
|
|
|
Cluster Name vault-cluster-d040e74c
|
|
|
|
Cluster ID 9f82e03b-71fb-97a6-9c5a-46fa6715d6e4
|
|
|
|
HA Enabled true
|
|
|
|
HA Cluster https://127.0.0.1:8201
|
|
|
|
HA Mode standby
|
|
|
|
Active Node Address http://127.0.0.1:8200
|
|
|
|
Performance Standby Node true
|
|
|
|
Performance Standby Last Remote WAL 380329
|
|
|
|
```
|