Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to access the Scope UI in k8s #1426

Merged
merged 1 commit into from
May 4, 2016
Merged

Document how to access the Scope UI in k8s #1426

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 24 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,9 +223,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 @@ -246,10 +247,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 @@ -259,6 +262,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