diff --git a/site/installing.md b/site/installing.md index 8d8236259..b97b37b71 100644 --- a/site/installing.md +++ b/site/installing.md @@ -4,7 +4,7 @@ menu_order: 20 --- -Weave Scope consists of three parts: the probe, the app and the user interface. Scope can be deployed in either a standalone configuration, where you run everything yourself, or by using Weave Cloud. +Weave Scope consists of three parts: the probe, the app and the user interface. Scope can be deployed in either a standalone configuration, where you run everything yourself, or by using Weave Cloud. Weave Cloud is the recommended option if: @@ -16,6 +16,7 @@ The following topics are discussed: * [Installing Scope on Docker](#docker) * [Using Weave Cloud](#docker-weave-cloud) + * [On A Local Cluster](#local-cluster) * [Weave Net and Scope](#net-scope) * [Using Docker Compose](#docker-compose) * [Using Docker Compose in Weave Cloud](#docker-compose-cloud) @@ -27,7 +28,7 @@ The following topics are discussed: ##Installing Scope on Docker -To install Scope onto your local Docker machine in standalone mode, run the following commands: +To install Scope onto your PC with docker installed in standalone mode, run the following commands: sudo curl -L git.io/scope -o /usr/local/bin/scope sudo chmod a+x /usr/local/bin/scope @@ -43,7 +44,8 @@ Where, * `` is the name you gave to your virtual machine with docker-machine. -> **Note:** Scope allows anyone with access to the UI control over your containers: as such, the Scope app endpoint (port 4040) should not be made accessible on the Internet. Additionally traffic between the app and the probe is currently insecure and should also not traverse the Internet. +### Scope allows anyone with access to the UI control over your containers, and the hosts running them! +Therefore, the Scope app endpoint (port 4040) should not be made accessible on the Internet. Additionally, traffic between the app and the probe is currently insecure and should also not traverse the Internet, meaning that you should either use the private / internal IP addresses of your nodes when setting it up, or route this traffic through weave net. To put scope behind a very simple password, you can use [Caddy](https://github.com/mholt/caddy) to protect the endpoint by making the port 4040 available to localhost and using caddy to proxy it.... or, just use weave cloud. ###Using Weave Cloud @@ -63,6 +65,29 @@ This script downloads and runs a recent Scope docker image from the Docker Hub. 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. +### Local-Cluster without WeaveNet / WeaveDNS +These are the directions for "Any Random Cluster," with no dependency on Weave Net. Suppose I have a cluster like this: + +192.168.100.16 +192.168.100.17 +192.168.100.18 +192.168.100.19 +192.168.100.20 + +We'll assume that no special hostnames or DNS settings have been fiddled with, so we're going to use IP addresses only to configure scope on this cluster: + +**On Each Node, first run:** + sudo curl -L git.io/scope -o /usr/local/bin/scope + sudo chmod a+x /usr/local/bin/scope +**Then Run on the first node** + scope launch 192.168.100.18 192.168.100.19 192.168.100.20 +**Second node** + scope launch 192.168.100.17 192.168.100.20 192.168.100.21 + scope launch 192.168.100.17 192.168.100.18 192.168.100.21 + scope launch 192.168.100.17 192.198.100.19 192.168.100.20 + +Key point here being that you need to make each node aware of the others. + ### 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`.