From c2eb900dd34cd8bbac0659d127c053df202fd8e4 Mon Sep 17 00:00:00 2001 From: Adam Harrison Date: Mon, 21 Mar 2016 14:58:14 +0000 Subject: [PATCH] Correct IPAM state docs --- site/ipam.md | 32 +++++++++++++++++++------------- site/troubleshooting.md | 2 +- 2 files changed, 20 insertions(+), 14 deletions(-) diff --git a/site/ipam.md b/site/ipam.md index 74288e93..5b00a0a5 100644 --- a/site/ipam.md +++ b/site/ipam.md @@ -48,17 +48,6 @@ time, you can give the number of peers like this: host3$ weave launch --init-peer-count 3 $HOST2 -The consensus mechanism used to determine a majority transitions -through three states: 'deferred', 'waiting' and 'achieved': - -* 'deferred' - no allocation requests or claims have been made yet; - consensus is deferred until then -* 'waiting' - an attempt to achieve consensus is ongoing, triggered by - an allocation or claim request; allocations will block. This state - persists until a quorum of peers are able to communicate amongst - themselves successfully -* 'achieved' - consensus achieved; allocations proceed normally - ### More on `--init-peer-count` TL;DR: it isn't a problem to over-estimate by a bit, but if you supply @@ -214,7 +203,7 @@ reports on the current status of the weave router and IP allocator: ... Service: ipam - Consensus: waiting(quorum: 2, known: 0) + Status: awaiting consensus (quorum: 2, known: 0) Range: 10.32.0.0-10.47.255.255 DefaultSubnet: 10.32.0.0/12 @@ -225,4 +214,21 @@ The first section covers the router; see the [troubleshooting guide](troubleshooting.html#weave-status) for full details. The 'Service: ipam' section displays the consensus state as well as -the total allocation range and default subnet. +the total allocation range and default subnet. Columns are as follows: + +* 'Status' - allocator state + * 'idle' - no allocation requests or claims have been made yet; + consensus is deferred until then + * 'awaiting consensus' - an attempt to achieve consensus is + ongoing, triggered by an allocation or claim request; + allocations will block. This state persists until a quorum of + peers are able to communicate amongst themselves successfully + * 'ready' - consensus achieved; allocations proceed normally + * 'waiting for IP range grant from peers' - peer has exhausted its + agreed portion of the range and is waiting to be granted some + more + * 'all IP ranges owned by unreachable peers' - peer has exhausted + its agreed portion of the range but cannot reach anyone to ask + for more +* 'Range' - total allocation range set by `--ipalloc-range` +* 'DefaultSubnet' - default subnet set by `--ipalloc-default-subnet` diff --git a/site/troubleshooting.md b/site/troubleshooting.md index c258651a..7f24b747 100644 --- a/site/troubleshooting.md +++ b/site/troubleshooting.md @@ -62,7 +62,7 @@ $ weave status TrustedSubnets: none Service: ipam - Consensus: achieved + Status: ready Range: 10.32.0.0-10.47.255.255 DefaultSubnet: 10.32.0.0/12