cm-beetle

Computing Infrastructure Migration

This repository provides computing infrastructure migration features. This is a sub-system on Cloud-Barista platform and utilizes CB-Tumblebug to depoly a multi-cloud infra as a target computing infrastructure.

Overview

Computing Infrastructure Migration framework (codename: cm-beetle) is going to support:

• migration execution and control from source to target computing infrastructure, and
• recommendation of optimal configuration of target cloud infrastructure.

Execution and development environment

• Operating system (OS):
  • Ubuntu 22.04
• Languages:
  • Go: 1.21
  • Python: 3.8.10
• Container runtime:
  • Docker: 20.10.12

How to run CM-Beetle

Source code based installation and execution

Configure build environment

1. Install dependencies

# Ensure that your system is up to date
sudo apt update -y

# Ensure that you have installed the dependencies, 
# such as `ca-certificates`, `curl`, and `gnupg` packages.
sudo apt install make gcc git

1. Install Go

Note - Install the latest stable version of Go for CM-Beetle contribution/development since backward compatibility is supported. For example, install Go 1.21.4, which is stable version on 2023-11-30, even though go.mod says go 1.19. (In the opposite case, you will encounter a build error.)

Example - Install Go 1.21.4, see Go all releases and Download and install

# Set Go version
GO_VERSION=1.21.4

# Get Go archive
wget https://go.dev/dl/go${GO_VERSION}.linux-amd64.tar.gz

# Remove any previous Go installation and
# Extract the archive into /usr/local/
sudo rm -rf /usr/local/go && sudo tar -C /usr/local -xzf go${GO_VERSION}.linux-amd64.tar.gz

# Append /usr/local/go/bin to .bashrc
echo 'export PATH=$PATH:/usr/local/go/bin:$HOME/go/bin' >> ~/.bashrc
echo 'export GOPATH=$HOME/go' >> ~/.bashrc

# Apply the .bashrc changes
source ~/.bashrc

# Verify the installation
echo $GOPATH
go version

Download source code

Clone CM-Beetle repository

git clone https://github.com/cloud-barista/cm-beetle.git ${HOME}/cm-beetle

Build CM-Beetle

Build CM-Beetle source code

cd ${HOME}/cm-beetle
make

(Optional) Update Swagger API document

cd ${HOME}/cm-beetle
make swag

If you got an error because of missing swag, install swag:

go install github.com/swaggo/swag/cmd/swag@latest

Run CM-Beetle binary

Set enviroment variable (See setup.env)

source ./conf/setup.env

Run CM-Beetle server

cd ${HOME}/cm-beetle
make run

Health-check CM-Beetle

Check if CM-Beetle is running

curl http://localhost:8056/beetle/health

# Output if it's running successfully
# {"message":"CM-Beetle API server is running"}

Container based execution

Check a tag of CM-Beetle container image in cloudbaristaorg/cm-beetle

Run CM-Beetle container

docker run -p 8056:8056 \
--name cm-beetle \
cloudbaristaorg/cm-beetle:latest

Health-check CM-Beetle

Check if CM-Beetle is running

curl http://localhost:8056/beetle/health

# Output if it's running successfully
# {"message":"CM-Beetle API server is running"}