Connection Management Guide(KR) - cloud-barista/cb-spider GitHub Wiki

Connection Management Guide

Language: English | 한국어

1. CB-Spider Register Connection 개요

멀티클라우드 인프라를 제어하려면 먼저 대상 클라우드(CSP)의 연결 설정(Connection Configuration) 을 등록해야 합니다.
연결 설정 등록 후에는 등록 시 부여한 연결 이름(Connection Name) 을 이용하여 대상 클라우드에 연결 및 제어할 수 있습니다.
연결 설정 등록은 다음 4단계로 진행합니다:

┌───────────────────────────────────────────────────────────────┐
│              CB-Spider 연결 설정 등록                          │
│                                                               │
│  (1) Cloud Driver 등록                                        │
│       └── CSP 드라이버 플러그인 (예: aws-driver-v1.0.so)       │
│                                                               │
│  (2) Cloud Credential 등록                                    │
│       └── CSP 접속 키 (예: AccessKey, SecretKey)              │
│                                                               │
│  (3) Cloud Region/Zone 등록                                   │
│       └── 대상 리전 및 존 (예: us-east-2, us-east-2a)          │
│                                                               │
│  (4) Cloud Connection 등록                                    │
│       └── Driver + Credential + Region 조합                   │
│           → 모든 API 호출에 사용할 ConnectionName 생성         │
│                                                               │
│  ┌──────────┐  ┌─────────────┐  ┌────────────┐                │
│  │  Driver  │  │ Credential  │  │Region/Zone │                │
│  └────┬─────┘  └──────┬──────┘  └─────┬──────┘                │
│       └───────────────┼───────────────┘                       │
│                       ▼                                       │
│            ┌─────────────────────┐                            │
│            │  Connection Config  │                            │
│            │  (ConnectionName)   │                            │
│            └─────────────────────┘                            │
└───────────────────────────────────────────────────────────────┘

참고

(1), (2), (3) 단계는 순서에 관계없이 등록할 수 있습니다.

(4) 단계는 앞의 3가지 등록이 모두 완료된 후에 등록 가능합니다.

Credential 발급 방법은 How to get CSP Credentials를 참고하세요.

자동 일괄 등록이 필요한 경우 Default Connection Helper 도구를 참고하세요.

2. 사전 요구사항

CB-Spider 서버가 실행 중이어야 합니다.
- 참고: Docker-based Start Guide | Source-based Start Guide
API 확인을 위한 curl 및 jq (또는 json_pp) 설치
CSP Credential 준비 (예: AWS Access Key, GCP Service Account Key)

3. CB-Spider 연결 설정 API 명세

CB-Spider REST API를 통해 연결 설정을 등록 및 관리할 수 있습니다.

3.1 연결 설정 API 엔드포인트

# Cloud Driver
POST   /spider/driver                - Cloud Driver 등록
GET    /spider/driver                - Cloud Driver 목록 조회
GET    /spider/driver/{DriverName}   - Cloud Driver 조회
DELETE /spider/driver/{DriverName}   - Cloud Driver 삭제

# Cloud Credential
POST   /spider/credential                    - Cloud Credential 등록
GET    /spider/credential                    - Cloud Credential 목록 조회
GET    /spider/credential/{CredentialName}   - Cloud Credential 조회
DELETE /spider/credential/{CredentialName}   - Cloud Credential 삭제

# Cloud Region/Zone
POST   /spider/region                  - Cloud Region/Zone 등록
GET    /spider/region                  - Cloud Region 목록 조회
GET    /spider/region/{RegionName}     - Cloud Region 조회
DELETE /spider/region/{RegionName}     - Cloud Region 삭제

# Cloud Connection Config
POST   /spider/connectionconfig                - Cloud Connection 등록
GET    /spider/connectionconfig                - Cloud Connection 목록 조회
GET    /spider/connectionconfig/{ConfigName}   - Cloud Connection 조회
DELETE /spider/connectionconfig/{ConfigName}   - Cloud Connection 삭제

3.2 요청 파라미터

Cloud Driver 등록

파라미터	설명	예시
DriverName	드라이버 이름	`aws-driver01`
ProviderName	클라우드 제공자 이름	`AWS`, `GCP`, `AZURE`, `ALIBABA`
DriverLibFileName	드라이버 라이브러리 파일명	`aws-driver-v1.0.so`

Cloud Credential 등록

파라미터	설명	예시
CredentialName	Credential 이름	`aws-credential01`
ProviderName	클라우드 제공자 이름	`AWS`
KeyValueInfoList	Credential 키-값 쌍	아래 예시 참고

Cloud Region/Zone 등록

파라미터	설명	예시
RegionName	리전 이름	`aws-ohio`
ProviderName	클라우드 제공자 이름	`AWS`
KeyValueInfoList	리전/존 키-값 쌍	`Region: us-east-2, Zone: us-east-2a`

Cloud Connection 등록

파라미터	설명	예시
ConfigName	연결 설정 이름	`aws-ohio-config`
ProviderName	클라우드 제공자 이름	`AWS`
DriverName	등록한 드라이버 이름	`aws-driver01`
CredentialName	등록한 Credential 이름	`aws-credential01`
RegionName	등록한 리전 이름	`aws-ohio`

4. CB-Spider 연결 설정 API 사용 예시

다음은 AWS의 Ohio, Oregon 2개 리전에 대한 연결 설정 등록 예시입니다.

4.1 Cloud Driver 등록

curl -sX POST http://localhost:1024/spider/driver \
    -H 'Content-Type: application/json' \
    -d '{
        "DriverName": "aws-driver01",
        "ProviderName": "AWS",
        "DriverLibFileName": "aws-driver-v1.0.so"
    }' | json_pp

응답 예시:

{
   "DriverLibFileName" : "aws-driver-v1.0.so",
   "DriverName" : "aws-driver01",
   "ProviderName" : "AWS"
}

4.2 Cloud Credential 등록

XXXXXXXXXXXXXXXXXXXXXXX 부분을 실제 CSP에서 발급받은 정보로 교체하세요.

curl -sX POST http://localhost:1024/spider/credential \
    -H 'Content-Type: application/json' \
    -d '{
        "CredentialName": "aws-credential01",
        "ProviderName": "AWS",
        "KeyValueInfoList": [
            {"Key": "aws_access_key_id", "Value": "XXXXXXXXXXXXXXXXXXXXXXX"},
            {"Key": "aws_secret_access_key", "Value": "XXXXXXXXXXXXXXXXXXXXXXX"}
        ]
    }' | json_pp

응답 예시:

{
   "CredentialName" : "aws-credential01",
   "KeyValueInfoList" : [
      {
         "Key" : "ClientId",
         "Value" : "XXXXXXXXXXXXXXXXXXXXXXX"
      },
      {
         "Key" : "ClientSecret",
         "Value" : "XXXXXXXXXXXXXXXXXXXXXXX"
      }
   ],
   "ProviderName" : "AWS"
}

4.3 Cloud Region/Zone 등록

팁: 등록할 Region 이름(값)을 확인하려면 Region/Zone Info Guide의 연결 설정 전 API를 활용하세요. 예: GET /spider/preconfig/regionzone?DriverName=aws-driver01&CredentialName=aws-credential01

여러 리전/존을 한 번에 등록하는 예시 (AWS Ohio, Oregon):

regions=("aws-ohio:us-east-2:us-east-2a"
         "aws-oregon:us-west-2:us-west-2a")

for region in "${regions[@]}"; do
    IFS=":" read -r RegionName Region Zone <<< "$region"
    curl -sX POST http://localhost:1024/spider/region \
        -H 'Content-Type: application/json' \
        -d '{
            "RegionName": "'$RegionName'",
            "ProviderName": "AWS",
            "KeyValueInfoList": [
                {"Key": "Region", "Value": "'$Region'"},
                {"Key": "Zone", "Value": "'$Zone'"}
            ]
        }' | json_pp
done

응답 예시:

{
   "AvailableZoneList" : null,
   "KeyValueInfoList" : [
      {
         "Key" : "Region",
         "Value" : "us-east-2"
      },
      {
         "Key" : "Zone",
         "Value" : "us-east-2a"
      }
   ],
   "ProviderName" : "AWS",
   "RegionName" : "aws-ohio"
}

4.4 Cloud Connection 등록

앞에서 등록한 드라이버, Credential, 리전을 조합하여 연결 설정을 등록합니다:

configs=("aws-ohio-config:aws-ohio"
         "aws-oregon-config:aws-oregon")

for config in "${configs[@]}"; do
    IFS=":" read -r ConfigName RegionName <<< "$config"
    curl -sX POST http://localhost:1024/spider/connectionconfig \
        -H 'Content-Type: application/json' \
        -d '{
            "ConfigName": "'$ConfigName'",
            "ProviderName": "AWS",
            "DriverName": "aws-driver01",
            "CredentialName": "aws-credential01",
            "RegionName": "'$RegionName'"
        }' | json_pp
done

응답 예시:

{
   "ConfigName" : "aws-ohio-config",
   "CredentialName" : "aws-credential01",
   "DriverName" : "aws-driver01",
   "ProviderName" : "AWS",
   "RegionName" : "aws-ohio"
}
{
   "ConfigName" : "aws-oregon-config",
   "CredentialName" : "aws-credential01",
   "DriverName" : "aws-driver01",
   "ProviderName" : "AWS",
   "RegionName" : "aws-oregon"
}

5. CSP별 Credential 키 이름

각 CSP에 필요한 Credential 키 이름을 조회할 수 있습니다:

# 예시: AWS의 Credential 키 이름 확인
curl -sX GET http://localhost:1024/spider/cloudos/metainfo/AWS \
    -H 'Content-Type: application/json' | json_pp

CSP	타입	키 이름
AWS	Spider 타입	`ClientId`, `ClientSecret`
AWS	CSP 타입	`aws_access_key_id`, `aws_secret_access_key`
GCP	Spider 타입	`ClientEmail`, `ProjectID`, `PrivateKey`
Azure	Spider 타입	`ClientId`, `ClientSecret`, `TenantId`, `SubscriptionId`
Alibaba	Spider 타입	`ClientId`, `ClientSecret`

참고

Spider 타입과 CSP 타입 Credential 키 모두 지원됩니다.

전체 CSP의 키 이름은 MetaInfo API로 확인 가능합니다: GET /spider/cloudos/metainfo/{CSP이름}

각 CSP에서 Credential을 발급받는 방법은 How to get CSP Credentials를 참고하세요.

6. 등록된 연결 설정 확인

등록 후 연결 설정을 확인합니다:

# 등록된 전체 연결 설정 목록 조회
curl -sX GET http://localhost:1024/spider/connectionconfig | json_pp

# 특정 연결 설정 조회
curl -sX GET http://localhost:1024/spider/connectionconfig/aws-ohio-config | json_pp

7. API 응답 코드

HTTP 상태 코드	설명
200 OK	요청 성공
400 Bad Request	잘못된 요청 (필수 파라미터 누락 등)
404 Not Found	대상 리소스를 찾을 수 없음
500 Internal Server Error	서버 내부 오류

Connection Management Guide(KR) - cloud-barista/cb-spider GitHub Wiki

Connection Management Guide

1. CB-Spider Register Connection 개요

2. 사전 요구사항

3. CB-Spider 연결 설정 API 명세

3.1 연결 설정 API 엔드포인트

3.2 요청 파라미터

4. CB-Spider 연결 설정 API 사용 예시

4.1 Cloud Driver 등록

4.2 Cloud Credential 등록

4.3 Cloud Region/Zone 등록

4.4 Cloud Connection 등록

5. CSP별 Credential 키 이름

6. 등록된 연결 설정 확인

7. API 응답 코드

8. 참고 자료