From 905729af832357e60ed5f719915f0e90aaffd386 Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Tue, 30 Oct 2018 12:26:02 +0100 Subject: [PATCH 1/2] Start off FAQ document @fbarl and I talked about having a FAQ doc for Scope, where we can list tid-bits of information to work with Scope. Started off the doc with a piece that was discussed in #3406. Signed-off-by: Daniel Holbach --- README.md | 1 + site/faq.md | 47 ++++++++++++++++++++++++++++++++++++++++++++ site/how-it-works.md | 1 + site/installing.md | 1 + 4 files changed, 50 insertions(+) create mode 100644 site/faq.md diff --git a/README.md b/README.md index ace78cd6d..af51f40c2 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,7 @@ If you have any questions, feedback, or problems with Scope: - Docs - Read [the Weave Scope docs](https://www.weave.works/docs/scope/latest/introducing/) + - Check out the [frequently asked questions](/site/faq.md) - Find out how to [contribute to Scope](CONTRIBUTING.md) - Learn more about how the [Scope community operates](GOVERNANCE.md) - Join the discussion diff --git a/site/faq.md b/site/faq.md new file mode 100644 index 000000000..f6239da7a --- /dev/null +++ b/site/faq.md @@ -0,0 +1,47 @@ +--- +title: Frequently asked questions +menu_order: 95 +search_type: Documentation +--- + +# Frequently asked questions + +## Running Scope in a Kubernetes setting + +A simple way to get Scope running in a Kubernetes setting is to + +1. Clone the Scope repo: + + ```sh + git clone https://github.com/weaveworks/scope + cd scope + ``` + +1. Spin up a cluster wherever it suits you. + [Minikube](https://github.com/kubernetes/minikube) is a simple option. +1. Run + + ```sh + kubectl apply -f example/k8s + ``` + + to deploy Scope to your cluster. +1. Port-forward to access `weave-scope-app`: + + ```sh + kubectl port-forward svc/weave-scope-app -n weave 4040:80 + ``` + +1. Point your browser to + +## Disabling Scope Write Access + +Can be done by using the `probe.no-controls` option and set it to false for the scope agents. This can be done in the scope deployment manifest under the `weave-scope-agent`'s argument section with `—probe.no-control=true`. + +## RBAC and Weave Scope OSS + +OSS Scope has no user concept, this is only available in Weave Cloud. To limit the access to the UI, + +- setup a reverse proxy with auth and block access to non admin users, +- capture the calls with something like Chrome network console to get the endpoints to know which requests to authenticate in the proxy server. +- you can use Basic HTTP Auth since Scope 1.10.0 - just use the `BASIC_AUTH_USERNAME` and `BASIC_AUTH_PASSWORD` environment variables. \ No newline at end of file diff --git a/site/how-it-works.md b/site/how-it-works.md index 4382e8232..2e3a50ebb 100644 --- a/site/how-it-works.md +++ b/site/how-it-works.md @@ -86,4 +86,5 @@ For more information, see [Go Checkpoint](https://github.com/weaveworks/go-check **See Also** * [Installing Weave Scope](/site/installing.md) + * [Scope's FAQ](/site/faq.md) diff --git a/site/installing.md b/site/installing.md index 923d38134..72b865809 100644 --- a/site/installing.md +++ b/site/installing.md @@ -239,3 +239,4 @@ For more information see, [Deploying Weave Scope on DC/OS](https://www.weave.wor **See Also** * [Understanding Weave Scope](/site/how-it-works.md) + * [Scope's FAQ](/site/faq.md) From dca56f73cee363022f9e36dbb3160383d409353a Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Fri, 23 Nov 2018 15:54:52 +0100 Subject: [PATCH 2/2] it's not env variables, it's cli arguments --- site/faq.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/site/faq.md b/site/faq.md index f6239da7a..949635d50 100644 --- a/site/faq.md +++ b/site/faq.md @@ -44,4 +44,14 @@ OSS Scope has no user concept, this is only available in Weave Cloud. To limit t - setup a reverse proxy with auth and block access to non admin users, - capture the calls with something like Chrome network console to get the endpoints to know which requests to authenticate in the proxy server. -- you can use Basic HTTP Auth since Scope 1.10.0 - just use the `BASIC_AUTH_USERNAME` and `BASIC_AUTH_PASSWORD` environment variables. \ No newline at end of file +- you can use Basic HTTP Auth since Scope 1.10.0 - just use these command line + arguments: + + ```cli + -app.basicAuth + Enable basic authentication for app + -app.basicAuth.password string + Password for basic authentication (default "admin") + -app.basicAuth.username string + Username for basic authentication (default "admin") + ```