diff --git a/site/features.md b/site/features.md index c0078471..19d8b1ae 100644 --- a/site/features.md +++ b/site/features.md @@ -27,8 +27,7 @@ Net: * [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 [Using Weave Net](/site/using-weave.md). ###Virtual Ethernet Switch @@ -46,8 +45,8 @@ a container network. Broadcast and Multicast protocols can also be implemented 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) +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). ###Fast Datapath @@ -67,7 +66,7 @@ See [Using Fast Datapath](/site/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) @@ -77,7 +76,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 [Using the Weave Docker API Proxy](/site/weave-docker-api/using-proxy.md) +See [Using the Weave Docker API Proxy](/site/weave-docker-api/using-proxy.md). ###Weave Network Docker Plugin @@ -87,7 +86,7 @@ named `weave` is created by `weave launch`, which is used as follows: $ docker run --net=weave -ti ubuntu -Using the Weave plugin enables you to take advantage of [Docker's network functionality](https://docs.docker.com/engine/extend/plugins_network/) +Using the Weave plugin enables you to take advantage of [Docker's network functionality](https://docs.docker.com/engine/extend/plugins_network/). Also, Weave’s Docker Network plugin doesn't require an external cluster store and you can start and stop containers even when there are network connectivity problems. @@ -182,18 +181,15 @@ running alongside Weave. Weave Net implements encryption and security using [Daniel J. Bernstein's NaCl library](http://nacl.cr.yp.to/index.html). -For information on how to secure your Docker network connections, -see [Securing Connections Across Untrusted Networks](/site/using-weave/security-untrusted-networks.md) -and for a more technical discussion on how Weave implements encryption see, [Using Encryption with Weave](/site/encryption.md) and [How Weave Implements Encryption](/site/encryption/implementation.md) +For information on how to secure your Docker network connections, see [Securing Connections Across Untrusted Networks](/site/using-weave/security-untrusted-networks.md) and for a more technical discussion on how Weave implements encryption see, [Using Encryption with Weave](/site/encryption.md) and [How Weave Implements Encryption](/site/encryption/implementation.md). ###Host Network Integration -Weave Net application networks can be integrated with a host's -network, and establish connectivity between the host and +Weave Net application networks can be integrated with a host's network, and establish connectivity between the host and application containers anywhere. -See [Integrating a Host Network with Weave](/site/using-weave/host-network-integration.md) +See [Integrating a Host Network with Weave](/site/using-weave/host-network-integration.md). ###Managing Services: Exporting, Importing, Binding and Routing @@ -212,7 +208,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/using-weave/multi-cloud-multi-hop.md). ###Multi-Hop Routing @@ -222,14 +218,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/using-weave/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/using-weave/finding-adding-hosts-dynamically.md) ###Container Mobility diff --git a/site/installing-weave.md b/site/installing-weave.md index 9ee868e2..5484be72 100644 --- a/site/installing-weave.md +++ b/site/installing-weave.md @@ -18,16 +18,14 @@ 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. 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) +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#launching) +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/guides/blob/master/aws-ecs/LATESTAMIs.md) -for the latest Weave AMIs and -[here](http://weave.works/guides/service-discovery-with-weave-aws-ecs.html) to get started with Weave on ECS. +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. ###Quick Start Screencast diff --git a/site/introducing-weave.md b/site/introducing-weave.md index 7149f286..e65d715d 100644 --- a/site/introducing-weave.md +++ b/site/introducing-weave.md @@ -26,7 +26,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 “Using the Weave Network Docker Plugin” +For information about the Weave Docker Plugin, see [How The Weave Network Plugin Works](/site/plugin/plugin-how-it-works.md). ###Operates in Partially Connected Networks @@ -59,7 +59,7 @@ With Weave Net, deploy your peer-to-peer file sharing applications and voice ove 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/features.md). diff --git a/site/plugin/cni-plugin-how-to.md b/site/plugin/cni-plugin-how-to.md index aeb57c43..224aba36 100644 --- a/site/plugin/cni-plugin-how-to.md +++ b/site/plugin/cni-plugin-how-to.md @@ -55,7 +55,7 @@ All CNI plugins are configured by a JSON file in the directory `/etc/cni/net.d/`. `weave setup` installs a minimal configuration file named `10-weave.conf`, which you can alter to suit your needs. -See the [CNI Spec]](https://github.com/appc/cni/blob/master/SPEC.md#network-configuration) +See the [CNI Spec](https://github.com/appc/cni/blob/master/SPEC.md#network-configuration) for details on the format and contents of this file. By default, the Weave CNI plugin adds a default route out via the Weave bridge, so your containers can access resources on the internet. If you do not want this, add a section to the config file that specifies no routes: diff --git a/site/using-weave/security-untrusted-networks.md b/site/using-weave/security-untrusted-networks.md index 63af311c..7a77605e 100644 --- a/site/using-weave/security-untrusted-networks.md +++ b/site/using-weave/security-untrusted-networks.md @@ -15,7 +15,7 @@ or host1$ export WEAVE_PASSWORD=wfvAwt7sj host1$ weave launch ->NOTE: The command line option takes precedence over the environment variable._ +>**NOTE**: The command line option takes precedence over the environment variable._ > To avoid leaking your password via the kernel process table or your > shell history, we recommend you store it in a file and capture it @@ -39,11 +39,11 @@ If some of your peers are co-located in a trusted network (for example within th Be aware that: * Containers will be able to access the router REST API if fast datapath is disabled. You can prevent this by setting: - [`icc=false`](https://docs.docker.com/engine/userguide/networking/default_network/container-communication/#communication-between-containers) + [`icc=false`](https://docs.docker.com/engine/userguide/networking/default_network/container-communication/#communication-between-containers). * Containers are able to access the router control and data plane ports, but this can be mitigated by enabling encryption. **See Also** * [Using Encryption With Weave Net](/site/encryption.md) - * [Using Fast Datapath](/site/using-weave.md) + * [Using Fast Datapath](/site/fastdp.md) diff --git a/site/weavedns/how-works-weavedns.md b/site/weavedns/how-works-weavedns.md index d57615a7..52b4e77d 100644 --- a/site/weavedns/how-works-weavedns.md +++ b/site/weavedns/how-works-weavedns.md @@ -41,14 +41,14 @@ is assumed to be `docker0`. Some configurations may use a different Docker bridge device. To supply a different bridge device, use the environment variable `DOCKER_BRIDGE`, e.g., -```bash +``` $ sudo DOCKER_BRIDGE=someother weave launch ``` In the event that weaveDNS is launched in this way, it's important that other calls to `weave` also specify the bridge device: -```bash +``` $ sudo DOCKER_BRIDGE=someother weave run ... ``` diff --git a/site/weavedns/load-balance-fault-weavedns.md b/site/weavedns/load-balance-fault-weavedns.md index 2631581e..7ffa4907 100644 --- a/site/weavedns/load-balance-fault-weavedns.md +++ b/site/weavedns/load-balance-fault-weavedns.md @@ -9,12 +9,10 @@ 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 2nd host, and then run -some ping tests... +Expanding the [overview example](/site/weavedns.md), let us start an additional `pingme` container on a second host, and then run +some ping tests. -```bash +``` host2$ weave launch $HOST1 host2$ eval $(weave env) host2$ docker run -dti --name=pingme ubuntu @@ -36,7 +34,7 @@ PING pingme.weave.local (10.32.0.2) 56(84) bytes of data. Notice how the ping reaches different addresses. -## Fault resilience +## Fault Resilience 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 @@ -47,6 +45,6 @@ container that is still alive. **See Also** - * [How Weave Finds Containers](/site/weave-docker-api.md) + * [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) diff --git a/site/weavedns/managing-domains-weavedns.md b/site/weavedns/managing-domains-weavedns.md index 2470208b..758a2415 100644 --- a/site/weavedns/managing-domains-weavedns.md +++ b/site/weavedns/managing-domains-weavedns.md @@ -23,7 +23,7 @@ hostnames across all sub-domains plus some external domains, you need *also* to supply the `weave.local` domain to retain the above behaviour. -```bash +``` docker run -ti \ --dns-search=zone1.weave.local --dns-search=zone2.weave.local \ --dns-search=corp1.com --dns-search=corp2.com \ @@ -37,7 +37,7 @@ Weave network. In general users do not need to change this domain, but you can force weaveDNS to use a different domain by launching it with the `--dns-domain` argument. For example, -```bash +``` $ weave launch --dns-domain="mycompany.local." ``` @@ -46,6 +46,6 @@ link-local as per [RFC6762](https://tools.ietf.org/html/rfc6762), (though this is not strictly necessary). - * [How Weave Finds Containers](/site/weave-docker-api.md) + * [How Weave Finds Containers](/site/how-works-weavedns.md.md) * [Load Balancing and Fault Resilience with WeaveDNS](/site/weavedns/load-balance-fault-weavedns.md) * [Managing Domain Entries](/site/weavedns/managing-entries-weavedns.md) diff --git a/site/weavedns/managing-entries-weavedns.md b/site/weavedns/managing-entries-weavedns.md index 93dd31c4..e135082d 100644 --- a/site/weavedns/managing-entries-weavedns.md +++ b/site/weavedns/managing-entries-weavedns.md @@ -19,7 +19,7 @@ The following topics are discussed: If you want to give the container a name in DNS *other* than its hostname, you can register it using the `dns-add` command. For example: -```bash +``` $ C=$(docker run -ti ubuntu) $ weave dns-add $C -h pingme2.weave.local ``` @@ -32,7 +32,7 @@ addresses to be registered against the container's hostname e.g. The inverse operation can be carried out using the `dns-remove` command: -```bash +``` $ weave dns-remove $C ``` @@ -40,8 +40,7 @@ By omitting the container name it is possible to add/remove DNS records that associate names in the weaveDNS domain with IP addresses that do not belong to containers, e.g. non-weave addresses of external services: - -```bash +``` $ weave dns-add 192.128.16.45 -h db.weave.local ``` @@ -71,7 +70,7 @@ By default, weaveDNS specifies a TTL of 30 seconds in responses to DNS requests. However, you can force a different TTL value by launching weave with the `--dns-ttl` argument: -```bash +``` $ weave launch --dns-ttl=10 ``` @@ -82,6 +81,6 @@ weaveDNS instance will receive. **See Also** - * [How Weave Finds Containers](/site/weave-docker-api.md) + * [How Weave Finds Containers](/site/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)