Ansible Role: Weave Scope

An Ansible Role that deploys Weave-Scope (https://github.com/weaveworks/scope) in an OpenShift cluster running locally, generally created by using Minishift (https://www.openshift.org/minishift).

Weave Scope is a Monitoring, visualisation & management Tool for Docker & Kubernetes. For further details here: https://github.com/weaveworks/scope

This Role performs the following tasks:

• Check if OpenShift is running locally.
• Installs from Internet or local.
• Uses the latest oc binary from ~/.minishift/cache/oc/<VERSION>/<OS>/ to deploy Weave Scope.

Observations

The Weave Scope Ansible Role has been tested with:

• Ansible 2.3+
• minishift v1.11.0+4459917
• VirtualBox 5.1.30
• macOS High Sierra, version 10.13.2 (17C88)
• Prior to running the role, clear your terminal session of any DOCKER* environment variables.
• Weave Scope requires access to OpenShift running locally and an system account. If you want to get an OpenShift instance running locally, please, see https://galaxy.ansible.com/chilcano/minishift to get a VM with OpenShift.

Default Role variables

The default variables are in defaults/main.yml.

Using the Ansible Role

Install the role:

$ sudo ansible-galaxy install chilcano.weave-scope

Copy the playbook from your roles path to the current working directory:

$ cp ${ANSIBLE_ROLES_PATH}/chilcano.weave-scope/sample-1-weave-scope.yml .

Create an inventory file:

$ echo $(hostname) > ./inventory

Run the playbook:

$ ansible-playbook -i inventory --ask-become-pass sample-1-weave-scope.yml

Check if Weave Scope was deployed successfully

$ oc get pods -n weave

Where weave is the default namespace or project used in the Weave Scope installation.

Access to Weave Scope from a browser

Port forwarding

In order to get access to Weave Scope from browser, we should forward the Weave Scope's port to the Host's port. Considering the Weave Scope App listens, by default, on the port 4040, then to forward to host's port on 4041 to use next command:

$ oc port-forward -n weave-scope "$(oc get -n weave-scope pod --selector=weave-scope-component=app -o jsonpath='{.items..metadata.name}')" 4041:4040
Forwarding from 127.0.0.1:4041 -> 4040
Forwarding from [::1]:4041 -> 4040
Handling connection for 4041
Handling connection for 4041
Handling connection for 4041
Handling connection for 4041
Handling connection for 4041
...

If you have deployed in the weave namespace, change it before. The updated command will be:

$ oc port-forward -n weave "$(oc get -n weave pod --selector=weave-scope-component=app -o jsonpath='{.items..metadata.name}')" 4041:4040

Once done, open your browser with the http://127.0.0.1:4041 URL and you could visualize all Pods, Containers, Controllers, etc. of your OpenShift Cluster.

LoadBalancer and NodePort Service

Add a new LoadBalancer or NodePort Service to expose weave-scope-app service:

$ oc apply -f ${ANSIBLE_ROLES_PATH}/chilcano.weave-scope/sample-2-weave-scope-app-svc.yml

For example:

$ oc apply -f /etc/ansible/roles/chilcano.weave-scope/sample-2-weave-scope-app-svc.yml -n weave-scope
service "weave-scope-app-svc" created

Now open the Weave Scope from Minishift automatically:

$ minishift openshift service weave-scope-app-svc --in-browser -n weave-scope
Opening the route/NodePort http://192.168.99.100:32689 in the default browser...

Or open it manually:

$ eval $(minishift oc-env)
$ oc login -u system:admin

$ oc get svc/weave-scope-app-svc -o yaml -n weave-scope | grep -i nodeport
    nodePort: 32689

$ minishift ip
192.168.99.100

Now, you can open your browser with the http://192.168.99.100:32689 URL.

Screenshots

• Exploring OpenShift with Weave Scope.

• Exploring in depth the API Mesh.

License

MIT / BSD

Author Information

This role was created in 2017 by Roger Carhuatocto, author of HolisticSecurity.io Blog.