Docker deployment

• Deployment process
  • Single node installation
  • Cluster node installation
• Logs
• Base image configuration

This guide explains how to deploy a Kaa cluster using the Docker containerization platform.

The deployed cluster will include:

• Kaa nodes
• One Zookeeper node
• One SQL Database node – MariaDB/PostgreSQL
• One NoSQL Database node – MongoDB/Cassandra

Deployment process

To deploy a Kaa cluster on your machine:

1. Install Docker Engine.

   If you use Linux, you can install the Docker Engine by running the installation script.

    wget -qO- https://get.docker.com/ | sh
   

   IMPORTANT: If you use Windows, you must also have Python installed.

2. Install Docker Сompose.

3. Download Kaa debian package from the official site or build your Kaa project locally (use kaa-node.deb located in server/node/target/). Put the kaa-node.deb file in the server/containers/docker/ directory.

4. Run the following command from the server/containers/docker directory.

    docker build --build-arg setupfile=kaa-node.deb -t kaa-node:0.10.1 .
   

   Alternatively, you can run the following command.

    build.sh
   

Single node installation

To install a single node:

1. Get your public host by specifying the TRANSPORT_PUBLIC_INTERFACE parameter in the server/containers/docker/docker-compose-1-node/kaa-example.env file.

   • Linux / macOS

       ip route get 8.8.8.8 | awk '{print $NF; exit}'
     

   • Windows

       netsh interface ip show address "Ethernet" | findstr "IP Address"
     

2. Open any directory in the docker-compose-1-node directory.

    cd docker-compose-1-node/$SQL-NoSQL/
   

   The following SQL-NoSQL databases are available:

   • mariadb-mongodb
   • mariadb-cassandra
   • postgresql-mongodb
   • postgresql-cassandra

3. Run the following command.

    docker-compose up
   

   If you want to run Docker container as a daemon, run

    docker-compose up -d
   

Cluster node installation

To install a cluster node:

1. Specify SQL-NoSQL databases which you want to use. To do this, run the following command from the server/containers/docker/using-compose directory.

    python launch-kaa.py SQL-NoSQL
   

   See example below.

    python launch-kaa.py mariadb-mongodb
   

   The following SQL-NoSQL databases are available:

   • mariadb-mongodb
   • mariadb-cassandra
   • postgresql-mongodb
   • postgresql-cassandra

   If you want deploy Kaa in cluster mode, run the previous command with an additional option.

    python launch-kaa.py SQL-NoSQL NODE_COUNT
   

   See example below.

    python launch-kaa.py mariadb-mongodb 3
   

2. Execute the following command to access the running container.

    docker exec -it usingcompose_KAA_SERVICE_NAME_1 /bin/bash -c "export TERM=xterm; exec bash"
   

   KAA_SERVICE_NAME is the Kaa service name specified in the kaa-docker-compose.yml file.

   See example below.

    docker exec -it usingcompose_kaa_0_1 /bin/bash -c "export TERM=xterm; exec bash"
   

   usingcompose is the name of the directory containing the kaa-docker-compose.yml and third-party-docker-compose.yml files.

3. Wait a few seconds until the kaa-node service starts and open your browser at localhost:8080. See the kaa node container log to check if the service has started.

Logs

When you run your Docker container as a daemon, its output is not displayed. To access it, run

docker-compose -f kaa-docker-compose.yml -p usingcompose exec KAA_SERVICE_NAME sh /kaa/tail-node.sh

KAA_SERVICE_NAME is the Kaa service name specified in the kaa-docker-compose.yml file.

Alternatively, you can run the view-kaa-node-logs.sh to obtain the same result.

You can also use the command below.

docker logs DOCKER_SERVICE_NAME

To get the names of all Docker containers, run

docker ps -a

To get the names of all Docker containers that are running, execute the following command.

docker ps

Base image configuration

Base image configuration is done using the following environment variables.