diff --git a/README.md b/README.md index 6c83303..68ed22a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Computing Infrastructure Migration Model This repository provides computing infrastructure migration features. -This is a sub-system of [Cloud-Barista platform](https://github.com/cloud-barista/docs), and intended to deploy a multi-cloud infra as a target computing infrastructure. +This is a sub-system of [Cloud-Barista platform](https://cloud-barista.github.io/technology/), and intended to deploy a multi-cloud infra as a target computing infrastructure. ## Overview @@ -14,13 +14,11 @@ As a Cloud Computing Infrastructure Migration Framework (codename: cm-damselply) - Operating system (OS): - Ubuntu 22.04 - Languages: - - Go: 1.23.0 + - Go 1.23.0 ## How to run CM-Damselfly -### Source code based installation and execution - -#### Configure build environment +### Configure build environment 1. Install dependencies @@ -34,8 +32,7 @@ sudo apt install make gcc git ``` 2. Install Go -Note - **Install the stable version of Go**. -For example, install Go v1.23.0 +**_NOTE :_** Install the stable version of Go. For example, Go v1.23.0 ```bash # Set Go version @@ -61,14 +58,14 @@ go version ``` -#### Download the source code +### Download the source code ```bash # Clone CM-Damselfly repository git clone https://github.com/cloud-barista/cm-damselfly.git ${HOME}/cm-damselfly ``` -#### Build and Run with docker compose +### Build and Run with docker compose - Open ubuntu firewall TCP 8088 port on the system to access to the API(If need) ```bash sudo ufw allow 8088/tcp @@ -109,25 +106,27 @@ cd [DAMSELFLY_ROOT] sudo make compose-up ``` -#### Default API URL and File Path +### Default REST API URL and DB/log file path - Swagger API URL
- http://localhost:8088/damselfly/api (username: default / password: default) - Swagger web UI URL
- https://cloud-barista.github.io/api/?url=https://raw.githubusercontent.com/cloud-barista/cm-damselfly/refs/heads/main/api/swagger.yaml -- Default DB file path (The user migration model is stored to K/V DB as a file in the following location.) +- Default DB file path (The created and updated user migration models are stored to K/V DB as a file in the following location.) - ./cm-damselfly/cmd/cm-damselfly/db/damselfly.db - Default log file path - ./cm-damselfly/cmd/cm-damselfly/log/damselfly.log -#### Versions of packages applied to the released Damselfly +### Versions of packages applied to the released Damselfly | cm-damselfly | cm-model
(OnpremInfraModel) | cb-tumblebug
(CloudInfraModel) | |--------|--------|--------| | v0.2.0 | v0.0.3 | v0.9.16 | | v0.2.1 | v0.0.3 | v0.10.0 | +| v0.2.2 | v0.0.3 | v0.10.0 | +| v0.3.0 | v0.0.3 | v0.10.3 | -#### CM-Damselfly APIs user guide +### CM-Damselfly REST API user guide - Discussion link : [How to use and test CM-Damselfly APIs (with test examples)](https://github.com/cloud-barista/cm-damselfly/discussions/25) diff --git a/docker-compose.yaml b/docker-compose.yaml index 8b809dc..cfff516 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -1,6 +1,6 @@ services: cm-damselfly: - image: cloudbaristaorg/cm-damselfly:0.2.2 + image: cloudbaristaorg/cm-damselfly:0.3.0 container_name: cm-damselfly pull_policy: missing restart: always diff --git a/go.mod b/go.mod index 3976cfa..320f10e 100644 --- a/go.mod +++ b/go.mod @@ -3,7 +3,7 @@ module github.com/cloud-barista/cm-damselfly go 1.23.0 require ( - github.com/cloud-barista/cb-tumblebug v0.10.0 + github.com/cloud-barista/cb-tumblebug v0.10.3 github.com/cloud-barista/cm-model v0.0.3 github.com/fsnotify/fsnotify v1.7.0 github.com/labstack/echo/v4 v4.12.0 diff --git a/go.sum b/go.sum index 3d188ff..8dce16f 100644 --- a/go.sum +++ b/go.sum @@ -13,8 +13,8 @@ github.com/Masterminds/semver/v3 v3.1.1/go.mod h1:VPu/7SZ7ePZ3QOrcuXROw5FAcLl4a0 github.com/chzyer/logex v1.2.0/go.mod h1:9+9sk7u7pGNWYMkh0hdiL++6OeibzJccyQU4p4MedaY= github.com/chzyer/readline v1.5.0/go.mod h1:x22KAscuvRqlLoK9CsoYsmxoXZMMFVyOl86cAH8qUic= github.com/chzyer/test v0.0.0-20210722231415-061457976a23/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU= -github.com/cloud-barista/cb-tumblebug v0.10.0 h1:WpdwVaDrfsIrTrNl3SlV6ncY97Ekp0goYorVDTNjd28= -github.com/cloud-barista/cb-tumblebug v0.10.0/go.mod h1:G5U23uALL84Qu2N7qpQJmZQ+2wBrh7rhV0WKk1weGZE= +github.com/cloud-barista/cb-tumblebug v0.10.3 h1:a7toSyzDIb7/4/TSSpf1bZaU+bAjNRhwZZjLNO8WKOo= +github.com/cloud-barista/cb-tumblebug v0.10.3/go.mod h1:fey4X6GLmN+6Wfbz5BiV/ZmuCNy7KYeem6oy55641mY= github.com/cloud-barista/cm-model v0.0.3 h1:sYowqaUMw77j2Hmz8nt/pjEA6lfMkGkZ31jNDDPN0Tk= github.com/cloud-barista/cm-model v0.0.3/go.mod h1:gSuMhQxD813KIdSvkp8uGptYOeyDik749sYcICZjhj8= github.com/cockroachdb/apd v1.1.0/go.mod h1:8Sl8LxpKi29FqWXR16WEFZRNSz3SoPzUzeMeY4+DwBQ= diff --git a/go.work.sum b/go.work.sum index 70dac23..a0e958c 100644 --- a/go.work.sum +++ b/go.work.sum @@ -10,6 +10,7 @@ github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578/go.mod h1:uGdko github.com/armon/go-metrics v0.4.1/go.mod h1:E6amYzXo6aW1tqzoZGT755KkbgrJsSdpwZ+3JqfkOG4= github.com/cloud-barista/mc-terrarium v0.0.7/go.mod h1:qey9GFrJidyJ3tVfeL/gcImgWLqsF64j/fVmBfaddDI= github.com/cloud-barista/mc-terrarium v0.0.10/go.mod h1:iQxZNRa04d7mHA0h5dEPfF7ch1SBUS/ZFGUynKsKJ6I= +github.com/cloud-barista/mc-terrarium v0.0.18/go.mod h1:iQxZNRa04d7mHA0h5dEPfF7ch1SBUS/ZFGUynKsKJ6I= github.com/coreos/go-semver v0.3.1/go.mod h1:irMmmIw/7yzSRPWryHsK7EYSg09caPQL03VsM8rvUec= github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU= github.com/decred/dcrd/dcrec/secp256k1/v4 v4.3.0/go.mod h1:v57UDF4pDQJcEfFUCRop3lJL149eHGSe9Jvczhzjo/0= @@ -24,6 +25,7 @@ github.com/go-playground/validator/v10 v10.17.0/go.mod h1:9iXMNT7sEkjXb0I+enO7QX github.com/go-resty/resty/v2 v2.13.1/go.mod h1:GznXlLxkq6Nh4sU59rPmUw3VtgpO3aS96ORAI6Q7d+0= github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q= github.com/golang-jwt/jwt/v4 v4.5.0/go.mod h1:m21LjoU+eqJr34lmDMbreY2eSTRJ1cv77w39/MY0Ch0= +github.com/golang-jwt/jwt/v4 v4.5.1/go.mod h1:m21LjoU+eqJr34lmDMbreY2eSTRJ1cv77w39/MY0Ch0= github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= github.com/golang/protobuf v1.5.3/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY= github.com/google/s2a-go v0.1.7/go.mod h1:50CgR4k1jNlWBu4UfS4AcfhVe1r6pdZPygJ3R8F0Qdw=