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..949635d50 --- /dev/null +++ b/site/faq.md @@ -0,0 +1,57 @@ +--- +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 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") + ``` 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)