Skip to content

Commit

Permalink
Merge pull request #1426 from weaveworks/1390-k8s-how-to-open-scope
Browse files Browse the repository at this point in the history
Document how to access the Scope UI in k8s
  • Loading branch information
Alfonso Acosta committed May 4, 2016
2 parents d8e8365 + acac4d3 commit f65e198
Showing 1 changed file with 24 additions and 7 deletions.
31 changes: 24 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,9 +231,10 @@ in your Kubernetes cluster using
make sure your API Server and all your Kubelets are provided with flag `--allow_privileged`
at launch time.

2. Make sure your cluster supports
[DaemonSets](https://github.com/kubernetes/kubernetes/blob/master/docs/design/daemon.md).
DaemonSets are needed to ensure that each Kubernetes node
2. Make sure
[DaemonSets](https://github.com/kubernetes/kubernetes/blob/master/docs/design/daemon.md)
are enabled in your cluster (enabled by default from
Kubernetes 1.2). DaemonSets are needed to ensure that each Kubernetes node
runs a Scope Probe:

* To enable them in an existing cluster, make sure to add a
Expand All @@ -254,10 +255,12 @@ done
```

4. Tweak the Scope probe configuration at `scope-probe-ds.yaml`, namely:
* If you have an account at http://scope.weave.works and want to use Scope in
Cloud Service Mode, uncomment the `--probe.token=foo` argument, substitute `foo`
by the token found in your account page, and comment out the
`$(WEAVE_SCOPE_APP_SERVICE_HOST):$(WEAVE_SCOPE_APP_SERVICE_PORT)` argument.
* If you have an account at
[http://scope.weave.works](http://scope.weave.works) and want to use Scope
in Cloud Service Mode, uncomment the `--probe.token=foo` argument,
substitute `foo` by the token found in your account page, and comment out
the `$(WEAVE_SCOPE_APP_SERVICE_HOST):$(WEAVE_SCOPE_APP_SERVICE_PORT)`
argument.

5. Install Scope in your cluster (order is important):

Expand All @@ -267,6 +270,20 @@ kubectl create -f scope-app-svc.yaml # Only if you want to run Scope in Standalo
kubectl create -f scope-probe-ds.yaml
```

6. Open Scope in your browser

* When running Scope in Standalone mode do:

```
kubectl port-forward $(kubectl get pod --selector=provider=weave-scope-app -o jsonpath={.items..metadata.name}) 4040
```

and open [http://localhost:4040](http://localhost:4040) in your browser. This allows you to access the Scope UI securely, without
opening it to the Internet.

* When running Scope in Cloud Service mode, simply log in to [https://scope.weave.works](https://scope.weave.works)

## <a name="probe_plugins"></a>Scope Probe Plugins

Scope allows you to create plugins generating custom
Expand Down

0 comments on commit f65e198

Please sign in to comment.