diff --git a/prog/weaver/main.go b/prog/weaver/main.go index 3d2c1fa3..210f5bf2 100644 --- a/prog/weaver/main.go +++ b/prog/weaver/main.go @@ -194,7 +194,7 @@ func main() { peers = mflag.Args() if resume && len(peers) > 0 { - Log.Fatalf("You must not specify an initial peer list in conjuction with --resume") + Log.Fatalf("You must not specify an initial peer list in conjunction with --resume") } common.SetLogLevel(logLevel) diff --git a/site/features.md b/site/features.md index 2c48ab03..2c1448ea 100644 --- a/site/features.md +++ b/site/features.md @@ -88,11 +88,6 @@ Using the Weave plugin enables you to take advantage of [Docker's network functi Also, Weave’s Docker Network plugin doesn't require an external cluster store and you can start and stop containers even when there are network connectivity problems. - - ->*Note:* The plugin is an *alternative* to the proxy, and therefore you do -*not* need to run `eval $(weave env)` beforehand. - See [Using the Weave Docker Network Plugin](/site/plugin.md) for more details. diff --git a/site/operational-guide.md b/site/operational-guide.md index b0cc8ac6..bba5f42d 100644 --- a/site/operational-guide.md +++ b/site/operational-guide.md @@ -1,5 +1,32 @@ --- title: Operational Guide -menu_order: 35 +menu_order: 45 --- -Operations manual. +This operational guide is intended to give you an overview of how to +operate and manage a Weave Network in production. It consists of three +main parts: + +* A [glossary of concepts](/site/operational-guide/concepts.md) with + which you will need to be familiar +* Detailed instructions for safely bootstrapping, growing and + shrinking Weave networks in a number of different deployment + scenarios: + * An [interactive + installation](/site/operational-guide/interactive.md), suitable + for evaluation and development + * A [uniformly configured + cluster](/site/operational-guide/uniform-fixed-cluster.md) with + a fixed number of initial nodes, suitable for automated + provisioning but requiring manual intervention for resizing + * A [heterogenous cluster](/site/operational-guide/autoscaling.md) + comprising fixed and autoscaling components, suitable for a base + load with automated scale-out/scale-in + * A [uniformly configured + cluster](/site/operational-guide/uniform-dynamic-cluster.md) + with dynamic nodes, suitable for automated provisioning and + resizing. +* A list of [common administrative + tasks](/site/operational-guide/tasks.md), such as configuring Weave + Net to start on boot, upgrading clusters, cleaning up peers and + reclaiming IP address space + diff --git a/site/operational-guide/concepts.md b/site/operational-guide/concepts.md index e087fe59..c2584120 100644 --- a/site/operational-guide/concepts.md +++ b/site/operational-guide/concepts.md @@ -6,18 +6,30 @@ This section describes some of the essential concepts with which you will need to be familiar before continuing to the example deployment scenarios. -## Host +The following concepts are described: + + * [Host](#host) + * [Peer](#peer) + * [Peer Discovery](#peer-discovery) + * [Network Partition](#network-partition) + * [IP Address Manager- IPAM](#ip-address-manager) + * [Seeding](#seeding) + * [Consensus](#consensus) + * [Observers](#observers) + * [Persistence](#persistence) + +##Host For the purposes of this documentation a host is an installation of the Linux operating system that is running an instance of the Docker Engine. The host may be executing directly on bare hardware or inside a virtual machine. -## Peer +##Peer A peer is a running instance of Weave Net, typically one per host. -## Peer Name +##Peer Name Weave Net peers are identified by a 48-bit value formatted like an ethernet MAC address, for example, `01:23:45:67:89:ab`. The 'peer @@ -50,14 +62,14 @@ The appropriate strategy for assigning peer names depends on the type and method of your particular deployment and is discussed in more detail below. -## Peer Discovery +##Peer Discovery Peer discovery is a mechanism that allows peers to learn about new Weave Net hosts from existing peers without being explicitly told. Peer discovery is [enabled by default](/site/using-weave/finding-adding-hosts-dynamically.md). -## Network Partition +##Network Partition A network partition is a transient condition whereby some arbitrary subsets of peers are unable to communicate with each other for the @@ -66,7 +78,7 @@ optic line severed. Weave Net is designed to allow peers and their containers to make maximum safe progress under conditions of partition, healing automatically once the partition is over. -## IP Address Manager (IPAM) +##IP Address Manager (IPAM) [IPAM](/site/ipam.md) is the subsystem responsible for dividing up a large contiguous block of IP addresses (known as the IP allocation @@ -77,7 +89,7 @@ When a new network is formed an initial division of the IP allocation range must be made. Two (mutually exclusive) mechanisms with different tradeoffs are provided to perform this task: seeding and consensus. -### Seeding +### Seeding Seeding requires each peer to be told the list of peer names amongst which the address space is to be divided initially. There are some @@ -100,7 +112,7 @@ scenarios: * [Uniform Dynamic Cluster](/site/operational-guide/uniform-dynamic-cluster.md) -### Consensus +###Consensus Alternatively, when a new network is formed for the first time, peers can be configured to co-ordinate amongst themselves to automatically @@ -116,7 +128,7 @@ scenarios: * [Interactive Deployment](/site/operational-guide/interactive.md) * [Uniform Fixed Cluster](/site/operational-guide/uniform-fixed-cluster.md) -### Observers +###Observers Finally, an option is provided to start a peer as an _observer_. Such peers do not require a seed peer name list or an initial peer @@ -130,7 +142,7 @@ scenarios: * [Autoscaling](/site/operational-guide/autoscaling.md) -## Persistence +##Persistence Certain information is remembered between launches of Weave Net (for example across reboots): diff --git a/site/plugin.md b/site/plugin.md index d3c4e8dc..64f4bb07 100644 --- a/site/plugin.md +++ b/site/plugin.md @@ -25,8 +25,6 @@ After you've launched Weave Net and peered your hosts, you can start containers on any of the hosts, and they can all communicate with each other using any protocol, even multicast. ->**Warning!** It is inadvisable to attach containers to the Weave network using the Weave Docker Networking Plugin and Weave Docker API Proxy simultaneously. Such containers will end up with two Weave network interfaces and two IP addresses, which is rarely desirable. To ensure that the proxy is not being used, do not run `eval $(weave env)`, or `docker $(weave config) ...`. - In order to use Weave Net's [Service Discovery](/site/weavedns.md) you must pass the additional arguments `--dns` and `-dns-search`, for which a helper is provided in the Weave script: diff --git a/site/using-weave.md b/site/using-weave.md index f71de569..cb9d3cda 100644 --- a/site/using-weave.md +++ b/site/using-weave.md @@ -50,9 +50,6 @@ Where, > modify environment entries and hence they all need to be executed from > the same shell. -> **Important!** If you intend to use the -> [Weave Docker Network Plugin](/site/plugin.md) do not run `eval $(weave env)`. - Weave Net must be launched once per host. The relevant container images will be pulled down from Docker Hub on demand during `weave launch`. You can also preload the images by running `weave setup`. Preloaded images are useful for automated deployments, and ensure there are no delays during later operations.