Skip to content
Taylor Nekroze Lawson edited this page Nov 3, 2018 · 3 revisions

To facilitate management and inspection of the lab network and any containers running on your machine, Dab provides access to various tools with both web and terminal interfaces.

For the most up to date list execute dab tools list so at time of writing that would give a list such as the following:

      TOOL | DESCRIPTION
chronograf | Chronograf metrics explorer from the TICK stack
 cyberchef | The Cyber Swiss Army Knife
   grafana | The open platform for analytics and monitoring, user=admin pass=admin
  kafkacat | Lightweight kafka console consumer/producer
 kapacitor | Real-Time metrics processing from the TICK stack
     ngrok | Secure introspectable tunnels, points to traefik
    ntopng | Monitor network interfaces, requires redis service
   pgadmin | Postgres administration console, user=user@dab pass=admin
 portainer | Docker Management Web UI
    serveo | Expose local servers to the internet
    sysdig | Universal system visibility tool with native support for containers
   traefik | The Cloud Native Edge Router, docker reverse proxy
  vaultbot | Automate interaction with Hashicorp Vault
watchtower | Watches labelled container images for updates and applies them

The dab tools subcommand namespace consists of various subcommands, as per convention, these can be listed by executing dab tools --help which at time of writing would give:

Usage:
        dab tools <SUBCOMMAND> [<ARGUMENT>...]

SUBCOMMAND | DESCRIPTION
   address | Displays the address of any tools exposed by the tool
   destroy | Destroy containers and volumes for a specific (or all if none given) tool
      exec | Run a command in the running instance of the given tool
      help | You are looking at it
      list | List available tools
      logs | Display logs for a given tool, or all tools if none is given
   restart | Restart the running instance of the given tool, or all tools if none is given
       run | Run a command in a new instance of given tool's container
     start | Start the container for a given tool, or all tools if none is given
    status | Display the status of the given tool, or all tools if none is given
      stop | Stop the container for the given tool, or all tools if none is given
    update | Update the image for the given tool, or all tools if none is given
   version | Display dab and docker information

Some of these subcommands target only one tool container and some can (or must) work with all tools. For example you can only get the exposed web address (if any) for a tool by executing dab tools address whereas you can destroy a specific tool's and its data by passing its name to dab tools destroy but giving no tool name will destroy all tools.

For the tools that only provide a cli interface you will most likely want to use dab tools run rather than dab tools start as you might for a web service, this keeps the process attached to your terminal allowing you to interact with it.

Most tools can have their version customized by defining an environment variable such as DAB_TOOLS_GRAFANA_TAG to a valid docker tag for the official grafana docker image.

Tools can be updated via dab tools update which will pull images and the attempt to build them.

Clone this wiki locally