From 82c9a88aa22c83f48473339a897cb0f1454de167 Mon Sep 17 00:00:00 2001 From: Adam Harrison Date: Mon, 18 Apr 2016 12:17:25 +0100 Subject: [PATCH 01/11] Update titles and menu order --- site/building.md | 2 +- site/encryption.md | 2 +- site/faq.md | 4 ++-- site/fastdp.md | 2 +- site/features.md | 2 +- site/ipam.md | 4 ++-- site/plugin.md | 4 ++-- site/router-topology.md | 4 ++-- site/troubleshooting.md | 2 +- site/using-weave.md | 2 +- site/weave-docker-api.md | 4 ++-- site/weavedns.md | 4 ++-- 12 files changed, 18 insertions(+), 18 deletions(-) diff --git a/site/building.md b/site/building.md index b40fd53a..a295c1de 100644 --- a/site/building.md +++ b/site/building.md @@ -1,6 +1,6 @@ --- title: Building Weave Net -menu_order: 160 +menu_order: 120 --- # Building Weave Net diff --git a/site/encryption.md b/site/encryption.md index 55308da1..a5562314 100644 --- a/site/encryption.md +++ b/site/encryption.md @@ -1,6 +1,6 @@ --- title: Encryption and Weave Net -menu_order: 90 +menu_order: 95 --- diff --git a/site/faq.md b/site/faq.md index dca84cb4..05036655 100644 --- a/site/faq.md +++ b/site/faq.md @@ -1,6 +1,6 @@ --- -title: Weave Net FAQ -menu_order: 140 +title: FAQ +menu_order: 100 --- diff --git a/site/fastdp.md b/site/fastdp.md index 15b6ffe4..58057099 100644 --- a/site/fastdp.md +++ b/site/fastdp.md @@ -1,6 +1,6 @@ --- title: Using Fast Datapath -menu_order: 70 +menu_order: 96 --- diff --git a/site/features.md b/site/features.md index 19d8b1ae..dcddfa6c 100644 --- a/site/features.md +++ b/site/features.md @@ -1,5 +1,5 @@ --- -title: Weave Features +title: Feature Overview menu_order: 20 --- diff --git a/site/ipam.md b/site/ipam.md index 4876bdda..49884fc9 100644 --- a/site/ipam.md +++ b/site/ipam.md @@ -1,6 +1,6 @@ --- -title: Address Allocation with IP Address Management (IPAM) -menu_order: 110 +title: Allocating IP Addresses +menu_order: 70 --- diff --git a/site/plugin.md b/site/plugin.md index 0e153fbe..cf5e1c26 100644 --- a/site/plugin.md +++ b/site/plugin.md @@ -1,6 +1,6 @@ --- -title: Using the Weave Net Docker Network Plugin -menu_order: 80 +title: Integrating Docker via the Network Plugin +menu_order: 60 --- diff --git a/site/router-topology.md b/site/router-topology.md index 525779da..eadb30a2 100644 --- a/site/router-topology.md +++ b/site/router-topology.md @@ -1,7 +1,7 @@ --- -title: How Weave Net Works +title: Understanding how Weave Net Works layout: default -menu_order: 100 +menu_order: 90 --- diff --git a/site/troubleshooting.md b/site/troubleshooting.md index 24cff738..1f016755 100644 --- a/site/troubleshooting.md +++ b/site/troubleshooting.md @@ -1,6 +1,6 @@ --- title: Troubleshooting Weave Net -menu_order: 150 +menu_order: 110 --- diff --git a/site/using-weave.md b/site/using-weave.md index f9521100..671ddd8a 100644 --- a/site/using-weave.md +++ b/site/using-weave.md @@ -1,5 +1,5 @@ --- -title: Using Weave Net - Example +title: Using Weave Net menu_order: 40 --- diff --git a/site/weave-docker-api.md b/site/weave-docker-api.md index 6fbf51ca..41672f66 100644 --- a/site/weave-docker-api.md +++ b/site/weave-docker-api.md @@ -1,6 +1,6 @@ --- -title: Setting Up The Weave Net Docker API Proxy -menu_order: 60 +title: Integrating Docker via the API Proxy +menu_order: 50 --- diff --git a/site/weavedns.md b/site/weavedns.md index 7b177fa6..e4a2aa59 100644 --- a/site/weavedns.md +++ b/site/weavedns.md @@ -1,6 +1,6 @@ --- -title: Using WeaveDNS -menu_order: 120 +title: Discovering Containers with WeaveDNS +menu_order: 80 --- From 3a2452baf618450c388e67ad8a00bac9a1590af4 Mon Sep 17 00:00:00 2001 From: Adam Harrison Date: Mon, 18 Apr 2016 12:19:27 +0100 Subject: [PATCH 02/11] Style FAQ questions with emphasis --- site/faq.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/site/faq.md b/site/faq.md index 05036655..2797b597 100644 --- a/site/faq.md +++ b/site/faq.md @@ -5,19 +5,19 @@ menu_order: 100 -###Q:How do I obtain the IP of a specific container when I'm using Weave? +**Q:How do I obtain the IP of a specific container when I'm using Weave?** You can use `weave ps ` to see the allocated address of a container on a Weave network. See [Troubleshooting Weave - List attached containers](/site/troubleshooting.md#list-attached-containers). -###Q: How do I expose one of my containers to the outside world? +**Q: How do I expose one of my containers to the outside world?** Exposing a container to the outside world is described in [Exposing Services to the Outside](/site/using-weave/service-export.md). -###Q: My dockerized app needs to check the request of a an application that uses a static IP. Is it possible to manually change the IP of a container? +**Q: My dockerized app needs to check the request of a an application that uses a static IP. Is it possible to manually change the IP of a container?** You can manually change the IP of a container using [Classless Inter-Domain Routing or CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). @@ -25,7 +25,7 @@ You can manually change the IP of a container using [Classless Inter-Domain Rout For more information, refer to [Manually Specifying the IP Address of a Container](/site/using-weave/manual-ip-address.md). -###Q:Can I connect my existing 'legacy' network with a Weave container network? +**Q:Can I connect my existing 'legacy' network with a Weave container network?** Yes you can. @@ -36,7 +36,7 @@ The simplest way to accomplish this would be to run Weave on the host and then r You can read about exposing ports in [Service Exporting](/site/using-weave/service-export.md) -###Q: Why am I seeing the same IP address assigned to two different containers on different hosts? +**Q: Why am I seeing the same IP address assigned to two different containers on different hosts?** Under normal circumstances, this should never happen, but it can occur if `weave forget` and `weave rmpeer` was run on more than one host. @@ -49,14 +49,14 @@ Some peers may be able to communicate their claim to the others before they run For more information on see [Address Allocation with IP Address Management (IPAM)](/site/ipam.md) and also, [Starting, Stopping and Removing Peers](/site/ipam/stop-remove-peers-ipam.md) -###Q: What is the best practise for resetting a node that goes out of service? +**Q: What is the best practice for resetting a node that goes out of service?** When a node goes out of service, the best option is to call `weave rmpeer` on one host and then `weave forget` on all the other hosts. -See [Starting, Stopping and Removing Peers](/site/ipam/stop-remove-peers-ipam.md) for an indepth discussion. +See [Starting, Stopping and Removing Peers](/site/ipam/stop-remove-peers-ipam.md) for an in-depth discussion. -###Q: What about Weave's performance? Are software defined network overlays just as fast as native networking? +**Q: What about Weave's performance? Are software defined network overlays just as fast as native networking?** All virtualization techniques have some overhead, and Weave's overhead is typically around 2-3%. Unless your system is completely bottlenecked on the network, you won't notice this during normal operation. @@ -65,14 +65,14 @@ Weave Net also automatically uses the fastest datapath between two hosts. When W For more information about fast datapath see [How Fast Datapath Works](/site/fastdp/fastdp-how-it-works.md) -###Q:How can I tell if Weave is using fast datapath (fastdp) or not? +**Q:How can I tell if Weave is using fast datapath (fastdp) or not?** To view whether Weave is using fastdp or not, you can run, `weave status connections` For more information on this command, see [Using Fast Datapath](/site/fastdp.md) -###Q: Does encryption work with fastdp? +**Q: Does encryption work with fastdp?** Encryption does not work with fast datapath. If you enable encryption using the `--password` option to launch Weave (or you use the `WEAVE_PASSWORD` environment variable), fast datapath will by default be disabled. @@ -80,7 +80,7 @@ You can however have a mixture of fast datapath connections over trusted links, See [Using Fast Datapath](/site/fastdp.md) for more information -###Q: Can I create multiple networks where containers can communicate on one network, but are isolated from containers on other networks? +**Q: Can I create multiple networks where containers can communicate on one network, but are isolated from containers on other networks?** Yes, of course! Weave allows you to run isolated networks and still allow open communications between individual containers from those isolated networks. You can find information on how to do this in [Application Isolation](/site/using-weave/application-isolation.md) From e1478eefd438267c9ac94faebb06df6d495bbaab Mon Sep 17 00:00:00 2001 From: Adam Harrison Date: Mon, 18 Apr 2016 12:24:25 +0100 Subject: [PATCH 03/11] Remove language spec from code fences --- site/building.md | 16 ++++++++-------- site/weavedns.md | 4 ++-- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/site/building.md b/site/building.md index a295c1de..e1fb008d 100644 --- a/site/building.md +++ b/site/building.md @@ -25,7 +25,7 @@ The weave git repository should be cloned into `$GOPATH/src/github.com/weaveworks/weave`, in accordance with [the go workspace conventions](https://golang.org/doc/code.html#Workspaces): -```bash +``` $ WEAVE=github.com/weaveworks/weave $ git clone https://$WEAVE $GOPATH/src/$WEAVE $ cd $GOPATH/src/$WEAVE @@ -36,7 +36,7 @@ Next install Docker if you haven't already, by following the instructions Then to actually build, simply do: -```bash +``` $ make ``` @@ -62,7 +62,7 @@ Vagrant to run VMs in. First, check out the code: -```bash +``` $ git clone https://github.com/weaveworks/weave $ cd weave ``` @@ -78,7 +78,7 @@ The `Vagrantfile` in the top directory constructs a VM that has Once you are in the working directory you can issue -```bash +``` $ vagrant up ``` @@ -90,7 +90,7 @@ use git and so on in the regular filesystem. To build and run the code, you need to use the VM. To log in and build the weave image, do -```bash +``` $ vagrant ssh vm$ cd src/github.com/weaveworks/weave vm$ make @@ -98,7 +98,7 @@ vm$ make The Docker daemon is also running in this VM, so you can then do -```bash +``` vm$ sudo ./weave launch vm$ sudo docker ps ``` @@ -108,7 +108,7 @@ and so on. If you are looking to just do a build and not run anything on this VM, you can do so with -```bash +``` $ vagrant ssh -c 'make -C src/github.com/weaveworks/weave' ``` @@ -116,7 +116,7 @@ you should then find a `weave.tar.gz` container snapshot tarball in the top-level directory. You can use that snapshot with `docker load` against a different host, e.g. -```bash +``` $ export DOCKER_HOST=tcp:// $ docker load < weave.tar.gz ``` diff --git a/site/weavedns.md b/site/weavedns.md index e4a2aa59..18c4679c 100644 --- a/site/weavedns.md +++ b/site/weavedns.md @@ -14,7 +14,7 @@ it works across hosts. WeaveDNS is deployed as an embedded service within the Weave router. The service is automatically started when the router is launched: -```bash +``` host1$ weave launch host1$ eval $(weave env) ``` @@ -26,7 +26,7 @@ running when they are started. They use it for name resolution, and will register themselves if they either have a hostname in the weaveDNS domain (`weave.local` by default) or are given an explicit container name: -```bash +``` host1$ docker run -dti --name=pingme ubuntu host1$ docker run -ti --hostname=ubuntu.weave.local ubuntu root@ubuntu:/# ping pingme From b9706e456adbb307e32ff4ebc8a072cb4a5b7b52 Mon Sep 17 00:00:00 2001 From: Adam Harrison Date: Mon, 18 Apr 2016 12:25:31 +0100 Subject: [PATCH 04/11] Strip erroneous extra backtick from code fences --- site/ipam/troubleshooting-ipam.md | 4 ++-- site/troubleshooting.md | 16 ++++++++-------- site/weave-docker-api/troubleshooting-proxy.md | 4 ++-- site/weavedns/troubleshooting-weavedns.md | 4 ++-- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/site/ipam/troubleshooting-ipam.md b/site/ipam/troubleshooting-ipam.md index 4ea94aff..5e518deb 100644 --- a/site/ipam/troubleshooting-ipam.md +++ b/site/ipam/troubleshooting-ipam.md @@ -10,14 +10,14 @@ The command reports on the current status of the weave router and IP allocator: -```` +``` ... Service: ipam Status: awaiting consensus (quorum: 2, known: 0) Range: 10.32.0.0-10.47.255.255 DefaultSubnet: 10.32.0.0/12 ... -```` +``` The first section covers the router; see the [troubleshooting guide](/site/troubleshooting.md#weave-status) for full details. diff --git a/site/troubleshooting.md b/site/troubleshooting.md index 1f016755..a1469b8f 100644 --- a/site/troubleshooting.md +++ b/site/troubleshooting.md @@ -45,7 +45,7 @@ capture and analysis tools, such as tcpdump and wireshark, to the A status summary can be obtained using `weave status`: -```` +``` $ weave status Version: 1.1.0 (up to date; next check at 2016/04/06 12:30:00) @@ -75,7 +75,7 @@ $ weave status Service: plugin DriverName: weave -```` +``` The terms used here are explained further at [How Weave Net Works](/site/router-topology.md). @@ -129,14 +129,14 @@ exponential back-off. To view detailed information on the local Weave Net router's type `weave status connections`: -```` +``` $ weave status connections <- 192.168.48.12:33866 established unencrypted fastdp 7e:21:4a:70:2f:45(host2) <- 192.168.48.13:60773 pending encrypted fastdp 7e:ae:cd:d5:23:8d(host3) -> 192.168.48.14:6783 retrying dial tcp4 192.168.48.14:6783: no route to host -> 192.168.48.15:6783 failed dial tcp4 192.168.48.15:6783: no route to host, retry: 2015-08-06 18:55:38.246910357 +0000 UTC -> 192.168.48.16:6783 connecting -```` +``` The columns are as follows: @@ -160,7 +160,7 @@ The columns are as follows: Detailed information on peers can be obtained with `weave status peers`: -```` +``` $ weave status peers ce:31:e0:06:45:1a(host1) <- 192.168.48.12:39634 ea:2d:b2:e6:e4:f5(host2) established @@ -171,7 +171,7 @@ ea:2d:b2:e6:e4:f5(host2) ee:38:33:a7:d9:71(host3) -> 192.168.48.12:6783 ea:2d:b2:e6:e4:f5(host2) established -> 192.168.48.11:6783 ce:31:e0:06:45:1a(host1) established -```` +``` This lists all peers known to this router, including itself. Each peer is shown with its name and nickname, then each line thereafter @@ -185,7 +185,7 @@ the `host3` end of the same connection as `192.168.48.13:49619`. Detailed information on DNS registrations can be obtained with `weave status dns`: -```` +``` $ weave status dns one 10.32.0.1 eebd81120ee4 4a:0f:f6:ec:1c:93 one 10.43.255.255 4fcec78d2a9b 66:c4:47:c6:65:bf @@ -196,7 +196,7 @@ three 10.40.0.2 8a9c2e2ef00f ba:98:d0:37:4f:1c two 10.32.0.2 83689b8f34e0 4a:0f:f6:ec:1c:93 two 10.44.0.0 7edc306cb668 66:c4:47:c6:65:bf two 10.40.0.1 68a5e9c2641b ba:98:d0:37:4f:1c -```` +``` The columns are as follows: diff --git a/site/weave-docker-api/troubleshooting-proxy.md b/site/weave-docker-api/troubleshooting-proxy.md index aeb105a0..f12f98a7 100644 --- a/site/weave-docker-api/troubleshooting-proxy.md +++ b/site/weave-docker-api/troubleshooting-proxy.md @@ -10,12 +10,12 @@ The command reports on the current status of various Weave Net components, including the proxy, if it is running: -```` +``` ... Service: proxy Address: tcp://127.0.0.1:12375 ... -```` +``` Information on the operation of the proxy can be obtained from the weaveproxy container logs using: diff --git a/site/weavedns/troubleshooting-weavedns.md b/site/weavedns/troubleshooting-weavedns.md index 3e8b6154..0cb1fb0c 100644 --- a/site/weavedns/troubleshooting-weavedns.md +++ b/site/weavedns/troubleshooting-weavedns.md @@ -15,7 +15,7 @@ The command: reports on the current status of various Weave Net components, including DNS: -```` +``` ... Service: dns Domain: weave.local. @@ -23,7 +23,7 @@ DNS: TTL: 1 Entries: 9 ... -```` +``` The first section covers the router; see the [troubleshooting guide](/site/troubleshooting.md#weave-status) for more details. From ca2e54c36101bdc542a83e4c5b0fcba4df280dd7 Mon Sep 17 00:00:00 2001 From: Bryan Boreham Date: Mon, 18 Apr 2016 16:44:40 +0100 Subject: [PATCH 05/11] Renamed 'router-topology' to 'how-it-works' --- site/encryption.md | 2 +- site/encryption/implementation.md | 2 +- site/{router-topology.md => how-it-works.md} | 4 ++-- site/{router-topology => how-it-works}/network-topology.md | 2 +- .../{router-topology => how-it-works}/router-encapsulation.md | 2 +- site/troubleshooting.md | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) rename site/{router-topology.md => how-it-works.md} (92%) rename site/{router-topology => how-it-works}/network-topology.md (98%) rename site/{router-topology => how-it-works}/router-encapsulation.md (96%) diff --git a/site/encryption.md b/site/encryption.md index a5562314..54b8b0cf 100644 --- a/site/encryption.md +++ b/site/encryption.md @@ -5,7 +5,7 @@ menu_order: 95 Weave Net peers -[communicate with each other over both TCP and UDP](/site/router-topology.md). This +[communicate with each other over both TCP and UDP](/site/how-it-works.md). This communication [can be encrypted](/site/using-weave/security-untrusted-networks.md). diff --git a/site/encryption/implementation.md b/site/encryption/implementation.md index d1537f3e..f3055f54 100644 --- a/site/encryption/implementation.md +++ b/site/encryption/implementation.md @@ -145,7 +145,7 @@ follows: | Frame N: Captured payload | | +-----------------------------------+ -+ -This is very similar to the [non-crypto encapsulation](/site/router-topology/router-encapsulation.md). +This is very similar to the [non-crypto encapsulation](/site/how-it-works/router-encapsulation.md). All of the frames on a connection are encrypted with the same ephemeral session key, and a nonce constructed from a message sequence diff --git a/site/router-topology.md b/site/how-it-works.md similarity index 92% rename from site/router-topology.md rename to site/how-it-works.md index eadb30a2..3c701b58 100644 --- a/site/router-topology.md +++ b/site/how-it-works.md @@ -47,5 +47,5 @@ first send it to peer 3: **See Also** - * [Weave Router Sleeve Encapsulation](/site/router-topology/router-encapsulation.md) - * [How Weave Inteprets Network Topology](/site/router-topology/network-topology.md) + * [Weave Router Sleeve Encapsulation](/site/how-it-works/router-encapsulation.md) + * [How Weave Inteprets Network Topology](/site/how-it-works/network-topology.md) diff --git a/site/router-topology/network-topology.md b/site/how-it-works/network-topology.md similarity index 98% rename from site/router-topology/network-topology.md rename to site/how-it-works/network-topology.md index 0a5dce6c..bd5381c0 100644 --- a/site/router-topology/network-topology.md +++ b/site/how-it-works/network-topology.md @@ -144,7 +144,7 @@ which time the topology should have updated. **See Also** - * [Weave Net Router Encapsulation](/site/router-topology/router-encapsulation.md) + * [Weave Net Router Encapsulation](/site/how-it-works/router-encapsulation.md) diff --git a/site/router-topology/router-encapsulation.md b/site/how-it-works/router-encapsulation.md similarity index 96% rename from site/router-topology/router-encapsulation.md rename to site/how-it-works/router-encapsulation.md index 57b69d7e..44cd5cde 100644 --- a/site/router-topology/router-encapsulation.md +++ b/site/how-it-works/router-encapsulation.md @@ -61,4 +61,4 @@ MAC discovery. **See Also** - * [How Weave Net Inteprets Network Topology](/site/router-topology/network-topology.md) + * [How Weave Net Inteprets Network Topology](/site/how-it-works/network-topology.md) diff --git a/site/troubleshooting.md b/site/troubleshooting.md index a1469b8f..53467820 100644 --- a/site/troubleshooting.md +++ b/site/troubleshooting.md @@ -78,7 +78,7 @@ $ weave status ``` The terms used here are explained further at -[How Weave Net Works](/site/router-topology.md). +[How Weave Net Works](/site/how-it-works.md). * **Version** - shows the Weave Net version. If checkpoint is enabled (i.e. `CHECKPOINT_DISABLE` is not set), information about existence of a new version From 85bda720384c553851a898407a1c8c77b9c24d5d Mon Sep 17 00:00:00 2001 From: Bryan Boreham Date: Mon, 18 Apr 2016 16:49:59 +0100 Subject: [PATCH 06/11] Move fastdp pages out of top level --- site/faq.md | 6 +++--- site/features.md | 4 ++-- site/how-it-works.md | 2 +- .../{fastdp => how-it-works}/fastdp-how-it-works.md | 4 ++-- site/how-it-works/router-encapsulation.md | 2 +- .../weave-frame-encapsulation-178x300.png | Bin .../weave-net-encap1-1024x459.png | Bin .../weave-net-fdp1-1024x454.png | Bin site/introducing-weave.md | 2 +- site/using-weave/deploying-applications.md | 2 +- site/{ => using-weave}/fastdp.md | 4 ++-- site/using-weave/security-untrusted-networks.md | 4 ++-- 12 files changed, 15 insertions(+), 15 deletions(-) rename site/{fastdp => how-it-works}/fastdp-how-it-works.md (96%) rename site/{fastdp => how-it-works}/weave-frame-encapsulation-178x300.png (100%) rename site/{fastdp => how-it-works}/weave-net-encap1-1024x459.png (100%) rename site/{fastdp => how-it-works}/weave-net-fdp1-1024x454.png (100%) rename site/{ => using-weave}/fastdp.md (93%) diff --git a/site/faq.md b/site/faq.md index 2797b597..b6008219 100644 --- a/site/faq.md +++ b/site/faq.md @@ -62,14 +62,14 @@ All virtualization techniques have some overhead, and Weave's overhead is typica Weave Net also automatically uses the fastest datapath between two hosts. When Weave Net can't use the fast datapath between two hosts, it falls back to the slower packet forwarding approach. Selecting the fastest forwarding approach is automatic, and is determined on a connection-by-connection basis. For example, a Weave network spanning two data centers might use fast datapath within the data centers, but not for the more constrained network link between them. -For more information about fast datapath see [How Fast Datapath Works](/site/fastdp/fastdp-how-it-works.md) +For more information about fast datapath see [How Fast Datapath Works](/site/how-it-works/fastdp-how-it-works.md) **Q:How can I tell if Weave is using fast datapath (fastdp) or not?** To view whether Weave is using fastdp or not, you can run, `weave status connections` -For more information on this command, see [Using Fast Datapath](/site/fastdp.md) +For more information on this command, see [Using Fast Datapath](/using-weave/fastdp.md) **Q: Does encryption work with fastdp?** @@ -78,7 +78,7 @@ Encryption does not work with fast datapath. If you enable encryption using the You can however have a mixture of fast datapath connections over trusted links, as well as, encrypted connections over untrusted links. -See [Using Fast Datapath](/site/fastdp.md) for more information +See [Using Fast Datapath](/using-weave/fastdp.md) for more information **Q: Can I create multiple networks where containers can communicate on one network, but are isolated from containers on other networks?** diff --git a/site/features.md b/site/features.md index dcddfa6c..9c81f862 100644 --- a/site/features.md +++ b/site/features.md @@ -58,8 +58,8 @@ Fast datapath does not support encryption. For full details on configuring Weave when you have connections that traverse untrusted networks, see [Securing Connections Across Untrusted Networks](/site/using-weave/security-untrusted-networks.md) for more details. -See [Using Fast Datapath](/site/fastdp.md) and -[How Fast Datapath Works](/site/fastdp/fastdp-how-it-works.md). +See [Using Fast Datapath](/using-weave/fastdp.md) and +[How Fast Datapath Works](/site/how-it-works/fastdp-how-it-works.md). ###Seamless Docker Integration (Weave Docker API Proxy) diff --git a/site/how-it-works.md b/site/how-it-works.md index 3c701b58..361b1dd3 100644 --- a/site/how-it-works.md +++ b/site/how-it-works.md @@ -27,7 +27,7 @@ is given an IP address and netmask supplied either by the user or by Weave Net's IP address allocator. Weave Net routes packets between containers on different hosts via two -methods: a [fast data path](/site/fastdp.md) method, which operates +methods: a [fast data path](/using-weave/fastdp.md) method, which operates entirely in kernel space, and a fallback `sleeve` method, in which packets destined for non-local containers are captured by the kernel and processed by the Weave Net router in user space, forwarded over diff --git a/site/fastdp/fastdp-how-it-works.md b/site/how-it-works/fastdp-how-it-works.md similarity index 96% rename from site/fastdp/fastdp-how-it-works.md rename to site/how-it-works/fastdp-how-it-works.md index 55ecda4d..84d8c3dc 100644 --- a/site/fastdp/fastdp-how-it-works.md +++ b/site/how-it-works/fastdp-how-it-works.md @@ -1,6 +1,6 @@ --- title: How Fast Datapath Works -menu_order: 10 +menu_order: 30 --- @@ -25,6 +25,6 @@ Prior to version 1.2, Weave Net used a custom encapsulation format. Fast datapat **See Also** * [Deploying Applications to Weave](/site/using-weave/deploying-applications.md) - * [Using Fast Datapath](/site/fastdp.md) + * [Using Fast Datapath](/using-weave/fastdp.md) diff --git a/site/how-it-works/router-encapsulation.md b/site/how-it-works/router-encapsulation.md index 44cd5cde..6f65025e 100644 --- a/site/how-it-works/router-encapsulation.md +++ b/site/how-it-works/router-encapsulation.md @@ -4,7 +4,7 @@ menu_order: 10 --- When the Weave Net router forwards packets to peers in `sleeve` mode -(rather than via the [fast data path](/site/fastdp.md)), the +(rather than via the [fast data path](/using-weave/fastdp.md)), the encapsulation looks something like this: +-----------------------------------+ diff --git a/site/fastdp/weave-frame-encapsulation-178x300.png b/site/how-it-works/weave-frame-encapsulation-178x300.png similarity index 100% rename from site/fastdp/weave-frame-encapsulation-178x300.png rename to site/how-it-works/weave-frame-encapsulation-178x300.png diff --git a/site/fastdp/weave-net-encap1-1024x459.png b/site/how-it-works/weave-net-encap1-1024x459.png similarity index 100% rename from site/fastdp/weave-net-encap1-1024x459.png rename to site/how-it-works/weave-net-encap1-1024x459.png diff --git a/site/fastdp/weave-net-fdp1-1024x454.png b/site/how-it-works/weave-net-fdp1-1024x454.png similarity index 100% rename from site/fastdp/weave-net-fdp1-1024x454.png rename to site/how-it-works/weave-net-fdp1-1024x454.png diff --git a/site/introducing-weave.md b/site/introducing-weave.md index e65d715d..5be2968d 100644 --- a/site/introducing-weave.md +++ b/site/introducing-weave.md @@ -36,7 +36,7 @@ Weave Net can forward traffic between nodes, and it works even if the mesh netwo Weave Net automatically chooses the fastest path between two hosts, offering near native throughput and latency, all without your intervention. -See [How Fast Datapath Works](/site/fastdp.md) for more information. +See [How Fast Datapath Works](/using-weave/fastdp.md) for more information. ###Network Operations Friendly diff --git a/site/using-weave/deploying-applications.md b/site/using-weave/deploying-applications.md index f784da00..ae1bf61a 100644 --- a/site/using-weave/deploying-applications.md +++ b/site/using-weave/deploying-applications.md @@ -108,5 +108,5 @@ Weave Net supports *any* protocol, and it doesn't have to be over TCP/IP. For ex **See Also** * [Installing Weave Net](/site/installing-weave.md) - * [Using Fastdp With Weave Net](/site/fastdp.md) + * [Using Fastdp With Weave Net](/using-weave/fastdp.md) * [Using the Weave Net Docker Network Plugin](/site/plugin.md) diff --git a/site/fastdp.md b/site/using-weave/fastdp.md similarity index 93% rename from site/fastdp.md rename to site/using-weave/fastdp.md index 58057099..9f6d79ab 100644 --- a/site/fastdp.md +++ b/site/using-weave/fastdp.md @@ -8,7 +8,7 @@ The most important thing to know about fast datapath is that you don't need to c When Weave Net cannot use the fast data path between two hosts, it falls back to a slower packet forwarding approach called `sleeve`. Selecting the fastest forwarding approach is automatic, and is determined on a connection-by-connection basis. For example, a Weave network spanning two data centers might use fast data path within the data centers, but not for the more constrained network link between them. -See [How Fastdp Works](/site/fastdp/fastdp-how-it-works.md) for a more in-depth discussion of this feature. +See [How Fastdp Works](/site/how-it-works/fastdp-how-it-works.md) for a more in-depth discussion of this feature. ###Disabling Fast Datapath @@ -45,5 +45,5 @@ Where fastdp indicates that fast datapath is being used on a connection. If fast **See Also** * [Deploying Applications to Weave](/site/using-weave/deploying-applications.md) - * [How Fastdp Works](/site/fastdp/fastdp-how-it-works.md) + * [How Fastdp Works](/site/how-it-works/fastdp-how-it-works.md) diff --git a/site/using-weave/security-untrusted-networks.md b/site/using-weave/security-untrusted-networks.md index 7a77605e..7e0e0241 100644 --- a/site/using-weave/security-untrusted-networks.md +++ b/site/using-weave/security-untrusted-networks.md @@ -34,7 +34,7 @@ password at `weave launch` the router falls back to a slower If some of your peers are co-located in a trusted network (for example within the boundary of your own data center) you can use the `--trusted-subnets` argument to `weave launch` to selectively disable data plane encryption as an optimization. ->**Note:** Both peers must consider the other to be in a trusted subnet for this to take place - if they do not agree, Weave Net [falls back to a slower method](/site/fastdp.md) for transporting data between peers, since fast datapath does not support encryption. +>**Note:** Both peers must consider the other to be in a trusted subnet for this to take place - if they do not agree, Weave Net [falls back to a slower method](/using-weave/fastdp.md) for transporting data between peers, since fast datapath does not support encryption. Be aware that: @@ -46,4 +46,4 @@ Be aware that: **See Also** * [Using Encryption With Weave Net](/site/encryption.md) - * [Using Fast Datapath](/site/fastdp.md) + * [Using Fast Datapath](/using-weave/fastdp.md) From 3f0a5d9e5d42f870380557d2eae609a52473fc73 Mon Sep 17 00:00:00 2001 From: Bryan Boreham Date: Mon, 18 Apr 2016 16:59:28 +0100 Subject: [PATCH 07/11] Move systemd page out of top level --- site/installing-weave.md | 2 +- site/{ => installing-weave}/systemd.md | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename site/{ => installing-weave}/systemd.md (100%) diff --git a/site/installing-weave.md b/site/installing-weave.md index b08e9745..81056eda 100644 --- a/site/installing-weave.md +++ b/site/installing-weave.md @@ -41,5 +41,5 @@ for the latest Weave AMIs and [here](http://weave.works/guides/service-discovery * [Features](/site/features.md) * [Troubleshooting](/site/troubleshooting.md) * [Building](/site/building.md) - * [Using Weave with Systemd](/site/systemd.md) + * [Using Weave with Systemd](/site/installing-weave/systemd.md) diff --git a/site/systemd.md b/site/installing-weave/systemd.md similarity index 100% rename from site/systemd.md rename to site/installing-weave/systemd.md From 4d060691383feada208355d8c982b6f55bb97e95 Mon Sep 17 00:00:00 2001 From: Bryan Boreham Date: Mon, 18 Apr 2016 17:05:34 +0100 Subject: [PATCH 08/11] Move IP Addressing overview under how-it-works and Configuring IP under Using Weave --- site/features.md | 2 +- site/{ => how-it-works}/ip-addresses.md | 0 site/{ip-addresses => using-weave}/configuring-weave.md | 4 ++-- site/using-weave/manual-ip-address.md | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) rename site/{ => how-it-works}/ip-addresses.md (100%) rename site/{ip-addresses => using-weave}/configuring-weave.md (95%) diff --git a/site/features.md b/site/features.md index 9c81f862..7905f0d3 100644 --- a/site/features.md +++ b/site/features.md @@ -114,7 +114,7 @@ Instead of allowing Weave to automatically allocate addresses, an IP address and specified. See [How to Manually Specify IP Addresses and Subnets](/site/using-weave/manual-ip-address.md) for instructions. For a discussion on how Weave Net uses IPAM, see [Automatic IP Address Management](/site/ipam.md). And also review the -[the basics of IP addressing](/site/ip-addresses.md) for an explanation of addressing and private networks. +[the basics of IP addressing](/how-it-works/ip-addresses.md) for an explanation of addressing and private networks. ###Naming and Discovery diff --git a/site/ip-addresses.md b/site/how-it-works/ip-addresses.md similarity index 100% rename from site/ip-addresses.md rename to site/how-it-works/ip-addresses.md diff --git a/site/ip-addresses/configuring-weave.md b/site/using-weave/configuring-weave.md similarity index 95% rename from site/ip-addresses/configuring-weave.md rename to site/using-weave/configuring-weave.md index 810dd662..94e552d8 100644 --- a/site/ip-addresses/configuring-weave.md +++ b/site/using-weave/configuring-weave.md @@ -1,6 +1,6 @@ --- title: Configuring Weave to Explicitly Use an IP Range -menu_order: 10 +menu_order: 15 --- The default configurations for both Weave Net and Docker use [Private @@ -39,4 +39,4 @@ Networks](https://en.wikipedia.org/wiki/Private_network). For example **See Also** - * [IP Addresses, Routes and Networks](/site/ip-addresses.md) + * [IP Addresses, Routes and Networks](/how-it-works/ip-addresses.md) diff --git a/site/using-weave/manual-ip-address.md b/site/using-weave/manual-ip-address.md index f5bff319..59bcea78 100644 --- a/site/using-weave/manual-ip-address.md +++ b/site/using-weave/manual-ip-address.md @@ -10,7 +10,7 @@ Containers are automatically allocated an IP address that is unique across the W Weave Net detects when a container has exited and releases its allocated addresses so they can be re-used by the network. -See the [Automatic IP Address Management](/site/ipam.md) and also an explanation of [the basics of IP addressing](/site/ip-addresses.md) for further details. +See the [Automatic IP Address Management](/site/ipam.md) and also an explanation of [the basics of IP addressing](/how-it-works/ip-addresses.md) for further details. Instead of allowing Weave Net to allocate IP addresses automatically (using IPAM), there may be instances where you need to control a particular container or a cluster by setting an IP address for it. @@ -52,6 +52,6 @@ Individual IP addresses given to containers must, of course, be unique. If you p **See Also** * [Managing Services: Exporting, Importing, Binding and Routing](/site/using-weave/service-management.md) - * [Configuring Weave to Explicitly Use an IP Range](/site/ip-addresses/configuring-weave.md) + * [Configuring Weave to Explicitly Use an IP Range](/site/using-weave/configuring-weave.md) * [Automatic IP Address Management](/site/ipam.md) From d454e610f1ec4bfc60c668ae1f86d046cca6a19a Mon Sep 17 00:00:00 2001 From: Bryan Boreham Date: Mon, 18 Apr 2016 17:13:01 +0100 Subject: [PATCH 09/11] Move encryption out of top level --- site/features.md | 2 +- .../encryption-implementation.md} | 3 ++- site/{ => how-it-works}/encryption.md | 4 ++-- site/troubleshooting.md | 2 +- site/using-weave/security-untrusted-networks.md | 2 +- 5 files changed, 7 insertions(+), 6 deletions(-) rename site/{encryption/implementation.md => how-it-works/encryption-implementation.md} (99%) rename site/{ => how-it-works}/encryption.md (94%) diff --git a/site/features.md b/site/features.md index 7905f0d3..4139c0a4 100644 --- a/site/features.md +++ b/site/features.md @@ -181,7 +181,7 @@ running alongside Weave. Weave Net implements encryption and security using [Daniel J. Bernstein's NaCl library](http://nacl.cr.yp.to/index.html). -For information on how to secure your Docker network connections, see [Securing Connections Across Untrusted Networks](/site/using-weave/security-untrusted-networks.md) and for a more technical discussion on how Weave implements encryption see, [Using Encryption with Weave](/site/encryption.md) and [How Weave Implements Encryption](/site/encryption/implementation.md). +For information on how to secure your Docker network connections, see [Securing Connections Across Untrusted Networks](/site/using-weave/security-untrusted-networks.md) and for a more technical discussion on how Weave implements encryption see, [Weave Encryption](/how-it-works/encryption.md) and [How Weave Implements Encryption](/site/how-it-works/encryption-implementation.md). ###Host Network Integration diff --git a/site/encryption/implementation.md b/site/how-it-works/encryption-implementation.md similarity index 99% rename from site/encryption/implementation.md rename to site/how-it-works/encryption-implementation.md index f3055f54..3ee989d4 100644 --- a/site/encryption/implementation.md +++ b/site/how-it-works/encryption-implementation.md @@ -1,10 +1,11 @@ --- title: How Weave Net Implements Encryption layout: default +menu_order: 70 --- This section describes some details of Weave Net's built-in -[encryption](/site/encryption.md): +[encryption](/how-it-works/encryption.md): * [Establishing the Ephemeral Session Key](#ephemeral-key) * [Key Generation](#csprng) diff --git a/site/encryption.md b/site/how-it-works/encryption.md similarity index 94% rename from site/encryption.md rename to site/how-it-works/encryption.md index 54b8b0cf..65c0f6e8 100644 --- a/site/encryption.md +++ b/site/how-it-works/encryption.md @@ -1,6 +1,6 @@ --- title: Encryption and Weave Net -menu_order: 95 +menu_order: 60 --- @@ -34,5 +34,5 @@ deployed. **See Also** - * [How Weave Implements Encryption](/site/encryption/implementation.md) + * [How Weave Implements Encryption](/site/how-it-works/encryption-implementation.md) * [Securing Containers Across Untrusted Networks](/site/using-weave/security-untrusted-networks.md) diff --git a/site/troubleshooting.md b/site/troubleshooting.md index 53467820..0ee5139a 100644 --- a/site/troubleshooting.md +++ b/site/troubleshooting.md @@ -94,7 +94,7 @@ can be overridden by using the `--nickname` argument at `weave launch`. * **Encryption** - indicates whether -[encryption](/site/encryption.md) is in use for communication +[encryption](/how-it-works/encryption.md) is in use for communication between peers. * **PeerDiscovery** - indicates whether diff --git a/site/using-weave/security-untrusted-networks.md b/site/using-weave/security-untrusted-networks.md index 7e0e0241..4e685e85 100644 --- a/site/using-weave/security-untrusted-networks.md +++ b/site/using-weave/security-untrusted-networks.md @@ -45,5 +45,5 @@ Be aware that: **See Also** - * [Using Encryption With Weave Net](/site/encryption.md) + * [Weave Encryption](/how-it-works/encryption.md) * [Using Fast Datapath](/using-weave/fastdp.md) From 2dddc58754c68db49433cedb5494f68d54e58776 Mon Sep 17 00:00:00 2001 From: Adam Harrison Date: Mon, 18 Apr 2016 17:30:51 +0100 Subject: [PATCH 10/11] Remove unnecessary title from building doc --- site/building.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/site/building.md b/site/building.md index e1fb008d..34c2a2e8 100644 --- a/site/building.md +++ b/site/building.md @@ -2,9 +2,6 @@ title: Building Weave Net menu_order: 120 --- - -# Building Weave Net - You only need to build Weave Net if you want to work on the Weave Net codebase (or you just enjoy building software). From 278f7d8381abcf82aaa4ed636b0b9bc27bfe6eab Mon Sep 17 00:00:00 2001 From: Bryan Boreham Date: Mon, 18 Apr 2016 18:15:32 +0100 Subject: [PATCH 11/11] Move CNI up to top level --- site/{plugin/cni-plugin-how-to.md => cni-plugin.md} | 3 ++- site/features.md | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) rename site/{plugin/cni-plugin-how-to.md => cni-plugin.md} (97%) diff --git a/site/plugin/cni-plugin-how-to.md b/site/cni-plugin.md similarity index 97% rename from site/plugin/cni-plugin-how-to.md rename to site/cni-plugin.md index 224aba36..b2ba55ec 100644 --- a/site/plugin/cni-plugin-how-to.md +++ b/site/cni-plugin.md @@ -1,6 +1,7 @@ --- -title: Using the Weave Net CNI Plugin +title: Integrating Kubernetes via the CNI Plugin layout: default +menu_order: 65 --- CNI, the [_Container Network Interface_](https://github.com/appc/cni#cni---the-container-network-interface), diff --git a/site/features.md b/site/features.md index 4139c0a4..c7efb19b 100644 --- a/site/features.md +++ b/site/features.md @@ -103,7 +103,7 @@ See [Using the Weave Docker Network Plugin](/site/plugin.md) for more details. Weave can be used as a plugin to systems that support the [Container Network Interface](https://github.com/appc/cni), such as Kubernetes. -See [Using the Weave CNI Plugin](/site/plugin/cni-plugin-how-to.md) for more details. +See [Using the Weave CNI Plugin](/site/cni-plugin.md) for more details. ###IP Address Management (IPAM)