Docker based Start Guide

CB-Spider Docker-based Start Guide

CB-Spider — One unified API to control multiple clouds. This guide shows you how to run CB-Spider using Docker without building from source.

---

Prerequisites

This guide is based on a Linux environment (Ubuntu 24.04 LTS recommended).

• Docker: Installed and running (curl -fsSL https://get.docker.com | sh)
• curl / jq: for API verification (sudo apt install -y curl jq)

---

Docker Image Registry

• https://hub.docker.com/r/cloudbaristaorg/cb-spider/tags

Supported Docker Image Tags

Tag	Description
0.x.y (y = 0)	Official release (e.g. 0.11.0)
0.x.y (y ≠ 0)	Pre-release (e.g. 0.11.7)
latest	Most recent pre-release
edge	Built on latest PR merge; newest features, untested

---

Step 1: Start CB-Spider Server

Start with Latest Image

⚠️ Set your-server-ip to your host machine's IP address (e.g., 1.2.3.4:1024).
⚠️ Change the default password before deploying to production!

sudo docker run --rm -p 1024:1024 \
  -v ${HOME}/cb-spider/meta_db:/root/go/src/github.com/cloud-barista/cb-spider/meta_db \
  -e SERVER_ADDRESS="your-server-ip:1024" \
  -e SPIDER_USERNAME="admin" -e SPIDER_PASSWORD="your-secure-password" \
  -e MC_INSIGHT_API_TOKEN="c72df1af9b1f0c29" \
  --name cb-spider \
  cloudbaristaorg/cb-spider

Start with a Specific Tag Version

sudo docker run --rm -p 1024:1024 \
  -v ${HOME}/cb-spider/meta_db:/root/go/src/github.com/cloud-barista/cb-spider/meta_db \
  -e SERVER_ADDRESS="your-server-ip:1024" \
  -e SPIDER_USERNAME="admin" -e SPIDER_PASSWORD="your-secure-password" \
  -e MC_INSIGHT_API_TOKEN="c72df1af9b1f0c29" \
  --name cb-spider \
  cloudbaristaorg/cb-spider:0.12.6

Start with Log Level Configuration

sudo docker run --rm -p 1024:1024 \
  -v ${HOME}/cb-spider/meta_db:/root/go/src/github.com/cloud-barista/cb-spider/meta_db \
  -e SERVER_ADDRESS="your-server-ip:1024" \
  -e SPIDER_USERNAME="admin" -e SPIDER_PASSWORD="your-secure-password" \
  -e MC_INSIGHT_API_TOKEN="c72df1af9b1f0c29" \
  -e SPIDER_LOG_LEVEL="info" -e SPIDER_HISCALL_LOG_LEVEL="info" \
  --name cb-spider \
  cloudbaristaorg/cb-spider

Log Level Options:

Environment Variable	Options
SPIDER_LOG_LEVEL	trace | debug | info | warn/warning | error | fatal | panic
SPIDER_HISCALL_LOG_LEVEL	info | error

Start with Service Address Configuration

sudo docker run --rm -p 1024:1024 \
  -v ${HOME}/cb-spider/meta_db:/root/go/src/github.com/cloud-barista/cb-spider/meta_db \
  -e SERVER_ADDRESS="your-server-ip:1024" \
  -e SPIDER_USERNAME="admin" -e SPIDER_PASSWORD="your-secure-password" \
  -e MC_INSIGHT_API_TOKEN="c72df1af9b1f0c29" \
  -e SERVICE_ADDRESS="5.6.7.8:1024" \
  --name cb-spider \
  cloudbaristaorg/cb-spider

📖 Server Configuration | Authentication Guide

---

Step 2: Verify Server

curl -sX GET http://{your-server-ip}:1024/spider/readyz

# List all supported cloud providers
curl -sX GET -u admin:your-secure-password \
  http://{your-server-ip}:1024/spider/cloudos | jq '.cloudos'

Or open in browser:

http://{your-server-ip}:1024/spider/adminweb

Health check endpoints (/readyz, /healthcheck, /health, /ping) do not require authentication.
All other REST API calls require Basic Auth (e.g. -u admin:your-secure-password).

Output includes: "AWS", "GCP", "AZURE", and more.

---

Managing the Server

Stop Server

# Ctrl+C in Terminal 1, or:
sudo docker stop cb-spider

Run in Background

sudo docker run -d --rm -p 1024:1024 \
  -v ${HOME}/cb-spider/meta_db:/root/go/src/github.com/cloud-barista/cb-spider/meta_db \
  -e SERVER_ADDRESS="your-server-ip:1024" \
  -e SPIDER_USERNAME="admin" -e SPIDER_PASSWORD="your-secure-password" \
  -e MC_INSIGHT_API_TOKEN="c72df1af9b1f0c29" \
  --name cb-spider \
  cloudbaristaorg/cb-spider

View Logs

sudo docker logs -f cb-spider

Reset Metadata

# Reset all metadata (removes all registered clouds/resources)
sudo docker stop cb-spider && rm -rf ${HOME}/cb-spider/meta_db/*

---

Troubleshooting

Problem	Cause	Solution
Server won't start	Missing credentials	Set SPIDER_USERNAME and SPIDER_PASSWORD as environment variables
Container name conflict	Previous container not removed	sudo docker rm cb-spider then retry
Port conflict	Port 1024 in use	sudo lsof -i :1024 then stop the conflicting process

---

Initialize Meta Info

# 1. Stop server
sudo docker stop cb-spider

# 2. Remove metadata
rm -rf ${HOME}/cb-spider/meta_db/*

# 3. Start server again
sudo docker run ...

---