From 912908c0356a53a073cb2726378b15f69aaa2451 Mon Sep 17 00:00:00 2001 From: Armon Dadgar Date: Thu, 5 Jun 2014 22:46:11 -0700 Subject: [PATCH] website: Clarify outage vs forced server removal --- website/source/docs/guides/outage.html.markdown | 6 ++++++ website/source/docs/guides/servers.html.markdown | 15 +++++++++++++++ 2 files changed, 21 insertions(+) diff --git a/website/source/docs/guides/outage.html.markdown b/website/source/docs/guides/outage.html.markdown index 49d9764191..dc4c1fcd55 100644 --- a/website/source/docs/guides/outage.html.markdown +++ b/website/source/docs/guides/outage.html.markdown @@ -11,6 +11,12 @@ Do not panic! This is a critical first step. Depending on your take only a single server failure for cluster unavailability. Recovery requires an operator to intervene, but is straightforward. +
+This page covers recovery from Consul becoming unavailable due to a majority +of server nodes in a datacenter being lost. If you are just looking to +add or remove a server [see this page](/docs/guides/servers.html). +
+ If you had only a single server and it has failed, simply restart it. Note that a single server configuration requires the `-bootstrap` flag. If that server cannot be recovered, you need to bring up a new server. diff --git a/website/source/docs/guides/servers.html.markdown b/website/source/docs/guides/servers.html.markdown index a1d207fbeb..ba0a7e280b 100644 --- a/website/source/docs/guides/servers.html.markdown +++ b/website/source/docs/guides/servers.html.markdown @@ -102,3 +102,18 @@ The leader should also emit various logs including: At this point the node has been gracefully removed from the cluster, and will shut down. + +## Forced Removal + +In some cases, it may not be possible to gracefully remove a server. For example, +if the server simply fails, then there is no ability to issue a leave. Instead, +the cluster will detect the failure and replication will continuously retry. + +If the server can be recovered, it is best to bring it back online and then gracefully +leave the cluster. However, if this is not a possibility, then the `force-leave` command +can be used to force removal of a server. + +This is done by invoking that command with the name of the failed node. At this point, +the cluster leader will mark the node as having left the cluster and it will stop attempting +to replicate. +