cb-ladybug

README

CB-Ladybug 🪲

Multi-Cloud Application Management Framework

[NOTE]
CB-Ladybug is currently under development. (the latest release is 0.3.0 espresso)
So, we do not recommend using the current release in production.
Please note that the functionalities of CB-Ladybug are not stable and secure yet.
If you have any difficulties in using CB-Ladybug, please let us know.
(Open an issue or Join the cloud-barista Slack)

Getting started

Preparation

• Golang 1.16.+ (Download and install)

Dependencies

• CB-Spider v0.3.0-espresso
• CB-Tumbluebug v0.3.0-espresso

Clone

$ git clone https://github.com/cloud-barista/cb-ladybug.git
$ cd cb-ladybug
$ go get -v all

Run

$ export CBLOG_ROOT="$(pwd)"
$ export CBSTORE_ROOT="$(pwd)"
$ go run src/main.go

Build and Execute

$ go build -o cb-ladybug src/main.go

$ export CBLOG_ROOT="$(pwd)"
$ export CBSTORE_ROOT="$(pwd)"
$ nohup ./cb-ladybug & > /dev/null

Test

$ curl -s  http://localhost:8080/ladybug/healthy -o /dev/null -w "code:%{http_code}"

code:200

API documentation (swagger)

• Execute or Run
• Open http://localhost:8080/swagger/index.html in your web browser

How to generate an updated swagger.yaml

$ go get -u github.com/swaggo/swag/cmd/swag

# in src/ folder
$ swag init

Documentation

• Design

Contribution

Learn how to start contribution on the Contributing Guideline and Style Guideline