[Manual] Honeybee 주요 API 사용 방법

[ish-hcc]

빌드 후 실행 가이드는 아래 문서를 참고해 주세요

https://github.com/cloud-barista/cm-honeybee/blob/main/README.md

Honeybee Server 주요 API 사용 방법

1. Source Group 등록 하기 (Source 접속 정보들을 등록할 그룹 생성)

Source Group을 등록하고, 등록된 Source Group ID 인 sgID 를 확인합니다.

• Request

curl -X 'POST' \
  'http://127.0.0.1:8081/honeybee/source_group' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "test migration group",
  "name": "test-group"
}'

• Reply

{
 "id": "b9e86d53-9fbe-4a96-9e06-627f77fdd6b7",
 "name": "test-group",
 "description": "test migration group",
  "connection_info_status_count": {
    "count_connection_success": 0,
    "count_connection_failed": 0,
    "count_agent_success": 0,
    "count_agent_failed": 0,
    "connection_info_total": 0
  }
}

또는 아래와 같이 Source Group을 등록하면서 다수의 Source 접속 정보(Connectino Info)들을 동시에 입력할 수도 있습니다.
이때 등록된 Source 접속(Connectino Info)들에 대해서 Agent가 자동으로 설치됩니다.

• Request

curl -X 'POST' \
  'http://127.0.0.1:8081/honeybee/source_group' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "connection_info": [
    {
      "description": "NFS Server",
      "ip_address": "172.16.0.123",
      "name": "cm-nfs",
      "password": "some_pass",
      "private_key": "-----BEGIN RSA PRIVATE KEY-----\n******\n-----END RSA PRIVATE KEY-----",
      "ssh_port": "22",
      "user": "ubuntu"
    },
    {
      "description": "Web Server",
      "ip_address": "172.16.0.124",
      "name": "cm-web",
      "password": "some_pass",
      "private_key": "-----BEGIN RSA PRIVATE KEY-----\n******\n-----END RSA PRIVATE KEY-----",
      "ssh_port": "22",
      "user": "ubuntu"
    }
  ],
  "description": "test migration group",
  "name": "test-group"
}'

• Reply

{
 "id": "b9e86d53-9fbe-4a96-9e06-627f77fdd6b7",
 "name": "test-group",
 "description": "test migration group",
  "connection_info_status_count": {
    "count_connection_success": 2,
    "count_connection_failed": 0,
    "count_agent_success": 2,
    "count_agent_failed": 0,
    "connection_info_total": 0
  }
}

2. Connection Info 등록 하기 (Source Group에 Source 접속 정보들을 등록)

Source 접속 정보들을 Source Group에 등록합니다.
접속 정보(Connectino Info)들을 등록하면 Agent가 자동으로 설치됩니다.

• Request

curl -X 'POST' \
 'http://127.0.0.1:8081/honeybee/source_group/b9e86d53-9fbe-4a96-9e06-627f77fdd6b7/connection_info' \
 -H 'accept: application/json' \
 -H 'Content-Type: application/json' \
 -d '{ "description": "NFS Server", "ip_address": "172.16.0.123", "name": "cm-nfs", "password": "some_pass", "private_key": "-----BEGIN RSA PRIVATE KEY-----\n******\n-----END RSA PRIVATE KEY-----", "ssh_port": 22, "user": "ubuntu" }'

• Reply

{
  "id": "2f678139-e6e6-43e8-9722-33b834efc563",
  "name": "cm-nfs",
  "description": "NFS Server",
  "source_group_id": "b9e86d53-9fbe-4a96-9e06-627f77fdd6b7",
  "ip_address": "172.16.0.123",
  "ssh_port": "XXXXXXXX...=",
  "user": "XXXXXXXX...=",
  "password": "XXXXXXXX...=",
  "private_key": "XXXXXXXX...=",
  "public_key": "",
  "connection_status": "success",
  "connection_failed_message": "",
  "agent_status": "success",
  "agent_failed_message": ""
}

3. 현재 상태의 Source Group 정보 수집 하기

아래 예제는 Source Group의 Infra 정보를 수집하는 예시입니다.
Source Group에 등록 된 모든 Connectino Info 들의 Infra 정보를 수집합니다.

curl -X 'POST' \
 'http://127.0.0.1:8081/honeybee/source_group/b9e86d53-9fbe-4a96-9e06-627f77fdd6b7/import/infra' \
 -H 'accept: application/json'

Infra 정보 외에 Software, Kubernetes, Helm 정보를 다음과 같이 수집할 수 있습니다.

• Software: POST http://127.0.0.1:8081/honeybee/source_group/{SourceGroupID}/import/software
• Kubernetes: POST http://127.0.0.1:8081/honeybee/source_group/{SourceGroupID}/import/kubernetes
• Helm: POST http://127.0.0.1:8081/honeybee/source_group/{SourceGroupID}/import/helm

4. 수집된 Source Group 정보 조회하기 (수집된 Raw한 데이터 조회)

아래 예제는 Source Group의 수집 된 Infra 정보를 조회하는 예시입니다.
Source Group에 등록 된 모든 Connectino Info 들의 수집 된 Infra 정보를 조회합니다.

curl -X 'GET' \
 'http://127.0.0.1:8081/honeybee/source_group/b9e86d53-9fbe-4a96-9e06-627f77fdd6b7/infra' \
 -H 'accept: application/json'

Infra 정보 외에 Software, Kubernetes, Helm 정보를 다음과 같이 조회할 수 있습니다.

• Software: GET http://127.0.0.1:8081/honeybee/source_group/{SourceGroupID}/software
• Kubernetes: GET http://127.0.0.1:8081/honeybee/source_group/{SourceGroupID}/kubernetes
• Helm: GET http://127.0.0.1:8081/honeybee/source_group/{SourceGroupID}/helm

5. 수집된 데이터를 기반으로 정제된 Source Group 정보 조회하기 (수집된 데이터를 기반으로 정리된 데이터 조회)

아래 예제는 Source Group의 수집 된 Infra 정보를 기반으로 정제된 데이터를 조회하는 예시입니다.
Source Group에 등록 된 모든 Connectino Info 들의 수집 된 데이터를 기반으로 정제된 Infra 정보를 조회합니다.

curl -X 'GET' \
 'http://127.0.0.1:8081/honeybee/source_group/b9e86d53-9fbe-4a96-9e06-627f77fdd6b7/infra/refined' \
 -H 'accept: application/json'

Firewall 수집 테스트를 위한 스크립트

https://github.com/cloud-barista/cm-honeybee/blob/main/agent/scripts/firewall_test_script.sh