Skip to content

Commit

Permalink
[Enhance] Make and Swagger Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
niconicodex committed Dec 18, 2023
1 parent aa4b648 commit 5d1bcb6
Showing 1 changed file with 48 additions and 1 deletion.
49 changes: 48 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,51 @@ Collecting and Aggregating Information From Source Computing framework (codename
```
- Windows
- Run cm-honeybee.exe
- Click Yes when UAC window is appears.
- Click Yes when UAC window is appears.

#### Download source code

Clone CM-Honeybee repository

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

#### Build CM-Honeybee

Build CM-Honeybee source code

```bash
cd ${HOME}/cm-honeybee
make build
```

(Optional) Update Swagger API document
```bash
cd ${HOME}/cm-honeybee
make swag
```

Access to Swagger UI
(Default link) http://localhost:8056/beetle/swagger/index.html

#### Run CM-Honeybee binary

Run CM-Honeybee server

```bash
cd ${HOME}/cm-honeybee
make build
./cm-honeybee
```

#### Health-check CM-Honeybee

Check if CM-Honeybee is running

```bash
curl http://localhost:8056/honeybee/health
# Output if it's running successfully
# {"message":"CM-Honeybee API server is running"}
```

0 comments on commit 5d1bcb6

Please sign in to comment.