Merge pull request #2188 from weaveworks/doc-improvements
Minor improvements to docs
This commit is contained in:
Adam Harrison committed
commit
3afb12de32
20 files changed
+161
-174
No files matched your search
@@ -210,11 +210,3 @@ reached the peer that does the `rmpeer`, then we get an inconsistent
|
||||
ring. We could make it safe, up to partitions, by inquiring of every
|
||||
live peer what its view of the dead peer is, and making sure we use
|
||||
the latest info.)
|
||||
|
||||
## Limitations
|
||||
|
||||
Nothing is persisted. If one peer restarts it should receive gossip
|
||||
from other peers showing what it used to own, and in that case it can
|
||||
recover quite well. If, however, there are no peers left alive, or
|
||||
this peer cannot establish network communication with those that are,
|
||||
then it cannot recover.
|
||||
+1
-1
@@ -29,7 +29,7 @@ Then run:
|
||||
To create a network which can span multiple hosts, the Weave 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).
|
||||
|
||||
See [Deploying Applications to Weave Net](/site/using-weave/deploying-applications.md#peer-connections) for a discussion on peer connections.
|
||||
See [Using Weave Net](/site/using-weave.md#peer-connections) for a discussion on peer connections.
|
||||
|
||||
As well as launching Weave Net, you have to run an extra command to
|
||||
perform some additional configuration of the Weave bridge:
|
||||
|
||||
+2
-2
@@ -69,7 +69,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](/using-weave/fastdp.md)
|
||||
For more information on this command, see [Using Fast Datapath](/site/using-weave/fastdp.md)
|
||||
|
||||
|
||||
**Q: Does encryption work with fastdp?**
|
||||
@@ -78,7 +78,7 @@ Encryption does not work with fast datapath. If you enable encryption using the
|
||||
|
||||
You can however have a mixture of fast datapath connections over trusted links, as well as, encrypted connections over untrusted links.
|
||||
|
||||
See [Using Fast Datapath](/using-weave/fastdp.md) for more information
|
||||
See [Using Fast Datapath](/site/using-weave/fastdp.md) for more information
|
||||
|
||||
**Q: Can I create multiple networks where containers can communicate on one network, but are isolated from containers on other networks?**
|
||||
|
||||
|
||||
+7
-10
@@ -3,9 +3,6 @@ title: Feature Overview
|
||||
menu_order: 20
|
||||
---
|
||||
|
||||
The following is a comprehensive list and overview of all the features available in Weave
|
||||
Net:
|
||||
|
||||
* [Virtual Ethernet Switch](#virtual-ethernet-switch)
|
||||
* [Fast Data Path](#fast-data-path)
|
||||
* [Seamless Docker Integration](#docker)
|
||||
@@ -42,11 +39,11 @@ tools and applications, developed over decades, can still
|
||||
be used to configure, secure, monitor, and troubleshoot
|
||||
a container network.
|
||||
|
||||
Broadcast and Multicast protocols can also be implemented
|
||||
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 [Deploying Applications to Weave Net](/site/using-weave/deploying-applications.md).
|
||||
and [Using Weave Net](/site/using-weave.md).
|
||||
|
||||
###<a name="fast-data-path"></a>Fast Datapath
|
||||
|
||||
@@ -58,7 +55,7 @@ Fast datapath does not support encryption. For full details on configuring
|
||||
Weave when you have connections that traverse untrusted networks,
|
||||
see [Securing Connections Across Untrusted Networks](/site/using-weave/security-untrusted-networks.md) for more details.
|
||||
|
||||
See [Using Fast Datapath](/using-weave/fastdp.md) and
|
||||
See [Using Fast Datapath](/site/using-weave/fastdp.md) and
|
||||
[How Fast Datapath Works](/site/how-it-works/fastdp-how-it-works.md).
|
||||
|
||||
###<a name="docker"></a>Seamless Docker Integration (Weave Docker API Proxy)
|
||||
@@ -66,7 +63,7 @@ See [Using Fast Datapath](/using-weave/fastdp.md) and
|
||||
Weave Net includes a [Docker API Proxy](/site/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:
|
||||
To use the proxy, run:
|
||||
|
||||
host1$ eval $(weave env)
|
||||
|
||||
@@ -138,8 +135,8 @@ to communicate with each other but not with the containers
|
||||
of other applications.
|
||||
|
||||
To isolate applications, Weave Net can make use of the
|
||||
`isolation-through-subnets` technique. This common strategy
|
||||
is an example of how with Weave many of your `on metal`
|
||||
_isolation-through-subnets_ technique. This common strategy
|
||||
is an example of how with Weave many "on metal"
|
||||
techniques can be used to deploy your applications to
|
||||
containers.
|
||||
|
||||
@@ -179,7 +176,7 @@ mechanism which you can use in conjunction with or as an
|
||||
alternative to any other security technologies you have
|
||||
running alongside Weave.
|
||||
|
||||
Weave Net implements encryption and security using [Daniel J. Bernstein's NaCl library](http://nacl.cr.yp.to/index.html).
|
||||
Weave Net implements encryption and security using the Go version of [Daniel J. Bernstein's NaCl library](http://nacl.cr.yp.to/index.html).
|
||||
|
||||
For information on how to secure your Docker network connections, see [Securing Connections Across Untrusted Networks](/site/using-weave/security-untrusted-networks.md) and for a more technical discussion on how Weave implements encryption see, [Weave Encryption](/how-it-works/encryption.md) and [How Weave Implements Encryption](/site/how-it-works/encryption-implementation.md).
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ is given an IP address and netmask supplied either by the user or
|
||||
by Weave Net's IP address allocator.
|
||||
|
||||
Weave Net routes packets between containers on different hosts via two
|
||||
methods: a [fast data path](/using-weave/fastdp.md) method, which operates
|
||||
methods: a [fast data path](/site/using-weave/fastdp.md) method, which operates
|
||||
entirely in kernel space, and a fallback `sleeve` method, in which
|
||||
packets destined for non-local containers are captured by the kernel
|
||||
and processed by the Weave Net router in user space, forwarded over
|
||||
|
||||
@@ -24,7 +24,7 @@ Prior to version 1.2, Weave Net used a custom encapsulation format. Fast datapat
|
||||
|
||||
**See Also**
|
||||
|
||||
* [Deploying Applications to Weave](/site/using-weave/deploying-applications.md)
|
||||
* [Using Fast Datapath](/using-weave/fastdp.md)
|
||||
* [Using Weave Net](/site/using-weave.md)
|
||||
* [Using Fast Datapath](/site/using-weave/fastdp.md)
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ menu_order: 10
|
||||
---
|
||||
|
||||
When the Weave Net router forwards packets to peers in `sleeve` mode
|
||||
(rather than via the [fast data path](/using-weave/fastdp.md)), the
|
||||
(rather than via the [fast data path](/site/using-weave/fastdp.md)), the
|
||||
encapsulation looks something like this:
|
||||
|
||||
+-----------------------------------+
|
||||
|
||||
@@ -12,7 +12,7 @@ Install Weave Net by running the following:
|
||||
sudo curl -L git.io/weave -o /usr/local/bin/weave
|
||||
sudo chmod a+x /usr/local/bin/weave
|
||||
|
||||
If you are on OSX and are using Docker Machine) you need to make sure
|
||||
If you are on OSX and are using Docker Machine you need to make sure
|
||||
that a VM is running and configured before getting Weave Net. Setting up a VM is shown in [the Docker Machine
|
||||
documentation](https://docs.docker.com/installation/mac/#from-your-shell).
|
||||
After the VM is configured with Docker Machine, Weave Net can be launched directly from the OSX host.
|
||||
@@ -20,13 +20,7 @@ After the VM is configured with Docker Machine, Weave Net can be launched direct
|
||||
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).
|
||||
|
||||
With Weave Net downloaded onto your VMs or hosts, you are ready to launch a Weave network and deploy apps onto it. See [Deploying Applications to Weave](/site/using-weave/deploying-applications.md).
|
||||
|
||||
CoreOS users see [here](https://github.com/fintanr/weave-gs/blob/master/coreos-simple/user-data) for an example of installing Weave using cloud-config.
|
||||
|
||||
Amazon ECS users see [here](https://github.com/weaveworks/integrations/blob/master/aws/ecs/README.md)
|
||||
for the latest Weave AMIs and [here](http://weave.works/guides/service-discovery-with-weave-aws-ecs.html) to get started with Weave Net on ECS.
|
||||
|
||||
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).
|
||||
|
||||
###Quick Start Screencast
|
||||
|
||||
@@ -34,6 +28,13 @@ for the latest Weave AMIs and [here](http://weave.works/guides/service-discovery
|
||||
<img src="hello-screencast.png" />
|
||||
</a>
|
||||
|
||||
###Guides for specific platforms
|
||||
|
||||
CoreOS users see [here](/guides/networking-docker-containers-with-weave-on-coreos/) for an example of installing Weave using cloud-config.
|
||||
|
||||
Amazon ECS users see [here](https://github.com/weaveworks/integrations/blob/master/aws/ecs/README.md)
|
||||
for the latest Weave AMIs and [here](http://weave.works/guides/service-discovery-with-weave-aws-ecs.html) to get started with Weave Net on ECS.
|
||||
|
||||
**See Also**
|
||||
|
||||
* [Using Weave Net](/site/using-weave.md)
|
||||
|
||||
@@ -4,7 +4,7 @@ menu_order: 10
|
||||
---
|
||||
|
||||
|
||||
Weave Net creates a virtual network that connects Docker containers deployed across multiple hosts and enables their automatic discovery. With Weave Net, portable microservices-based applications consisting of multiple containers can run anywhere: on one host, multiple hosts or even across cloud providers and data centers. Applications use the network just as if the containers were all plugged into the same network switch, without having to configure port mappings, or ambassador links.
|
||||
Weave Net creates a virtual network that connects Docker containers across multiple hosts and enables their automatic discovery. With Weave Net, portable microservices-based applications consisting of multiple containers can run anywhere: on one host, multiple hosts or even across cloud providers and data centers. Applications use the network just as if the containers were all plugged into the same network switch, without having to configure port mappings, ambassadors or links.
|
||||
|
||||
Services provided by application containers on the weave network can be exposed to the outside world, regardless of where they are running. Similarly, existing internal systems can be opened to accept connections from application containers irrespective of their location.
|
||||
|
||||
@@ -36,7 +36,7 @@ Weave Net can forward traffic between nodes, and it works even if the mesh netwo
|
||||
|
||||
Weave Net automatically chooses the fastest path between two hosts, offering near native throughput and latency, all without your intervention.
|
||||
|
||||
See [How Fast Datapath Works](/using-weave/fastdp.md) for more information.
|
||||
See [How Fast Datapath Works](/site/using-weave/fastdp.md) for more information.
|
||||
|
||||
###Network Operations Friendly
|
||||
|
||||
@@ -52,9 +52,9 @@ Multicast addressing and routing is fully supported in Weave Net. Data can be se
|
||||
|
||||
###NAT Traversal
|
||||
|
||||
With Weave Net, deploy your peer-to-peer file sharing applications and voice over IP and take advantage of built-in NAT traversal. With Weave your app is portable, containerized and with its standardized approach to networking it gives you one less thing to worry about.
|
||||
With Weave Net, deploy your applications - whether peer-to-peer file sharing, voice over IP or anything else - and take advantage of built-in NAT traversal. With Weave your app is portable, containerized and with its standardized approach to networking it gives you one less thing to worry about.
|
||||
|
||||
###Run with Anything: Kubernetes, Mesos, Amazon ECS
|
||||
###Run with Anything: Kubernetes, Mesos, Amazon ECS, ...
|
||||
|
||||
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.
|
||||
|
||||
@@ -175,6 +175,18 @@ the rest (a partition), they can continue to work with the address
|
||||
ranges they had before isolation, and can subsequently be re-connected
|
||||
to the rest of the network without any conflicts arising.
|
||||
|
||||
### <a name="persistence"></a>Data persistence
|
||||
|
||||
Key IPAM data is saved to disk, so that it is immediately available
|
||||
when the peer restarts:
|
||||
|
||||
* The division of the IP allocation range amongst peers
|
||||
* Allocation of addresses to containers on the local peer
|
||||
|
||||
A [data volume
|
||||
container](https://docs.docker.com/engine/userguide/containers/dockervolumes/#creating-and-mounting-a-data-volume-container)
|
||||
named `weavedb` is used to store this data.
|
||||
|
||||
**See Also**
|
||||
|
||||
* [Automatic Allocation Across Multiple Subnets](/site/ipam/allocation-multi-ipam.md)
|
||||
|
||||
+3
-3
@@ -12,7 +12,7 @@ best of all doesn't require an external cluster store in order to use it.
|
||||
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).
|
||||
|
||||
See [Deploying Applications to Weave Net](/site/using-weave/deploying-applications.md#peer-connections) for a discussion on peer connections.
|
||||
See [Using Weave Net](/site/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:
|
||||
|
||||
@@ -54,11 +54,11 @@ then run your containers using the Docker command-line:
|
||||
|
||||
### Restarting the Plugin
|
||||
|
||||
The plugin is started with a policy of `--restart=always`, so that it is always there after a restart or reboot. If you remove this container (for example, when using `weave reset`) before removing all endpoints created using `--net=weave`, Docker may hang for a long time when it subsequently tries to re-establish communications to the plugin.
|
||||
The plugin, like all Weave Net components, is started with a policy of `--restart=always`, so that it is always there after a restart or reboot. If you remove this container (for example, when using `weave reset`) before removing all endpoints created using `--net=weave`, Docker may hang for a long time when it subsequently tries to re-establish communications to the plugin.
|
||||
|
||||
Unfortunately, [Docker 1.9 may also try to communicate with the plugin before it has even started it](https://github.com/docker/libnetwork/issues/813).
|
||||
|
||||
If you are using `systemd`, it is advised that you modify the Docker unit to remove the timeout on startup. This gives Docker enough time to abandon its attempts. For example, in the file `/lib/systemd/system/docker.service`, add the following under `[Service]`:
|
||||
If you are using `systemd` with Docker 1.9, it is advised that you modify the Docker unit to remove the timeout on startup. This gives Docker enough time to abandon its attempts. For example, in the file `/lib/systemd/system/docker.service`, add the following under `[Service]`:
|
||||
|
||||
TimeoutStartSec=0
|
||||
|
||||
|
||||
@@ -279,7 +279,9 @@ re-connect.
|
||||
|
||||
All the containers started by `weave launch` are configured with the
|
||||
Docker restart policy `--restart=always`, so they will come back again
|
||||
on reboot.
|
||||
on reboot. This can be disabled via:
|
||||
|
||||
weave launch --no-restart
|
||||
|
||||
Note that the
|
||||
[Weave Net Docker API Proxy](/site/weave-docker-api/set-up-proxy.md)
|
||||
|
||||
+106
-11
@@ -3,17 +3,112 @@ title: Using Weave Net
|
||||
menu_order: 40
|
||||
---
|
||||
|
||||
Weave Net provides a simple to deploy networking solution for containerized apps. The example described and built upon throughout this `Using Weave Net` section describes how to manage a Weave container network using a sample application which consists of two simple `netcat` services deployed to containers on two separate hosts, and sometimes extended across three hosts.
|
||||
Weave Net provides a simple to deploy networking solution for containerized apps. Here, we describe how to manage a Weave container network using a sample application which consists of two simple `netcat` services deployed to containers on two separate hosts, and sometimes extended across three hosts.
|
||||
|
||||
The following topics are discussed:
|
||||
This section contains the following topics:
|
||||
|
||||
* [Deploying Applications to Weave](/site/using-weave/deploying-applications.md)
|
||||
* [How to Manually Specify IP Addresses and Subnets](/site/using-weave/manual-ip-address.md)
|
||||
* [Isolating Applications](/site/using-weave/application-isolation.md)
|
||||
* [Dynamically Attaching and Detaching Containers](/site/using-weave/dynamically-attach-containers.md)
|
||||
* [Integrating an External Host Network with Weave](/site/using-weave/host-network-integration.md)
|
||||
* [Exposing Services to the Outside](/site/using-weave/service-export.md)
|
||||
* [Managing Services in Weave: Importing, Binding and Routing](/site/using-weave/service-management.md)
|
||||
* [Enabling Multi-cloud Networking and Multi-hop Routing](/site/using-weave/multi-cloud-multi-hop.md)
|
||||
* [Adding Hosts Dynamically](/site/using-weave/finding-adding-hosts-dynamically.md)
|
||||
* [Launching Weave Net](#launching)
|
||||
* [Creating Peer Connections Between Hosts](#peer-connections)
|
||||
* [Testing Container Communications](#testing)
|
||||
* [Starting the Netcat Service](#start-netcat)
|
||||
|
||||
|
||||
###<a name="launching"></a>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.
|
||||
|
||||
On `$HOST1` run:
|
||||
|
||||
host1$ weave launch
|
||||
host1$ eval $(weave env)
|
||||
host1$ docker run --name a1 -ti ubuntu
|
||||
|
||||
Where,
|
||||
|
||||
* The first line runs Weave Net.
|
||||
* The second line configures the Weave Net environment, so that containers launched via the Docker command line are automatically attached to the Weave network, and,
|
||||
* The third line runs the application container using [Docker commands](https://docs.Docker.com/engine/reference/commandline/daemon/).
|
||||
|
||||
>**Note:** If the first command results in an error like
|
||||
`http:///var/run/Docker.sock/v1.19/containers/create: dial unix
|
||||
/var/run/Docker.sock: permission denied. Are you trying to connect to a TLS-enabled daemon without TLS?` then you likely need to be 'root' in order to connect to the Docker daemon. If so, run the above and all subsequent commands in a *single* root shell (e.g. one created with `sudo -s`). Do *not* prefix individual commands with `sudo`, since some commands modify environment entries and hence they all need to be executed from the same shell.
|
||||
|
||||
|
||||
>**Important!** if you are running the Weave Docker Network Plugin do not run `eval $(weave env)`. See [Using the Weave Net Docker Network Plugin](/site/plugin.md) for more information.
|
||||
|
||||
Weave Net must be launched once per host. The relevant container images will be pulled down from Docker Hub on demand during `weave launch`.
|
||||
|
||||
You can also preload the images by running `weave setup`. Preloaded images are useful for automated deployments, and ensure there are no delays during later operations.
|
||||
|
||||
If you are deploying an application that consists of more than one container to the same host, launch them one after another using `docker run`, as appropriate.
|
||||
|
||||
|
||||
###<a name="peer-connections"></a>Creating Peer Connections Between Hosts
|
||||
|
||||
To launch Weave Net on an additional host and create a peer connection, run the following:
|
||||
|
||||
host2$ weave launch $HOST1
|
||||
host2$ eval $(weave env)
|
||||
host2$ docker run --name a2 -ti ubuntu
|
||||
|
||||
As noted above, the same steps are repeated for `$HOST2`. The only difference, besides the application container’s name, is that `$HOST2` is told to peer with Weave Net on `$HOST1` during launch.
|
||||
|
||||
You can also peer with other hosts by specifying the IP address, and a `:port` by which `$HOST2` can reach `$HOST1`.
|
||||
|
||||
>**Note:** If there is a firewall between `$HOST1` and `$HOST2`, you must permit traffic to flow through TCP 6783 and UDP 6783/6798, which are Weave’s control and data ports.
|
||||
|
||||
There are a number of different ways that you can specify peers on a Weave network. You can launch Weave Net on `$HOST1` and then peer with `$HOST2`, or you can launch on `$HOST2` and peer with `$HOST1` or you can tell both hosts about each other at launch. The order in which peers are specified is not important. Weave Net automatically (re)connects to peers when they become available.
|
||||
|
||||
####Specifying Multiple Peers at Launch
|
||||
|
||||
To specify multiple peers, supply a list of addresses to which you want to connect, all separated by spaces.
|
||||
|
||||
For example:
|
||||
|
||||
host2$ weave launch <ip address> <ip address>
|
||||
|
||||
Peers can also be dynamically added. See [Adding Hosts Dynamically](/site/using-weave/finding-adding-hosts-dynamically.md) for more information.
|
||||
|
||||
|
||||
###<a name="testing"></a>Testing Container Communications
|
||||
|
||||
With two containers running on separate hosts, test that both containers are able to find and communicate with one another using ping.
|
||||
|
||||
From the container started on `$HOST1`...
|
||||
|
||||
|
||||
root@a1:/# ping -c 1 -q a2
|
||||
PING a2.weave.local (10.40.0.2) 56(84) bytes of data.
|
||||
--- a2.weave.local ping statistics ---
|
||||
1 packets transmitted, 1 received, 0% packet loss, time 0ms
|
||||
rtt min/avg/max/mdev = 0.341/0.341/0.341/0.000 ms
|
||||
|
||||
Similarly, in the container started on `$HOST2`...
|
||||
|
||||
root@a2:/# ping -c 1 -q a1
|
||||
PING a1.weave.local (10.32.0.2) 56(84) bytes of data.
|
||||
--- a1.weave.local ping statistics ---
|
||||
1 packets transmitted, 1 received, 0% packet loss, time 0ms
|
||||
rtt min/avg/max/mdev = 0.366/0.366/0.366/0.000 ms
|
||||
|
||||
###<a name="start-netcat"></a>Starting the Netcat Service
|
||||
|
||||
The `netcat` service can be started using the following commands:
|
||||
|
||||
root@a1:/# nc -lk -p 4422
|
||||
|
||||
and then connected to from the another container on `$HOST2` using:
|
||||
|
||||
root@a2:/# echo 'Hello, world.' | nc a1 4422
|
||||
|
||||
Weave Net supports *any* protocol, and it doesn't have to be over TCP/IP. For example, a netcat UDP service can also be run by using the following:
|
||||
|
||||
root@a1:/# nc -lu -p 5533
|
||||
root@a2:/# echo 'Hello, world.' | nc -u a1 5533
|
||||
|
||||
|
||||
**See Also**
|
||||
|
||||
* [Installing Weave Net](/site/installing-weave.md)
|
||||
* [Using Fastdp With Weave Net](/site/using-weave/fastdp.md)
|
||||
* [Using the Weave Net Docker Network Plugin](/site/plugin.md)
|
||||
@@ -13,7 +13,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/deploying-applications.md), configure multiple subsets:
|
||||
Using [the netcat example](/site/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)
|
||||
|
||||
@@ -1,112 +0,0 @@
|
||||
---
|
||||
title: Deploying Applications To Weave Net
|
||||
menu_order: 10
|
||||
---
|
||||
|
||||
This section contains the following topics:
|
||||
|
||||
* [Launching Weave Net](#launching)
|
||||
* [Creating Peer Connections Between Hosts](#peer-connections)
|
||||
* [Testing Container Communications](#testing)
|
||||
* [Starting the Netcat Service](#start-netcat)
|
||||
|
||||
|
||||
###<a name="launching"></a>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.
|
||||
|
||||
On `$HOST1` run:
|
||||
|
||||
host1$ weave launch
|
||||
host1$ eval $(weave env)
|
||||
host1$ docker run --name a1 -ti ubuntu
|
||||
|
||||
Where,
|
||||
|
||||
* The first line runs Weave Net.
|
||||
* The second line configures the Weave Net environment, so that containers launched via the Docker command line are automatically attached to the Weave network, and,
|
||||
* The third line runs the application container using [Docker commands](https://docs.Docker.com/engine/reference/commandline/daemon/).
|
||||
|
||||
>**Note:** If the first command results in an error like
|
||||
`http:///var/run/Docker.sock/v1.19/containers/create: dial unix
|
||||
/var/run/Docker.sock: permission denied. Are you trying to connect to a TLS-enabled daemon without TLS?` then you likely need to be 'root' in order to connect to the Docker daemon. If so, run the above and all subsequent commands in a *single* root shell (e.g. one created with `sudo -s`). Do *not* prefix individual commands with `sudo`, since some commands modify environment entries and hence they all need to be executed from the same shell.
|
||||
|
||||
|
||||
>**Important!** if you are running the Weave Docker Network Plugin do not run `eval $(weave env)`. See [Using the Weave Net Docker Network Plugin](/site/plugin.md) for more information.
|
||||
|
||||
Weave Net must be launched once per host. The relevant container images will be pulled down from Docker Hub on demand during `weave launch`.
|
||||
|
||||
You can also preload the images by running `weave setup`. Preloaded images are useful for automated deployments, and ensure there are no delays during later operations.
|
||||
|
||||
If you are deploying an application that consists of more than one container to the same host, launch them one after another using `docker run`, as appropriate.
|
||||
|
||||
|
||||
###<a name="peer-connections"></a>Creating Peer Connections Between Hosts
|
||||
|
||||
To launch Weave Net on an additional host and create a peer connection, run the following:
|
||||
|
||||
host2$ weave launch $HOST1
|
||||
host2$ eval $(weave env)
|
||||
host2$ docker run --name a2 -ti ubuntu
|
||||
|
||||
As noted above, the same steps are repeated for `$HOST2`. The only difference, besides the application container’s name, is that `$HOST2` is told to peer with Weave Net on `$HOST1` during launch.
|
||||
|
||||
You can also peer with other hosts by specifying the IP address, and a `:port` by which `$HOST2` can reach `$HOST1`.
|
||||
|
||||
>**Note:** If there is a firewall between `$HOST1` and `$HOST2`, you must permit traffic to flow through TCP 6783 and UDP 6783/6798, which are Weave’s control and data ports.
|
||||
|
||||
There are a number of different ways that you can specify peers on a Weave network. You can launch Weave Net on `$HOST1` and then peer with `$HOST2`, or you can launch on `$HOST2` and peer with `$HOST1` or you can tell both hosts about each other at launch. The order in which peers are specified is not important. Weave Net automatically (re)connects to peers when they become available.
|
||||
|
||||
####Specifying Multiple Peers at Launch
|
||||
|
||||
To specify multiple peers, supply a list of addresses to which you want to connect, all separated by spaces.
|
||||
|
||||
For example:
|
||||
|
||||
host2$ weave launch <ip address> <ip address>
|
||||
|
||||
Peers can also be dynamically added. See [Adding Hosts Dynamically](/site/using-weave/finding-adding-hosts-dynamically.md) for more information.
|
||||
|
||||
|
||||
###<a name="testing"></a>Testing Container Communications
|
||||
|
||||
With two containers running on separate hosts, test that both containers are able to find and communicate with one another using ping.
|
||||
|
||||
From the container started on `$HOST1`...
|
||||
|
||||
|
||||
root@a1:/# ping -c 1 -q a2
|
||||
PING a2.weave.local (10.40.0.2) 56(84) bytes of data.
|
||||
--- a2.weave.local ping statistics ---
|
||||
1 packets transmitted, 1 received, 0% packet loss, time 0ms
|
||||
rtt min/avg/max/mdev = 0.341/0.341/0.341/0.000 ms
|
||||
|
||||
Similarly, in the container started on `$HOST2`...
|
||||
|
||||
root@a2:/# ping -c 1 -q a1
|
||||
PING a1.weave.local (10.32.0.2) 56(84) bytes of data.
|
||||
--- a1.weave.local ping statistics ---
|
||||
1 packets transmitted, 1 received, 0% packet loss, time 0ms
|
||||
rtt min/avg/max/mdev = 0.366/0.366/0.366/0.000 ms
|
||||
|
||||
###<a name="start-netcat"></a>Starting the Netcat Service
|
||||
|
||||
The `netcat` service can be started using the following commands:
|
||||
|
||||
root@a1:/# nc -lk -p 4422
|
||||
|
||||
and then connected to from the another container on `$HOST2` using:
|
||||
|
||||
root@a2:/# echo 'Hello, world.' | nc a1 4422
|
||||
|
||||
Weave Net supports *any* protocol, and it doesn't have to be over TCP/IP. For example, a netcat UDP service can also be run by using the following:
|
||||
|
||||
root@a1:/# nc -lu -p 5533
|
||||
root@a2:/# echo 'Hello, world.' | nc -u a1 5533
|
||||
|
||||
|
||||
**See Also**
|
||||
|
||||
* [Installing Weave Net](/site/installing-weave.md)
|
||||
* [Using Fastdp With Weave Net](/using-weave/fastdp.md)
|
||||
* [Using the Weave Net Docker Network Plugin](/site/plugin.md)
|
||||
@@ -44,6 +44,6 @@ Where fastdp indicates that fast datapath is being used on a connection. If fast
|
||||
|
||||
**See Also**
|
||||
|
||||
* [Deploying Applications to Weave](/site/using-weave/deploying-applications.md)
|
||||
* [Using Weave Net](/site/using-weave.md)
|
||||
* [How Fastdp Works](/site/how-it-works/fastdp-how-it-works.md)
|
||||
|
||||
@@ -5,7 +5,7 @@ menu_order: 60
|
||||
|
||||
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/deploying-applications.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/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:
|
||||
|
||||
@@ -41,5 +41,5 @@ Exposed addresses can also be added to weaveDNS by supplying fully qualified dom
|
||||
|
||||
**See Also**
|
||||
|
||||
* [Deploying Applications To Weave Net](/site/using-weave/deploying-applications.md)
|
||||
* [Using Weave Net](/site/using-weave.md)
|
||||
* [Managing Services in Weave: Exporting, Importing, Binding and Routing](/site/using-weave/service-management.md)
|
||||
@@ -34,7 +34,7 @@ password at `weave launch` the router falls back to a slower
|
||||
|
||||
If some of your peers are co-located in a trusted network (for example within the boundary of your own data center) you can use the `--trusted-subnets` argument to `weave launch` to selectively disable data plane encryption as an optimization.
|
||||
|
||||
>**Note:** Both peers must consider the other to be in a trusted subnet for this to take place - if they do not agree, Weave Net [falls back to a slower method](/using-weave/fastdp.md) for transporting data between peers, since fast datapath does not support encryption.
|
||||
>**Note:** Both peers must consider the other to be in a trusted subnet for this to take place - if they do not agree, Weave Net [falls back to a slower method](/site/using-weave/fastdp.md) for transporting data between peers, since fast datapath does not support encryption.
|
||||
|
||||
Be aware that:
|
||||
|
||||
@@ -46,4 +46,4 @@ Be aware that:
|
||||
**See Also**
|
||||
|
||||
* [Weave Encryption](/how-it-works/encryption.md)
|
||||
* [Using Fast Datapath](/using-weave/fastdp.md)
|
||||
* [Using Fast Datapath](/site/using-weave/fastdp.md)
|
||||
@@ -8,7 +8,7 @@ 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/deploying-applications.md),
|
||||
Returning to the [netcat example service](/site/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 a Host Network with a Weave Net](/site/using-weave/host-network-integration.md):
|
||||
|
||||
@@ -17,7 +17,7 @@ This section contains the following topics:
|
||||
|
||||
Services running in containers on a Weave network can be made accessible to the outside world (and, more generally, to other networks) from any Weave host, regardless of where the service containers are located.
|
||||
|
||||
Turning back to the [netcat example](/site/using-weave/deploying-applications.md), say you want the netcat service, which is running in a container on `$HOST1`, to be accessible to the outside world via `$HOST2`.
|
||||
Turning back to the [netcat example](/site/using-weave.md), say you want the netcat service, which is running in a container on `$HOST1`, to be accessible to the outside world via `$HOST2`.
|
||||
|
||||
To do this, expose the application network to `$HOST2`, as explained in [Host Network Integration](/site/using-weave/host-network-integration.md) by running:
|
||||
|
||||
@@ -44,7 +44,7 @@ Similar NAT rules to the above can used to expose services not just to the outsi
|
||||
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/deploying-applications.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/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`.
|
||||
|
||||
@@ -83,7 +83,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/deploying-applications.md), you can also import an additional netcat service running on `$HOST3` into Weave Net via `$HOST1`.
|
||||
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`.
|
||||
|
||||
Begin importing the service onto `$HOST2` by first exposing the application network:
|
||||
|
||||
|
||||
Reference in new issue
Block a user