Skip to content

Commit b36250c

Browse files
committed
WAN Fed and disaster recovery content
1 parent 2b92103 commit b36250c

File tree

12 files changed

+613
-619
lines changed

12 files changed

+613
-619
lines changed

content/consul/v1.22.x/content/commands/force-leave.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ consul force-leave ec2-001-staging
5757
```
5858

5959
When run on a server that is part of a
60-
[WAN gossip pool](/consul/tutorials/networking/federation-gossip-wan),
60+
[WAN gossip pool](/consul/docs/east-west/wan-federation/vms),
6161
`force-leave` can remove failed servers in other datacenters from the WAN pool.
6262

6363
The identifying node-name in a WAN pool is `[node-name].[datacenter]`.

content/consul/v1.22.x/content/docs/east-west/mesh-gateway/federation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Ensure that your Consul environment meets the following requirements.
3131
* A local Consul agent is required to manage its configuration.
3232
* Consul [service mesh](//consul/docs/reference/agent/configuration-file/service-mesh#connect) must be enabled in both datacenters.
3333
* Each [datacenter](/consul/docs/reference/agent/configuration-file/general#datacenter) must have a unique name.
34-
* Each datacenters must be [WAN joined](/consul/tutorials/networking/federation-gossip-wan).
34+
* Each datacenters must be [WAN joined](/consul/docs/east-west/wan-federation/vms ).
3535
* The [primary datacenter](/consul/docs/reference/agent//configuration-file/general#primary_datacenter) must be set to the same value in both datacenters. This specifies which datacenter is the authority for service mesh certificates and is required for services in all datacenters to establish mutual TLS with each other.
3636
* [gRPC](/consul/docs/reference/agent/configuration-file/general#grpc_port) must be enabled.
3737
* If you want to [enable gateways globally](/consul/docs/connect/gateways/mesh-gateway/service-to-service-traffic-wan-datacenters#enabling-gateways-globally) you must enable [centralized configuration](/consul/docs/reference/agent/configuration-file/general#enable_central_service_config).

content/consul/v1.22.x/content/docs/error-messages/consul.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,12 +165,14 @@ When restoring a Consul datacenter with a snapshot on new infrastructure, Consul
165165

166166
This error means that in the new datacenter there is at least one node with the same `node_name` as a node in the snapshot's datacenter, but with a different `node_id`. This represents a consistency issue.
167167

168-
There are two possible workarounds:
168+
There are three possible workarounds:
169169

170170
1. Save the UUID from the previous node’s data directory. Then re-use that same UUID when you first start the agent on the new node. You can configure node IDs for your Consul agent nodes with the [`node_id` configuration parameter](/consul/docs/reference/agent/configuration-file/node#_node_id).
171171

172172
1. Always use unique node names for your Consul datacenters so that there is no risk of conflicts. You can configure node names for your Consul agent nodes using the [`node_name`](/consul/docs/reference/agent/configuration-file/node#_node) configuration parameter.
173173

174+
1. Perform a [`consul leave`](/consul/commands/leave) on each server and then start the server again. Do this one server at a time. Once all servers are restarted, the node ids will be set to the expected value, resolving the errors in the logs.
175+
174176
## ACL not found
175177

176178
If Consul returns the following error, this indicates that you have ACL enabled in your cluster but you aren't passing a valid token.

content/consul/v1.22.x/content/docs/manage/disaster-recovery/backup-restore.mdx

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,16 @@ To reduce the burden on the leader, it is possible to [run the snapshot command
3535

3636
However, we still recommend you take `consistent` snapshots for write-heavy production use cases, or when you want to snapshot a cluster state immediately after a specific change.
3737

38+
3839
## Workflow
3940

4041
1. **Backup the Consul datacenter**: Use the `consul snapshot save` command to create a backup of the Consul datacenter.
4142
1. **Verify the backup**: Inspect the backup file to ensure it was created successfully.
4243
1. **Restore from snapshot**: Use the `consul snapshot restore` command to restore the Consul datacenter from the backup.
4344

4445

45-
4646
## Backup a Consul datacenter
4747

48-
4948
Run the basic snapshot command on one of the servers. Because it uses the default settings, this request runs in `consistent` mode.
5049

5150
```shell-session
@@ -68,6 +67,11 @@ Version 1
6867

6968
For more information about the `snapshot inspect` sub-command and its output, refer to the [`consul snapshot inspect` CLI documentation](/consul/commands/snapshot/inspect).
7069

70+
<Warning heading="Security warning">
71+
72+
Consul snapshots contain extremely sensitive data, such as credentials in recoverable form. Store snapshots on an encrypted medium with sufficiently strict access controls in place.
73+
74+
</Warning>
7175

7276

7377
## Restore a Consul datacenter
@@ -83,10 +87,9 @@ $ consul snapshot restore backup.snap
8387
Restored snapshot
8488
```
8589

86-
8790
## Additional guidance
8891

8992
For more information on disaster recovery, including detailed instructions on how to backup and restore Consul datacenters, refer to the following resources:
9093

9194
- [Consul Disaster Recovery](/consul/docs/manage/disaster-recovery)
92-
- [Disaster recovery for WAN-federated datacenters](/consul/docs/manage/disaster-recovery/federation)
95+
- [Disaster recovery for WAN-federated datacenters](/consul/docs/manage/disaster-recovery/restore/secondary)

0 commit comments

Comments
 (0)