Using Docker (Recommended) - Kaholo

Using Docker (Recommended)

We highly recommend using the docker agent if possible for consistency and ease of management. The agent image is public and can be found on the DockerHub in Kaholo.io/kaholo-agent.

Follow the steps below to install the Kaholo Agent using Docker:

Step 1: Pulling the Latest Image

docker pull kaholoio/kaholo-agent:2.0.0

Step 2: Create Configuration File

Create a new file and name it kaholo-agent.conf . It will store key-value pairs for the following options:

OptionsDescription
PORTThe port which the agent will run. Note: the default port is 8090, if you use any other port, you will also need to adjust the docker run command
SERVER_URL The URL of the Kaholo server that you want to connect to.
AGENT_KEY A unique random 32 characters to identify this specific agent.
AMQP_HOSTThe host of the queue, usually the same as the server.
AMQP_PORT The port of the AMQP server is usually 5671.
AMQP_USER“twiddlebugs”
AMQP_PASSWORD“twiddlebugs”
AMQP_RESULT_QUEUE“actions-outcome”
AMQP_CERT_PATH The path to the agent crt file.
AMQP_KEY_PATHThe path to the agent pem file. Note: when running inside docker, you will need to mount the local crt and pem files to the container and the path in the variable should be to the mounted path.

For more examples, click here.

Step 3: Run a New Container

docker run –restart unless-stopped -v <plugins-dir-path>:/usr/src/app/libs/plugins –env-file <path-to-conf-file> -d -p 8090:8090 kaholoio/kaholo-agent:latest

Step 4: Extending the Agent

In case of a need for additional CLIs to be installed on the agent image, you can create a custom image based on the kaholo-agent image.

Close Menu