Files
weave-scope/README.md
Anita Buehrle b624df63d3 Restructured Scope Docs (#1416)
* New Scope Docs

* Remove most of the readme and add links to the docs.

* Fix some links

* cosmetic

bolded docker versions and clarified kube section
2016-05-10 12:41:04 +02:00

51 lines
2.8 KiB
Markdown

# Weave Scope - Monitoring, visualisation & management for Docker & Kubernetes
[![Circle CI](https://circleci.com/gh/weaveworks/scope/tree/master.svg?style=shield)](https://circleci.com/gh/weaveworks/scope/tree/master) [![Coverage Status](https://coveralls.io/repos/weaveworks/scope/badge.svg)](https://coveralls.io/r/weaveworks/scope) [![Slack Status](https://weave-scope-slack.herokuapp.com/badge.svg)](https://weave-scope-slack.herokuapp.com) [![Go Report Card](https://goreportcard.com/badge/github.com/weaveworks/scope)](https://goreportcard.com/report/github.com/weaveworks/scope)
Weave Scope automatically generates a map of your application, enabling you to
intuitively understand, monitor, and control your containerized, microservices based application.
### Understand your Docker containers in real-time
<img src="imgs/topology.png" width="200" alt="Map you architecture" align="right">
Choose an overview of your container infrastructure, or focus on a specific microservice. Easily identify and correct issues to ensure the stability and performance of your containerized applications.
### Contextual details and deep linking
<img src="imgs/selected.png" width="200" alt="Focus on a single container" align="right">
View contextual metrics, tags and metadata for your containers. Effortlessly navigate between processes inside your container to hosts your containers run on, arranged in expandable, sortable tables. Easily to find the container using the most CPU or memory for a given host or service.
### Interact with and manage containers
<img src="imgs/terminals.png" width="200" alt="Launch a command line." align="right">
Interact with your containers directly: pause, restart and stop containers. Launch a command line. All without leaving the scope browser window.
## <a name="getting-started"></a>Getting started
```
sudo wget -O /usr/local/bin/scope https://git.io/scope
sudo chmod a+x /usr/local/bin/scope
sudo scope launch
```
This script will download and run a recent Scope image from the Docker Hub.
Now, open your web browser to **http://localhost:4040**. (If you're using
boot2docker, replace localhost with the output of `boot2docker ip`.)
For instructions on installing Scope on [Kubernetes](site/installing.md#k8s), [DCOS](site/installing.md#dcos) or [ECS](site/installing.md#ecs), see [our docs](site/introducing.md).
## <a name="help"></a>Getting help
If you have any questions about, feedback for or problem with Scope we invite
you to:
- Read [our docs](site/introducing.md).
- <a href="https://weave-scope-slack.herokuapp.com">join our public slack channel</a>
- send an email to <a href="mailto:weave-users@weave.works">weave-users@weave.works</a>
- <a href="https://github.com/weaveworks/scope/issues/new">file an issue</a>
Your feedback is always welcome!