diff --git a/README.md b/README.md index ec2066f1..b01e3248 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,13 @@ [Weaveworks](https://www.weave.works) is the company that delivers the most productive way for developers to connect, observe and control Docker containers. -This repository contains [Weave Net](https://www.weave.works/products/weave-net/), the first product developed by Weaveworks, and with over 8 million downloads to date, it enables you to get started with Docker clusters and portable apps in a fraction of the time compared with other solutions. +This repository contains [Weave Net](https://www.weave.works/products/weave-net/), the first product developed by Weaveworks, and with over 8 million downloads to date, enables you to get started with Docker clusters and portable apps in a fraction of the time compared with other solutions. ## Weave Cloud: [Weave Cloud](https://www.weave.works/product/cloud/) is software-as-a-service that simplifies deployment, monitoring and management for containers and microservices. It extends and complements popular orchestrators, and enables developers and DevOps to realize faster deployments, insightful monitoring, visualization and networking. -Weave Cloud is built using these Open Source projects: [Weave Scope](https://www.weave.works/products/weave-scope/), a powerful container monitoring tool that automatically maps Docker containers and their interactions, [Weave Cortex](https://github.com/weaveworks/cortex), a horizontally-scalable version of Prometheus, and [Weave Flux](https://www.weave.works/products/weave-flux/), a continuous deployment tool that works with Kubernetes. +Weave Cloud is built using these Open Source projects: [Weave Scope](https://www.weave.works/products/weave-scope/), a powerful container visualization tool that automatically maps Docker containers and their interactions, [Weave Cortex](https://github.com/weaveworks/cortex), a horizontally-scalable version of Prometheus, and [Weave Flux](https://www.weave.works/products/weave-flux/), a continuous deployment tool that works with Kubernetes. # Weave Net @@ -28,7 +28,7 @@ Services provided by application containers on the Weave network can be exposed If you have any questions about, feedback for or a problem with Weave Net: -- Read [the Weave Net docs](https://www.weave.works/docs/net/latest/introducing-weave/). +- Read [the Weave Net docs](https://www.weave.works/docs/net/latest/overview). - Invite yourself to the #weave-community slack channel. - Ask a question on the #weave-community slack channel. - Join the Weave User Group and get invited to online talks, hands-on training and meetups in your area. @@ -39,5 +39,5 @@ Your feedback is always welcome! ## Further Information -* [Installing Weave Net](https://www.weave.works/docs/net/latest/installing-weave/) -* [Weave Net Product Overview](https://www.weave.works/products/weave-net/) +* [Installing Weave Net](https://www.weave.works/docs/net/latest/install/installing-weave) +* [Weave Net Product Overview](https://www.weave.works/products/weave-net) diff --git a/site/building.md b/site/building.md index 50aac708..26d5109b 100644 --- a/site/building.md +++ b/site/building.md @@ -1,6 +1,6 @@ --- title: Building Weave Net -menu_order: 120 +menu_order: 220 search_type: Documentation --- You only need to build Weave Net if you want to work on the Weave Net codebase diff --git a/site/concepts.md b/site/concepts.md new file mode 100644 index 00000000..1251e51a --- /dev/null +++ b/site/concepts.md @@ -0,0 +1,23 @@ +--- +title: Concepts in Weave Net +menu_order: 20 +search_type: Documentation +--- + +The section contains topics about how Weave Net works as well as providing a technical deep dive on how Weave Net implements fast datapath, and encryption. + +* [Understanding Weave Net](/site/concepts/how-it-works.md) +* [Weave Net Router Sleeve Encapsulation](/site/concepts/router-encapsulation.md) +* [How Weave Net Interprets Network Topology](/site/concepts/network-topology.md) + * [Communicating Topology Among Peers](https://weave.works/docs/net/latest/concepts/network-topology/#topology) + * [How Messages are Formed](https://weave.works/docs/net/latest/concepts/network-topology/#messages) + * [Removing Peers](https://weave.works/docs/net/latest/concepts/network-topology/#removing-peers) + * [What Happens When The Topology is Out of Date?](https://weave.works/docs/net/latest/concepts/network-topology/#out-of-date-topology) +* [Fast Datapath & Weave Net](/site/concepts/fastdp-how-it-works.md) +* [IP Addresses, Routes and Networks](/site/concepts/ip-addresses.md) +* [Encryption and Weave Net](/site/concepts/encryption.md) + * [How Weave Net Implements Encryption](/site/concepts/encryption-implementation.md) + * [Establishing the Emphemeral Session Key](https://weave.works/docs/net/latest/concepts/network-topology/#ephemeral-key) + * [Key Generation and the Linux CSPRIN](https://weave.works/docs/net/latest/concepts/network-topology/#cspring) + * [Encrypting and Decrypting TCP Messages](https://weave.works/docs/net/latest/concepts/network-topology/#tcp) + * [Encrypting and Decrypting UDP Messages](https://weave.works/docs/net/latest/concepts/network-topology/#udp) diff --git a/site/how-it-works/encryption-implementation.md b/site/concepts/encryption-implementation.md similarity index 97% rename from site/how-it-works/encryption-implementation.md rename to site/concepts/encryption-implementation.md index 2d44bc4d..ab2ab5a5 100644 --- a/site/how-it-works/encryption-implementation.md +++ b/site/concepts/encryption-implementation.md @@ -1,11 +1,11 @@ --- title: How Weave Net Implements Encryption -menu_order: 70 +menu_order: 60 search_type: Documentation --- This section describes some details of Weave Net's built-in -[encryption](/site/how-it-works/encryption.md): +[encryption](/site/concepts/encryption.md): * [Establishing the Ephemeral Session Key](#ephemeral-key) * [Key Generation](#csprng) @@ -148,7 +148,7 @@ follows: | Frame N: Captured payload | | +-----------------------------------+ -+ -This is very similar to the [non-crypto encapsulation](/site/how-it-works/router-encapsulation.md). +This is very similar to the [non-crypto encapsulation](/site/concepts/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 @@ -211,4 +211,4 @@ Integrity Check Value of AES-GCM. * [architecture documentation](https://github.com/weaveworks/weave/blob/master/docs/architecture.txt) * [fastdp encryption](https://github.com/weaveworks/weave/blob/master/docs/fastdp-crypto.md) - * [Securing Containers Across Untrusted Networks](/site/using-weave/security-untrusted-networks.md) + * [Securing Containers Across Untrusted Networks](/site/tasks/manage/security-untrusted-networks.md) diff --git a/site/how-it-works/encryption.md b/site/concepts/encryption.md similarity index 82% rename from site/how-it-works/encryption.md rename to site/concepts/encryption.md index f804a3a1..b7d1cb4d 100644 --- a/site/how-it-works/encryption.md +++ b/site/concepts/encryption.md @@ -1,14 +1,14 @@ --- title: Encryption and Weave Net -menu_order: 60 +menu_order: 50 search_type: Documentation --- Weave Net peers -[communicate with each other over both TCP and UDP](/site/how-it-works.md). This +[communicate with each other over both TCP and UDP](/site/concepts/how-it-works.md). This communication -[can be encrypted](/site/using-weave/security-untrusted-networks.md). +[can be encrypted](/site/tasks/manage/security-untrusted-networks.md). Encryption of control plane traffic (TCP) and data plane traffic (UDP) of sleeve overlay is accomplished using the [NaCl](http://nacl.cr.yp.to/) @@ -41,5 +41,5 @@ the IP transformation framework (XFRM). **See Also** - * [How Weave Implements Encryption](/site/how-it-works/encryption-implementation.md) - * [Securing Containers Across Untrusted Networks](/site/using-weave/security-untrusted-networks.md) + * [How Weave Implements Encryption](/site/concepts/encryption-implementation.md) + * [Securing Containers Across Untrusted Networks](/site/tasks/manage/security-untrusted-networks.md) diff --git a/site/how-it-works/fastdp-how-it-works.md b/site/concepts/fastdp-how-it-works.md similarity index 92% rename from site/how-it-works/fastdp-how-it-works.md rename to site/concepts/fastdp-how-it-works.md index a1e52301..4774c6a2 100644 --- a/site/how-it-works/fastdp-how-it-works.md +++ b/site/concepts/fastdp-how-it-works.md @@ -1,5 +1,5 @@ --- -title: How Fast Datapath Works +title: Fast Datapath & Weave Net menu_order: 30 search_type: Documentation --- @@ -25,7 +25,7 @@ Prior to version 1.2, Weave Net used a custom encapsulation format. Fast datapat **See Also** - * [Using Weave Net](/site/using-weave.md) - * [Using Fast Datapath](/site/using-weave/fastdp.md) + * [Launching Weave Net](/site/install/using-weave.md) + * [Using Fast Datapath](/site/tasks/manage/fastdp.md) diff --git a/site/how-it-works.md b/site/concepts/how-it-works.md similarity index 84% rename from site/how-it-works.md rename to site/concepts/how-it-works.md index 14fda30b..165aa8b2 100644 --- a/site/how-it-works.md +++ b/site/concepts/how-it-works.md @@ -1,11 +1,9 @@ --- -title: Understanding how Weave Net Works -menu_order: 90 +title: Understanding Weave Net +menu_order: 10 search_type: Documentation --- - - A Weave network consists of a number of 'peers' - Weave Net routers residing on different hosts. Each peer has a name, which tends to remain the same over restarts, a human friendly nickname for use in @@ -15,7 +13,7 @@ the router is concerned, although the name defaults to a MAC address. Weave Net routers establish TCP connections with each other, over which they perform a protocol handshake and subsequently exchange -[topology](/site/router-topology/network-topology.md) information. +[topology](/site/concepts/network-topology.md) information. These connections are encrypted if so configured. Peers also establish UDP "connections", possibly encrypted, which carry encapsulated network packets. These @@ -27,7 +25,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/using-weave/fastdp.md) method, which operates +methods: a [fast data path](/site/tasks/manage/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 @@ -47,5 +45,5 @@ first send it to peer 3: **See Also** - * [Weave Router Sleeve Encapsulation](/site/how-it-works/router-encapsulation.md) - * [How Weave Interprets Network Topology](/site/how-it-works/network-topology.md) + * [Weave Router Sleeve Encapsulation](/site/concepts/router-encapsulation.md) + * [How Weave Interprets Network Topology](/site/concepts/network-topology.md) diff --git a/site/how-it-works/ip-addresses.md b/site/concepts/ip-addresses.md similarity index 94% rename from site/how-it-works/ip-addresses.md rename to site/concepts/ip-addresses.md index 58f9ff12..e510c1c6 100644 --- a/site/how-it-works/ip-addresses.md +++ b/site/concepts/ip-addresses.md @@ -1,6 +1,6 @@ --- title: IP Addresses, Routes and Networks -menu_order: 50 +menu_order: 40 search_type: Documentation --- @@ -8,7 +8,7 @@ search_type: Documentation Weave Net runs containers on a private network, which means that IP addresses are isolated from the rest of the Internet, and that you don't have to worry about addresses clashing. -You can of course also manually change the IP of any given container or subnet on a Weave network. See, [How to Manually Specify IP Addresses and Subnets](/site/using-weave/manual-ip-address.md) +You can of course also manually change the IP of any given container or subnet on a Weave network. See, [How to Manually Specify IP Addresses and Subnets](/site/tasks/ipam/manual-ip-address.md) ### Some Definitions @@ -64,4 +64,4 @@ find a match, so uses the default rule. **See Also** - * [Allocating IPs in a Specific Range](/site/using-weave/configuring-weave.md) + * [Allocating IPs in a Specific Range](/site/tasks/ipam/configuring-weave.md) diff --git a/site/how-it-works/network-topology.md b/site/concepts/network-topology.md similarity index 98% rename from site/how-it-works/network-topology.md rename to site/concepts/network-topology.md index d168b5b0..111dd453 100644 --- a/site/how-it-works/network-topology.md +++ b/site/concepts/network-topology.md @@ -145,7 +145,7 @@ which time the topology should have updated. **See Also** - * [Weave Net Router Encapsulation](/site/how-it-works/router-encapsulation.md) + * [Weave Net Router Encapsulation](/site/concepts/router-encapsulation.md) diff --git a/site/how-it-works/router-encapsulation.md b/site/concepts/router-encapsulation.md similarity index 93% rename from site/how-it-works/router-encapsulation.md rename to site/concepts/router-encapsulation.md index f6b729d3..fc031530 100644 --- a/site/how-it-works/router-encapsulation.md +++ b/site/concepts/router-encapsulation.md @@ -1,11 +1,11 @@ --- title: Weave Net Router Sleeve Encapsulation -menu_order: 10 +menu_order: 15 search_type: Documentation --- When the Weave Net router forwards packets to peers in `sleeve` mode -(rather than via the [fast data path](/site/using-weave/fastdp.md)), the +(rather than via the [fast data path](/site/tasks/manage/fastdp.md)), the encapsulation looks something like this: +-----------------------------------+ @@ -62,4 +62,4 @@ MAC discovery. **See Also** - * [How Weave Net Interprets Network Topology](/site/how-it-works/network-topology.md) + * [How Weave Net Interprets Network Topology](/site/concepts/network-topology.md) diff --git a/site/top-diag1.dot b/site/concepts/top-diag1.dot similarity index 100% rename from site/top-diag1.dot rename to site/concepts/top-diag1.dot diff --git a/site/top-diag1.png b/site/concepts/top-diag1.png similarity index 100% rename from site/top-diag1.png rename to site/concepts/top-diag1.png diff --git a/site/how-it-works/weave-frame-encapsulation-178x300.png b/site/concepts/weave-frame-encapsulation-178x300.png similarity index 100% rename from site/how-it-works/weave-frame-encapsulation-178x300.png rename to site/concepts/weave-frame-encapsulation-178x300.png diff --git a/site/how-it-works/weave-net-encap1-1024x459.png b/site/concepts/weave-net-encap1-1024x459.png similarity index 100% rename from site/how-it-works/weave-net-encap1-1024x459.png rename to site/concepts/weave-net-encap1-1024x459.png diff --git a/site/how-it-works/weave-net-fdp1-1024x454.png b/site/concepts/weave-net-fdp1-1024x454.png similarity index 100% rename from site/how-it-works/weave-net-fdp1-1024x454.png rename to site/concepts/weave-net-fdp1-1024x454.png diff --git a/site/faq.md b/site/faq.md index 8f9c83aa..7afc207c 100644 --- a/site/faq.md +++ b/site/faq.md @@ -19,13 +19,13 @@ See [Troubleshooting Weave - List attached containers](/site/troubleshooting.md# 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). -For more information, refer to [Manually Specifying the IP Address of a Container](/site/using-weave/manual-ip-address.md). +For more information, refer to [Manually Specifying the IP Address of a Container](/site/tasks/ipam/manual-ip-address.md). **Q: How do I expose one of my containers to the outside world?** -Exposing a container to the outside world is described in [Exporting Services](/site/using-weave/service-management.md#exporting). +Exposing a container to the outside world is described in [Exporting Services](/site/tasks/manage/service-management.md#exporting). @@ -35,9 +35,9 @@ Yes you can. For example, you have a Weave network that runs on hosts A, B, C. and you have an additional host, that we'll call P, where neither Weave nor Docker are running. However, you need to connect from a process running on host P to a specific container running on host B on the Weave network. Since the Weave network is completely separate from any network that P is connected to, you cannot connect the container using the container's IP address. -A simple way to accomplish this would be to run Weave on the host and then run, `weave expose` to expose the network to any running containers. Or you set up a route from P to one of A, B or C. See [Integrating a Network Host](/site/using-weave/host-network-integration.md). +A simple way to accomplish this would be to run Weave on the host and then run, `weave expose` to expose the network to any running containers. Or you set up a route from P to one of A, B or C. See [Integrating a Network Host](/site/tasks/manage/host-network-integration.md). -Yet another option is to expose a port from the container on host B and then connect to it. You can read about exposing ports in [Exporting Services](/site/using-weave/service-management.md#exporting). +Yet another option is to expose a port from the container on host B and then connect to it. You can read about exposing ports in [Exporting Services](/site/tasks/manage/service-management.md#exporting). @@ -45,7 +45,7 @@ Yet another option is to expose a port from the container on host B and then con Under normal circumstances, this should never happen, but it can occur if `weave rmpeer` was run on more than one host. -For more information see [Starting, Stopping and Removing Peers](/site/ipam/stop-remove-peers-ipam.md). +For more information see [Starting, Stopping and Removing Peers](/site/tasks/ipam/stop-remove-peers-ipam.md). @@ -53,7 +53,7 @@ For more information see [Starting, Stopping and Removing Peers](/site/ipam/stop 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 in-depth discussion. +See [Starting, Stopping and Removing Peers](/site/tasks/ipam/stop-remove-peers-ipam.md) for an in-depth discussion. @@ -63,7 +63,7 @@ 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/how-it-works/fastdp-how-it-works.md). +For more information about fast datapath see [How Fast Datapath Works](/site/concepts/fastdp-how-it-works.md). @@ -71,7 +71,7 @@ For more information about fast datapath see [How Fast Datapath Works](/site/how 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/using-weave/fastdp.md). +For more information on this command, see [Using Fast Datapath](/site/tasks/manage/fastdp.md). @@ -79,12 +79,12 @@ For more information on this command, see [Using Fast Datapath](/site/using-weav Yes, 1.9 version of Weave Net added the encryption feature to fastdp. -See [Using Fast Datapath](/site/using-weave/fastdp.md) for more information. +See [Using Fast Datapath](/site/tasks/manage/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?** -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). +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/tasks/manage/application-isolation.md). **Q: Which ports does Weave Net use (e.g. if I am configuring a firewall) ?** @@ -92,7 +92,7 @@ Yes, of course! Weave allows you to run isolated networks and still allow open You must permit traffic to flow through TCP 6783 and UDP 6783/6784, which are Weave’s control and data ports. -The daemon also uses TCP port 6782 for [metrics](/site/metrics.md), but +The daemon also uses TCP port 6782 for [metrics](/site/tasks/manage/metrics.md), but you would only need to open up this port if you wish to collect metrics from another host. @@ -116,6 +116,6 @@ Ubuntu image with those two commands added. **See Also** * [Troubleshooting Weave](/site/troubleshooting.md) - * [Troubleshooting IPAM](/site/ipam.md) - * [Troubleshooting the Proxy](/site/weave-docker-api/using-proxy.md) + * [Troubleshooting IPAM](/site/tasks/ipam/ipam.md) + * [Troubleshooting the Proxy](/site/tasks/weave-docker-api/using-proxy.md) diff --git a/site/install.md b/site/install.md new file mode 100644 index 00000000..16d0f822 --- /dev/null +++ b/site/install.md @@ -0,0 +1,42 @@ +--- +title: Installing Weave Net +menu_order: 30 +search_type: Documentation +--- + +Install Weave Net from the command line on its own or if you are using Docker, Kubernetes or Mesosphere as a Docker or a CNI plugin. Weave Net can also be launched it as a cloud agent within Weave Cloud to visualize and troubleshoot peer connections. + + +## Installing Weave Net Stand-alone and in Weave Cloud + +* [Installing Weave Net](https://www.weave.works/docs/net/latest/install/installing-weave/) +* [Launching Weave Net](https://www.weave.works/docs/net/latest/install/using-weave/) +* [Visualizing Weave Net in Weave Cloud](https://www.weave.works/docs/net/latest/install/weave-cloud/) +* [Using Weave with Systemd](https://www.weave.works/docs/net/latest/install/systemd/) + + +## Weave Net Docker Plugin + +* [How the Weave Net Docker Network Plugins Work](https://www.weave.works/docs/net/latestplugin/plugin-how-it-works/) +* [Integrating Docker via the Network Plugin (V2)](https://www.weave.works/docs/net/latest/install/plugin/plugin-v2/) + * [Installation](https://www.weave.works/docs/net/latest/install/plugin/plugin-v2/#installation) + * [Configuring the Plugin](https://www.weave.works/docs/net/latest/install/plugin/plugin-v2/#configuring) + * [Running Services or Containers Using the Plugin](https://www.weave.works/docs/net/latest/install/plugin/plugin-v2/#usage) +* [Integrating Docker via the Network Plugin (Legacy)](https://www.weave.works/docs/net/latest/install/plugin/plugin/) + * [Launching Weave Net and Running Containers Using the Plugin](https://www.weave.works/docs/net/latest/install/plugin/plugin/#launching) + * [Restarting the Plugin](https://www.weave.works/docs/net/latest/install/plugin/plugin/#restarting) + +## Weave Net CNI plugin for Kubernetes and Mesosphere + +* [Integrating Kubernetes and Mesos via the CNI Plugin](https://www.weave.works/docs/net/latest/kubernetes/) +* [Integrating Kubernetes via the Addon](https://www.weave.works/docs/net/latest/kubernetes/kube-addon/) + * [Installation](https://www.weave.works/docs/net/latest/kubernetes/kube-addon/#install) + * [Upgrading Kubernetes to version 1.6](https://www.weave.works/docs/net/latest/kubernetes/kube-addon/#kube-1.6-upgrade) + * [Upgrading the Daemon Sets](https://www.weave.works/docs/net/latest/kubernetes/kube-addon/#daemon-sets) + * [CPU and Memory Requirements](https://www.weave.works/docs/net/latest/kubernetes/kube-addon/#resources) + * [Pod Eviction](https://www.weave.works/docs/net/latest/kubernetes/kube-addon/#eviction) + * [Network Policy Controller](https://www.weave.works/docs/net/latest/kubernetes/kube-addon/#npc) + * [Troubleshooting Blocked Connections](https://www.weave.works/docs/net/latest/kubernetes/kube-addon/#blocked-connections) + * [Changing Configuration Options](https://www.weave.works/docs/net/latest/kubernetes/kube-addon/#configuration-options) + + diff --git a/site/hello-screencast.png b/site/install/hello-screencast.png similarity index 100% rename from site/hello-screencast.png rename to site/install/hello-screencast.png diff --git a/site/installing-weave.md b/site/install/installing-weave.md similarity index 81% rename from site/installing-weave.md rename to site/install/installing-weave.md index 9f3e8042..4f4fdab1 100644 --- a/site/installing-weave.md +++ b/site/install/installing-weave.md @@ -1,6 +1,6 @@ --- title: Installing Weave Net -menu_order: 30 +menu_order: 10 search_type: Documentation --- @@ -17,9 +17,9 @@ If you are on OSX and you are using Docker Machine ensure that a VM is running a before downloading Weave Net. To set up a VM see [the Docker Machine documentation](https://docs.docker.com/installation/mac/#from-your-shell) or refer to ["Part 1: Launching Weave Net with Docker Machine"](/guides/part-1-launching-weave-net-with-docker-machine/). -After your VM is setup with Docker Machine, Weave Net can be launched directly from the OSX host. Weave Net respects the environment variable `DOCKER_HOST`, so that you can run and control a Weave Network locally on a remote host. See [Using The Weave Docker API Proxy](/site/weave-docker-api/using-proxy.md). +After your VM is setup with Docker Machine, Weave Net can be launched directly from the OSX host. Weave Net respects the environment variable `DOCKER_HOST`, so that you can run and control a Weave Network locally on a remote host. See [Using The Weave Docker API Proxy](/site/tasks/weave-docker-api/using-proxy.md). -With Weave Net downloaded onto your VMs or hosts, you are ready to launch a Weave network and deploy apps onto it. See [Using Weave Net](/site/using-weave.md). +With Weave Net downloaded onto your VMs or hosts, you are ready to launch a Weave network and deploy apps onto it. See [Launching Weave Net](/site/install/using-weave.md). ### Quick Start Screencast @@ -32,7 +32,7 @@ With Weave Net downloaded onto your VMs or hosts, you are ready to launch a Weav Weave Net [periodically contacts Weaveworks servers for available versions](https://github.com/weaveworks/go-checkpoint). New versions are announced in the log and in [the status -summary](/site/troubleshooting.md#weave-status). +summary](/site/troubleshooting.md/#weave-status). The information sent in this check is: @@ -55,19 +55,19 @@ for the latest Weave AMIs and [here](https://www.weave.works/docs/tutorials/old- If you're on Amazon EC2, the standard installation instructions at the top of this page, provide the simplest setup and the most flexibility. -A [special no-overlay mode for EC2](/site/using-weave/awsvpc.md) can +A [special no-overlay mode for EC2](/site/tasks/manage/awsvpc.md) can optionally be enabled, which allows containers to communicate at the full speed of the underlying network. To make encryption in fast datapath work on Google Cloud Platform, see -[here](/site/faq.md#ports). +[here](/site/faq.md/#ports). **See Also** - * [Using Weave Net](/site/using-weave.md) - * [Getting Started Guides](http://www.weave.works/guides/) - * [Features](/site/features.md) + * [Launching Weave Net](/site/install/using-weave.md) + * [Tutorials](https://www.weave.works/docs/tutorials/) + * [Features](/site/overview/features.md) * [Troubleshooting](/site/troubleshooting.md) * [Building](/site/building.md) - * [Using Weave with Systemd](/site/installing-weave/systemd.md) + * [Using Weave with Systemd](/site/install/systemd.md) diff --git a/site/install/plugin.md b/site/install/plugin.md new file mode 100644 index 00000000..927cabfc --- /dev/null +++ b/site/install/plugin.md @@ -0,0 +1,6 @@ +--- +title: Weave Net Docker Plugin +menu_order: 50 +search_type: Documentation +--- + diff --git a/site/plugin/plugin-how-it-works.md b/site/install/plugin/plugin-how-it-works.md similarity index 88% rename from site/plugin/plugin-how-it-works.md rename to site/install/plugin/plugin-how-it-works.md index 573277e8..ef42a9a8 100644 --- a/site/plugin/plugin-how-it-works.md +++ b/site/install/plugin/plugin-how-it-works.md @@ -1,6 +1,6 @@ --- title: How the Weave Net Docker Network Plugins Work -menu_order: 20 +menu_order: 10 search_type: Documentation --- @@ -11,7 +11,7 @@ named `weave` that can only work with one (like Docker's overlay driver), while the V2 plugin provides *one* - `store/weaveworks/net-plugin:latest_release` operating only in swarm mode. -### `weavemesh` driver +### weavemesh driver * Weave Net handles all co-ordination between hosts (referred to by Docker as a "local scope" driver) * Supports a single network only. A network named `weave` is automatically created for you. @@ -19,7 +19,7 @@ operating only in swarm mode. If you do create additional networks using the `weavemesh` driver, containers attached to them will be able to communicate with containers attached to `weave`. There is no isolation between those networks. -### `weave` driver +### weave driver * This runs in what Docker calls "global scope", which requires an external cluster store * Supports multiple networks that must be created using `docker network create --driver weave ...` @@ -41,7 +41,7 @@ The plugin accepts the following options via `docker network create ... --opt`: network created when the plugin is first launched has the multicast option turned on, but for any networks you create it defaults to off. -### `store/weaveworks/net-plugin:latest_release` driver +### store/weaveworks/net-plugin:latest_release driver * The driver runs within the plugin V2. * Requires Docker to run in [swarm mode](https://docs.docker.com/engine/swarm/swarm-mode/). @@ -51,6 +51,6 @@ The plugin accepts the following options via `docker network create ... --opt`: **See Also** - * [Integrating Docker via the Network Plugin (Legacy)](/site/plugin.md) - * [Integrating Docker via the Network Plugin (V2)](/site/plugin-v2.md) + * [Integrating Docker via the Network Plugin (Legacy)](/site/install/plugin/plugin.md) + * [Integrating Docker via the Network Plugin (V2)](/site/install/plugin/plugin-v2.md) diff --git a/site/plugin-v2.md b/site/install/plugin/plugin-v2.md similarity index 87% rename from site/plugin-v2.md rename to site/install/plugin/plugin-v2.md index 00bfdc91..be5ecb4d 100644 --- a/site/plugin-v2.md +++ b/site/install/plugin/plugin-v2.md @@ -1,6 +1,6 @@ --- title: Integrating Docker via the Network Plugin (V2) -menu_order: 65 +menu_order: 20 search_type: Documentation --- @@ -34,18 +34,18 @@ There are several configuration parameters which can be set with: The parameters include: * `WEAVE_PASSWORD` - if non empty, it will instruct Weave Net to encrypt - traffic - see [here](/site/using-weave/security-untrusted-networks.md) for + traffic - see [here](/site/tasks/manage/security-untrusted-networks.md) for more details. * `WEAVE_MULTICAST` - set to 1 on each host running the plugin to enable multicast traffic on any Weave Net network. * `WEAVE_MTU` - Weave Net defaults to 1376 bytes, but you can set a smaller size if your underlying network has a tighter limit, or set a larger size for better performance if your network supports jumbo - frames - see [here](/site/using-weave/fastdp.md#mtu) for more + frames - see [here](/site/tasks/manage/fastdp.md#mtu) for more details. * `IPALLOC_RANGE` - the range of IP addresses used by Weave Net and the subnet they are placed in (CIDR format; default 10.32.0.0/12). - See [here](/site/using-weave/configuring-weave.md) for more details. + See [here](/site/tasks/ipam/configuring-weave.md) for more details. Before setting any parameter, the plugin has to be disabled with: @@ -76,5 +76,5 @@ Or to start a container: **See Also** - * [Integrating Docker via the Network Plugin (Legacy)](/site/plugin.md) - * [How the Weave Network Plugins Work](/site/plugin/plugin-how-it-works.md) + * [Integrating Docker via the Network Plugin (Legacy)](/site/install/plugin/plugin.md) + * [How the Weave Network Plugins Work](/site/install/plugin/plugin-how-it-works.md) diff --git a/site/plugin.md b/site/install/plugin/plugin.md similarity index 89% rename from site/plugin.md rename to site/install/plugin/plugin.md index fc359807..3691e191 100644 --- a/site/plugin.md +++ b/site/install/plugin/plugin.md @@ -1,6 +1,6 @@ --- title: Integrating Docker via the Network Plugin (Legacy) -menu_order: 60 +menu_order: 30 search_type: Documentation --- @@ -14,9 +14,9 @@ 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). +[`weave connect`](/site/tasks/manage/finding-adding-hosts-dynamically.md). -See [Using Weave Net](/site/using-weave.md#peer-connections) for a discussion on peer connections. +See [Launching Weave Net](/site/install/using-weave.md#peer-connections) for a discussion on peer connections. After you've launched Weave Net and peered your hosts, you can start containers using the following, for example: @@ -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 using any protocol, even multicast. -In order to use Weave Net's [Service Discovery](/site/weavedns.md) you +In order to use Weave Net's [Service Discovery](/site/tasks/weavedns/weavedns.md) you must pass the additional arguments `--dns` and `-dns-search`, for which a helper is provided in the Weave script: @@ -63,7 +63,7 @@ this between hosts requires that you run Docker in ["swarm mode"](https://docs.d ["key-value store"](https://docs.docker.com/engine/userguide/networking/get-started-overlay/#/set-up-a-key-value-store). To operate in swarm mode, you are required to use the plugin v2 of Weave Net. -See [Integrating Docker via the Network Plugin (V2)](/site/plugin-v2.md) for +See [Integrating Docker via the Network Plugin (V2)](/site/install/plugin/plugin-v2.md) for more details. If your Docker installation has a key-value store, create a network @@ -96,4 +96,4 @@ If you are using `systemd` with Docker 1.9, it is advised that you modify the Do **See Also** - * [How the Weave Network Plugins Work](/site/plugin/plugin-how-it-works.md) + * [How the Weave Network Plugins Work](/site/install/plugin/plugin-how-it-works.md) diff --git a/site/installing-weave/systemd.md b/site/install/systemd.md similarity index 79% rename from site/installing-weave/systemd.md rename to site/install/systemd.md index 50bebabc..e2794cf7 100644 --- a/site/installing-weave/systemd.md +++ b/site/install/systemd.md @@ -1,11 +1,11 @@ --- title: Using Weave with Systemd -menu_order: 130 +menu_order: 40 search_type: Documentation --- -Having installed Weave Net as per [Installing Weave](/site/installing-weave.md), you might find it convenient to configure the +Having installed Weave Net as per [Installing Weave](/site/install/installing-weave.md), you might find it convenient to configure the init daemon to start Weave on boot. Most recent Linux distribution releases ship with [systemd](http://www.freedesktop.org/wiki/Software/systemd/). The information below provides you with some initial guidance on getting a Weave Net service configured on a systemd-based OS. ## Weave Net Service Unit and Configuration @@ -32,11 +32,11 @@ create the `/etc/sysconfig/weave` environment file using the following format: PEERS="HOST1 HOST2 .. HOSTn" -You can also use the [`weave connect`](/site/using-weave/finding-adding-hosts-dynamically.md) command to add participating hosts dynamically. +You can also use the [`weave connect`](/site/tasks/manage/finding-adding-hosts-dynamically.md) command to add participating hosts dynamically. -Additionally, if you want to enable [encryption](/site/using-weave/security-untrusted-networks.md) specify a +Additionally, if you want to enable [encryption](/site/tasks/manage/security-untrusted-networks.md) specify a password using `WEAVE_PASSWORD="wfvAwt7sj"` in the `/etc/sysconfig/weave` environment file, and it will get picked up by -Weave Net on launch. Recommendations for choosing a suitably strong password can be found [here](/site/using-weave/security-untrusted-networks.md). +Weave Net on launch. Recommendations for choosing a suitably strong password can be found [here](/site/tasks/manage/security-untrusted-networks.md). You can now launch Weave Net using @@ -64,7 +64,7 @@ context with the commands shown below. You will need to have the **See Also** - * [Using Weave Net](/site/using-weave.md) - * [Getting Started Guides](http://www.weave.works/guides/) - * [Features](/site/features.md) + * [Launching Weave Net](/site/install/using-weave.md) + * [Tutorials](https://www.weave.works/docs/tutorials/) + * [Features](/site/overview/features.md) * [Troubleshooting](/site/troubleshooting.md) diff --git a/site/using-weave.md b/site/install/using-weave.md similarity index 90% rename from site/using-weave.md rename to site/install/using-weave.md index 89a4d4c9..937933d9 100644 --- a/site/using-weave.md +++ b/site/install/using-weave.md @@ -1,6 +1,6 @@ --- -title: Using Weave Net -menu_order: 40 +title: Launching Weave Net +menu_order: 20 search_type: Documentation --- @@ -13,7 +13,6 @@ This section contains the following topics: * [Testing Container Communications](#testing) * [Starting the Netcat Service](#start-netcat) - ### Launching Weave Net Before launching Weave Net and deploying your apps, ensure that Docker is [installed](https://docs.docker.com/engine/installation/) on both hosts. @@ -82,7 +81,7 @@ For example: host2$ weave launch -Peers can also be dynamically added. See [Adding Hosts Dynamically](/site/using-weave/finding-adding-hosts-dynamically.md) for more information. +Peers can also be dynamically added. See [Adding Hosts Dynamically](/site/tasks/manage/finding-adding-hosts-dynamically.md) for more information. #### Restricting Access @@ -94,7 +93,7 @@ Standard firewall rules can be deployed to restrict access to the Weave Net control and data ports. For communication across untrusted networks, connections can be -[encrypted](/site/using-weave/security-untrusted-networks.md). +[encrypted](/site/tasks/manage/security-untrusted-networks.md). ### Testing Container Communications @@ -135,8 +134,8 @@ 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 Weave Cloud to get started with Weave Net](/site/using-weave/weave-cloud.md) - * [Using Fastdp With Weave Net](/site/using-weave/fastdp.md) - * [Integrating Docker via the Network Plugin (Legacy)](/site/plugin.md) - * [Integrating Docker via the Network Plugin (V2)](/site/plugin-v2.md) + * [Installing Weave Net](/site/install/installing-weave.md) + * [Using Weave Cloud to get started with Weave Net](/site/install/weave-cloud.md) + * [Using Fastdp With Weave Net](/site/tasks/manage/fastdp.md) + * [Integrating Docker via the Network Plugin (Legacy)](/site/install/plugin/plugin.md) + * [Integrating Docker via the Network Plugin (V2)](/site/install/plugin/plugin-v2.md) diff --git a/site/using-weave/weave-cloud-token.png b/site/install/weave-cloud-token.png similarity index 100% rename from site/using-weave/weave-cloud-token.png rename to site/install/weave-cloud-token.png diff --git a/site/using-weave/weave-cloud.md b/site/install/weave-cloud.md similarity index 87% rename from site/using-weave/weave-cloud.md rename to site/install/weave-cloud.md index 785a95aa..85780780 100644 --- a/site/using-weave/weave-cloud.md +++ b/site/install/weave-cloud.md @@ -1,6 +1,6 @@ --- -title: Using Weave Cloud to get started with Weave Net -menu_order: 10 +title: Visualizing Weave Net in Weave Cloud +menu_order: 30 search_type: Documentation --- @@ -86,7 +86,7 @@ first and automatically create a connection to it. >**Note:** If there is a firewall between `$HOST1` and `$HOST2`, you must permit traffic to flow through TCP 6783 and UDP 6783/6784, which are Weave’s control and data ports. -Now you can proceed to [test container communications](/site/using-weave#testing) +Now you can proceed to [test container communications](/site/install/using-weave#testing) ### How Peer Discovery Works @@ -110,19 +110,19 @@ error message in its log and exit. To check the logs run: host1$ docker logs weave When a Weave Net instance is formed for the first time, the peers must -initialize the [IP Allocation Manager](/site/ipam.md). This process, +initialize the [IP Allocation Manager](/site/tasks/ipam/ipam.md). This process, and the configuration options available, are unchanged when using Weave Cloud. When you shut down a peer for good, use [the `weave reset` -command](/site/ipam/stop-remove-peers-ipam.md) and it will be removed +command](/site/tasks/ipam/stop-remove-peers-ipam.md) and it will be removed from the Weave Cloud database so future peers will not attempt to connect to it. **See Also** - * [Installing Weave Net](/site/installing-weave.md) - * [Using Weave Net](/site/using-weave.md) - * [Using Fastdp With Weave Net](/site/using-weave/fastdp.md) - * [Integrating Docker via the Network Plugin (Legacy)](/site/plugin.md) - * [Integrating Docker via the Network Plugin (V2)](/site/plugin-v2.md) + * [Installing Weave Net](/site/install/installing-weave.md) + * [Launching Weave Net](/site/install/using-weave.md) + * [Using Fastdp With Weave Net](/site/tasks/manage/fastdp.md) + * [Integrating Docker via the Network Plugin (Legacy)](/site/install/plugin/plugin.md) + * [Integrating Docker via the Network Plugin (V2)](/site/install/plugin/plugin-v2.md) diff --git a/site/cni-plugin.md b/site/kubernetes.md similarity index 93% rename from site/cni-plugin.md rename to site/kubernetes.md index 2e5b3efd..0c8b13f8 100644 --- a/site/cni-plugin.md +++ b/site/kubernetes.md @@ -1,11 +1,11 @@ --- title: Integrating Kubernetes and Mesos via the CNI Plugin -menu_order: 65 +menu_order: 40 search_type: Documentation --- > The recommended way of using Weave with Kubernetes is via the new -> [Kubernetes Addon](/site/kube-addon.md). The instructions below +> [Kubernetes Addon](/site/kubernetes/kube-addon.md). The instructions below > remain valid however, and are still the recommended method for > integrating with Mesos. @@ -34,9 +34,9 @@ Then run: To create a network that spans multiple hosts, the Weave peers must be connected to each other. This is accomplished by specifying the other hosts during `weave launch` or via -[`weave connect`](/site/using-weave/finding-adding-hosts-dynamically.md). +[`weave connect`](/site/tasks/manage/finding-adding-hosts-dynamically.md). -See [Creating Peer Connections Between Hosts](/site/using-weave.md#peer-connections) +See [Creating Peer Connections Between Hosts](/site/install/using-weave.md#peer-connections) for a discussion on peer connections. weave launch diff --git a/site/kube-addon.md b/site/kubernetes/kube-addon.md similarity index 99% rename from site/kube-addon.md rename to site/kubernetes/kube-addon.md index 896ad37e..cdf2c4a5 100644 --- a/site/kube-addon.md +++ b/site/kubernetes/kube-addon.md @@ -1,6 +1,6 @@ --- title: Integrating Kubernetes via the Addon -menu_order: 63 +menu_order: 20 search_type: Documentation --- @@ -43,7 +43,7 @@ recommend your master node has at least two CPU cores. > Alternatively, you can [configure CNI yourself](http://kubernetes.io/docs/admin/network-plugins/#cni) **Note:** If using the [Weave CNI -Plugin](/site/cni-plugin.md) from a prior full install of Weave Net with your +Plugin](/site/kubernetes.md) from a prior full install of Weave Net with your cluster, you must first uninstall it before applying the Weave-kube addon. Shut down Kubernetes, and _on all nodes_ perform the following: @@ -237,7 +237,7 @@ The list of variables you can set is: * `WEAVE_MTU` - Weave Net defaults to 1376 bytes, but you can set a smaller size if your underlying network has a tighter limit, or set a larger size for better performance if your network supports jumbo - frames - see [here](/site/using-weave/fastdp.md#mtu) for more + frames - see [here](/site/tasks/manage/fastdp.md#mtu) for more details. Example: diff --git a/site/operational-guide/autoscaling.md b/site/operational-guide/autoscaling.md index 41ccf719..79a0db40 100644 --- a/site/operational-guide/autoscaling.md +++ b/site/operational-guide/autoscaling.md @@ -25,7 +25,7 @@ and partitions. ### Scaling Out On the additional dynamic peer, at boot, via -[systemd](/site/installing-weave/systemd.md) or equivalent: +[systemd](/site/install/systemd.md) or equivalent: weave launch --no-restart --ipalloc-init=observer $PEERS diff --git a/site/operational-guide/concepts.md b/site/operational-guide/concepts.md index 604db86d..0ffda7b6 100644 --- a/site/operational-guide/concepts.md +++ b/site/operational-guide/concepts.md @@ -72,7 +72,7 @@ detail below. 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). +[enabled by default](/site/tasks/manage/finding-adding-hosts-dynamically.md). ## Network Partition @@ -85,7 +85,7 @@ partition, healing automatically once the partition is over. ## IP Address Manager (IPAM) -[IPAM](/site/ipam.md) is the subsystem responsible for dividing up a +[IPAM](/site/tasks/ipam/ipam.md) is the subsystem responsible for dividing up a large contiguous block of IP addresses (known as the IP allocation range) amongst peers so that individual addresses may be uniquely assigned to containers anywhere on the overlay network. diff --git a/site/operational-guide/tasks.md b/site/operational-guide/tasks.md index 3cb14c87..3c703b97 100644 --- a/site/operational-guide/tasks.md +++ b/site/operational-guide/tasks.md @@ -21,7 +21,7 @@ once and your system is configured to start Docker on boot, then Weave Net will start automatically on system restarts. If you are aiming for a non-interactive installation, use -[systemd](/site/installing-weave/systemd.md) or a similar init system to +[systemd](/site/install/systemd.md) or a similar init system to launch Weave using the `--no-restart` flag after Docker has been started. ## Detecting and Reclaiming Lost IP Address Space @@ -66,7 +66,7 @@ after which one of the remaining peers could decide unilaterally that it is safe to appropriate the space for itself, and so an administrative action is required to reclaim it. -The [`weave rmpeer`](/site/ipam/stop-remove-peers-ipam.md) +The [`weave rmpeer`](/site/tasks/ipam/stop-remove-peers-ipam.md) command is provided to perform this task, and must be executed on _one_ of the remaining peers. That peer will then take ownership of the freed address space. @@ -115,6 +115,6 @@ you can issue the following command: **See Also** - * [Allocating IP Addresses](/site/ipam.md) - * [Troubleshooting the IP Allocator](/site/ipam/troubleshooting-ipam.md) + * [Allocating IP Addresses](/site/tasks/ipam/ipam.md) + * [Troubleshooting the IP Allocator](/site/tasks/ipam/troubleshooting-ipam.md) diff --git a/site/operational-guide/uniform-dynamic-cluster.md b/site/operational-guide/uniform-dynamic-cluster.md index fe067618..c33456d7 100644 --- a/site/operational-guide/uniform-dynamic-cluster.md +++ b/site/operational-guide/uniform-dynamic-cluster.md @@ -18,7 +18,7 @@ A uniform dynamic cluster has the following characteristics: ## Bootstrapping On each initial peer N, at boot, via -[systemd](/site/installing-weave/systemd.md): +[systemd](/site/install/systemd.md): hostN$ weave launch --no-restart --name ::N --ipalloc-init seed=$SEED $PEERS @@ -45,7 +45,7 @@ Where ## Adding a Peer On each new peer, at boot, via -[systemd](/site/installing-weave/systemd.md): +[systemd](/site/install/systemd.md): hostN$ weave launch --no-restart --name ::N --ipalloc-init seed=$SEED $PEERS diff --git a/site/operational-guide/uniform-fixed-cluster.md b/site/operational-guide/uniform-fixed-cluster.md index 0913fbc7..fa9c56d4 100644 --- a/site/operational-guide/uniform-fixed-cluster.md +++ b/site/operational-guide/uniform-fixed-cluster.md @@ -24,7 +24,7 @@ A uniform fixed cluster has the following characteristics: ### Bootstrapping On each initial peer, at boot, via -[systemd](/site/installing-weave/systemd.md): +[systemd](/site/install/systemd.md): weave launch --no-restart $PEERS @@ -56,7 +56,7 @@ that](/site/troubleshooting.md) before moving on. ### Adding a Peer On the new peer, at boot, via -[systemd](/site/installing-weave/systemd.md) run: +[systemd](/site/install/systemd.md) run: weave launch --no-restart $PEERS diff --git a/site/introducing-weave.md b/site/overview.md similarity index 95% rename from site/introducing-weave.md rename to site/overview.md index 93fb9e9f..850a030e 100644 --- a/site/introducing-weave.md +++ b/site/overview.md @@ -27,7 +27,7 @@ Weave Net implements service discovery by providing a fast "micro DNS" server at All other Docker networking plugins, including Docker's own "Overlay" driver, require that you set up Docker with a cluster store – a central database like Consul or Zookeeper – before you can even use them. Besides being difficult to set up, maintain and manage, every Docker host must also be in constant contact with the cluster store: if you lose the connection, even temporarily, then you cannot start or stop any containers. Weave Net is bundled with a Docker Network plugin that doesn't require an external cluster store. You can get started right away and you can start and stop containers even when there are network connectivity problems. -For information about the Weave Docker Plugin, see [How The Weave Network Plugin Works](/site/plugin/plugin-how-it-works.md). +For information about the Weave Docker Plugin, see [How The Weave Network Plugin Works](/site/install/plugin/plugin-how-it-works.md). ### Operates in Partially Connected Networks @@ -37,7 +37,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/using-weave/fastdp.md) for more information. +See [How Fast Datapath Works](/site/tasks/manage/fastdp.md) for more information. ### Network Operations Friendly @@ -60,7 +60,7 @@ With Weave Net, deploy your applications - whether peer-to-peer file sharing, vo Weave Net is a good choice if you want one tool for everything. For example: In addition to Docker plugins, you can also use Weave as a Kubernetes plugin. You can also use Weave with Amazon ECS or with Mesos and Marathon. Refer to our Getting Started and Integration Guides for more information. -For a complete list and description of Weave Net’s current feature set see, [Weave Net Features](/site/features.md). +For a complete list and description of Weave Net’s current feature set see, [Weave Net Features](/site/overview/features.md). diff --git a/site/features.md b/site/overview/features.md similarity index 80% rename from site/features.md rename to site/overview/features.md index 03187e3a..925171c5 100644 --- a/site/features.md +++ b/site/overview/features.md @@ -26,7 +26,7 @@ search_type: Documentation * [Container Mobility](#container-mobility) * [Fault Tolerance](#fault-tolerance) -For step-by-step instructions on how to use Weave Net, see [Using Weave Net](/site/using-weave.md). +For step-by-step instructions on how to use Weave Net, see [Launching Weave Net](/site/install/using-weave.md). ### Virtual Ethernet Switch @@ -44,8 +44,8 @@ a container network. Broadcast and Multicast protocols can also be used over Weave Net. -To start using Weave Net, see [Installing Weave Net](/site/installing-weave.md) -and [Using Weave Net](/site/using-weave.md). +To start using Weave Net, see [Installing Weave Net](/site/install/installing-weave.md) +and [Launching Weave Net](/site/install/using-weave.md). ### Fast Datapath @@ -53,12 +53,12 @@ Weave Net automatically chooses the fastest available method to transport data between peers. The best performing of these (the 'fast datapath') offers near-native throughput and latency. -See [Using Fast Datapath](/site/using-weave/fastdp.md) and -[How Fast Datapath Works](/site/how-it-works/fastdp-how-it-works.md). +See [Using Fast Datapath](/site/tasks/manage/fastdp.md) and +[How Fast Datapath Works](/site/concepts/fastdp-how-it-works.md). ### Seamless Docker Integration (Weave Docker API Proxy) -Weave Net includes a [Docker API Proxy](/site/weave-docker-api.md), which can be +Weave Net includes a [Docker API Proxy](/site/tasks/weave-docker-api/weave-docker-api.md), which can be used to start containers using the Docker [command-line interface](https://docs.docker.com/reference/commandline/cli/) or the [remote API](https://docs.docker.com/reference/api/docker_remote_api/), and attach them to the Weave network before they begin execution. To use the proxy, run: @@ -71,7 +71,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 [Integrating Docker via the API Proxy](/site/weave-docker-api.md). +See [Integrating Docker via the API Proxy](/site/tasks/weave-docker-api/weave-docker-api.md). ### Weave Network Docker Plugin @@ -84,15 +84,15 @@ named `weave` is created by `weave launch`, which is used as follows: Using the Weave plugin enables you to take advantage of [Docker's network functionality](https://docs.docker.com/engine/extend/plugins_network/). There are two plugin implementations for Weave Net: the -["Legacy"](/site/plugin.md) plugin which doesn't require an external -cluster store, and the ["V2"](/site/plugin-v2.md) plugin which +["Legacy"](/site/install/plugin/plugin.md) plugin which doesn't require an external +cluster store, and the ["V2"](/site/install/plugin/plugin-v2.md) plugin which supports Docker swarm mode. ### 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 and Mesosphere. -See [Integrating Kubernetes and Mesos via the CNI Plugin](/site/cni-plugin.md) for more details. +See [Integrating Kubernetes and Mesos via the CNI Plugin](/site/kubernetes.md) for more details. ### IP Address Management (IPAM) @@ -100,24 +100,24 @@ See [Integrating Kubernetes and Mesos via the CNI Plugin](/site/cni-plugin.md) f Containers are automatically allocated a unique IP address. To view the addresses allocated by Weave, run `weave ps`. Instead of allowing Weave to automatically allocate addresses, an IP address and a network can be explicitly -specified. See [How to Manually Specify IP Addresses and Subnets](/site/using-weave/manual-ip-address.md) for instructions. +specified. See [How to Manually Specify IP Addresses and Subnets](/site/tasks/ipam/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/how-it-works/ip-addresses.md) for an explanation of addressing and private networks. +For a discussion on how Weave Net uses IPAM, see [Automatic IP Address Management](/site/tasks/ipam/ipam.md). And also review the +[the basics of IP addressing](/site/concepts/ip-addresses.md) for an explanation of addressing and private networks. ### Naming and Discovery -Named containers are automatically registered in [weaveDNS](/site/weavedns.md), +Named containers are automatically registered in [weaveDNS](/site/tasks/weavedns/weavedns.md), and are discoverable by using standard, simple name lookups: host1$ docker run -dti --name=service weaveworks/ubuntu host1$ docker run -ti weaveworks/ubuntu root@7b21498fb103:/# ping service -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). +WeaveDNS also supports [load balancing](/site/tasks/weavedns/load-balance-fault-weavedns.md), [fault resilience](/site/tasks/weavedns/load-balance-fault-weavedns.md) and [hot swapping](/site/tasks/weavedns/managing-entries-weavedns.md). -See [Discovering Containers with WeaveDNS](/site/weavedns.md). +See [Discovering Containers with WeaveDNS](/site/tasks/weavedns/weavedns.md). ### Application Isolation @@ -132,13 +132,13 @@ _isolation-through-subnets_ technique. This common strategy techniques can be used to deploy your applications to containers. -See [Isolating Applications](/site/using-weave/application-isolation.md) +See [Isolating Applications](/site/tasks/manage/application-isolation.md) for information on how to use the isolation-through-subnets technique with Weave Net. ### Network Policy -The Weave [Kubernetes Addon](/site/kube-addon.md) includes a network +The Weave [Kubernetes Addon](/site/kubernetes/kube-addon.md) includes a network policy controller that implements [Kubernetes Network Policies](http://kubernetes.io/docs/user-guide/networkpolicies/). @@ -149,7 +149,7 @@ given container in advance. In these cases, you can take advantage of Weave's ability to attach and detach running containers to and from any network. -See [Dynamically Attaching and Detaching Containers](/site/using-weave/dynamically-attach-containers.md) +See [Dynamically Attaching and Detaching Containers](/site/tasks/manage/dynamically-attach-containers.md) for details. @@ -176,7 +176,7 @@ running alongside Weave. Weave Net implements encryption and security using the Go version of [Daniel J. Bernstein's NaCl library](http://nacl.cr.yp.to/index.html), and, additionally in the case of encrypted fast datapath using [the cryptography framework of the Linux kernel](https://en.wikipedia.org/wiki/Crypto_API_(Linux)). -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](/site/how-it-works/encryption.md) and [How Weave Implements Encryption](/site/how-it-works/encryption-implementation.md). +For information on how to secure your Docker network connections, see [Securing Connections Across Untrusted Networks](/site/tasks/manage/security-untrusted-networks.md) and for a more technical discussion on how Weave implements encryption see, [Weave Encryption](/site/concepts/encryption.md) and [How Weave Implements Encryption](/site/concepts/encryption-implementation.md). ### Host Network Integration @@ -184,7 +184,7 @@ For information on how to secure your Docker network connections, see [Securing Weave Net application networks can be integrated with a host's network, and establish connectivity between the host and application containers anywhere. -See [Integrating with the Host Network](/site/using-weave/host-network-integration.md). +See [Integrating with the Host Network](/site/tasks/manage/host-network-integration.md). ### Managing Services: Exporting, Importing, Binding and Routing @@ -193,7 +193,7 @@ See [Integrating with the Host Network](/site/using-weave/host-network-integrati * **Binding Services** - A container can be bound to a particular IP and port without having to change your application code, while at the same time will maintain its original endpoint. * **Routing Services** - By combining the importing and exporting features, you can connect to disjointed networks, even when separated by firewalls and where there may be overlapping IP addresses. -See [Managing Services - Exporting, Importing, Binding and Routing](/site/using-weave/service-management.md) for instructions on how to manage services on a Weave container network. +See [Managing Services - Exporting, Importing, Binding and Routing](/site/tasks/manage/service-management.md) for instructions on how to manage services on a Weave container network. ### Multi-Cloud Networking @@ -203,7 +203,7 @@ of containers that run on [Google Compute Engine](https://cloud.google.com/compu (GCE), [Amazon Elastic Compute Cloud](https://aws.amazon.com/ec2/) (EC2) and in a local data centre all at the same time. -See [Enabling Multi-Cloud networking and Muti-hop Routing](/site/using-weave/multi-cloud-multi-hop.md). +See [Enabling Multi-Cloud networking and Muti-hop Routing](/site/tasks/manage/multi-cloud-multi-hop.md). ### Multi-Hop Routing @@ -213,14 +213,14 @@ even when there is only partial connectivity between the hosts. Weave Net routes traffic between containers as long as there is at least one *path* of connected hosts between them. -See [Enabling Multi-Cloud networking and Multi-hop Routing](/site/using-weave/multi-cloud-multi-hop.md). +See [Enabling Multi-Cloud networking and Multi-hop Routing](/site/tasks/manage/multi-cloud-multi-hop.md). ### Dynamic Topologies Hosts can be added to or removed from a Weave network without stopping or reconfiguring the remaining hosts. See [Adding and Removing Hosts -Dynamically.](/site/using-weave/finding-adding-hosts-dynamically.md) +Dynamically.](/site/tasks/manage/finding-adding-hosts-dynamically.md) ### Container Mobility @@ -230,7 +230,7 @@ reconfiguration or, in many cases, restarts of other containers. All that is required is for the migrated container to be started with the same IP address as it was given originally. -See [Managing Services - Exporting, Importing, Binding and Routing](/site/using-weave/service-management.md), in particular, Routing Services for more information on container mobility. +See [Managing Services - Exporting, Importing, Binding and Routing](/site/tasks/manage/service-management.md), in particular, Routing Services for more information on container mobility. ### Fault Tolerance diff --git a/site/tasks.md b/site/tasks.md new file mode 100644 index 00000000..255996f4 --- /dev/null +++ b/site/tasks.md @@ -0,0 +1,71 @@ +--- +title: Weave Net Tasks +menu_order: 50 +search_type: Documentation +--- + +The section describes the configuration options available in Weave Net. It is divided into: Managing Containerized Applications, Administering IP Addresses, Managing WeaveDNS, and finally attaching Docker Containers via the Weave API Proxy. + + +## Managing Containerized Applications + + +* [Isolating Applications on a Weave Network](https://weave.works/docs/net/latest/tasks/manage/application-isolation/) +* [Dynamically Attaching and Detaching Applications](https://weave.works/docs/net/latest/tasks/dynamically-attach-containers/) +* [Integrating with the Host Network](https://weave.works/docs/net/latest/tasks/host-network-integration/) +* [Managing Services - Exporting, Importing, Binding and Routing](https://weave.works/docs/net/latest/tasks/manage/service-management/) + * [Exporting Services](https://weave.works/docs/net/latest/tasks/manage/service-management/#exporting) + * [Importing Services](https://weave.works/docs/net/latest/tasks/manage/service-management/#importing) + * [Binding Services](https://weave.works/docs/net/latest/tasks/manage/service-management/#binding) + * [Routing Services](https://weave.works/docs/net/latest/tasks/manage/service-management/#routing) + * [Dynamically Changing Service Locations](https://weave.works/docs/net/latest/tasks/manage/service-management/#change-location) +* [Securing Connections Across Untrusted Networks](https://weave.works/docs/net/latest/tasks//manage/security-untrusted-networks/) +* [Adding and Removing Hosts Dynamically](https://weave.works/docs/net/latest/tasks/manage/finding-adding-hosts-dynamically/) +* [Using Fast Datapath](https://weave.works/docs/net/latest/tasks/manage/fastdp/) +* [Enabling Multi-Cloud, Multi-Hop Networking and Routing](https://weave.works/docs/net/latest/tasks/manage/multi-cloud-multi-hop/) +* [Configuring IP Routing on an Amazon Web Services Virtual Private Cloud](https://weave.works/docs/net/latest/tasks/manage/awsvpc/) +* [Monitoring with Prometheus](https://weave.works/docs/net/latest/tasks/manage/metrics/) + + +## Administering IP Addresses + + +* [Allocating IP Addresses](https://weave.works/docs/net/latest/tasks/ipam/ipam/) + * [Initializing Peers on a Weave Network](https://weave.works/docs/net/latest/tasks/ipam/ipam/#initialization) + * [--ipalloc-init:consensus and How Quorum is Achieved](https://weave.works/docs/net/latest/tasks/ipam/ipam/#quorum) + * [Priming a Peer](https://weave.works/docs/net/latest/tasks/ipam/ipam/#priming-a-peer) + * [Choosing an Allocation Range](https://weave.works/docs/net/latest/tasks/ipam/ipam/#range) +* [Allocating IPs in a Specific Range](https://weave.works/docs/net/latest/tasks/ipam/configuring-weave/) +* [Manually Specifying the IP Address of a Container](https://weave.works/docs/net/latest/tasks/ipam/manual-ip-address/) +* [Automatic Allocation Across Multiple Subnets](https://weave.works/docs/net/latest/tasks/ipam/allocation-multi-ipam/) +* [Starting, Stopping and Removing Peers](https://weave.works/docs/net/latest/tasks/ipam/stop-remove-peers-ipam/) +* [Troubleshooting the IP Allocator](https://weave.works/docs/net/latest/tasks/ipam/troubleshooting-ipam/) + + +## Managing WeaveDNS + + +* [Discovering Containers with WeaveDNS](https://weave.works/docs/net/latest/tasks/weavedns/weavedns/) +* [How Weave Finds Containers](https://weave.works/docs/net/latest/tasks/weavedns/how-works-weavedns/) +* [Load Balancing and Fault Resilience with weaveDNS](https://weave.works/docs/net/latest/tasks/weavedns/load-balance-fault-weavedns/) +* [Managing Domains](https://weave.works/docs/net/latest/tasks/weavedns/managing-domains-weavedns/) + * [Configuring the domain search path](https://weave.works/docs/net/latest/tasks/weavedns/managing-domains-weavedns/#domain-search-path) + * [Using a different local domain](https://weave.works/docs/net/latest/tasks/weavedns/managing-domains-weavedns/#local-domain) +* [Managing Domain Entries](https://weave.works/docs/net/latest/tasks/weavedns/managing-entries-weavedns/) + * [Adding and removing extra DNS entries](https://weave.works/docs/net/latest/tasks/weavedns/managing-entries-weavedns/#add-remove) + * [Resolving WeaveDNS entries from the Host](https://weave.works/docs/net/latest/tasks/weavedns/managing-entries-weavedns/#resolve-weavedns-entries-from-host) + * [Hot-swapping Service Containers](https://weave.works/docs/net/latest/tasks/weavedns/managing-entries-weavedns/#hot-swapping) + * [Configuring a Custom TTL](https://weave.works/docs/net/latest/tasks/weavedns/managing-entries-weavedns/#ttl) +* [Troubleshooting and Present Limitations](https://weave.works/docs/net/latest/tasks/weavedns/troubleshooting-weavedns/) + + +## Attaching Docker Containers via the Weave API Proxy + + +* [Integrating Docker via the API Proxy](https://weave.works/docs/net/latest/tasks/weave-docker-api/weave-docker-api/) +* [Using The Weave Docker API Proxy](https://weave.works/docs/net/latest/tasks/weave-docker-api/using-proxy/) +* [Securing the Docker Communications With TLS](https://weave.works/docs/net/latest/tasks/weave-docker-api/securing-proxy/) +* [Automatic IP Allocation and the Weave Proxy](https://weave.works/docs/net/latest/tasks/weave-docker-api/ipam-proxy/) +* [Using Automatic Discovery With the Weave Net Proxy](https://weave.works/docs/net/latest/tasks/weave-docker-api/automatic-discovery-proxy/) +* [Name resolution via `/etc/hosts`](https://weave.works/docs/net/latest/tasks/weave-docker-api/name-resolution-proxy/) +* [Launching Containers With Weave Run (without the Proxy)](https://weave.works/docs/net/latest/tasks/weave-docker-api/launching-without-proxy/) diff --git a/site/tasks/ipam.md b/site/tasks/ipam.md new file mode 100644 index 00000000..eed33454 --- /dev/null +++ b/site/tasks/ipam.md @@ -0,0 +1,5 @@ +--- +title: Administering IP Addresses +menu_order: 20 +search_type: Documentation +--- \ No newline at end of file diff --git a/site/ipam/allocation-multi-ipam.md b/site/tasks/ipam/allocation-multi-ipam.md similarity index 89% rename from site/ipam/allocation-multi-ipam.md rename to site/tasks/ipam/allocation-multi-ipam.md index 794e2c93..908e74e4 100644 --- a/site/ipam/allocation-multi-ipam.md +++ b/site/tasks/ipam/allocation-multi-ipam.md @@ -1,6 +1,6 @@ --- title: Automatic Allocation Across Multiple Subnets -menu_order: 10 +menu_order: 30 search_type: Documentation --- @@ -10,7 +10,7 @@ puts all containers into a subnet that spans the entire allocation range, so that every Weave-attached container can communicate with every other Weave-attached container. -If you want some [isolation](/site/using-weave/application-isolation.md), you +If you want some [isolation](/site/tasks/manage/application-isolation.md), you can choose to run containers on different subnets. To request the allocation of an address from a particular subnet, set the `WEAVE_CIDR` environment variable to `net:` when creating the @@ -63,6 +63,6 @@ for manual allocation. **See Also** - * [Address Allocation with IP Address Management (IPAM)](/site/ipam.md) - * [Isolating Applications on a Weave Network](/site/using-weave/application-isolation.md) - * [Starting, Stopping and Removing Peers](/site/ipam/stop-remove-peers-ipam.md) + * [Address Allocation with IP Address Management (IPAM)](/site/tasks/ipam/ipam.md) + * [Isolating Applications on a Weave Network](/site/tasks/manage/application-isolation.md) + * [Starting, Stopping and Removing Peers](/site/tasks/ipam/stop-remove-peers-ipam.md) diff --git a/site/using-weave/configuring-weave.md b/site/tasks/ipam/configuring-weave.md similarity index 94% rename from site/using-weave/configuring-weave.md rename to site/tasks/ipam/configuring-weave.md index db7405cb..22353e6e 100644 --- a/site/using-weave/configuring-weave.md +++ b/site/tasks/ipam/configuring-weave.md @@ -1,6 +1,6 @@ --- title: Allocating IPs in a Specific Range -menu_order: 15 +menu_order: 10 search_type: Documentation --- @@ -40,4 +40,4 @@ Networks](https://en.wikipedia.org/wiki/Private_network). For example **See Also** - * [IP Addresses, Routes and Networks](/site/how-it-works/ip-addresses.md) + * [IP Addresses, Routes and Networks](/site/concepts/ip-addresses.md) diff --git a/site/ipam.md b/site/tasks/ipam/ipam.md similarity index 96% rename from site/ipam.md rename to site/tasks/ipam/ipam.md index ca014269..97be9031 100644 --- a/site/ipam.md +++ b/site/tasks/ipam/ipam.md @@ -1,6 +1,6 @@ --- title: Allocating IP Addresses -menu_order: 70 +menu_order: 5 search_type: Documentation --- @@ -180,7 +180,7 @@ The range parameter is written in in this example "/16" means the first 16 bits of the address form the network address and the allocator is to allocate container addresses that all start 10.2. See [IP -addresses and routes](/site/how-it-works/ip-addresses.md) for more information. +addresses and routes](/site/concepts/ip-addresses.md) for more information. Weave shares the IP address range across all peers, dynamically according to their needs. If a group of peers becomes isolated from @@ -202,5 +202,5 @@ named `weavedb` is used to store this data. **See Also** - * [Automatic Allocation Across Multiple Subnets](/site/ipam/allocation-multi-ipam.md) - * [Integrating Docker via the Network Plugin (Legacy)](/site/plugin.md) + * [Automatic Allocation Across Multiple Subnets](/site/tasks/ipam/allocation-multi-ipam.md) + * [Integrating Docker via the Network Plugin (Legacy)](/site/install/plugin/plugin.md) diff --git a/site/using-weave/manual-ip-address.md b/site/tasks/ipam/manual-ip-address.md similarity index 86% rename from site/using-weave/manual-ip-address.md rename to site/tasks/ipam/manual-ip-address.md index c206e577..78287e1b 100644 --- a/site/using-weave/manual-ip-address.md +++ b/site/tasks/ipam/manual-ip-address.md @@ -11,7 +11,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/how-it-works/ip-addresses.md) for further details. +See the [Automatic IP Address Management](/site/tasks/ipam/ipam.md) and also an explanation of [the basics of IP addressing](/site/concepts/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,7 +52,7 @@ 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) - * [Allocating IPs in a Specific Range](/site/using-weave/configuring-weave.md) - * [Automatic IP Address Management](/site/ipam.md) + * [Managing Services - Exporting, Importing, Binding and Routing](/site/tasks/manage/service-management.md) + * [Allocating IPs in a Specific Range](/site/tasks/ipam/configuring-weave.md) + * [Automatic IP Address Management](/site/tasks/ipam/ipam.md) diff --git a/site/ipam/stop-remove-peers-ipam.md b/site/tasks/ipam/stop-remove-peers-ipam.md similarity index 89% rename from site/ipam/stop-remove-peers-ipam.md rename to site/tasks/ipam/stop-remove-peers-ipam.md index f76d1331..c70f033a 100644 --- a/site/ipam/stop-remove-peers-ipam.md +++ b/site/tasks/ipam/stop-remove-peers-ipam.md @@ -1,6 +1,6 @@ --- title: Starting, Stopping and Removing Peers -menu_order: 20 +menu_order: 40 search_type: Documentation --- @@ -24,7 +24,7 @@ later rejoin the Weave network, the same IP address may be allocated twice. Assume you had started the three peers in the -[overview example](/site/ipam.md), and then host3 +[overview example](/site/tasks/ipam/ipam.md), and then host3 caught fire, you can go to one of the other hosts and run: host1$ weave rmpeer host3 @@ -56,6 +56,6 @@ dropping attempted connections with peers in other cliques. **See Also** - * [Address Allocation with IP Address Management (IPAM)](/site/ipam.md) - * [Automatic Allocation Across Multiple Subnets](/site/ipam/allocation-multi-ipam.md) - * [Isolating Applications on a Weave Network](/site/using-weave/application-isolation.md) + * [Address Allocation with IP Address Management (IPAM)](/site/tasks/ipam/ipam.md) + * [Automatic Allocation Across Multiple Subnets](/site/tasks/ipam/allocation-multi-ipam.md) + * [Isolating Applications on a Weave Network](/site/tasks/manage/application-isolation.md) diff --git a/site/ipam/troubleshooting-ipam.md b/site/tasks/ipam/troubleshooting-ipam.md similarity index 96% rename from site/ipam/troubleshooting-ipam.md rename to site/tasks/ipam/troubleshooting-ipam.md index 3a5f80b9..34f46277 100644 --- a/site/ipam/troubleshooting-ipam.md +++ b/site/tasks/ipam/troubleshooting-ipam.md @@ -1,6 +1,6 @@ --- title: Troubleshooting the IP Allocator -menu_order: 30 +menu_order: 50 search_type: Documentation --- @@ -64,4 +64,4 @@ Columns are as follows: ipam` was run; whilst this could be a transient condition due to a partition, it may be because the peer has failed and needs to be removed administratively - see [Starting, Stopping and Removing - Peers](/site/ipam/stop-remove-peers-ipam.md) for more details. + Peers](/site/tasks/ipam/stop-remove-peers-ipam.md) for more details. diff --git a/site/tasks/manage.md b/site/tasks/manage.md new file mode 100644 index 00000000..b45300bf --- /dev/null +++ b/site/tasks/manage.md @@ -0,0 +1,5 @@ +--- +title: Managing Containerized Applications +menu_order: 10 +search_type: Documentation +--- diff --git a/site/using-weave/application-isolation.md b/site/tasks/manage/application-isolation.md similarity index 93% rename from site/using-weave/application-isolation.md rename to site/tasks/manage/application-isolation.md index 8e89d28e..956dc0d6 100644 --- a/site/using-weave/application-isolation.md +++ b/site/tasks/manage/application-isolation.md @@ -1,6 +1,6 @@ --- title: Isolating Applications on a Weave Network -menu_order: 30 +menu_order: 5 search_type: Documentation --- @@ -14,7 +14,7 @@ techniques can still be used to deploy applications to a container network. To begin isolating an application (or parts of an application), configure Weave Net's IP allocator to manage multiple subnets. -Using [the netcat example](/site/using-weave.md), configure multiple subsets: +Using [the netcat example](/site/install/using-weave.md), configure multiple subsets: host1$ weave launch --ipalloc-range 10.2.0.0/16 --ipalloc-default-subnet 10.2.1.0/24 host1$ eval $(weave env) @@ -66,5 +66,5 @@ isolation between application containers, that feature needs to be disabled by [ **See Also** - * [Automatic Allocation Across Multiple Subnets](/site/ipam/allocation-multi-ipam.md) - * [Managing Services - Exporting, Importing, Binding and Routing](/site/using-weave/service-management.md) + * [Automatic Allocation Across Multiple Subnets](/site/tasks/ipam/allocation-multi-ipam.md) + * [Managing Services - Exporting, Importing, Binding and Routing](/site/tasks/manage/service-management.md) diff --git a/site/using-weave/awsvpc.md b/site/tasks/manage/awsvpc.md similarity index 94% rename from site/using-weave/awsvpc.md rename to site/tasks/manage/awsvpc.md index 02ce182b..386e2f66 100644 --- a/site/using-weave/awsvpc.md +++ b/site/tasks/manage/awsvpc.md @@ -1,6 +1,6 @@ --- -title: Using IP Routing on an Amazon Web Services Virtual Private Cloud -menu_order: 110 +title: Configuring IP Routing on an Amazon Web Services Virtual Private Cloud +menu_order: 80 search_type: Documentation --- @@ -75,7 +75,7 @@ your cluster. is all or nothing. In this mode, all hosts in a cluster must be AWS instances. (We hope to ease this limitation in future.) - The `weave launch` command waits until the - [IP address manager](/site//operational-guide/concepts.md#ip-address-manager-ipam) + [IP address manager](/site/operational-guide/concepts.md#ip-address-manager-ipam) is ready, i.e. until after this peer has been able to make contact with other peers and confirm that it has joined the cluster the bridge. Without AWS-VPC, `weave launch` returns without waiting. @@ -101,5 +101,5 @@ In AWS-VPC mode you can run the following: **See Also** - * [Using Weave Net](/site/using-weave.md) + * [Launching Weave Net](/site/install/using-weave.md) diff --git a/site/using-weave/dynamically-attach-containers.md b/site/tasks/manage/dynamically-attach-containers.md similarity index 92% rename from site/using-weave/dynamically-attach-containers.md rename to site/tasks/manage/dynamically-attach-containers.md index 0907e341..d64c18c4 100644 --- a/site/using-weave/dynamically-attach-containers.md +++ b/site/tasks/manage/dynamically-attach-containers.md @@ -1,6 +1,6 @@ --- title: Dynamically Attaching and Detaching Applications -menu_order: 40 +menu_order: 10 search_type: Documentation --- @@ -32,7 +32,7 @@ with the `--without-dns` argument). 10.32.0.1 If you would like `/etc/hosts` to contain the Weave Net address (the -same way [the proxy does](/site/weave-docker-api/name-resolution-proxy.md)), +same way [the proxy does](/site/tasks/weave-docker-api/name-resolution-proxy.md)), specify `--rewrite-hosts` when running `weave attach`: host1$ weave attach --rewrite-hosts c1 @@ -69,4 +69,4 @@ Finally, multiple addresses can be attached or detached using a single command: **See Also** - * [Adding and Removing Hosts Dynamically](/site/using-weave/finding-adding-hosts-dynamically.md) + * [Adding and Removing Hosts Dynamically](/site/tasks/manage/finding-adding-hosts-dynamically.md) diff --git a/site/using-weave/fastdp.md b/site/tasks/manage/fastdp.md similarity index 91% rename from site/using-weave/fastdp.md rename to site/tasks/manage/fastdp.md index 2711cfc8..b0adce64 100644 --- a/site/using-weave/fastdp.md +++ b/site/tasks/manage/fastdp.md @@ -1,6 +1,6 @@ --- title: Using Fast Datapath -menu_order: 96 +menu_order: 60 search_type: Documentation --- @@ -9,7 +9,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/how-it-works/fastdp-how-it-works.md) for a more in-depth discussion of this feature. +See [How Fastdp Works](/site/concepts/fastdp-how-it-works.md) for a more in-depth discussion of this feature. ### Disabling Fast Datapath @@ -26,7 +26,7 @@ Each encrypted dataplane packet is encapsulated into [ESP](https://tools.ietf.or thus in some networks a firewall rule for allowing ESP traffic needs to be installed. E.g. Google Cloud Platform denies ESP packets by default. -See [How Weave Implements Encryption](/site/how-it-works/encryption-implementation.md) +See [How Weave Implements Encryption](/site/concepts/encryption-implementation.md) for more details for the fastdp encryption. ### Viewing Connection Mode Fastdp or Sleeve @@ -71,6 +71,6 @@ frame" configuration: **See Also** - * [Using Weave Net](/site/using-weave.md) - * [How Fastdp Works](/site/how-it-works/fastdp-how-it-works.md) + * [Launching Weave Net](/site/install/using-weave.md) + * [How Fastdp Works](/site/concepts/fastdp-how-it-works.md) * [Performance measurements](/blog/weave-docker-networking-performance-fast-data-path/) diff --git a/site/using-weave/finding-adding-hosts-dynamically.md b/site/tasks/manage/finding-adding-hosts-dynamically.md similarity index 94% rename from site/using-weave/finding-adding-hosts-dynamically.md rename to site/tasks/manage/finding-adding-hosts-dynamically.md index c0c623b7..12dc350a 100644 --- a/site/using-weave/finding-adding-hosts-dynamically.md +++ b/site/tasks/manage/finding-adding-hosts-dynamically.md @@ -1,6 +1,6 @@ --- title: Adding and Removing Hosts Dynamically -menu_order: 90 +menu_order: 50 search_type: Documentation --- @@ -68,5 +68,5 @@ with `weave launch` and `weave connect` run: **See Also** - * [Enabling Multi-Cloud, Multi-Hop Networking and Routing](/site/using-weave/multi-cloud-multi-hop.md) - * [Stopping and Removing Peers](/site/ipam/stop-remove-peers-ipam.md) + * [Enabling Multi-Cloud, Multi-Hop Networking and Routing](/site/tasks/manage/multi-cloud-multi-hop.md) + * [Stopping and Removing Peers](/site/tasks/ipam/stop-remove-peers-ipam.md) diff --git a/site/using-weave/host-network-integration.md b/site/tasks/manage/host-network-integration.md similarity index 80% rename from site/using-weave/host-network-integration.md rename to site/tasks/manage/host-network-integration.md index 3ea2d494..e8a3c723 100644 --- a/site/using-weave/host-network-integration.md +++ b/site/tasks/manage/host-network-integration.md @@ -1,12 +1,12 @@ --- title: Integrating with the Host Network -menu_order: 60 +menu_order: 20 search_type: Documentation --- Weave application networks can be integrated with an external host network, establishing connectivity between the host and with application containers running anywhere. -For example, returning to the [netcat example](/site/using-weave.md), you’ve now decided that you need to have the application containers that are running on `$HOST2` accessible by other hosts and containers. +For example, returning to the [netcat example](/site/install/using-weave.md), you’ve now decided that you need to have the application containers that are running on `$HOST2` accessible by other hosts and containers. On `$HOST2` run: @@ -53,12 +53,12 @@ for example, `10.2.0.0/16` or `10.32.0.0/12` and, * `` is the address of the machine on which you ran `weave expose`. >**Note:** You must ensure that the [IP subnet used by Weave -Net](/site/ipam.md#range) does not clash with anything on those other +Net](/site/tasks/ipam/ipam.md#range) does not clash with anything on those other hosts. **See Also** - * [Using Weave Net](/site/using-weave.md) - * [General information on IP Addresses, Routes and Networks](/site/how-it-works/ip-addresses.md) - * [Managing Services - Exporting, Importing, Binding and Routing](/site/using-weave/service-management.md) + * [Launching Weave Net](/site/install/using-weave.md) + * [General information on IP Addresses, Routes and Networks](/site/concepts/ip-addresses.md) + * [Managing Services - Exporting, Importing, Binding and Routing](/site/tasks/manage/service-management.md) diff --git a/site/metrics.md b/site/tasks/manage/metrics.md similarity index 96% rename from site/metrics.md rename to site/tasks/manage/metrics.md index b116bde5..93cbbbe7 100644 --- a/site/metrics.md +++ b/site/tasks/manage/metrics.md @@ -1,12 +1,12 @@ --- title: Monitoring with Prometheus -menu_order: 105 +menu_order: 90 search_type: Documentation --- Two endpoints are exposed: one for the Weave Net router, and, when deployed as -a [Kubernetes Addon](/site/kube-addon.md), one for the [network policy -controller](/site/kube-addon.md#npc). +a [Kubernetes Addon](/site/kubernetes/kube-addon.md), one for the [network policy +controller](/site/kubernetes/kube-addon.md#npc). ### Router Metrics diff --git a/site/using-weave/multi-cloud-multi-hop.md b/site/tasks/manage/multi-cloud-multi-hop.md similarity index 91% rename from site/using-weave/multi-cloud-multi-hop.md rename to site/tasks/manage/multi-cloud-multi-hop.md index e75144ae..25c82844 100644 --- a/site/using-weave/multi-cloud-multi-hop.md +++ b/site/tasks/manage/multi-cloud-multi-hop.md @@ -1,6 +1,6 @@ --- title: Enabling Multi-Cloud, Multi-Hop Networking and Routing -menu_order: 100 +menu_order: 70 search_type: Documentation --- @@ -39,6 +39,6 @@ traffic via the local data center. **See Also** - * [Finding and Adding Hosts Dynamically](/site/using-weave/finding-adding-hosts-dynamically.md) + * [Finding and Adding Hosts Dynamically](/site/tasks/manage/finding-adding-hosts-dynamically.md) diff --git a/site/using-weave/security-untrusted-networks.md b/site/tasks/manage/security-untrusted-networks.md similarity index 94% rename from site/using-weave/security-untrusted-networks.md rename to site/tasks/manage/security-untrusted-networks.md index 951ff12a..de7cfb49 100644 --- a/site/using-weave/security-untrusted-networks.md +++ b/site/tasks/manage/security-untrusted-networks.md @@ -1,6 +1,6 @@ --- title: Securing Connections Across Untrusted Networks -menu_order: 80 +menu_order: 40 search_type: Documentation --- @@ -53,5 +53,5 @@ Be aware that: **See Also** - * [Weave Encryption](/site/how-it-works/encryption.md) - * [Using Fast Datapath](/site/using-weave/fastdp.md) + * [Weave Encryption](/site/concepts/encryption.md) + * [Using Fast Datapath](/site/tasks/manage/fastdp.md) diff --git a/site/using-weave/service-management.md b/site/tasks/manage/service-management.md similarity index 85% rename from site/using-weave/service-management.md rename to site/tasks/manage/service-management.md index fac03585..4114bbbb 100644 --- a/site/using-weave/service-management.md +++ b/site/tasks/manage/service-management.md @@ -1,6 +1,6 @@ --- title: Managing Services - Exporting, Importing, Binding and Routing -menu_order: 70 +menu_order: 30 search_type: Documentation --- @@ -21,10 +21,10 @@ accessible to the outside world (and, more generally, to other networks) from any Weave Net host, irrespective of where the service containers are located. -Returning to the [netcat example service](/site/using-weave.md), +Returning to the [netcat example service](/site/install/using-weave.md), you can expose the netcat service running on `HOST1` and make it accessible to the outside world via `$HOST2`. -First, expose the application network to `$HOST2`, as explained in [Integrating with the Host Network](/site/using-weave/host-network-integration.md): +First, expose the application network to `$HOST2`, as explained in [Integrating with the Host Network](/site/tasks/manage/host-network-integration.md): host2$ weave expose 10.2.1.132 @@ -49,11 +49,11 @@ Similar NAT rules to the above can be used to expose services not just to the ou Applications running in containers on a Weave network can be given access to services, which are only reachable from certain Weave hosts, regardless of where the actual application containers are located. -Expanding on the [netcat service example](/site/using-weave.md), you now decide to add a third, non-containerized, netcat service. This additional netcat service runs on `$HOST3`, and listens on port 2211, but it is not on the Weave network. +Expanding on the [netcat service example](/site/install/using-weave.md), you now decide to add a third, non-containerized, netcat service. This additional netcat service runs on `$HOST3`, and listens on port 2211, but it is not on the Weave network. An additional caveat is that `$HOST3` can only be reached from `$HOST1`, which is not accessible via `$HOST2`. Nonetheless, you still need to make the `$HOST3` service available to an application that is running in a container on `$HOST2`. -To satisfy this scenario, first [expose the application network to the host](/site/using-weave/host-network-integration.md) by running the following on `$HOST1`: +To satisfy this scenario, first [expose the application network to the host](/site/tasks/manage/host-network-integration.md) by running the following on `$HOST1`: host1$ weave expose -h host1.weave.local 10.2.1.3 @@ -88,7 +88,7 @@ You can combine the service export and service import features to establish conn Each network imports its services into Weave Net, while at the same time, exports from Weave Net any services that are required by its applications. In this scenario, there are no application containers (although, there could be). Weave Net is acting as an address translation and routing facility, and uses the Weave container network as an intermediary. -Expanding on the [netcat example](/site/using-weave.md), you can also import an additional netcat service running on `$HOST3` into Weave Net via `$HOST1`. +Expanding on the [netcat example](/site/install/using-weave.md), you can also import an additional netcat service running on `$HOST3` into Weave Net via `$HOST1`. Begin importing the service onto `$HOST2` by first exposing the application network: @@ -113,6 +113,6 @@ For example, you can move the netcat service to `$HOST4:2211` and it will retai **See Also** - * [Adding and Removing Hosts Dynamically](/site/using-weave/finding-adding-hosts-dynamically.md) - * [Enabling Multi-Cloud, Multi-Hop Networking and Routing](/site/using-weave/multi-cloud-multi-hop.md) + * [Adding and Removing Hosts Dynamically](/site/tasks/manage/finding-adding-hosts-dynamically.md) + * [Enabling Multi-Cloud, Multi-Hop Networking and Routing](/site/tasks/manage/multi-cloud-multi-hop.md) diff --git a/site/using-weave/weave-net-awsvpc-1007x438.png b/site/tasks/manage/weave-net-awsvpc-1007x438.png similarity index 100% rename from site/using-weave/weave-net-awsvpc-1007x438.png rename to site/tasks/manage/weave-net-awsvpc-1007x438.png diff --git a/site/tasks/weave-docker-api.md b/site/tasks/weave-docker-api.md new file mode 100644 index 00000000..75382591 --- /dev/null +++ b/site/tasks/weave-docker-api.md @@ -0,0 +1,6 @@ +--- +title: Attaching Docker Containers via the Weave API Proxy +menu_order: 40 +search_type: Documentation +--- + diff --git a/site/weave-docker-api/automatic-discovery-proxy.md b/site/tasks/weave-docker-api/automatic-discovery-proxy.md similarity index 88% rename from site/weave-docker-api/automatic-discovery-proxy.md rename to site/tasks/weave-docker-api/automatic-discovery-proxy.md index d0ad1921..127cc622 100644 --- a/site/weave-docker-api/automatic-discovery-proxy.md +++ b/site/tasks/weave-docker-api/automatic-discovery-proxy.md @@ -1,12 +1,12 @@ --- title: Using Automatic Discovery With the Weave Net Proxy -menu_order: 30 +menu_order: 40 search_type: Documentation --- -Containers launched via the proxy use [weaveDNS](/site/weavedns.md) +Containers launched via the proxy use [weaveDNS](/site/tasks/weavedns/weavedns.md) automatically if it is running when they are started - -see the [weaveDNS usage](/site/weavedns.md#usage) section for an in depth +see the [weaveDNS usage](/site/tasks/weavedns/weavedns.md#usage) section for an in depth explanation of the behaviour and how to control it. Typically, the proxy passes on container names as-is to weaveDNS @@ -56,5 +56,5 @@ to the proxy, the specified label takes precedence over the container's name. **See Also** - * [Name resolution via `/etc/hosts`](/site/weave-docker-api/name-resolution-proxy.md) - * [How Weave Finds Containers](/site/weavedns/how-works-weavedns.md) + * [Name resolution via `/etc/hosts`](/site/tasks/weave-docker-api/name-resolution-proxy.md) + * [How Weave Finds Containers](/site/tasks/weavedns/how-works-weavedns.md) diff --git a/site/weave-docker-api/ipam-proxy.md b/site/tasks/weave-docker-api/ipam-proxy.md similarity index 84% rename from site/weave-docker-api/ipam-proxy.md rename to site/tasks/weave-docker-api/ipam-proxy.md index f468ff10..8b81bdae 100644 --- a/site/weave-docker-api/ipam-proxy.md +++ b/site/tasks/weave-docker-api/ipam-proxy.md @@ -1,11 +1,11 @@ --- title: Automatic IP Allocation and the Weave Proxy -menu_order: 25 +menu_order: 30 search_type: Documentation --- -If [automatic IP address allocation](/site/ipam.md) is enabled in Weave Net (by default IPAM is enabled), +If [automatic IP address allocation](/site/tasks/ipam/ipam.md) is enabled in Weave Net (by default IPAM is enabled), then containers started via the proxy are automatically assigned an IP address, *without having to specify any special environment variables or any other options*. @@ -38,5 +38,5 @@ container with a blank `WEAVE_CIDR`, for example: **See Also** - * [Address Allocation with IP Address Management (IPAM)](/site/ipam.md) - * [How to Manually Specify IP Addresses and Subnets](/site/using-weave/manual-ip-address.md) + * [Address Allocation with IP Address Management (IPAM)](/site/tasks/ipam/ipam.md) + * [How to Manually Specify IP Addresses and Subnets](/site/tasks/ipam/manual-ip-address.md) diff --git a/site/weave-docker-api/launching-without-proxy.md b/site/tasks/weave-docker-api/launching-without-proxy.md similarity index 88% rename from site/weave-docker-api/launching-without-proxy.md rename to site/tasks/weave-docker-api/launching-without-proxy.md index a261452f..6ecf26cb 100644 --- a/site/weave-docker-api/launching-without-proxy.md +++ b/site/tasks/weave-docker-api/launching-without-proxy.md @@ -1,6 +1,6 @@ --- title: Launching Containers With Weave Run (without the Proxy) -menu_order: 50 +menu_order: 60 search_type: Documentation --- @@ -14,7 +14,7 @@ limitations, we have removed `weave run`. If you have scripts using `weave run`, you can achieve exactly the same effect by combining `docker run` and `weave attach`; see [Dynamically Attaching and Detaching -Containers](/site/using-weave/dynamically-attach-containers.md) for +Containers](/site/tasks/manage/dynamically-attach-containers.md) for details. The `weave start` and `weave restart` commands have also been removed, diff --git a/site/weave-docker-api/name-resolution-proxy.md b/site/tasks/weave-docker-api/name-resolution-proxy.md similarity index 90% rename from site/weave-docker-api/name-resolution-proxy.md rename to site/tasks/weave-docker-api/name-resolution-proxy.md index 60635ae1..3a2e0a74 100644 --- a/site/weave-docker-api/name-resolution-proxy.md +++ b/site/tasks/weave-docker-api/name-resolution-proxy.md @@ -1,6 +1,6 @@ --- title: Name resolution via `/etc/hosts` -menu_order: 40 +menu_order: 50 search_type: Documentation --- @@ -31,5 +31,5 @@ Docker-managed networks), the proxy must be launched using the **See Also** - * [Using Automatic Discovery With the Weave Proxy](/site/weave-docker-api/automatic-discovery-proxy.md) + * [Using Automatic Discovery With the Weave Proxy](/site/tasks/weave-docker-api/automatic-discovery-proxy.md) diff --git a/site/weave-docker-api/securing-proxy.md b/site/tasks/weave-docker-api/securing-proxy.md similarity index 95% rename from site/weave-docker-api/securing-proxy.md rename to site/tasks/weave-docker-api/securing-proxy.md index feb9f26f..4431a691 100644 --- a/site/weave-docker-api/securing-proxy.md +++ b/site/tasks/weave-docker-api/securing-proxy.md @@ -56,4 +56,4 @@ proxy port. **See Also** - * [Setting Up The Weave Docker API Proxy](/site/weave-docker-api.md) + * [Setting Up The Weave Docker API Proxy](/site/tasks/weave-docker-api/weave-docker-api.md) diff --git a/site/weave-docker-api/using-proxy.md b/site/tasks/weave-docker-api/using-proxy.md similarity index 88% rename from site/weave-docker-api/using-proxy.md rename to site/tasks/weave-docker-api/using-proxy.md index aa46b0b5..00f49596 100644 --- a/site/weave-docker-api/using-proxy.md +++ b/site/tasks/weave-docker-api/using-proxy.md @@ -10,7 +10,7 @@ modified to wait for the Weave network interface to become available. When they are started via the Weave Net proxy, containers are -[automatically assigned IP addresses](/site/ipam.md) and connected to the +[automatically assigned IP addresses](/site/tasks/ipam/ipam.md) and connected to the Weave network. ### Creating and Starting Containers with the Weave Net Proxy @@ -55,7 +55,7 @@ route, add the `--no-multicast-route` flag to `weave launch`. ### Other Weave Proxy options - * `--without-dns` -- stop telling containers to use [WeaveDNS](/site/weavedns.md) + * `--without-dns` -- stop telling containers to use [WeaveDNS](/site/tasks/weavedns/weavedns.md) * `--log-level=debug|info|warning|error` -- controls how much information to emit for debugging * `--no-restart` -- remove the default policy of `--restart=always`, if @@ -70,5 +70,5 @@ If for some reason you need to disable the proxy, but still want to start other **See Also** - * [Setting Up The Weave Docker API Proxy](/site/weave-docker-api.md) - * [Securing Docker Communications With TLS](/site/weave-docker-api/securing-proxy.md) + * [Setting Up The Weave Docker API Proxy](/site/tasks/weave-docker-api/weave-docker-api.md) + * [Securing Docker Communications With TLS](/site/tasks/weave-docker-api/securing-proxy.md) diff --git a/site/weave-docker-api.md b/site/tasks/weave-docker-api/weave-docker-api.md similarity index 86% rename from site/weave-docker-api.md rename to site/tasks/weave-docker-api/weave-docker-api.md index 14e7b6ad..c44613b6 100644 --- a/site/weave-docker-api.md +++ b/site/tasks/weave-docker-api/weave-docker-api.md @@ -1,6 +1,6 @@ --- title: Integrating Docker via the API Proxy -menu_order: 50 +menu_order: 5 search_type: Documentation --- @@ -28,12 +28,12 @@ Docker containers are started with the --net flag, for example: 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 (Legacy)](/site/plugin.md) and -[Integrating Docker via the Network Plugin (V2)](/site/plugin-v2.md). +See [Integrating Docker via the Network Plugin (Legacy)](/site/install/plugin/plugin.md) and +[Integrating Docker via the Network Plugin (V2)](/site/install/plugin/plugin-v2.md). **3.** Containers can also be attached to the Weave network with `weave attach` commands. This method also does not use the Weave Docker API Proxy. -See [Dynamically Attaching and Detaching Containers](/site/using-weave/dynamically-attach-containers.md). +See [Dynamically Attaching and Detaching Containers](/site/tasks/manage/dynamically-attach-containers.md). ### Setting Up The Weave Net Docker API Proxy @@ -89,8 +89,8 @@ to the original settings prior to running `stop`. **See Also** - * [Using The Weave Docker API Proxy](/site/weave-docker-api/using-proxy.md) - * [Securing Docker Communications With TLS](/site/weave-docker-api/securing-proxy.md) - * [Launching Containers With Weave Run (without the Proxy)](/site/weave-docker-api/launching-without-proxy.md) + * [Using The Weave Docker API Proxy](/site/tasks/weave-docker-api/using-proxy.md) + * [Securing Docker Communications With TLS](/site/tasks/weave-docker-api/securing-proxy.md) + * [Launching Containers With Weave Run (without the Proxy)](/site/tasks/weave-docker-api/launching-without-proxy.md) diff --git a/site/tasks/weavedns.md b/site/tasks/weavedns.md new file mode 100644 index 00000000..a1f13376 --- /dev/null +++ b/site/tasks/weavedns.md @@ -0,0 +1,5 @@ +--- +title: Managing WeaveDNS +menu_order: 30 +search_type: Documentation +--- \ No newline at end of file diff --git a/site/weavedns/how-works-weavedns.md b/site/tasks/weavedns/how-works-weavedns.md similarity index 87% rename from site/weavedns/how-works-weavedns.md rename to site/tasks/weavedns/how-works-weavedns.md index 0f6a5882..a7bae14f 100644 --- a/site/weavedns/how-works-weavedns.md +++ b/site/tasks/weavedns/how-works-weavedns.md @@ -43,6 +43,6 @@ $ sudo DOCKER_BRIDGE=someother weave attach ... **See Also** - * [Using WeaveDNS](/site/weavedns.md) - * [Load Balancing with weaveDNS](/site/weavedns/load-balance-fault-weavedns.md) - * [Managing Domain Entries](/site/weavedns/managing-domains-weavedns.md) + * [Using WeaveDNS](/site/tasks/weavedns/weavedns.md) + * [Load Balancing with weaveDNS](/site/tasks/weavedns/load-balance-fault-weavedns.md) + * [Managing Domain Entries](/site/tasks/weavedns/managing-domains-weavedns.md) diff --git a/site/weavedns/load-balance-fault-weavedns.md b/site/tasks/weavedns/load-balance-fault-weavedns.md similarity index 80% rename from site/weavedns/load-balance-fault-weavedns.md rename to site/tasks/weavedns/load-balance-fault-weavedns.md index d55c416a..3421f8bd 100644 --- a/site/weavedns/load-balance-fault-weavedns.md +++ b/site/tasks/weavedns/load-balance-fault-weavedns.md @@ -10,7 +10,7 @@ It is permissible to register multiple containers with the same name: weaveDNS returns all addresses, in a random order, for each request. This provides a basic load balancing capability. -Expanding the [overview example](/site/weavedns.md), let us start an additional `pingme` container on a second host, and then run +Expanding the [overview example](/site/tasks/weavedns/weavedns.md), let us start an additional `pingme` container on a second host, and then run some ping tests. ``` @@ -49,11 +49,11 @@ WeaveDNS removes the addresses of any container that dies. This offers a simple way to implement redundancy. E.g. if in our example we stop one of the `pingme` containers and re-run the ping tests, eventually (within ~30s at most, since that is the weaveDNS -[cache expiry time](/site/weavedns/managing-entries-weavedns.md#ttl)) we will only be hitting the address of the +[cache expiry time](/site/tasks/weavedns/managing-entries-weavedns.md#ttl)) we will only be hitting the address of the container that is still alive. **See Also** * [How Weave Finds Containers](/site/how-works-weavedns.md) - * [Managing Domains](/site/weavedns/managing-domains-weavedns.md) - * [Managing Domain Entries](/site/weavedns/managing-entries-weavedns.md) + * [Managing Domains](/site/tasks/weavedns/managing-domains-weavedns.md) + * [Managing Domain Entries](/site/tasks/weavedns/managing-entries-weavedns.md) diff --git a/site/weavedns/managing-domains-weavedns.md b/site/tasks/weavedns/managing-domains-weavedns.md similarity index 84% rename from site/weavedns/managing-domains-weavedns.md rename to site/tasks/weavedns/managing-domains-weavedns.md index 49a12b57..083c9cbc 100644 --- a/site/weavedns/managing-domains-weavedns.md +++ b/site/tasks/weavedns/managing-domains-weavedns.md @@ -12,7 +12,7 @@ The following topics are discussed: ## Configuring the domain search paths If you don't supply a domain search path (with `--dns-search=`), Weave -Net (via the [proxy](/site/weave-docker-api.md) or via `weave attach`) +Net (via the [proxy](/site/tasks/weave-docker-api/weave-docker-api.md) or via `weave attach`) tells a container to look for "bare" hostnames, like `pingme`, in its own domain (or in `weave.local` if it has no domain). @@ -46,5 +46,5 @@ link-local as per [RFC6762](https://tools.ietf.org/html/rfc6762), * [How Weave Finds Containers](/site/how-works-weavedns.md) - * [Load Balancing and Fault Resilience with WeaveDNS](/site/weavedns/load-balance-fault-weavedns.md) - * [Managing Domain Entries](/site/weavedns/managing-entries-weavedns.md) + * [Load Balancing and Fault Resilience with WeaveDNS](/site/tasks/weavedns/load-balance-fault-weavedns.md) + * [Managing Domain Entries](/site/tasks/weavedns/managing-entries-weavedns.md) diff --git a/site/weavedns/managing-entries-weavedns.md b/site/tasks/weavedns/managing-entries-weavedns.md similarity index 90% rename from site/weavedns/managing-entries-weavedns.md rename to site/tasks/weavedns/managing-entries-weavedns.md index 7600c573..75bfa6e1 100644 --- a/site/weavedns/managing-entries-weavedns.md +++ b/site/tasks/weavedns/managing-entries-weavedns.md @@ -78,6 +78,6 @@ weaveDNS instance will receive. **See Also** - * [How Weave Finds Containers](/site/weavedns/how-works-weavedns.md) - * [Load Balancing and Fault Resilience with WeaveDNS](/site/weavedns/load-balance-fault-weavedns.md) - * [Managing Domains](/site/weavedns/managing-domains-weavedns.md) + * [How Weave Finds Containers](/site/tasks/weavedns/how-works-weavedns.md) + * [Load Balancing and Fault Resilience with WeaveDNS](/site/tasks/weavedns/load-balance-fault-weavedns.md) + * [Managing Domains](/site/tasks/weavedns/managing-domains-weavedns.md) diff --git a/site/weavedns/troubleshooting-weavedns.md b/site/tasks/weavedns/troubleshooting-weavedns.md similarity index 100% rename from site/weavedns/troubleshooting-weavedns.md rename to site/tasks/weavedns/troubleshooting-weavedns.md diff --git a/site/weavedns.md b/site/tasks/weavedns/weavedns.md similarity index 87% rename from site/weavedns.md rename to site/tasks/weavedns/weavedns.md index a83e6fec..c66da58f 100644 --- a/site/weavedns.md +++ b/site/tasks/weavedns/weavedns.md @@ -1,6 +1,6 @@ --- title: Discovering Containers with WeaveDNS -menu_order: 80 +menu_order: 5 search_type: Documentation --- @@ -45,5 +45,5 @@ disable weaveDNS itself, launch weave with the `--no-dns` option. **See Also** - * [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) + * [Integrating Docker via the API Proxy](/site/tasks/weave-docker-api/weave-docker-api.md) + * [Load Balancing and Fault Resilience with WeaveDNS](/site/tasks/weavedns/load-balance-fault-weavedns.md) diff --git a/site/troubleshooting.md b/site/troubleshooting.md index d849c272..03661925 100644 --- a/site/troubleshooting.md +++ b/site/troubleshooting.md @@ -79,7 +79,7 @@ $ weave status ``` The terms used here are explained further at -[How Weave Net Works](/site/how-it-works.md). +[How Weave Net Works](/site/concepts/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 @@ -95,11 +95,11 @@ can be overridden by using the `--nickname` argument at `weave launch`. * **Encryption** - indicates whether -[encryption](/site/how-it-works/encryption.md) is in use for communication +[encryption](/site/concepts/encryption.md) is in use for communication between peers. * **PeerDiscovery** - indicates whether -[automatic peer discovery](/site/ipam/allocation-multi-ipam.md) is +[automatic peer discovery](/site/tasks/ipam/allocation-multi-ipam.md) is enabled (which is the default). * **Targets** - are the number of hosts that the local Weave Router has been @@ -286,7 +286,7 @@ on reboot. This can be disabled via: Note that the Weave Net router will create the `weave` network bridge if necessary when it restarts, and the [Weave Net Docker API -Proxy](/site/weave-docker-api.md) will re-attach any application +Proxy](/site/tasks/weave-docker-api/weave-docker-api.md) will re-attach any application containers that it originally attached to the Weave network when they restart. @@ -307,5 +307,5 @@ and the container image versions as git hashes. **See Also** - * [Troubleshooting IPAM](/site/ipam/troubleshooting-ipam.md) - * [Troubleshooting the Proxy](/site/weave-docker-api/using-proxy.md) + * [Troubleshooting IPAM](/site/tasks/ipam/troubleshooting-ipam.md) + * [Troubleshooting the Proxy](/site/tasks/weave-docker-api/using-proxy.md)