Skip to content

Commit 2c415ee

Browse files
authored
Merge branch 'main' into waf-seo-improvements-2
2 parents a1d659a + 326f938 commit 2c415ee

File tree

48 files changed

+1801
-215
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+1801
-215
lines changed

content/boundary/v0.20.x/content/docs/client-agent/configuration.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,14 @@ The configuration file contains the following fields:
7070
log_to_stdout=false
7171
```
7272

73+
- `operational_state_file` - Specifies the file that tracks the Client Agent's operational state, or whether it is running or paused.
74+
The Client Agent uses this file to persist the operational state across restarts.
75+
76+
Example:
77+
```hcl
78+
operational_state_file= "/Library/Application\ /Support/HashiCorp/Boundary/boundary-client-agent-operational-state.json"
79+
```
80+
7381
- `override_upstream_dns_servers` - Lists the DNS servers that should be used for recursing non-Boundary requests, overriding those configured on the system.
7482

7583
Example:

content/boundary/v0.20.x/content/docs/release-notes/v0_20_0.mdx

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,5 +223,27 @@ description: >-
223223
</td>
224224
</tr>
225225

226+
<tr>
227+
<td style={{verticalAlign: 'middle'}}>
228+
Client Agent 0.1.4 - 0.20.0
229+
<br /><br />
230+
(Fixed in Client Agent version 0.20.1)
231+
</td>
232+
<td style={{verticalAlign: 'middle'}}>
233+
Boundary Client Agent does not maintain its operational state after a restart
234+
</td>
235+
<td style={{verticalAlign: 'middle'}}>
236+
If you paused the Boundary Client Agent and then restarted the system or the Client Agent, the Client Agent ignored the pause command and resumed running after the restart.
237+
<br /><br />
238+
This known issue was resolved in Client Agent version 0.20.1. The Client Agent now tracks the operational state in a file so that it persists across restarts. You can configure where the file resides in the <code>boundary-client-agent.hcl</code> configuration. Now, if you pause the Client Agent and then restart the system or the Client Agent, the Client Agent remains paused after the restart.
239+
<br /><br />
240+
Install the latest version of the Client Agent to ensure the operational state persists through restarts.
241+
<br /><br />
242+
Learn more: <a href="/boundary/docs/client-agent/configuration">Configure the Client Agent</a> or <a href="/boundary/docs/client-agent/manage">Manage the Client Agent</a>
243+
<br /><br />
244+
<a href="/boundary/docs/deploy/self-managed/install-clients">Install the latest version of the Boundary Client Agent</a>
245+
</td>
246+
</tr>
247+
226248
</tbody>
227249
</table>

content/consul/v1.22.x/content/docs/hcp.mdx

Lines changed: 334 additions & 0 deletions
Large diffs are not rendered by default.

content/consul/v1.22.x/data/docs-nav-data.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2552,6 +2552,10 @@
25522552
"path": "openshift"
25532553
}
25542554
]
2555+
},
2556+
{
2557+
"title": "HCP Consul Dedicated",
2558+
"path": "hcp"
25552559
},
25562560
{
25572561
"divider": true
Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
---
2+
page_title: Enable cross region disaster recovery
3+
sidebar_title: Enable cross region disaster recovery
4+
description: >-
5+
Enable disaster recovery for your HCP Vault Dedicated cluster.
6+
---
7+
8+
# Enable HCP Vault Dedicated cross region disaster recovery
9+
10+
<Highlight title="Production tier feature">
11+
12+
Cross region disaster recovery is available on HCP Vault Dedicated essential and
13+
standard tier clusters.
14+
15+
</Highlight>
16+
17+
HCP Vault Dedicated supports disaster recovery (DR) replication to a different region
18+
without having to manually manage the setup, failover, or failback.
19+
20+
## What is cross region disaster recovery?
21+
22+
Cross region disaster recovery replicates data from your primary cluster to a
23+
secondary cluster in a different region. Unlike self-managed Vault, cross-region
24+
disaster recovery is managed by the HCP platform.
25+
26+
![Diagram explaining cross region disaster recovery replicating from the primary
27+
cluster to the disaster recovery cluster](/img/docs/vault/diagram-dr-replication-dark.png#dark-theme-only)
28+
![Diagram explaining cross region disaster recovery replicating from the primary
29+
cluster to the disaster recovery cluster](/img/docs/vault/diagram-dr-replication-light.png#light-theme-only)
30+
31+
The primary cluster is the system of record. Data streams
32+
from the primary cluster to the secondary cluster. You can configure the primary
33+
cluster to stream data to both disaster recovery secondary clusters and [performance
34+
replication clusters](/hcp/docs/vault/perf-replication).
35+
36+
You can create a cross region DR cluster by selecting a **Backup network** for
37+
new, or existing essentials or plus tier clusters.
38+
39+
## How does cross region disaster recovery work?
40+
41+
The HashiCorp Cloud Platform automates the creation of the secondary cluster and
42+
the replication of data from the primary cluster to the secondary cluster.
43+
44+
HashiCorp manages the full disaster recovery lifecycle, including:
45+
46+
1. Monitoring the health of every HCP region and availability zone.
47+
48+
1. Working with each cloud provider during an outage to determine if a disaster
49+
event is occurring, or if the outage is temporary.
50+
51+
1. If a disaster event is occurring, HashiCorp initiates and manages a failover
52+
to the secondary cluster.
53+
54+
1. The secondary cluster becomes accessible to your clients using the same
55+
address as the primary cluster. You do not need to make changes to your clients.
56+
57+
1. When the cloud provider resolves the issue, HashiCorp initiates and manages a failback
58+
to the primary cluster.
59+
60+
## Enable cross region disaster recovery
61+
62+
Before you begin, ensure you have a [HashiCorp Virtual Network
63+
(HVN)](/hcp/docs/hcp/network) created in the region you want to deploy the DR
64+
secondary cluster.
65+
66+
The HVN for the DR secondary cluster must:
67+
68+
- Be in a different region than the primary HVN.
69+
- Use a non-overlapping CIDR block than the primary HVN.
70+
71+
If the HVN for the DR cluster is in the same region, or the CIDR block overlaps
72+
with the primary cluster's HVN, you will not be able to enable cross region
73+
disaster recovery.
74+
75+
<Tabs>
76+
<Tab heading="New cluster">
77+
78+
1. Log into the HCP Portal.
79+
80+
1. Click **Vault Dedicated**.
81+
82+
1. From the **Vault overview** page click **Create cluster**.
83+
84+
1. Under **Vault tier**, select **Essentials** or **Standard**.
85+
86+
1. Under **Network**, select the HVN for the primary cluster.
87+
88+
1. Click the toggle switch for **Backup network**.
89+
90+
1. Click the pull-down menu and select the HVN for the DR secondary cluster.
91+
92+
1. Click **Create cluster**.
93+
94+
The HCP Platform creates the cluster and configures cross region disaster recovery
95+
between the primary and DR secondary cluster.
96+
97+
</Tab>
98+
<Tab heading="Existing cluster">
99+
100+
<Warning title="Expected downtime">
101+
102+
When you enable cross region disaster recovery for an existing cluster, the
103+
cluster is unavailable for approximately 10 minutes while the HCP Platform
104+
configures the cluster for cross region disaster recovery.
105+
106+
</Warning>
107+
108+
1. Log into the HCP Portal.
109+
110+
1. Click **Vault Dedicated**.
111+
112+
1. From the **Vault overview** page click the cluster you want to enable
113+
cross region disaster recovery for.
114+
115+
1. Click the **Manage** pull-down menu and select **Edit configuration**.
116+
117+
1. Click the toggle switch for **Backup network**.
118+
119+
1. Click the pull-down menu and select the HVN for the DR secondary cluster.
120+
121+
1. Click **Next**.
122+
123+
1. Review the changes and click **Apply changes**.
124+
125+
The HCP Platform creates the cluster and configures cross region disaster recovery
126+
between the primary and DR secondary cluster.
127+
128+
</Tab>
129+
</Tabs>
130+
131+
## Test cross region disaster recovery
132+
133+
If you would like to test the disaster recovery process, [contact HCP
134+
support](https://support.hashicorp.com/hc/en-us/requests/new) to initiate a
135+
failover.
136+
137+
## Audit log and metric monitoring during a disaster event
138+
139+
During the failover, the HCP Platform continues to send audit
140+
logs and metrics to the same destinations as the primary cluster. However, you
141+
must update or create DR cluster specific queries or alerts using the ID of the
142+
DR secondary cluster.
143+
144+
To retrieve the DR secondary cluster's ID:
145+
146+
1. From the primary Vault cluster's **Overview** page, click the name of the **Backup
147+
network** in the **Cluster networking** pane.
148+
149+
1. Click **Connected clusters** in the left navigation menu.
150+
151+
1. Set any queries or alerts that rely on the primary cluster's ID to the
152+
**Resource** value of the DR secondary cluster.
153+
154+
## Tutorial
155+
156+
- [Get started with HCP Vault Dedicated](/vault/tutorials/get-started-hcp-vault-dedicated)
157+
- [Well-Architected Framework - Disaster recovery](/well-architected-framework/design-resilient-systems/principles/disaster-recovery)

content/hcp-docs/data/docs-nav-data.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -597,6 +597,10 @@
597597
"title": "Configure private DNS forwarding<sup>Beta</sup>",
598598
"path": "vault/private-dns"
599599
},
600+
{
601+
"title": "Enable cross region disaster recovery",
602+
"path": "vault/cross-region-disaster-recovery"
603+
},
600604
{
601605
"title": "Enable performance replication",
602606
"path": "vault/perf-replication"
29.1 KB
Loading
27.3 KB
Loading

content/hcp-docs/redirects.jsonc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -624,7 +624,12 @@
624624
},
625625
{
626626
"source": "/hcp/docs/consul/:slug*",
627-
"destination": "/hcp/docs/changelog#2025-11-12",
627+
"destination": "/consul/docs/hcp",
628628
"permanent": true,
629+
},
630+
{
631+
"source": "/consul/docs/:version(v1\\.(?:18|19|20)\\.x)/hcp",
632+
"destination": "/consul/docs/hcp",
633+
"permanent": true
629634
}
630635
]

0 commit comments

Comments
 (0)