Standalone deployment

This guide describes how to deploy Tawon manually.

Requirements

  • An installation of Docker

  • A Linux kernel with version >= 4.19

Check out detailed requirement.

Getting Tawon Image

Tawon runs in a Docker container. You will first need to login to our registry with the credentials provided to you.

docker login quay.io

Then you can pull the image:

docker pull quay.io/mantisnet/tawon

Running a Simple NATS Instance

You will need at least one instance of NATS. A simple way to run it is with Docker. The following container contains NATS and NATS Streaming (also called STAN).

docker run -d --rm --name stan --network host nats-streaming

We are making port 4222 available to the host, which will give you access to the NATS/STAN instance.

Start the Tawon Controller

Tawon Controller manages the Tawon system. It has a GraphQL API that allows you to view the topology information collected by the agents, and create directives.

To start the Controller (using Docker’s integrated restart system – not recommended for production):

docker run -d --rm --name tawon-controller --network host -v `pwd`/data:/data quay.io/mantisnet/tawon controller --cmd.bus.msg.nats.url nats://localhost:4222

Add Tawon Agents

Install Tawon Agents on every machine you want to monitor. Make sure to configure the appropriate NAT server address.

docker run -d --rm --name tawon-agent1 --network host --pid=host --privileged \
    -v /sys/kernel/debug:/sys/kernel/debug \
    -v /:/var/run/tawon/host \
    quay.io/mantisnet/tawon agent \
    --cmd.bus.msg.nats.url nats://localhost:4222

Run Tawon Workers

Tawon Workers are an optional part of the Tawon system. They enable processing of the data using the same directives and tasks system as the agents.

docker run -d --rm --name tawon-worker1 --network host \
    quay.io/mantisnet/tawon worker \
    --cmd.bus.msg.nats.url nats://localhost:4222
To learn how to run agent directives, check out the tawonctl directives documentation and the kind section to learn how to send directives to worker instances.

Inspect and Stop Containers

You can look at the running container with:

docker ps

You can view a container’s log by calling the following, with the name of the container:

docker logs -f tawon-agent1

And you can stop a container by running with the name of the container:

docker kill tawon-agent1