From a71d2a1682adfbb7555cf72164aef4080694ab34 Mon Sep 17 00:00:00 2001 From: Matthias Radestock Date: Wed, 30 Dec 2015 19:06:04 +0000 Subject: [PATCH] move things around on troubleshooting page - level 2 headings for top-level instead of level 3 - put all status reporting as L3s under one L2 heading - add 'Reboots' to ToC - move 'Stopping weave' into its own section and and move that --- site/troubleshooting.md | 72 ++++++++++++++++++++++------------------- 1 file changed, 39 insertions(+), 33 deletions(-) diff --git a/site/troubleshooting.md b/site/troubleshooting.md index e6272849..c76a3272 100644 --- a/site/troubleshooting.md +++ b/site/troubleshooting.md @@ -5,14 +5,19 @@ layout: default # Troubleshooting Weave - * [Overall status](#weave-status) - * [List connections](#weave-status-connections) - * [List peers](#weave-status-peers) - * [List DNS entries](#weave-status-dns) - * [JSON report](#weave-report) - * [List attached containers](#list-attached-containers) + * [Basic diagnostics](#diagnostics) + * [Status reporting](#weave-status) + - [List connections](#weave-status-connections) + - [List peers](#weave-status-peers) + - [List DNS entries](#weave-status-dns) + - [JSON report](#weave-report) + - [List attached containers](#list-attached-containers) + * [Stopping weave](#stop) + * [Reboots](#reboots) * [Snapshot releases](#snapshots) +## Basic diagnostics + Check what version of weave you are running with weave version @@ -37,31 +42,7 @@ Another useful debugging technique is to attach standard packet capture and analysis tools, such as tcpdump and wireshark, to the `weave` network bridge on the host. -To stop weave, if you have configured your environment to use the -Weave Docker API Proxy, e.g. by running `eval $(weave env)` in your -shell, you must first restore the environment with - - eval $(weave env --restore) - -Then run - - weave stop - -Note that this leaves the local application container network intact; -containers on the local host can continue to communicate, whereas -communication with containers on different hosts, as well as service -export/import, is disrupted but resumes when weave is relaunched. - -To stop weave and completely remove all traces of the weave network on -the local host, run - - weave reset - -Any running application containers will permanently lose connectivity -with the weave network and have to be restarted in order to -re-connect. - -### Overall status +## Status reporting A status summary can be obtained with `weave status`: @@ -267,7 +248,32 @@ You can also supply a list of container IDs/names to `weave ps`, like this: able ce:15:34:a9:b5:6d 10.2.5.1/24 baker 7a:61:a2:49:4b:91 10.2.8.3/24 -### Reboots +## Stopping weave +To stop weave, if you have configured your environment to use the +Weave Docker API Proxy, e.g. by running `eval $(weave env)` in your +shell, you must first restore the environment with + + eval $(weave env --restore) + +Then run + + weave stop + +Note that this leaves the local application container network intact; +containers on the local host can continue to communicate, whereas +communication with containers on different hosts, as well as service +export/import, is disrupted but resumes when weave is relaunched. + +To stop weave and completely remove all traces of the weave network on +the local host, run + + weave reset + +Any running application containers will permanently lose connectivity +with the weave network and have to be restarted in order to +re-connect. + +## Reboots When a host reboots, docker's default behaviour is to restart any containers that were running. Since weave relies on special network @@ -282,7 +288,7 @@ For a more permanent solution, and create appropriate startup scripts to launch weave and run application containers from your favourite process manager. -### Snapshot Releases +## Snapshot Releases We sometimes publish snapshot releases, to provide previews of new features, assist in validation of bug fixes, etc. One can install the