From 1ce478092d301c83009ee0b27d6a344d927c1962 Mon Sep 17 00:00:00 2001 From: Paul Bellamy Date: Fri, 13 Nov 2015 13:18:32 +0000 Subject: [PATCH 1/3] add kuberenetes docs to the readme --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/README.md b/README.md index a7373ee95..6d40c6191 100644 --- a/README.md +++ b/README.md @@ -137,6 +137,48 @@ sudo scope launch --service-token= ``` +## Using Weave Scope with Kubernetes + +To try scope's Kubernetes integration, you will start Scope with the +special `--probe.kubernetes true` flag. While the probe needs to be +installed on all nodes (master and minions), this flag should only be +enabled on the Kubernetes master node. + +As per the normal requirements, you will need to run Scope on every +machine you want to monitor, as shown in [Getting +Started](#getting-started). However, when launching Scope you will +need to pass different arguments to the Kubernetes master and minion +nodes. + +On the master node you will launch scope with Kubernetes support. + +``` +sudo scope launch --probe.kubernetes true +``` + +Depending on your setup, you may find that Kubernetes has renamed your +docker bridge interface. In this instance you'll need to tell scope +about the new name when launching it. For example, if your docker bridge is +named `cbr0`: + +``` +sudo DOCKER_BRIDGE=cbr0 scope launch --probe.docker.bridge cbr0 --probe.kubernetes true +``` + +At this point, on each minion node, you launch the probe, telling it +to connect to the master node. + +``` +sudo scope launch --no-app kubernetes-master.my.network +``` + +Again, if your docker bridge interface is named differently, you'll +need to pass that to your probe when launching it. + +Once the first few reports come in, the UI should begin displaying two +Kubernetes-specific views "Pods", and "Pods by Service". + + ## Developing The build is in five stages. `make deps` installs some tools we use later in From 16abd16e814d3623e7c2a23c98e4a96e8801c85a Mon Sep 17 00:00:00 2001 From: Paul Bellamy Date: Fri, 13 Nov 2015 13:20:34 +0000 Subject: [PATCH 2/3] add anchors to each section of the readme --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6d40c6191..2ffe8adb7 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,13 @@ ![Weave Scope Screenshot](http://weave.works/img/header-image-left.png) -## Overview +## Overview Weave Scope automatically generates a map of your containers, enabling you to intuitively understand, monitor, and control your applications. -## Getting started +## Getting started ``` sudo wget -O /usr/local/bin/scope \ @@ -25,13 +25,13 @@ Now, open your web browser to **http://localhost:4040**. (If you're using boot2docker, replace localhost with the output of `boot2docker ip`.) -## Requirements +## Requirements Scope does not need any configuration and does not require the Weave Network. But Scope does need to be running on every machine you want to monitor. -## Architecture +## Architecture Weave Scope consists of two components: the app and the probe. These two components are deployed as a single Docker container using the `scope` @@ -59,7 +59,7 @@ serving the UI, and pushing these topologies to the UI. +-----------------------+ ``` -## Using Weave Scope in Standalone Mode +## Using Weave Scope in Standalone Mode When running Scope in a cluster, each probe sends reports to each app. The App merges the reports from each probe into a more complete report. @@ -99,7 +99,7 @@ acceptable, both with and without ports: Hostnames will be regularly resolved as A records, and each answer used as a target. -## Using Weave Scope in Cloud Service Mode +## Using Weave Scope in Cloud Service Mode Scope can also be used to feed reports to the Scope Service. The Scope Service allows you centrally manage and share access to your Scope UI. In this @@ -137,7 +137,7 @@ sudo scope launch --service-token= ``` -## Using Weave Scope with Kubernetes +## Using Weave Scope with Kubernetes To try scope's Kubernetes integration, you will start Scope with the special `--probe.kubernetes true` flag. While the probe needs to be @@ -179,7 +179,7 @@ Once the first few reports come in, the UI should begin displaying two Kubernetes-specific views "Pods", and "Pods by Service". -## Developing +## Developing The build is in five stages. `make deps` installs some tools we use later in the build. `make frontend` builds a UI build image with all NPM dependencies. From 7ce7ff1735d4b9b15c645cec5656d9dd1e01bc32 Mon Sep 17 00:00:00 2001 From: Tom Wilkie Date: Fri, 13 Nov 2015 15:19:47 +0000 Subject: [PATCH 3/3] Some editing --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2ffe8adb7..0751fe197 100644 --- a/README.md +++ b/README.md @@ -139,40 +139,40 @@ sudo scope launch --service-token= ## Using Weave Scope with Kubernetes -To try scope's Kubernetes integration, you will start Scope with the -special `--probe.kubernetes true` flag. While the probe needs to be -installed on all nodes (master and minions), this flag should only be -enabled on the Kubernetes master node. +To use Scope's Kubernetes integration, you need to start Scope with the +`--probe.kubernetes true` flag. Scope needs to be installed on all +nodes (master and minions), but this flag should only be enabled on the +Kubernetes master node. As per the normal requirements, you will need to run Scope on every machine you want to monitor, as shown in [Getting -Started](#getting-started). However, when launching Scope you will +Started](#getting-started). However, when launching Scope you need to pass different arguments to the Kubernetes master and minion nodes. -On the master node you will launch scope with Kubernetes support. +On the master node you need to launch Scope with Kubernetes support: ``` sudo scope launch --probe.kubernetes true ``` Depending on your setup, you may find that Kubernetes has renamed your -docker bridge interface. In this instance you'll need to tell scope -about the new name when launching it. For example, if your docker bridge is +Docker bridge interface. In this instance you'll need to tell Scope +about the new name when launching it. For example, if your Docker bridge is named `cbr0`: ``` sudo DOCKER_BRIDGE=cbr0 scope launch --probe.docker.bridge cbr0 --probe.kubernetes true ``` -At this point, on each minion node, you launch the probe, telling it +On each minion node you need to launch Scope telling it to connect to the master node. ``` sudo scope launch --no-app kubernetes-master.my.network ``` -Again, if your docker bridge interface is named differently, you'll +Again, if your Docker bridge interface is named differently, you'll need to pass that to your probe when launching it. Once the first few reports come in, the UI should begin displaying two