From a4cd4d5a2f64d5c96c2fc2b73df657bf99c9202f Mon Sep 17 00:00:00 2001 From: Matthias Radestock Date: Mon, 6 Jun 2016 11:22:07 +0100 Subject: [PATCH 1/6] tweak plugin pitch --- site/plugin.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/site/plugin.md b/site/plugin.md index bed54551..15aa5095 100644 --- a/site/plugin.md +++ b/site/plugin.md @@ -9,9 +9,10 @@ menu_order: 60 * [Using other plugin command-line arguments](#plugin-args) Docker versions 1.9 and later have a plugin mechanism for adding -different network providers. Weave Net installs itself as a network plugin -when you start it with `weave launch`. The Weave Docker Networking plugin is fast and easy to use and -best of all doesn't require an external cluster store in order to use it. +different network providers. Weave Net installs itself as a network +plugin when you start it with `weave launch`. The Weave Docker +Networking Plugin is fast and easy to use, and, unlike other +networking plugins, does not require an external cluster store. To create a network which can span multiple Docker hosts, Weave Net peers must be connected to each other, by specifying the other hosts during `weave launch` or via [`weave connect`](/site/using-weave/finding-adding-hosts-dynamically.md). From c25281e82728261fb3ec8dc7240f3a40757b64ef Mon Sep 17 00:00:00 2001 From: Matthias Radestock Date: Mon, 6 Jun 2016 11:30:10 +0100 Subject: [PATCH 2/6] remove dead link --- site/plugin.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/site/plugin.md b/site/plugin.md index 15aa5095..593bf36d 100644 --- a/site/plugin.md +++ b/site/plugin.md @@ -107,6 +107,3 @@ route, add the `--no-multicast-route` flag to `weave launch-plugin`. **See Also** * [How the Weave Network Plugin Works](/site/plugin/plugin-how-it-works.md) - * [Plugin Command-line Arguments](/site/plugin/plug-in-command-line.md) - - From 2491f492433fcb813e05f0b8de877814da7933c8 Mon Sep 17 00:00:00 2001 From: Matthias Radestock Date: Mon, 6 Jun 2016 11:32:15 +0100 Subject: [PATCH 3/6] tweak plugin config docs --- site/plugin.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/site/plugin.md b/site/plugin.md index 593bf36d..7d0d0d58 100644 --- a/site/plugin.md +++ b/site/plugin.md @@ -6,7 +6,7 @@ menu_order: 60 * [Launching Weave Net and Running Containers Using the Plugin](#launching) * [Restarting the Plugin](#restarting) * [Bypassing the Central Cluster Store When Building Docker Apps](#cluster-store) - * [Using other plugin command-line arguments](#plugin-args) + * [Configuring the Plugin](#configuring) Docker versions 1.9 and later have a plugin mechanism for adding different network providers. Weave Net installs itself as a network @@ -78,15 +78,16 @@ To run a Docker cluster without a central database, you need to ensure the follo All cross-host coordination is handled by Weave Net's "mesh" communication, using gossipDNS and eventual consistency to avoid the need for constant communication and dependency on a central cluster store. -###Using other plugin command-line arguments +###Configuring the Plugin -If you need to give additional arguments to the plugin independently, don't -use `weave launch`, but instead run: +The plugin accepts a number of configuration parameters. To supply +these, instead of running `weave launch`, start the router and plugin +separately with: $ weave launch-router [other peers] - $ weave launch-plugin [plugin arguments] + $ weave launch-plugin [plugin parameters] -The plugin command-line arguments are: +The plugin configuration parameters are: * `--log-level=debug|info|warning|error` --tells the plugin how much information to emit for debugging. From e7e27796e4434d1ef1a7eb9c3e351420ed5b676a Mon Sep 17 00:00:00 2001 From: Matthias Radestock Date: Mon, 6 Jun 2016 11:32:57 +0100 Subject: [PATCH 4/6] eliminate some duplication in the plugin docs --- site/plugin.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/site/plugin.md b/site/plugin.md index 7d0d0d58..5ef03212 100644 --- a/site/plugin.md +++ b/site/plugin.md @@ -101,10 +101,6 @@ To turn this off, e.g. you want to configure your own multicast route, add the `--no-multicast-route` flag to `weave launch-plugin`. ->Note: When using the Docker Plugin, there is no need to run `eval - $(weave env)` to enable the Proxy. If you do, you may end up with two - weave network interfaces and two IP addresses for each container. - **See Also** * [How the Weave Network Plugin Works](/site/plugin/plugin-how-it-works.md) From 7f5bf67d3375cb68b0eeb2848622cbeac051a518 Mon Sep 17 00:00:00 2001 From: Matthias Radestock Date: Mon, 6 Jun 2016 11:33:38 +0100 Subject: [PATCH 5/6] cosmetic: fix some styling in plugin docs --- site/plugin.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/plugin.md b/site/plugin.md index 5ef03212..6bb2b488 100644 --- a/site/plugin.md +++ b/site/plugin.md @@ -25,7 +25,7 @@ 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. ->**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). +>**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 From aa4980bbda0d71924c19dcd1e4c472e3b9c939cd Mon Sep 17 00:00:00 2001 From: Matthias Radestock Date: Mon, 6 Jun 2016 11:36:18 +0100 Subject: [PATCH 6/6] remove plugin cluster store section it served no purpose and was misleading --- site/plugin.md | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/site/plugin.md b/site/plugin.md index 6bb2b488..c9f7fa3f 100644 --- a/site/plugin.md +++ b/site/plugin.md @@ -5,7 +5,6 @@ menu_order: 60 * [Launching Weave Net and Running Containers Using the Plugin](#launching) * [Restarting the Plugin](#restarting) - * [Bypassing the Central Cluster Store When Building Docker Apps](#cluster-store) * [Configuring the Plugin](#configuring) Docker versions 1.9 and later have a plugin mechanism for adding @@ -67,16 +66,6 @@ If you are using `systemd` with Docker 1.9, it is advised that you modify the Do TimeoutStartSec=0 -###Bypassing the Central Cluster Store When Building Docker Apps - -To run a Docker cluster without a central database, you need to ensure the following: - - 1. Run in "local" scope. This tells Docker to ignore any cross-host coordination. - 2. Allow Weave to handle all the cross-host coordination and to set up all networks. This is done by using the `weave launch` command. - 3. Provide an IP Address Management (IPAM) driver, which links to Weave Net's own IPAM system - -All cross-host coordination is handled by Weave Net's "mesh" communication, using gossipDNS and eventual consistency to avoid the need for constant communication and dependency on a central cluster store. - ###Configuring the Plugin