Skip to content

cloud-barista/cb-spider

CB-Spider : "One-Code, Multi-Cloud"

A unified framework for multi-cloud infrastructure control

Go Version License Release Docs Swagger

CB-Spider Architecture


  • CB-Spider is a sub-framework of the Cloud-Barista Multi-Cloud Platform.
  • CB-Spider provides a single unified API for multi-cloud infrastructure control.
  • CB-Spider enables write once, run on any cloud.

[NOTE]
CB-Spider is currently under development and has not yet reached version 1.0.
We welcome suggestions, issues, feedback, and contributions!
Please be aware that the functionalities of Cloud-Barista are not yet stable or secure.
Exercise caution if you plan to use the current release in a production environment.
If you encounter any difficulties while using Cloud-Barista, please let us know.
(You can open an issue or join the Cloud-Barista Slack community.)

Key Features

  • Unified API — One consistent REST API for all supported CSPs
  • Multi-Cloud Abstraction — VPC, VM, Disk, NLB, Kubernetes, Object Storage and more
  • Dynamic Plugin Drivers — Extensible cloud driver architecture with hot-plugin
  • AdminWeb & CLI — Built-in web console and spctl CLI tool
  • Swagger API Docs — Auto-generated, always up-to-date API documentation

Supported Cloud Providers

Provider VM Price
Info
Region/Zone
Info
Image
Info
VMSpec
Info
VPC
Subnet
Security
Group
VM KeyPair VM Disk MyImage NLB K8S Object
Storage
AWS O O O O O O O O O O O O O
Azure O O O O O O O O O O O O WIP
GCP O O O O O O O O O O O O O
Alibaba O O O O O O O O O O O O O
Tencent O O O O O O O O O O O O O
IBM O O O O O O O O O O O O O
OpenStack NA O O O O O O O O O O TBD O
NCP O O O O O O O O O O O O O
NHN NA O O O O O O O
(Note1)
O O O O O
KT NA O O O O
(Type1)
O O O O O O
(Note2)
TBD O
KT Classic NA O O O O
(Type2)
O O O O O O NA -

※ WIP: Work In Progress, NA: Not Applicable, -: Excluded (Classic Resource)

Provider-specific Notes

VPC Notes (see each driver's README for details):

  • Type1: Default VPC (KT VPC)

    • CSP: Provides one fixed default VPC only
    • CB-Spider: Only one VPC can be created (for abstraction)
  • Type2: VPC/Subnet Emulation

    • CSP: No VPC concept provided
    • CB-Spider: Provides single emulated VPC/Subnet

VM Notes:

  • Note1: For Windows VMs, after creating a VM with SSH key, the password must be checked in Console.

NLB Notes:

  • Note2: VMs registered to NLB must be in the same Subnet as the NLB.

Quick Start

The Quick Start Guide walks you through the following steps:

  1. Start CB-Spider server — Run with a single Docker command
  2. Set cloud credentials — Register your AWS / GCP access keys
  3. Register cloud connections — Configure driver, credential, region, and connection
  4. Create infrastructure — Create VPC, Security Group, KeyPair, and VM with unified API calls
  5. Multi-cloud verification — Query both clouds with the same API, only ConnectionName changes
  6. Cleanup — Terminate VMs and delete resources

Start methods: Docker Guide | Source Guide | Authentication Guide


Documentation

Getting Started

Guide Description
Quick Start Guide Start server & create VMs on AWS + GCP in minutes
Docker-based Start Guide Run CB-Spider using Docker
Source-based Start Guide Build and run from source
How to get CSP Credentials Obtain credentials for each cloud provider

API & Tools

Resource Link
Swagger API Docs Swagger UI · Swagger Guide
AdminWeb AdminWeb Guide
CLI (spctl) CLI Tool Guide
Driver Capability Info Capability Info Guide
Function Menu CB-Spider Menu
MetaDB Auto Backup Backup Guide

Resource Management Guides

Resource Guide
Register Connection Register Connection Guide
Region/Zone Info Region/Zone Info Guide
Quota Info Quota Info Guide
VM Price Info VM Price Info Guide
VM Image Info Public Image Info Guide
VM Spec Info VM Spec Info Guide
VPC/Subnet VPC/Subnet Management Guide
Security Group SecurityGroup Management Guide
KeyPair KeyPair Management Guide
VM VM Management Guide
Disk Disk Management Guide
NLB Network Load Balancer Guide
Kubernetes Cluster K8S Cluster Management Guide
Object Storage (S3) Object Storage and S3 API Guide
Tag Management Tag Management Guide

VM default accounts: Ubuntu/Debian → cb-user · Windows → Administrator

📖 Full documentation: CB-Spider Wiki


Contributing

We welcome contributions! Please read CONTRIBUTING.md before submitting a pull request.


License

CB-Spider is licensed under the Apache License 2.0.