From db17d9548c387f032d740506de28a4b41f524dcf Mon Sep 17 00:00:00 2001 From: abuehrle Date: Wed, 16 Aug 2017 07:30:37 -0500 Subject: [PATCH 1/4] remove extra indent on note --- site/installing.md | 2 +- site/plugins.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/site/installing.md b/site/installing.md index 0df79857af..7b32685bd1 100644 --- a/site/installing.md +++ b/site/installing.md @@ -47,7 +47,7 @@ Where, * `` is the name you gave to your virtual machine with docker-machine. ->>**Note:** Scope allows anyone with access to the user interface, control over your containers. As such, the Scope app endpoint (port 4040) should not be made accessible on the Internet. Also traffic between the app and the probe is insecure and should not traverse the Internet. This means that you should either use the private / internal IP addresses of your nodes when setting it up, or route this traffic through Weave Net. Put Scope behind a password, by using somthing like [Caddy](https://github.com/mholt/caddy) to protect the endpoint and make port 4040 available to localhost with Caddy proxying it. Or you can skip these steps, and just use Weave Cloud to manage the security for you. +>**Note:** Scope allows anyone with access to the user interface, control over your containers. As such, the Scope app endpoint (port 4040) should not be made accessible on the Internet. Also traffic between the app and the probe is insecure and should not traverse the Internet. This means that you should either use the private / internal IP addresses of your nodes when setting it up, or route this traffic through Weave Net. Put Scope behind a password, by using an application like [Caddy](https://github.com/mholt/caddy) to protect the endpoint and by making port 4040 available to localhost with Caddy proxying it. Or you can skip these steps, and just use Weave Cloud to manage the security for you. ### Using Weave Cloud diff --git a/site/plugins.md b/site/plugins.md index 15907d5a41..a8a03191b1 100644 --- a/site/plugins.md +++ b/site/plugins.md @@ -34,7 +34,7 @@ Official Weave Scope plugins can be found at [Weaveworks Plugins](https://github * Number of HTTP requests per seconds. * Number of HTTP responses code per second (per code). -> **Note:** The HTTP Statistics plugin requires a [recent kernel version with ebpf support](https://github.com/iovisor/bcc/blob/master/INSTALL.md#kernel-configuration) and it will not compile on [dlite](https://github.com/nlf/dlite) or on boot2docker hosts. +>**Note:** The HTTP Statistics plugin requires a [recent kernel version with ebpf support](https://github.com/iovisor/bcc/blob/master/INSTALL.md#kernel-configuration) and it will not compile on [dlite](https://github.com/nlf/dlite) or on boot2docker hosts. * [Traffic Control](https://github.com/weaveworks-plugins/scope-traffic-control): This plugin allows you to modify latency and packet loss for a specific container via controls from the container's detailed view in the Scope user interface. @@ -88,7 +88,7 @@ For example: } ``` -> **Note:** The `Plugins` section includes exactly one plugin description that displays in the UI. The other plugin fields are: +>**Note:** The `Plugins` section includes exactly one plugin description that displays in the UI. The other plugin fields are: * `id` - checks for duplicate plugins. It is required. * `label` - a human readable label displayed in the UI. It is required. From a2fbfcc095d4f6526dc5113114643a5cc34a5821 Mon Sep 17 00:00:00 2001 From: abuehrle Date: Wed, 16 Aug 2017 07:46:53 -0500 Subject: [PATCH 2/4] add a space after --- site/installing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/installing.md b/site/installing.md index 7b32685bd1..07501a401c 100644 --- a/site/installing.md +++ b/site/installing.md @@ -47,7 +47,7 @@ Where, * `` is the name you gave to your virtual machine with docker-machine. ->**Note:** Scope allows anyone with access to the user interface, control over your containers. As such, the Scope app endpoint (port 4040) should not be made accessible on the Internet. Also traffic between the app and the probe is insecure and should not traverse the Internet. This means that you should either use the private / internal IP addresses of your nodes when setting it up, or route this traffic through Weave Net. Put Scope behind a password, by using an application like [Caddy](https://github.com/mholt/caddy) to protect the endpoint and by making port 4040 available to localhost with Caddy proxying it. Or you can skip these steps, and just use Weave Cloud to manage the security for you. +> **Note:** Scope allows anyone with access to the user interface, control over your containers. As such, the Scope app endpoint (port 4040) should not be made accessible on the Internet. Also traffic between the app and the probe is insecure and should not traverse the Internet. This means that you should either use the private / internal IP addresses of your nodes when setting it up, or route this traffic through Weave Net. Put Scope behind a password, by using an application like [Caddy](https://github.com/mholt/caddy) to protect the endpoint and by making port 4040 available to localhost with Caddy proxying it. Or you can skip these steps, and just use Weave Cloud to manage the security for you. ### Using Weave Cloud From 009976fa9a0f5b17da5d9252077e8a9861bdf39e Mon Sep 17 00:00:00 2001 From: abuehrle Date: Wed, 16 Aug 2017 08:05:07 -0500 Subject: [PATCH 3/4] add space after for note pin --- site/building.md | 2 +- site/plugins.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/site/building.md b/site/building.md index 1cc4ba2d1f..2073bbbc2c 100644 --- a/site/building.md +++ b/site/building.md @@ -36,7 +36,7 @@ Similarly the frontent client tests can be run via: make client-test ->**Note:** The tools from `make deps` depend on a local install of +> **Note:** The tools from `make deps` depend on a local install of [Go](https://golang.org). ## Debugging diff --git a/site/plugins.md b/site/plugins.md index a8a03191b1..c072a9f76e 100644 --- a/site/plugins.md +++ b/site/plugins.md @@ -34,13 +34,13 @@ Official Weave Scope plugins can be found at [Weaveworks Plugins](https://github * Number of HTTP requests per seconds. * Number of HTTP responses code per second (per code). ->**Note:** The HTTP Statistics plugin requires a [recent kernel version with ebpf support](https://github.com/iovisor/bcc/blob/master/INSTALL.md#kernel-configuration) and it will not compile on [dlite](https://github.com/nlf/dlite) or on boot2docker hosts. +> **Note:** The HTTP Statistics plugin requires a [recent kernel version with ebpf support](https://github.com/iovisor/bcc/blob/master/INSTALL.md#kernel-configuration) and it will not compile on [dlite](https://github.com/nlf/dlite) or on boot2docker hosts. * [Traffic Control](https://github.com/weaveworks-plugins/scope-traffic-control): This plugin allows you to modify latency and packet loss for a specific container via controls from the container's detailed view in the Scope user interface. * [Volume Count](https://github.com/weaveworks-plugins/scope-volume-count): This plugin (written in Python) requests the number of mounted volumes for each container, and provides a container-level count. ->**Note:**Installed and running plugins are shown in the list of `PLUGINS` in the bottom right of the Scope UI. +> **Note:**Installed and running plugins are shown in the list of `PLUGINS` in the bottom right of the Scope UI. ## How Plugins Communicate with Scope @@ -88,7 +88,7 @@ For example: } ``` ->**Note:** The `Plugins` section includes exactly one plugin description that displays in the UI. The other plugin fields are: +> **Note:** The `Plugins` section includes exactly one plugin description that displays in the UI. The other plugin fields are: * `id` - checks for duplicate plugins. It is required. * `label` - a human readable label displayed in the UI. It is required. From b3823399fc7be4047181279c7057352588ab2d60 Mon Sep 17 00:00:00 2001 From: abuehrle Date: Wed, 16 Aug 2017 12:01:43 -0500 Subject: [PATCH 4/4] remove space to match weave net convention --- site/building.md | 2 +- site/installing.md | 2 +- site/plugins.md | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/site/building.md b/site/building.md index 2073bbbc2c..1cc4ba2d1f 100644 --- a/site/building.md +++ b/site/building.md @@ -36,7 +36,7 @@ Similarly the frontent client tests can be run via: make client-test -> **Note:** The tools from `make deps` depend on a local install of +>**Note:** The tools from `make deps` depend on a local install of [Go](https://golang.org). ## Debugging diff --git a/site/installing.md b/site/installing.md index 07501a401c..7b32685bd1 100644 --- a/site/installing.md +++ b/site/installing.md @@ -47,7 +47,7 @@ Where, * `` is the name you gave to your virtual machine with docker-machine. -> **Note:** Scope allows anyone with access to the user interface, control over your containers. As such, the Scope app endpoint (port 4040) should not be made accessible on the Internet. Also traffic between the app and the probe is insecure and should not traverse the Internet. This means that you should either use the private / internal IP addresses of your nodes when setting it up, or route this traffic through Weave Net. Put Scope behind a password, by using an application like [Caddy](https://github.com/mholt/caddy) to protect the endpoint and by making port 4040 available to localhost with Caddy proxying it. Or you can skip these steps, and just use Weave Cloud to manage the security for you. +>**Note:** Scope allows anyone with access to the user interface, control over your containers. As such, the Scope app endpoint (port 4040) should not be made accessible on the Internet. Also traffic between the app and the probe is insecure and should not traverse the Internet. This means that you should either use the private / internal IP addresses of your nodes when setting it up, or route this traffic through Weave Net. Put Scope behind a password, by using an application like [Caddy](https://github.com/mholt/caddy) to protect the endpoint and by making port 4040 available to localhost with Caddy proxying it. Or you can skip these steps, and just use Weave Cloud to manage the security for you. ### Using Weave Cloud diff --git a/site/plugins.md b/site/plugins.md index c072a9f76e..a8a03191b1 100644 --- a/site/plugins.md +++ b/site/plugins.md @@ -34,13 +34,13 @@ Official Weave Scope plugins can be found at [Weaveworks Plugins](https://github * Number of HTTP requests per seconds. * Number of HTTP responses code per second (per code). -> **Note:** The HTTP Statistics plugin requires a [recent kernel version with ebpf support](https://github.com/iovisor/bcc/blob/master/INSTALL.md#kernel-configuration) and it will not compile on [dlite](https://github.com/nlf/dlite) or on boot2docker hosts. +>**Note:** The HTTP Statistics plugin requires a [recent kernel version with ebpf support](https://github.com/iovisor/bcc/blob/master/INSTALL.md#kernel-configuration) and it will not compile on [dlite](https://github.com/nlf/dlite) or on boot2docker hosts. * [Traffic Control](https://github.com/weaveworks-plugins/scope-traffic-control): This plugin allows you to modify latency and packet loss for a specific container via controls from the container's detailed view in the Scope user interface. * [Volume Count](https://github.com/weaveworks-plugins/scope-volume-count): This plugin (written in Python) requests the number of mounted volumes for each container, and provides a container-level count. -> **Note:**Installed and running plugins are shown in the list of `PLUGINS` in the bottom right of the Scope UI. +>**Note:**Installed and running plugins are shown in the list of `PLUGINS` in the bottom right of the Scope UI. ## How Plugins Communicate with Scope @@ -88,7 +88,7 @@ For example: } ``` -> **Note:** The `Plugins` section includes exactly one plugin description that displays in the UI. The other plugin fields are: +>**Note:** The `Plugins` section includes exactly one plugin description that displays in the UI. The other plugin fields are: * `id` - checks for duplicate plugins. It is required. * `label` - a human readable label displayed in the UI. It is required.