Skip to content

Commit

Permalink
add anchors to each section of the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
paulbellamy committed Nov 13, 2015
1 parent 3011604 commit dc48412
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
![Weave Scope Screenshot](http://weave.works/img/header-image-left.png)


## Overview
## <a name="overview"></a>Overview

Weave Scope automatically generates a map of your containers, enabling you to
intuitively understand, monitor, and control your applications.


## Getting started
## <a name="getting-started"></a>Getting started

```
sudo wget -O /usr/local/bin/scope \
Expand All @@ -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
## <a name="requirements"></a>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
## <a name="architecture"></a>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`
Expand Down Expand Up @@ -59,7 +59,7 @@ serving the UI, and pushing these topologies to the UI.
+-----------------------+
```

## Using Weave Scope in Standalone Mode
## <a name="using-weave-scope-in-standalone-mode"></a>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.
Expand Down Expand Up @@ -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
## <a name="using-weave-scope-in-cloud-service-mode"></a>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
Expand Down Expand Up @@ -137,7 +137,7 @@ sudo scope launch --service-token=<token>
```


## Using Weave Scope with Kubernetes
## <a name="using-weave-scope-with-kubernetes"></a>Using Weave Scope with Kubernetes

To try scope's Kubernetes integration, we will boot the probe with the
special `--probe.kubernetes true` flag. While the probe needs to be
Expand Down Expand Up @@ -176,7 +176,7 @@ Once the first few reports come in, the UI should begin displaying two
Kubernetes-specific views "Pods", and "Pods by Service".


## Developing
## <a name="developing"></a>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.
Expand Down

0 comments on commit dc48412

Please sign in to comment.