From 5c8f6175b5fb30a26403b925d1c72dd2b334cec5 Mon Sep 17 00:00:00 2001 From: abuehrle Date: Tue, 2 Aug 2016 12:34:52 -0500 Subject: [PATCH 1/8] added note about net flag --- site/weave-docker-api.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/site/weave-docker-api.md b/site/weave-docker-api.md index 179948b0..fb98ec26 100644 --- a/site/weave-docker-api.md +++ b/site/weave-docker-api.md @@ -10,6 +10,21 @@ network when they are started using the ordinary Docker or the [remote API](https://docs.docker.com/reference/api/docker_remote_api/), instead of `weave run`. +###Attaching Containers to a Weave Network + +There are two ways to attach containers to a Weave network, +the first uses the Weave Net Docker API Proxy, and is described in this section. +The other method uses the Docker network plugin framework. It’s your choice which method to use. + +To use the Docker Network Plugin launch Weave with the --net flag. Note that once +you’ve launched Weave with this flag the Proxy is automatically disabled. + +For more information about using the Network Plugin, see +[Integrating Docker via the Network Plugin](plugin.md). + +For more information about using the Weave Docker +API proxy then read on. + ###Setting Up The Weave Net Docker API Proxy From 358fddb95814ee235ce53ae796fffd4917dac52a Mon Sep 17 00:00:00 2001 From: abuehrle Date: Tue, 2 Aug 2016 12:52:36 -0500 Subject: [PATCH 2/8] fixed broken link and title --- site/plugin/plugin-how-it-works.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/site/plugin/plugin-how-it-works.md b/site/plugin/plugin-how-it-works.md index 54d9f26a..d04f9c2b 100644 --- a/site/plugin/plugin-how-it-works.md +++ b/site/plugin/plugin-how-it-works.md @@ -38,6 +38,5 @@ The plugin accepts the following options via `docker network create ... --opt`: **See Also** - * [Using the Weave Net Docker Network Plugin](/site/plugin.md) - * [Plugin Command-line Arguments](/site/plugin/plug-in-command-line.md) - + * [Integrating Docker via the Network Plugin](/site/plugin.md) + From 74b20265e43d0083cf151d591d9af2ab6800e79b Mon Sep 17 00:00:00 2001 From: abuehrle Date: Tue, 2 Aug 2016 12:59:27 -0500 Subject: [PATCH 3/8] fixed links and some titles --- site/features.md | 10 +++++----- site/weavedns.md | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/site/features.md b/site/features.md index 2c1448ea..3a987960 100644 --- a/site/features.md +++ b/site/features.md @@ -73,7 +73,7 @@ Containers started in this way that subsequently restart, either by an explicit `docker restart` command or by Docker restart policy, are re-attached to the Weave network by the `Weave Docker API Proxy`. -See [Using the Weave Docker API Proxy](/site/weave-docker-api/using-proxy.md). +See [Integrating Docker via the API Proxy](/site/weave-docker-api.md). ###Weave Network Docker Plugin @@ -88,14 +88,14 @@ 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. -See [Using the Weave Docker Network Plugin](/site/plugin.md) for more details. +See [Integrating Docker via the Network Plugin](/site/plugin.md) for more details. ###Weave Network CNI Plugin -Weave can be used as a plugin to systems that support the [Container Network Interface](https://github.com/appc/cni), such as Kubernetes. +Weave can be used as a plugin to systems that support the [Container Network Interface](https://github.com/appc/cni), such as Kubernetes and Mesosphere. -See [Using the Weave CNI Plugin](/site/cni-plugin.md) for more details. +See [Integrating Kubernetes and Mesos via the CNI Plugin](/site/cni-plugin.md) for more details. ###IP Address Management (IPAM) @@ -120,7 +120,7 @@ and are discoverable by using standard, simple name lookups: WeaveDNS also supports [load balancing](/site/weavedns/load-balance-fault-weavedns.md), [fault resilience](/site/weavedns/load-balance-fault-weavedns.md) and [hot swapping](/site/weavedns/managing-entries-weavedns.md). -See [Naming and discovery with WeaveDNS](/site/weavedns/how-works-weavedns.md). +See [Discovering Containers with WeaveDNS](/site/weavedns.md). ###Application Isolation diff --git a/site/weavedns.md b/site/weavedns.md index 2e21d507..d9f42eb6 100644 --- a/site/weavedns.md +++ b/site/weavedns.md @@ -44,5 +44,5 @@ disable weaveDNS itself, launch weave with the `--no-dns` option. **See Also** - * [How Weave Finds Containers](/site/weave-docker-api.md) + * [Integrating Docker via the API Proxy](/site/weave-docker-api.md) * [Load Balancing and Fault Resilience with WeaveDNS](/site/weavedns/load-balance-fault-weavedns.md) From 39b80f26ed3602550a5ee208d09e9f8412e183c8 Mon Sep 17 00:00:00 2001 From: abuehrle Date: Tue, 2 Aug 2016 13:15:17 -0500 Subject: [PATCH 4/8] made terminology consistent --- site/weave-docker-api.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/site/weave-docker-api.md b/site/weave-docker-api.md index fb98ec26..3189ef0c 100644 --- a/site/weave-docker-api.md +++ b/site/weave-docker-api.md @@ -14,10 +14,10 @@ instead of `weave run`. There are two ways to attach containers to a Weave network, the first uses the Weave Net Docker API Proxy, and is described in this section. -The other method uses the Docker network plugin framework. It’s your choice which method to use. +The other method uses the Docker Network Plugin framework. It’s your choice which method to use. -To use the Docker Network Plugin launch Weave with the --net flag. Note that once -you’ve launched Weave with this flag the Proxy is automatically disabled. +To use the Docker Network Plugin, launch Weave with the --net flag. Note that after +you’ve launched Weave Net with this flag, then the Weave Docker API Proxy is automatically disabled. For more information about using the Network Plugin, see [Integrating Docker via the Network Plugin](plugin.md). From 0b49c961a7563905d8772df15fee16ea2a796a0c Mon Sep 17 00:00:00 2001 From: abuehrle Date: Tue, 2 Aug 2016 16:30:32 -0500 Subject: [PATCH 5/8] reconfigured note to include additional method --- site/weave-docker-api.md | 32 +++++++++++++++++++++----------- 1 file changed, 21 insertions(+), 11 deletions(-) diff --git a/site/weave-docker-api.md b/site/weave-docker-api.md index 3189ef0c..98179dda 100644 --- a/site/weave-docker-api.md +++ b/site/weave-docker-api.md @@ -3,30 +3,40 @@ title: Integrating Docker via the API Proxy menu_order: 50 --- - The Docker API proxy automatically attaches containers to the Weave network when they are started using the ordinary Docker [command-line interface](https://docs.docker.com/reference/commandline/cli/) or the [remote API](https://docs.docker.com/reference/api/docker_remote_api/), instead of `weave run`. + ###Attaching Containers to a Weave Network -There are two ways to attach containers to a Weave network, -the first uses the Weave Net Docker API Proxy, and is described in this section. -The other method uses the Docker Network Plugin framework. It’s your choice which method to use. +There are three ways to attach containers to a Weave network (which method to use is +entirely up to you): -To use the Docker Network Plugin, launch Weave with the --net flag. Note that after -you’ve launched Weave Net with this flag, then the Weave Docker API Proxy is automatically disabled. + * The Weave Net Docker API Proxy. See [Setting Up the Weave Net Docker API Proxy](#weave-api-proxy). -For more information about using the Network Plugin, see -[Integrating Docker via the Network Plugin](plugin.md). + * The Docker Network Plugin framework. The Docker Network Plugin is used when +Docker containers are started with the --net flag, for example: -For more information about using the Weave Docker -API proxy then read on. +`docker run --net ` + +**Where,** + + * are the [docker run options](https://docs.docker.com/engine/reference/run/) + you give to your container on start + +Note that if a Docker container is started with the --net flag, then the Weave Docker API Proxy +is automatically disabled and is not used to attach containers. +See [Integrating Docker via the Network Plugin](plugin.md). + + * Containers can also be attached to the Weave network by using `weave run` commands. This method also +does not use the Weave Docker API Proxy. +See [Launching Containers With Weave Run (without the Proxy)](/site/weave-docker-api/launching-without-proxy.md). -###Setting Up The Weave Net Docker API Proxy +###Setting Up The Weave Net Docker API Proxy The proxy sits between the Docker client (command line or API) and the Docker daemon, and intercepts the communication between the two. You can From 14350ff463fd6d3e1bb823ea8f752bf0e0c0074f Mon Sep 17 00:00:00 2001 From: abuehrle Date: Tue, 2 Aug 2016 16:35:52 -0500 Subject: [PATCH 6/8] added anchor to attaching containers --- site/weave-docker-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/weave-docker-api.md b/site/weave-docker-api.md index 98179dda..4bf3972a 100644 --- a/site/weave-docker-api.md +++ b/site/weave-docker-api.md @@ -10,7 +10,7 @@ or the [remote API](https://docs.docker.com/reference/api/docker_remote_api/), instead of `weave run`. -###Attaching Containers to a Weave Network +###Attaching Containers to a Weave Network There are three ways to attach containers to a Weave network (which method to use is entirely up to you): From 5fdbbf37229a4ed4df8803cc75d416a9d8d53733 Mon Sep 17 00:00:00 2001 From: abuehrle Date: Tue, 2 Aug 2016 16:38:41 -0500 Subject: [PATCH 7/8] wording formatting --- site/weave-docker-api.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/site/weave-docker-api.md b/site/weave-docker-api.md index 4bf3972a..8619c5e8 100644 --- a/site/weave-docker-api.md +++ b/site/weave-docker-api.md @@ -9,7 +9,6 @@ network when they are started using the ordinary Docker or the [remote API](https://docs.docker.com/reference/api/docker_remote_api/), instead of `weave run`. - ###Attaching Containers to a Weave Network There are three ways to attach containers to a Weave network (which method to use is @@ -24,18 +23,17 @@ Docker containers are started with the --net flag, for example: **Where,** - * are the [docker run options](https://docs.docker.com/engine/reference/run/) + * `` are the [docker run options](https://docs.docker.com/engine/reference/run/) you give to your container on start Note that if a Docker container is started with the --net flag, then the Weave Docker API Proxy is automatically disabled and is not used to attach containers. See [Integrating Docker via the Network Plugin](plugin.md). - * Containers can also be attached to the Weave network by using `weave run` commands. This method also + * Containers can also be attached to the Weave network with `weave run` commands. This method also does not use the Weave Docker API Proxy. See [Launching Containers With Weave Run (without the Proxy)](/site/weave-docker-api/launching-without-proxy.md). - ###Setting Up The Weave Net Docker API Proxy The proxy sits between the Docker client (command line or API) and the From 3273d1366610ecd96eb57a89dd6d6b67957de91a Mon Sep 17 00:00:00 2001 From: Anita Buehrle Date: Tue, 2 Aug 2016 16:40:16 -0500 Subject: [PATCH 8/8] gave points numbers for clarity --- site/weave-docker-api.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/site/weave-docker-api.md b/site/weave-docker-api.md index 8619c5e8..ccab0096 100644 --- a/site/weave-docker-api.md +++ b/site/weave-docker-api.md @@ -14,9 +14,9 @@ instead of `weave run`. There are three ways to attach containers to a Weave network (which method to use is entirely up to you): - * The Weave Net Docker API Proxy. See [Setting Up the Weave Net Docker API Proxy](#weave-api-proxy). +**1.** The Weave Net Docker API Proxy. See [Setting Up the Weave Net Docker API Proxy](#weave-api-proxy). - * The Docker Network Plugin framework. The Docker Network Plugin is used when +**2.** The Docker Network Plugin framework. The Docker Network Plugin is used when Docker containers are started with the --net flag, for example: `docker run --net ` @@ -30,7 +30,7 @@ Note that if a Docker container is started with the --net flag, then the Weave D is automatically disabled and is not used to attach containers. See [Integrating Docker via the Network Plugin](plugin.md). - * Containers can also be attached to the Weave network with `weave run` commands. This method also +**3.** Containers can also be attached to the Weave network with `weave run` commands. This method also does not use the Weave Docker API Proxy. See [Launching Containers With Weave Run (without the Proxy)](/site/weave-docker-api/launching-without-proxy.md).