How to deploy CB-Tumblebug, along with its related components, using Docker Compose

[yunkon-kim]

How to deploy CB-Tumblebug, along with its related components

This guide will help you to deploy CB-Tumblebug, along with its related components CB-Spider, etcd, and CB-MapUI, using Docker Compose.

In advance, I'd like to mention specifying the service to run, as it is required when developing CB-Tumblebug.

For example, CB-Tumblebug builds and runs the source code, and the remaining components can be run via Docker Compose.

docker compose up -d cb-spider etcd etcd-conf cb-mapui

From here, we will explain the two methods we provide.

• one is simple 😉
• the other one can be customized as you wish 🎯

Please note that it has been tested in the following environments.

Click to see the details

Pre-requisites, Install Docker and Docker Compose

First, please ensure that Docker and Docker Compose are installed on your system.

docker --version
docker compose --version

If they are not, you can install them using the following guides.

• Install Docker Engine
• Install the Compose plugin

Test environment and test case

• Tested environment
  • Ubuntu 22.04.3 LTS on Windows Subsystem for Linux 2 (WLS 2)
  • Docker 27.0.3
  • Docker Compose 2.29.1
• Test case (completed)
  • Create and delete MCIS across AWS, Azure, and GCP on mapui

Simple method

: docker-compose.yaml has been set as default values for running CB-Tumblebug and related components.
: All services are run via docker compose up.

Please see the following for details on checking service status, initializing Tumblebug, and shutting it down.

1. Explore the docker compose.yaml

You can find the docker-compose.yaml file located in the CB-Tumblebug root directory. You can review, verify, and modify any necessary configurations.

☑️ CB-Tumblebug docker-compose.yaml

2. Run the services

You can run the services, defined in the docker-compose.yaml

Start Services in detached mode:

docker compose up -d

The -d option runs the containers in detached mode (in the background).

3. Check the services

You can view a list of all service containers defined in the docker-compose.yaml

Check Service Status:

docker compose ps

View Logs:

docker compose logs

4. Use the CB-Tumblebug service

You can find how to use CB-Tumblebug in the following links:

⏩ See (4) Configure Multi-Cloud info (required)
⏩ See How to Use CB-TB Features

5. Stop the services

We can stop all running containers (and remove networks and volumes created by up).

docker compose down

Customizable method

: Predefined docker-compose-custom.yaml and .env allow you to set existing environment variables for CB-Tumblebug and related components. : .env is set to use the default value if the host environment variable is not set.
: This allows us to set environment variables in a guided way in each component/service (e.g. source setup.env).
: All services are run via docker compose -f docker-compose-custom.yaml up.
: Please note that if the environment variable names are the same between components, it is difficult to use the existing names (e.g., API_USERNAME, API_PASSWORD).

: References:

• Set, use, and manage variables in a Compose file with interpolation
• Environment variables precedence in Docker Compose
• Set environment variables within your container's environment

1. Explore the env setup guide of each component

For example:

• CB-Spider: https://github.com/cloud-barista/cb-spider/wiki/Quick-Start-Guide
• CB-Tumblebug: https://github.com/cloud-barista/cb-tumblebug/wiki/Quick-Start-Guide
• etcd:
  • Configuration options: https://etcd.io/docs/v3.5/op-guide/configuration/
  • Authentication guides: https://etcd.io/docs/v3.5/op-guide/authentication/

2. Set environment variables of each component

Tumblebug example

source conf/setup.env

3. Run the services

You can run the services, defined in the docker-compose-custom.yaml

Start Services in detached mode:

docker compose -f docker-compose-custom.yaml up -d

The -d option runs the containers in detached mode (in the background).

Note - It's possible to run with specific environment variable values, such as COMPOSE_TB_VERSION_TAG=0.9.1 docker compose -f docker-compose-custom.yaml up

4. Check the services

You can view a list of all service containers defined in the docker-compose.yaml

Check Service Status:

docker compose ps

View Logs:

docker compose logs

5. Use the CB-Tumblebug service

You can find how to use CB-Tumblebug in the following links:

⏩ See (4) Configure Multi-Cloud info (required)
⏩ See How to Use CB-TB Features

6. Stop the services

We can stop all running containers (and remove networks and volumes created by up).

docker compose down

---

Appendix

Other useful commands and options

Click to see the details

We can view all the commands and options with the following commands:

--help option

docker compose --help

Please refer to the following for frequently used commands.

-f option:

docker compose -f docker-compose-local.yaml up

To set the specific docker-compose.yaml file or path

start command

docker compose start cb-mapui

To start a specific service, which is down

stop command

docker compose stop cb-mapui

To stop a specific service, which is down

restart command

docker compose restart cb-mapui

To restart a specific service

exec command

docker compose exec cb-mapui env

To execute a command to a specific service

run command

docker compose run cb-mapui env

To run a specific command in the service container one-time

config command

docker compose config

To check configs (Note: Useful when using multiple configuration files with the -f option)