Skip to content
This repository has been archived by the owner on Jun 20, 2024. It is now read-only.

Commit

Permalink
Document automatic overlay selection feature
Browse files Browse the repository at this point in the history
  • Loading branch information
awh committed Oct 15, 2015
1 parent 0fcd7af commit c6606ce
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 10 deletions.
32 changes: 26 additions & 6 deletions site/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Weave has a few more features beyond those illustrated by the [basic
example](https://github.com/weaveworks/weave#example):

* [Virtual ethernet switch](#virtual-ethernet-switch)
* [Optimised traffic transport](#optimised-traffic-transport)
* [Seamless Docker integration](#docker)
* [Address allocation](#addressing)
* [Naming and discovery](#naming-and-discovery)
Expand Down Expand Up @@ -55,6 +56,20 @@ now re-use the same tools and techniques when deploying applications
as containers as we would have done when deploying them 'on metal' in
our data centre.

### <a name="optimised-traffic-transport"></a>Optimised traffic transport

Weave automatically chooses the fastest available method to transport
traffic between peers. The most performant of these ('fastdp') offers
near-native throughput and latency but does not support encryption;
consequently supplying a password will cause the router to fall back
to a slower mode ('sleeve') that does. You can see which method is in
use by examining the output of `weave status connections`.

You can also administratively disable fastdp with the
`WEAVE_NO_FASTDP` environment variable:

$ WEAVE_NO_FASTDP=true weave launch

### <a name="docker"></a>Seamless Docker integration

Weave includes a [Docker API proxy](proxy.html) so that containers
Expand Down Expand Up @@ -282,7 +297,10 @@ way to generate a random password which satsifies this requirement is

< /dev/urandom tr -dc A-Za-z0-9 | head -c9 ; echo

The same password must be specified for all weave peers.
The same password must be specified for all weave peers. Note that
supplying a password will [cause weave to fall back to a slower
method](#optimised-traffic-transport) for transporting traffic between
peers.

### <a name="host-network-integration"></a>Host network integration

Expand Down Expand Up @@ -449,11 +467,13 @@ Weave can network containers hosted in different cloud providers /
data centres. So, for example, one could run an application consisting
of containers on GCE, EC2 and in local data centres.

To enable this, the network must be configured to permit TCP and UDP
connections to the weave port of the docker hosts. The weave port
defaults to 6783. This can be overriden by setting `WEAVE_PORT`, but
it is highly recommended that all peers in a weave network are given
the same port setting.
To enable this, the network must be configured to permit connections
to weave's control and data ports on the docker hosts. The control
port defaults to TCP 6783, and the data ports to UDP 6783/6784. You
can override these defaults by setting `WEAVE_PORT` (this is a base
value - setting `WEAVE_PORT=9000` will result in weave using TCP 9000
for control and UDP 9000/9001 for data). Note that it is highly
recommended that all peers be given the same setting.

### <a name="multi-hop-routing"></a>Multi-hop routing

Expand Down
9 changes: 5 additions & 4 deletions site/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,8 @@ obtained with `weave status connections`:

````
$ weave status connections
<- 192.168.48.12:33866 established 7e:21:4a:70:2f:45(host2)
<- 192.168.48.13:60773 pending 7e:ae:cd:d5:23:8d(host3)
<- 192.168.48.12:33866 established fastdp 7e:21:4a:70:2f:45(host2)
<- 192.168.48.13:60773 pending fastdp 7e:ae:cd:d5:23:8d(host3)
-> 192.168.48.14:6783 retrying dial tcp4 192.168.48.14:6783: no route to host
-> 192.168.48.15:6783 failed dial tcp4 192.168.48.15:6783: no route to host, retry: 2015-08-06 18:55:38.246910357 +0000 UTC
-> 192.168.48.16:6783 connecting
Expand All @@ -161,8 +161,9 @@ The columns are as follows:
* `pending` - TCP connection up, waiting for confirmation of
UDP heartbeat
* `established` - TCP connection and corresponding UDP path are up
* Info - the remote peer name and nickname for (un)established
connections, the failure reason for failed and retrying connection
* Info - the traffic transport method, remote peer name and nickname
for (un)established connections, the failure reason for failed and
retrying connection

### <a name="weave-status-peers"></a>List peers

Expand Down

0 comments on commit c6606ce

Please sign in to comment.