How to deploy CM-Beetle, along with its related components

[yunkon-kim]

How to deploy CM-Beetle and related components

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

Note

Please ensure that Docker and Docker Compose are installed on your system

docker --version
docker compose version

Tip

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

Getting started

Important

• docker-compose.yaml is located in [BEETLE_ROOT]/deployments/docker-compose.
• In this directory, other subsystems' assets/configs are included.

Note

Please refer to the CM-Beetle release nodes for ubsystem versions
https://github.com/cloud-barista/cm-beetle/releases

1. Explore the docker-compose.yaml

You can find the docker-compose.yaml file. You can review, verify, and modify any necessary configurations.

☑️ CM-Beetle docker-compose.yaml

2. Run CM-Beetle and related components

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

The easiest way:

cd [BEETLE_ROOT]
make compose-up

Note - The API username and Password are displayed when Beetle starts.

Click to see the other ways

**Locate to `[BEETLE_ROOT]/deployments/docker-compose`**
```bash
cd [BEETLE_ROOT]/deployments/docker-compose
```	


**Start services as defined:**

To run services as pre-defined in `docker-compose.yaml` file, use the following command:
```bash
docker compose up
```


**Start services in detached mode with build option:**

To build the current CM-Beetle source code into a container image and run it along with the other containers, use the following command:
```bash
docker compose up -d --build
```


**Start services in detached mode:**
```bash
docker compose up -d
```
The `-d` option runs the containers in detached mode (in the background).

3. Initialize the CB-Tumblebug service

❗❗❗ Required ❗❗❗

Important

CB-Tumblebug MUST be initialized to configure multi-cloud information.
⏩ See (1) Download CB-Tumblebug, and then
⏩ See (3) Initialize CB-Tumblebug to configure Multi-Cloud info

4. Use the CM-Beetle APIs

Note

• provider와 region 지정 가능
  • AWS, Azure, NCP 지원 중
• on-premise model (a.k.a. source model for computing infra) 통합 및 테스트 완료
• Tumblebug과 통합 및 테스트 완료
• Honeybee에서 정제된 소스 컴퓨팅 인프라 정보를 제공하는 API와 연동 테스트 완료

Important

Swagger UI 접속 및 활용 (환경변수의 API Username과 Password 활용)
API 활용 관련 자세한 사항: Integration and Test: Beetle, Tumblebug, Honeybee and model 참조

5. Use the other APIs to manage Multi-Cloud Infrastructure (MCI)

After you have recommended and migrated the appropriate infrastructure by Beetle, you can manage the migrated infrastructure with Tumblebug.

Here is a brief overview:

Note

Beetle has a reverse proxy.
The Beetle and Tumblebug APIs are accessible through a single endpoint provided by Beetle.
A unique path identifier is used to distinguish the APIs. For example:

http://localhost:8056/beetle: Beetle API base
http://localhost:8056/beetle/api/index.html: Beetle API docs
http://localhost:8056/tumblebug: Tumblebug API base
http://localhost:8056/tumblebug/api/index.html: Tumblebug API docs

6. Stop the services

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

make 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)