From 6f6de077160f21341de8558065042dae2942d44e Mon Sep 17 00:00:00 2001 From: abuehrle Date: Mon, 13 Feb 2017 22:16:28 -0600 Subject: [PATCH 1/7] update bullet point minor edits --- site/installing.md | 68 ++++++++++++++++++++++++---------------------- 1 file changed, 36 insertions(+), 32 deletions(-) diff --git a/site/installing.md b/site/installing.md index f3836dd2b..d07ed7b3b 100644 --- a/site/installing.md +++ b/site/installing.md @@ -11,6 +11,7 @@ Weave Cloud is the recommended option if: * You are deploying to larger clusters. * You require secure remote access. * You want to share access with your coworkers. + * You want to minimize Weave Scope memory and CPU usage. The following topics are discussed: @@ -28,15 +29,15 @@ The following topics are discussed: ##Installing Scope on Docker -To install Scope onto your machine with Docker installed in stand-alone mode, run the following commands: +To install Scope in stand-alone mode, run the following commands: sudo curl -L git.io/scope -o /usr/local/bin/scope sudo chmod a+x /usr/local/bin/scope scope launch -This script downloads and runs a recent Scope image from the Docker Hub. Scope needs to be installed onto every machine that you want to monitor. Once launched, Scope doesn’t require any other configuration and it also doesn’t depend on Weave Net. +This script downloads and runs a recent Scope image from Docker Hub. Scope needs to be installed onto every machine that you want to monitor. -After it’s been launched, open your browser to `http://localhost:4040`. The URLs are also displayed to you in the terminal window after Weave Scope was launched. +After Scope is installed, open your browser to `http://localhost:4040`. If you are using docker-machine, you can find the IP by running, `docker-machine ip `. @@ -48,9 +49,11 @@ Where, ###Using Weave Cloud -First, obtain a service-token from Weave Cloud by signing up at [https://cloud.weave.works](https://cloud.weave.works/). +First, obtain a Cloud service token by signing up at [https://cloud.weave.works](https://cloud.weave.works/). -Then, install Scope onto your local Docker machine and start using Weave Cloud: +!['Weave Cloud Token'](images/weave-cloud-token.png) + +Launch Scope onto your nodes: sudo curl -L git.io/scope -o /usr/local/bin/scope sudo chmod a+x /usr/local/bin/scope @@ -58,18 +61,18 @@ Then, install Scope onto your local Docker machine and start using Weave Cloud: Where, -* `--service-token=` is the token you obtained after you signed up for Weave Cloud. +* `--service-token=` is the token you obtained from Weave Cloud. -This script downloads and runs a recent Scope Docker image from the Docker Hub. Scope needs to be installed onto every machine that you want to monitor. Once launched, Scope doesn’t require any other configuration and it does not depend on Weave Net. +This script downloads and runs a recent Scope Docker image from the Docker Hub. Scope needs to be installed onto every machine that you want to monitor. -After Scope is launched, open your web browser to [https://cloud.weave.works](https://cloud.weave.works) and login. Click 'View Instance' in the top right-hand corner to see the Scope user interface. +Open your web browser to [https://cloud.weave.works](https://cloud.weave.works) and login. Click 'View Instance' to see the Scope user interface. ###Installing Scope on a Local Cluster Without Weave Net -This example assumes that you have a local cluster that is not using Weave Net, and which also has no special hostnames or DNS settings. Only the IP addresses assigned to it will be used to configure Scope. You will launch Scope using the IP addresses of all the nodes in the cluster. +This example assumes a local cluster that is not networked with Weave Net, and also has no special hostnames or DNS settings. You will launch Scope with the IP addresses of all of the nodes in the cluster. -Suppose you have the following cluster: +Suppose you have the following nodes in a cluster: 192.168.100.16 192.168.100.17 @@ -77,14 +80,14 @@ Suppose you have the following cluster: 192.168.100.19 192.168.100.20 - In the steps that follow, you will manually peer each node with all of the other nodes during Scope launch. + Using the IP addresses, you will manually peer each node with all of the other nodes during Scope launch. -**1. To begin run the following on each node:** +**1. Run the following on each node:** sudo curl -L git.io/scope -o /usr/local/bin/scope sudo chmod a+x /usr/local/bin/scope - **2. Then on the first node run:** + **2. Then on the first node launch scope with:** scope launch 192.168.100.18 192.168.100.19 192.168.100.20 @@ -95,7 +98,6 @@ Suppose you have the following cluster: scope launch 192.168.100.17 192.198.100.19 192.168.100.20 - ### Weave Net and Scope If Scope is running on the same machine as the Weave Network, then the probe uses weaveDNS to automatically discover any other apps on the network. Scope does this by registering itself under the address `scope.weave.local`. @@ -152,19 +154,11 @@ Version 2 of this YAML file supports networks and volumes as defined by any plug ###Using Docker Compose with Weave Cloud -First, obtain a service-token from Weave Cloud by signing up at [https://cloud.weave.works](https://cloud.weave.works/). +**1.** First, obtain a Cloud token from Weave Cloud by signing up at [https://cloud.weave.works](https://cloud.weave.works/). -To install Scope on your local Docker machine with Weave Cloud and use Docker Compose, run the following commands, using one of the two fragments below. +!['Weave Cloud Token'](images/weave-cloud-token.png) - SCOPE_SERVICE_TOKEN= docker-compose up -d - -Where, - -* `SCOPE_SERVICE_TOKEN=` is the token you obtained after you signed up for Weave Cloud. - -Scope needs to be installed onto every machine that you want to monitor. Once launched, Scope doesn’t require any other configuration and it also doesn’t depend on Weave Net. - -After it’s been launched, open your web browser to [https://cloud.weave.works](https://cloud.weave.works) and login. Click 'View Instance' in the top right-hand corner to see the Scope user interface. +**2.** Decide on which format version to use: **Docker Compose Format Version 1:** @@ -198,29 +192,39 @@ After it’s been launched, open your web browser to [https://cloud.weave.works] - "--probe.docker=true" - "--service-token=${SCOPE_SERVICE_TOKEN}" -Version 2 of this YAML file supports networks and volumes as defined by any plugins you might be using. See [Compose File Reference](https://docs.docker.com/compose/compose-file/) for more information. +Version 2 of this YAML file supports a network mode that may be required with any Docker plugins that you are using. See [Compose File Reference](https://docs.docker.com/compose/compose-file/) for more information. -After Scope has been launched, open your web browser to [https://cloud.weave.works](https://cloud.weave.works) and login. Click 'View Instance' in the top right-hand corner to see the Scope user interface. +**3.** Once you've set up a compose file, launch Scope onto your local machine: + + SCOPE_SERVICE_TOKEN= docker-compose up -d + +Where, + +* `SCOPE_SERVICE_TOKEN=` is the token you obtained after you signed up for Weave Cloud. + +Note that you will need to launch Scope onto every node that you want to monitor. + +**4.** Go to [https://cloud.weave.works](https://cloud.weave.works) and click 'View Instance'. ##Installing Scope on Kubernetes ### With Weave Cloud (recommended) -Weave Cloud runs the Scope UI for you, and provides secure access control for your team. +Weave Cloud hosts the Scope UI for you, provides secure access control for your team and saves resources such as CPU or memory usage. -Register for a [Weave Cloud account](https://cloud.weave.works/) to get a service token and then replace `` with your token below, running this either on the master or on a machine where `kubectl` is configured to authenticate to your Kubernetes cluster: +Sign up for [Weave Cloud account](https://cloud.weave.works/) and obtain a token. Replace `` with your token by running this on the master node or on whatever machine that has `kubectl` is configured to authenticate to your Kubernetes cluster: $ kubectl apply -f 'https://cloud.weave.works/launch/k8s/weavescope.yaml?service-token=' **SECURITY NOTE: This allows control of your Kubernetes cluster from Weave Cloud, which is a hosted service.** -### Without Weave Cloud (run the Scope UI yourself) +### Without Weave Cloud (run Scope in standalone mode) The simplest way to get the latest release of Scope deployed onto a Kubernetes cluster is by running the following: $ kubectl apply -f 'https://cloud.weave.works/launch/k8s/weavescope.yaml' -This runs a recent Scope image from the Docker Hub and launches a probe onto every node as well as a single app. Once launched, Scope doesn’t require any other configuration and it also doesn’t depend on Weave Net. +This runs a recent Scope image from Dockerhub and launches a probe onto every node as well as a single Scope app. Once launched, Scope doesn’t require any other configuration. Allowable parameters for the launcher URL: @@ -236,7 +240,7 @@ To download and read the Scope manifest run: kubectl port-forward $(kubectl get pod --selector=weave-scope-component=app -o jsonpath='{.items..metadata.name}') 4040 -Open http://localhost:4040 in your browser. This allows you to access the Scope UI securely, without opening it to the Internet. +The URL is: http://localhost:4040. ##Installing Scope on Amazon ECS From b054bb3cdf9114567f1a7098752fe6e4ed3f47b3 Mon Sep 17 00:00:00 2001 From: abuehrle Date: Tue, 14 Feb 2017 13:44:02 -0600 Subject: [PATCH 2/7] update slack channel add meetup --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 150b00c79..63fcae45d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Weave Scope - Monitoring, visualisation & management for Docker & Kubernetes +# Weave Scope - Troubleshooting & Monitoring 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) @@ -35,7 +35,7 @@ sudo chmod a+x /usr/local/bin/scope scope launch ``` -This script will download and run a recent Scope image from the Docker Hub. +This script downloads and runs a recent Scope image from Docker Hub. Now, open your web browser to **http://localhost:4040**. (If you're using boot2docker, replace localhost with the output of `boot2docker ip`.) @@ -46,7 +46,8 @@ For instructions on installing Scope on [Kubernetes](https://www.weave.works/doc If you have any questions about, feedback for or problem with Scope we invite you to: - Read [the docs](https://www.weave.works/docs/scope/latest/introducing/). -- join our public slack channel +- join our #weave-community slack channel +- join the Weave User Group for online talks, free training sessions and meetups in your area - send an email to weave-users@weave.works - file an issue From a7fcb9f5b93562035b3dbb41294e4c0ea16ccc90 Mon Sep 17 00:00:00 2001 From: abuehrle Date: Tue, 14 Feb 2017 14:02:18 -0600 Subject: [PATCH 3/7] fix sentence --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 63fcae45d..89e5dd1ac 100644 --- a/README.md +++ b/README.md @@ -43,8 +43,8 @@ For instructions on installing Scope on [Kubernetes](https://www.weave.works/doc ## Getting help -If you have any questions about, feedback for or problem with Scope we invite -you to: +If you have any questions about, feedback for or problems with Scope: + - Read [the docs](https://www.weave.works/docs/scope/latest/introducing/). - join our #weave-community slack channel - join the Weave User Group for online talks, free training sessions and meetups in your area From c24e497a362b202f121c7e1afe8a34b45003b8b9 Mon Sep 17 00:00:00 2001 From: abuehrle Date: Tue, 14 Feb 2017 14:14:05 -0600 Subject: [PATCH 4/7] added how to invite yourself to community slack --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 89e5dd1ac..29e36a578 100644 --- a/README.md +++ b/README.md @@ -45,9 +45,11 @@ For instructions on installing Scope on [Kubernetes](https://www.weave.works/doc If you have any questions about, feedback for or problems with Scope: -- Read [the docs](https://www.weave.works/docs/scope/latest/introducing/). -- join our #weave-community slack channel -- join the Weave User Group for online talks, free training sessions and meetups in your area +- Read [the Weave Scope docs](https://www.weave.works/docs/scope/latest/introducing/). +- Read [the Weave Net docs](https://www.weave.works/docs/net/latest/introducing-weave/). +- Invite yourself to the #weave-community slack channel +- Ask a question on the #weave-community slack channel +- Join the Weave User Group and get invited to online talks, hands-on training and meetups in your area - send an email to weave-users@weave.works - file an issue From 49af0dcbfd15862699cb32418e666fb3beca15ef Mon Sep 17 00:00:00 2001 From: abuehrle Date: Tue, 14 Feb 2017 14:28:45 -0600 Subject: [PATCH 5/7] changed to pro link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 29e36a578..e52467220 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ If you have any questions about, feedback for or problems with Scope: - Read [the Weave Net docs](https://www.weave.works/docs/net/latest/introducing-weave/). - Invite yourself to the #weave-community slack channel - Ask a question on the #weave-community slack channel -- Join the Weave User Group and get invited to online talks, hands-on training and meetups in your area +- Join the Weave User Group and get invited to online talks, hands-on training and meetups in your area - send an email to weave-users@weave.works - file an issue From 920e1664b22cb535bfe98dcce1b83d6a7d86d499 Mon Sep 17 00:00:00 2001 From: abuehrle Date: Tue, 14 Feb 2017 14:42:59 -0600 Subject: [PATCH 6/7] open new window punctuation --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e52467220..dedbce080 100644 --- a/README.md +++ b/README.md @@ -46,12 +46,11 @@ For instructions on installing Scope on [Kubernetes](https://www.weave.works/doc If you have any questions about, feedback for or problems with Scope: - Read [the Weave Scope docs](https://www.weave.works/docs/scope/latest/introducing/). -- Read [the Weave Net docs](https://www.weave.works/docs/net/latest/introducing-weave/). -- Invite yourself to the #weave-community slack channel -- Ask a question on the #weave-community slack channel -- Join the Weave User Group and get invited to online talks, hands-on training and meetups in your area -- send an email to weave-users@weave.works -- file an issue +- Invite yourself to the #weave-community slack channel. +- Ask a question on the #weave-community slack channel. +- Join the Weave User Group and get invited to online talks, hands-on training and meetups in your area. +- Send an email to weave-users@weave.works +- File an issue. Your feedback is always welcome! From ccaf321d41095034477cbfa62435c233f374cf42 Mon Sep 17 00:00:00 2001 From: abuehrle Date: Wed, 15 Feb 2017 10:36:01 -0600 Subject: [PATCH 7/7] weave cloud token consistency --- site/installing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/site/installing.md b/site/installing.md index d07ed7b3b..e049129d0 100644 --- a/site/installing.md +++ b/site/installing.md @@ -49,7 +49,7 @@ Where, ###Using Weave Cloud -First, obtain a Cloud service token by signing up at [https://cloud.weave.works](https://cloud.weave.works/). +First, obtain a Weave Cloud token by signing up at [https://cloud.weave.works](https://cloud.weave.works/). !['Weave Cloud Token'](images/weave-cloud-token.png) @@ -212,7 +212,7 @@ Note that you will need to launch Scope onto every node that you want to monitor Weave Cloud hosts the Scope UI for you, provides secure access control for your team and saves resources such as CPU or memory usage. -Sign up for [Weave Cloud account](https://cloud.weave.works/) and obtain a token. Replace `` with your token by running this on the master node or on whatever machine that has `kubectl` is configured to authenticate to your Kubernetes cluster: +Sign up for a [Weave Cloud account](https://cloud.weave.works/) and obtain a token. Replace `` with your token by running this on the master node or on whatever machine that has `kubectl` configured to authenticate to your Kubernetes cluster: $ kubectl apply -f 'https://cloud.weave.works/launch/k8s/weavescope.yaml?service-token='