Visualizeer

Inspect and search through containers and nodes in a Docker EE cluster.

Uses the Universal Control Plane (UCP) API

Installation

Docker Run

docker run \
  -d \
  -p 80 \
  -e 'ucp_fqdn=ucp.contoso.com' \
  -e 'ucp_username=admin' \
  -e 'ucp_password=SecurePassw0rd1' \
  --name visualizeer \
  stevenfollis/visualizeer:latest

Docker Secrets

Visualizeer uses Docker Secrets to access an instance of Universal Control Plane

To setup secets, connect to the UCP cluster via a Client Bundle and create either with the GUI or:

printf 'ucp.moby.com' | docker secret create visualizeer.ucp_fqdn -

printf 'admin' | docker secret create visualizeer.ucp_username -

printf 'SecurePassw0rd1' | docker secret create visualizeer.ucp_password -

Docker Stack with Secrets:

version: "3.3"
services:
  visualizeer:
    image: stevenfollis/visualizeer:latest
    ports:
      - "80"
    deploy:
      placement:
        constraints:
          - node.platform.os == linux
          - node.role == worker
    secrets:
      - visualizeer.ucp_fqdn
      - visualizeer.ucp_username
      - visualizeer.ucp_password

secrets:
  visualizeer.ucp_fqdn:
    external: true
  visualizeer.ucp_username:
    external: true
  visualizeer.ucp_password:
    external: true

Environment Variables

Instead of Secrets, Visualizeer can use environment variable strings to access an instance of Universal Control Plane

Variable Name	Purpose	Example Value
ucp_fqdn	FQDN for UCP load balancer	ucp.contoso.com
ucp_username	Username for account to use for querying the UCP API	admin
ucp_password	Password for account to use for querying the UCP API	SecurePassw0rd1
refresh_rate	How often to poll the API (ms). Defaults to 3000 (3s)	3000
debug	Enable debug mode for additional logging (default false)	false

Docker Stack with Environment Variables:

version: "3.3"
services:
  visualizeer:
    image: stevenfollis/visualizeer:latest
    ports:
      - "80"
    deploy:
      placement:
        constraints:
          - node.platform.os == linux
          - node.role == worker
    environment:
      - ucp_fqdn=ucp.contoso.com
      - ucp_username=admin
      - ucp_password=SecurePassw0rd1

Docker Stack with Interlock:

version: "3.3"
services:
  web:
    image: stevenfollis/visualizeer:latest
    deploy:
      placement:
        constraints:
          - node.platform.os == linux
          - node.role == worker
      labels:
        com.docker.lb.hosts: viz.apps.moby.com
        com.docker.lb.network: visualizeer_default
        com.docker.lb.port: 80
        com.docker.lb.websocket_endpoints: /socket.io
    secrets:
      - visualizeer.ucp_fqdn
      - visualizeer.ucp_username
      - visualizeer.ucp_password

secrets:
  visualizeer.ucp_fqdn:
    external: true
  visualizeer.ucp_username:
    external: true
  visualizeer.ucp_password:
    external: true

Features

• View node name, OS, and enabled schedulers (Swarm, Kubernets, Mixed)

• Hover on node OS to see architecture and engine version

• Colored node availability indicators for active, pause, and drain

• Colored container status indicators

• No browser refreshes needed - automatically polls the server and updates the UI

• Filter box to find particular nodes

Inspiration

Inspired by docker-swarm-visualizer