You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Chat: Join the [Weave community](https://weaveworks.github.io/community-slack/) Slack workspace and use the [#scope](https://weave-community.slack.com/messages/scope/) channel
23
24
24
25
When sending email, it's usually best to use the mailing list. The maintainers are usually quite busy and the mailing list will more easily find somebody who can reply quickly. You will also be potentially be helping others who had the same question.
25
26
26
-
We also meet regularly at the [Scope community meeting](https://docs.google.com/document/d/103_60TuEkfkhz_h2krrPJH8QOx-vRnPpbcCZqrddE1s/). Don't feel discouraged to attend the meeting due to not being a developer. Everybody is welcome!
27
+
**Currently on hold**: We also meet regularly at the [Scope community meeting](https://docs.google.com/document/d/103_60TuEkfkhz_h2krrPJH8QOx-vRnPpbcCZqrddE1s/). Don't feel discouraged to attend the meeting due to not being a developer. Everybody is welcome!
27
28
28
29
We follow the [CNCF Code of Conduct](CODE-OF-CONDUCT.md).
29
30
30
-
# Getting Started
31
+
##Getting Started
31
32
32
33
- Fork the repository on GitHub
33
-
- Read the [README](README.md) for getting started as a user and learn how/where to ask for help
34
+
- Read the [README](README.md) for getting started as a user and learn how/where to ask for help
34
35
- If you want to contribute as a developer, continue reading this document for further instructions
35
36
- Play with the project, submit bugs, submit pull requests!
36
37
@@ -43,7 +44,7 @@ This is a rough outline of how to prepare a contribution:
43
44
- Make sure your commit messages are in the proper format (see below).
44
45
- Push your changes to a topic branch in your fork of the repository.
45
46
- If you changed code:
46
-
- add automated tests to cover your changes
47
+
- add automated tests to cover your changes
47
48
- Submit a pull request to the original repository.
48
49
49
50
## How to build and run the project
@@ -80,15 +81,15 @@ Use `yarn` to run all Javascript tests and linting checks:
80
81
cd client && yarn install && yarn test&& yarn lint
81
82
```
82
83
83
-
# Acceptance policy
84
+
##Acceptance policy
84
85
85
86
These things will make a PR more likely to be accepted:
86
87
87
-
* a well-described requirement
88
-
* tests for new code
89
-
* tests for old code!
90
-
* new code and tests follow the conventions in old code and tests
91
-
* a good commit message (see below)
88
+
- a well-described requirement
89
+
- tests for new code
90
+
- tests for old code!
91
+
- new code and tests follow the conventions in old code and tests
92
+
- a good commit message (see below)
92
93
93
94
In general, we will merge a PR once two maintainers have endorsed it.
94
95
Trivial changes (e.g., corrections to spelling) may get waved through.
@@ -100,7 +101,7 @@ We follow a rough convention for commit messages that is designed to answer two
100
101
questions: what changed and why. The subject line should feature the what and
101
102
the body of the commit should describe the why.
102
103
103
-
```
104
+
```txt
104
105
scripts: add the test-cluster command
105
106
106
107
this uses tmux to setup a test cluster that you can easily kill and
@@ -111,7 +112,7 @@ Fixes #38
111
112
112
113
The format can be described more formally as follows:
113
114
114
-
```
115
+
```txt
115
116
<subsystem>: <what changed>
116
117
<BLANK LINE>
117
118
<why this change was made>
@@ -128,7 +129,7 @@ git tools.
128
129
129
130
So you've built a Scope plugin. Where should it live?
130
131
131
-
Until it matures, it should live in your own repo. You are encouraged to annouce your plugin at the [mailing list](https://groups.google.com/forum/#!forum/scope-community) and to demo it at a [community meetings](https://docs.google.com/document/d/103_60TuEkfkhz_h2krrPJH8QOx-vRnPpbcCZqrddE1s/).
132
+
Until it matures, it should live in your own repo. You are encouraged to announce your plugin at the [mailing list](https://groups.google.com/forum/#!forum/scope-community) and to demo it at a [community meetings](https://docs.google.com/document/d/103_60TuEkfkhz_h2krrPJH8QOx-vRnPpbcCZqrddE1s/).
132
133
133
134
If you have a good reason why the Scope maintainers should take custody of your
134
135
plugin, please open an issue so that it can potentially be promoted to the [Scope plugins](https://github.com/weaveworks-plugins/) organization.
Copy file name to clipboardexpand all lines: README.md
+7-6
Original file line number
Diff line number
Diff line change
@@ -10,25 +10,25 @@
10
10
Weave Scope automatically generates a map of your application, enabling you to
11
11
intuitively understand, monitor, and control your containerized, microservices-based application.
12
12
13
-
###Understand your Docker containers in real time
13
+
## Understand your Docker containers in real time
14
14
15
15
<imgsrc="imgs/topology.png"width="200"alt="Map you architecture"align="right">
16
16
17
17
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.
18
18
19
-
###Contextual details and deep linking
19
+
## Contextual details and deep linking
20
20
21
21
<imgsrc="imgs/selected.png"width="200"alt="Focus on a single container"align="right">
22
22
23
23
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 find the container using the most CPU or memory for a given host or service.
24
24
25
-
###Interact with and manage containers
25
+
## Interact with and manage containers
26
26
27
27
<imgsrc="imgs/terminals.png"width="200"alt="Launch a command line."align="right">
28
28
29
29
Interact with your containers directly: pause, restart, and stop containers. Launch a command line. All without leaving the scope browser window.
30
30
31
-
###Extend and customize via plugins
31
+
## Extend and customize via plugins
32
32
33
33
Add custom details or interactions for your hosts, containers, and/or processes by creating Scope plugins. Or, just choose from some that others have already written at the GitHub [Weaveworks Scope Plugins](https://github.com/weaveworks-plugins/) organization.
34
34
@@ -51,7 +51,7 @@ scope launch
51
51
```
52
52
53
53
This script downloads and runs a recent Scope image from Docker Hub.
54
-
Now, open your web browser to **http://localhost:4040**.
54
+
Now, open your web browser to **<http://localhost:4040>**.
55
55
56
56
For instructions on installing Scope on [Kubernetes](https://www.weave.works/docs/scope/latest/installing/#k8s), [DCOS](https://www.weave.works/docs/scope/latest/installing/#dcos), or [ECS](https://www.weave.works/docs/scope/latest/installing/#ecs), see [the docs](https://www.weave.works/docs/scope/latest/introducing/).
57
57
@@ -71,7 +71,7 @@ If you have any questions, feedback, or problems with Scope:
71
71
- Send an email to [Scope community group](https://groups.google.com/forum/#!forum/scope-community)
72
72
- Meetings and events
73
73
- Join the [Weave User Group](https://www.meetup.com/pro/Weave/) and get invited to online talks, hands-on training and meetups in your area
74
-
- Join (and read up on) the regular [Scope community meetings](https://docs.google.com/document/d/103_60TuEkfkhz_h2krrPJH8QOx-vRnPpbcCZqrddE1s/edit)
74
+
- Join (and read up on) the regular [Scope community meetings](https://docs.google.com/document/d/103_60TuEkfkhz_h2krrPJH8QOx-vRnPpbcCZqrddE1s/edit) - currently on hold.
75
75
- Contributing
76
76
- Find out how to [contribute to Scope](CONTRIBUTING.md)
77
77
-[File an issue](https://github.com/weaveworks/scope/issues/new) or make a pull request for one of our [good first issues](https://github.com/weaveworks/scope/issues?q=is%3Aissue+is%3Aopen+label%3Agood-first-issue)
@@ -81,5 +81,6 @@ Your feedback is always welcome!
81
81
We follow the [CNCF Code of Conduct](CODE-OF-CONDUCT.md).
82
82
83
83
## License
84
+
84
85
Scope is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full license text.
85
86
Find more details about the licenses of vendored code in [VENDORED_CODE.md](VENDORED_CODE.md).
Copy file name to clipboardexpand all lines: site/features.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ menu_order: 15
4
4
search_type: Documentation
5
5
---
6
6
7
-
Browse the current feature set for Scope with links to relevant indepth topics:
7
+
Browse the current feature set for Scope with links to relevant in-depth topics:
8
8
9
9
*[Topology Mapping](#topology-mapping)
10
10
*[Views in Scope](#views)
@@ -24,7 +24,7 @@ Scope builds logical topologies of your application and infrastructure. A topol
24
24
25
25
## <aname="views"></a>Views in Scope
26
26
27
-
Views in Scope can be thought of as high-level filters on your containerized microservices as they run in the cloud. They are categorized into: Processes, Containers, Orchestrators, and Hosts. The Orchestrator view is context-sensitive, and as a result, if an app is running in Kubernetes, then Scope displays Pods, Replica Sets, Deployments, and Services that allow you to drilldown on Kubernetes clusters.
27
+
Views in Scope can be thought of as high-level filters on your containerized microservices as they run in the cloud. They are categorized into: Processes, Containers, Orchestrators, and Hosts. The Orchestrator view is context-sensitive, and as a result, if an app is running in Kubernetes, then Scope displays Pods, Replica Sets, Deployments, and Services that allow you to drill down on Kubernetes clusters.
28
28
29
29

# Scope probe pods also need to run as priviliaged containers, so grant 'priviliged' Security Context Constrains (SCC) for 'weave-scope' service account
216
+
# Scope probe pods also need to run as privileged containers, so grant 'privileged' Security Context Constrains (SCC) for 'weave-scope' service account
0 commit comments