From d1e004dedc484e1f12377c8f40a7638427ce7cdb Mon Sep 17 00:00:00 2001 From: abuehrle Date: Thu, 5 May 2016 15:18:43 -0500 Subject: [PATCH 1/6] removed duplicate content added links to website --- README.md | 159 +++--------------------------------------------------- 1 file changed, 8 insertions(+), 151 deletions(-) diff --git a/README.md b/README.md index f046ca5a..e32a658d 100644 --- a/README.md +++ b/README.md @@ -4,162 +4,19 @@ # About Weaveworks -[Weaveworks](http://weave.works) is the company that delivers the most productive way for developers to connect, observe and control -Docker containers. The first product developed by Weaveworks, with nearly 5 million downloads to date, is Weave Net, enabling users to get started with Docker clusters and portable apps in a fraction of the time compared to other solutions. In addition, Weaveworks offers Weave Scope, a powerful container monitoring tool that automatically maps Docker containers and their interactions, as well as Weave Flux, a microservice router that automates the access of containers as services. - +[Weaveworks](https://www.weave.works) is the company that delivers the most productive way for developers to connect, observe and control +Docker containers. The first product developed by Weaveworks, with nearly 5 million downloads to date, is Weave Net, enabling users to get started with Docker clusters and portable apps in a fraction of the time compared with other solutions. Other products from Weaveworks include [Weave Scope](https://www.weave.works/products/weave-scope/), a powerful container monitoring tool that automatically maps Docker containers and their interactions, and [Weave Flux](https://www.weave.works/products/weave-flux/), a microservice router that automates the access of containers as services. -# Introduction -This document is intended to cover some of the more technical aspects of Weave Net. To learn about our products, including getting -started tutorials, visit our [website](http://weave.works) and -[documentation](http://docs.weave.works). +# Weave Net Documentation -# Weave Net - -Weave Net creates a virtual network that connects Docker containers -deployed across multiple hosts and enables their automatic discovery. - -![Weave Virtual Network](/docs/virtual-network.png?raw=true "Weave Virtual Network") - -Applications use the network just as if the containers were all -plugged into the same network switch, with no need to configure port -mappings, links, etc. Services provided by application containers on -the weave network can be made accessible to the outside world, -regardless of where those containers are running. Similarly, existing -internal systems can be exposed to application containers irrespective -of their location. - -![Weave Net Deployment](/docs/deployment.png?raw=true "Weave Net Deployment") - -Weave Net can traverse firewalls and operate in partially connected -networks. Traffic can be encrypted, allowing hosts to be connected -across an untrusted network. - -With Weave Net you can easily construct applications consisting of -multiple containers, running anywhere. - -Weave Net works alongside Docker's existing (single host) networking -capabilities, so these can continue to be used by containers. - -## Installation - -To get started, you should be running Linux (kernel 3.8 or later) and have Docker -(version 1.6.0 or later) installed. Then install Weave Net with - - sudo curl -L git.io/weave -o /usr/local/bin/weave - sudo chmod a+x /usr/local/bin/weave - -For usage on OSX (with Docker Machine) you first need to -[make sure that a VM is running and configured](https://docs.docker.com/installation/mac/#from-your-shell). -Then you can launch Weave Net directly from the OSX host. - -For installing Weave Net on other platforms, follow the [integration guides](http://weave.works/product/integrations/). - -Weave Net respects the environment variable `DOCKER_HOST`, so you can run -it locally to control a weave network on a remote host. - -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](http://docs.weave.works/weave/latest_release/troubleshooting.html#weave-status). -To disable this check, run: - -``` -export CHECKPOINT_DISABLE=1 -``` - -before launching Weave Net. - -## Quick Start Screencast - - - - - -## Example - -Say you have docker running on two hosts, accessible to each other as -`$HOST1` and `$HOST2`, and want to deploy an application consisting of -two containers, one on each host. - -On $HOST1 you would run: - - host1$ weave launch - host1$ eval $(weave env) - host1$ docker run --name a1 -ti ubuntu - -> NB: 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. - -The first line runs Weave Net. The second line configures your environment -so that containers launched via the docker command line are -automatically attached to the weave network. Finally, you run your -application container. - -That's it! If your application consists of more than one container on -this host, you can simply launch them with `docker run` as appropriate. - -Next you'll repeat similar steps on `$HOST2`... - - host2$ weave launch $HOST1 - host2$ eval $(weave env) - host2$ docker run --name a2 -ti ubuntu - -The only difference, apart from the name of the application container, -is that weave is being told that it should peer with the weave on -`$HOST1` (specified as the IP address or hostname, and optional -`:port`, by which `$HOST2` can reach it). NB: if there is a firewall -between `$HOST1` and `$HOST2`, you must permit traffic to the weave -control port (TCP 6783) and data ports (UDP 6783/6784). - -Note that you could instead have told the Weave Net instance on `$HOST1` to connect to -`$HOST2`, or told both about each other. Order does not matter here; -Weave Net automatically (re)connects to peers when they become -available. You can instruct Weave Net to connect to multiple peers by -supplying multiple addresses, separated by spaces; you can also -[add peers dynamically](http://docs.weave.works/weave/latest_release/features.html#dynamic-topologies). - -Weave Net must be started once per host. The relevant container images are -pulled down on demand, but if you wish you can preload them by running -`weave setup` - this is particularly useful for automated deployments, -and ensures that there are no delays during later operations. - -Now that you've got everything set up, let's confirm that your containers -can talk to each other... - -In 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 - -So there you have it, two containers on separate hosts happily talking -to each other. +To learn more about our products, visit the [Weaveworks website](https://www.weave.works) and for indepth information on Weave Net, see the +[Weave Net User's Guide](https://www.weave.works/docs/net/latest/introducing-weave/). ## Find out more - * [Documentation homepage](http://docs.weave.works/weave/latest_release/) - * [Getting Started Guides](http://weave.works/guides/) - * [Features](http://docs.weave.works/weave/latest_release/features.html) - * [Troubleshooting](http://docs.weave.works/weave/latest_release/troubleshooting.html) - * [Building](http://docs.weave.works/weave/latest_release/building.html) - * [How it works](http://docs.weave.works/weave/latest_release/how-it-works.html) + * [Product Documentation](https://www.weave.works/docs/) + * [Getting Started Guides](https://www.weave.works/guides/) + ## Contact Us From 8c8709e5272b12b32db0a496cb33a308fac51236 Mon Sep 17 00:00:00 2001 From: abuehrle Date: Thu, 5 May 2016 16:41:23 -0500 Subject: [PATCH 2/6] added overview links to install --- README.md | 32 ++++++++++---------------------- 1 file changed, 10 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index e32a658d..f9c66710 100644 --- a/README.md +++ b/README.md @@ -5,34 +5,22 @@ # About Weaveworks [Weaveworks](https://www.weave.works) is the company that delivers the most productive way for developers to connect, observe and control -Docker containers. The first product developed by Weaveworks, with nearly 5 million downloads to date, is Weave Net, enabling users to get started with Docker clusters and portable apps in a fraction of the time compared with other solutions. Other products from Weaveworks include [Weave Scope](https://www.weave.works/products/weave-scope/), a powerful container monitoring tool that automatically maps Docker containers and their interactions, and [Weave Flux](https://www.weave.works/products/weave-flux/), a microservice router that automates the access of containers as services. +Docker containers. The first product developed by Weaveworks, with nearly 5 million downloads to date, is Weave Net, enabling users to get started with Docker clusters and portable apps in a fraction of the time compared with other solutions. -# Weave Net Documentation +Other products from Weaveworks include [Weave Scope](https://www.weave.works/products/weave-scope/), a powerful container monitoring tool that automatically maps Docker containers and their interactions, and [Weave Flux](https://www.weave.works/products/weave-flux/), a microservice router that automates the access of containers as services. -To learn more about our products, visit the [Weaveworks website](https://www.weave.works) and for indepth information on Weave Net, see the -[Weave Net User's Guide](https://www.weave.works/docs/net/latest/introducing-weave/). +##Weave Net -## Find out more +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. - * [Product Documentation](https://www.weave.works/docs/) - * [Getting Started Guides](https://www.weave.works/guides/) - +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. -## Contact Us +##Installing -Found a bug, want to suggest a feature, or have a question? Please -[file an issue](https://github.com/weaveworks/weave/issues), or post -to the -[Weave Users Google Group](https://groups.google.com/a/weave.works/forum/#!forum/weave-users), -which you can email at weave-users@weave.works. When reporting a bug, please -include which version of Weave Net you are running, as shown by `weave -version`. +See [Installing Weave Net](https://www.weave.works/docs/net/latest/installing-weave/) for setup instructions. -Follow us on Twitter: -[@weaveworks](https://twitter.com/weaveworks). +###Find Out More -Check out our blog for the latest product and ecosystem news: -[Weaveworks Blog](https://www.weave.works/blog/). +* [Weaveworks Products](https://www.weave.works/products/weave-net/) +* [Getting Started Guides](https://www.weave.works/guides/) -IRC: -[#weavenetwork](https://botbot.me/freenode/weavenetwork/) From e1ab6a903554af65a9eb85009727d83df378c45b Mon Sep 17 00:00:00 2001 From: Anita Buehrle Date: Thu, 5 May 2016 16:42:47 -0500 Subject: [PATCH 3/6] removed installing heading --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index f9c66710..844e447d 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,6 @@ Weave Net creates a virtual network that connects Docker containers across multi 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. -##Installing - See [Installing Weave Net](https://www.weave.works/docs/net/latest/installing-weave/) for setup instructions. ###Find Out More From 658c91086226bd6830dd2ad4c9d8539ef4f03505 Mon Sep 17 00:00:00 2001 From: Matthias Radestock Date: Fri, 6 May 2016 09:29:59 +0100 Subject: [PATCH 4/6] fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 844e447d..270fdd35 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ # About Weaveworks [Weaveworks](https://www.weave.works) is the company that delivers the most productive way for developers to connect, observe and control -Docker containers. The first product developed by Weaveworks, with nearly 5 million downloads to date, is Weave Net, enabling users to get started with Docker clusters and portable apps in a fraction of the time compared with other solutions. +Docker containers. The first product developed by Weaveworks, with nearly 5 million downloads to date, is Weave Net, enables users to get started with Docker clusters and portable apps in a fraction of the time compared with other solutions. Other products from Weaveworks include [Weave Scope](https://www.weave.works/products/weave-scope/), a powerful container monitoring tool that automatically maps Docker containers and their interactions, and [Weave Flux](https://www.weave.works/products/weave-flux/), a microservice router that automates the access of containers as services. From 1b50285609f1d7685134823891ec1219bc2e05d2 Mon Sep 17 00:00:00 2001 From: Matthias Radestock Date: Fri, 6 May 2016 09:32:28 +0100 Subject: [PATCH 5/6] add link to Weave Net product when first mentioning it just as we do for scope and flux --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 270fdd35..dd904205 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ # About Weaveworks [Weaveworks](https://www.weave.works) is the company that delivers the most productive way for developers to connect, observe and control -Docker containers. The first product developed by Weaveworks, with nearly 5 million downloads to date, is Weave Net, enables users to get started with Docker clusters and portable apps in a fraction of the time compared with other solutions. +Docker containers. The first product developed by Weaveworks, with nearly 5 million downloads to date, is [Weave Net](https://www.weave.works/products/weave-net/), enables users to get started with Docker clusters and portable apps in a fraction of the time compared with other solutions. Other products from Weaveworks include [Weave Scope](https://www.weave.works/products/weave-scope/), a powerful container monitoring tool that automatically maps Docker containers and their interactions, and [Weave Flux](https://www.weave.works/products/weave-flux/), a microservice router that automates the access of containers as services. From d2ea7e046db53173d9fdc1b496db4a75d8ca50a9 Mon Sep 17 00:00:00 2001 From: Matthias Radestock Date: Fri, 6 May 2016 09:40:27 +0100 Subject: [PATCH 6/6] make clear that this repo is for Weave Net ...and make the links more relevant and 'active' --- README.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index dd904205..9ce3b58b 100644 --- a/README.md +++ b/README.md @@ -5,20 +5,17 @@ # About Weaveworks [Weaveworks](https://www.weave.works) is the company that delivers the most productive way for developers to connect, observe and control -Docker containers. The first product developed by Weaveworks, with nearly 5 million downloads to date, is [Weave Net](https://www.weave.works/products/weave-net/), enables users to get started with Docker clusters and portable apps in a fraction of the time compared with other solutions. +Docker containers. + +This repository contains [Weave Net](https://www.weave.works/products/weave-net/), the first product developed by Weaveworks, with nearly 5 million downloads to date, which enables users to get started with Docker clusters and portable apps in a fraction of the time compared with other solutions. Other products from Weaveworks include [Weave Scope](https://www.weave.works/products/weave-scope/), a powerful container monitoring tool that automatically maps Docker containers and their interactions, and [Weave Flux](https://www.weave.works/products/weave-flux/), a microservice router that automates the access of containers as services. -##Weave Net +# Weave Net 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. -See [Installing Weave Net](https://www.weave.works/docs/net/latest/installing-weave/) for setup instructions. - -###Find Out More - -* [Weaveworks Products](https://www.weave.works/products/weave-net/) -* [Getting Started Guides](https://www.weave.works/guides/) - +* [Install Weave Net](https://www.weave.works/docs/net/latest/installing-weave/) +* [Find out more about Weave Net](https://www.weave.works/products/weave-net/)