Support M-CMP scenario (how to use APIs)

[seokho-son]

M-CMP 시나리오에 관련된 API 및 사용 방법 요약

• CB-TB 버전: v0.9.18
  • 관련 컴포넌트 버전: https://github.com/cloud-barista/cb-tumblebug/blob/v0.9.18/docker-compose.yaml
• CB-TB API: https://cloud-barista.github.io/api/?url=https://raw.githubusercontent.com/cloud-barista/cb-tumblebug/v0.9.18/src/api/rest/docs/swagger.yaml

Credential 등록

• 가이드: Secure Credential Registration Guide (How to use the credential APIs) #1773

(init.sh 를 통해 시스템 초기화 수행시에는 활용 필요 없음)

Assets (spec, image) 등록

• GET /loadAssets (Load Common Resources from internal asset files)

(init.sh 를 통해 시스템 초기화 수행시에는 활용 필요 없음)

MCI 생성/조회/활용/종료/자원정리 관련

• 가이드: Quick provisioning using mciDynamic #1570
• 가이드: How to use ​/mciRecommendVm #1234
• 네트워크 리소스 관리 관련 정비 및 추가 사항 참고
  • vNet/Subnet 제어(CRUD), 검증 및 상태 관리, Zone 지정하여 Subnet 생성, 설계/검증 기능 등
    • 참고: CSP 네트워크 특성에 따라, Zone지정하여 Subnet을 생성하는 기능은 AWS에서 유의미한 상황
    • vNet/Subnet APIs: https://cloud-barista.github.io/api/?url=https://converter.swagger.io/api/convert?url=https://raw.githubusercontent.com/cloud-barista/cb-tumblebug/main/src/api/rest/docs/swagger.json#/%5BInfra%20Resource%5D%20Network%20Management
    • 참고: 향후 CB-SP v0.9.6+ 신규 버전 연동 이후, 추가 개선 예정 있음 (Test result of the enhanced network features #1783 및 A network structure in Multi-Cloud Infrastructure #1749 를 통해 가이드 예정)

Label 및 LabelSelector를 통한 자유로운 정보 조회

• 가이드: How to use Label and LabelSelector #1803

K8s 클러스터 생성/조회/활용/종료 관련

• 가이드: How to create and manage a K8sCluster (kubernetes cluster) #1614

기존 CSP 자원, CB-TB에 등록 기능

• POST /registerCspResources
  Register CSP Native Resources (vNet, securityGroup, sshKey, vm) to CB-Tumblebug

  요청 및 응답 예시 (option=exceptVm)

  {
    "connectionName": "aws-ap-southeast-1",
    "mciName": "csp",
    "nsId": "ns01"
  }
  

  {
    "connectionName": "aws-ap-southeast-1",
    "systemMessage": "",
    "elapsedTime": 17,
    "registerationOverview": {
      "vNet": 13,
      "securityGroup": 28,
      "sshKey": 24,
      "dataDisk": 2,
      "customImage": 0,
      "vm": 0,
      "nlb": 0,
      "failed": 0
    },
    "registerationOutputs": {
      "output": [
        "vNet: aws-ap-southeast-1-vpc-0757c665436c8f276",
        "vNet: aws-ap-southeast-1-vpc-01898d54949ed51eb",
        "vNet: aws-ap-southeast-1-vpc-03e4610d8a4e151e7",
        "vNet: aws-ap-southeast-1-vpc-0a98d73db5104ce20",
        "vNet: aws-ap-southeast-1-vpc-068ba0241619a6552",
        "vNet: aws-ap-southeast-1-vpc-028e341099ab9615b",
        "vNet: aws-ap-southeast-1-vpc-0a3f50515e12e5ea7",
        "vNet: aws-ap-southeast-1-vpc-0d176bed02b54c4a4",
        "vNet: aws-ap-southeast-1-vpc-049e173cfe142322e",
        "vNet: aws-ap-southeast-1-vpc-031f3b02839cfdcaf",
        "vNet: aws-ap-southeast-1-vpc-e4f4d483",
        "vNet: aws-ap-southeast-1-vpc-0f5c4a299ef3e63ee",
        "vNet: aws-ap-southeast-1-vpc-0dbc2796370f73912",
        "securityGroup: aws-ap-southeast-1-sg-04b6eb9d7671f6eae",
        "securityGroup: aws-ap-southeast-1-sg-0f5fb44e63da68a2f",
        "securityGroup: aws-ap-southeast-1-sg-0487c0d85ed0c2046",
        "securityGroup: aws-ap-southeast-1-sg-03d318e3ef10a9e68",
        "securityGroup: aws-ap-southeast-1-sg-0ee7ae20fa0a6f573",
        "securityGroup: aws-ap-southeast-1-sg-06dd8d3372c00ada2",
        "securityGroup: aws-ap-southeast-1-sg-0444f62b12008e73b",
        "securityGroup: aws-ap-southeast-1-sg-01c186f216976d971",
        "securityGroup: aws-ap-southeast-1-sg-0611c0e4a54e986f8",
        "securityGroup: aws-ap-southeast-1-sg-0d025dcc942a6f211",
        "securityGroup: aws-ap-southeast-1-sg-0e07636d460f0bd8d",
        "securityGroup: aws-ap-southeast-1-sg-05101dae8cbd1ea9a",
        "securityGroup: aws-ap-southeast-1-sg-067beae73318637eb",
        "securityGroup: aws-ap-southeast-1-sg-0f536f3cb6acb4e34",
        "securityGroup: aws-ap-southeast-1-sg-07ecb635feddc3fc2",
        "securityGroup: aws-ap-southeast-1-sg-0c2f47a5c0a858c62",
        "securityGroup: aws-ap-southeast-1-sg-0412cf2738ddae9f4",
        "securityGroup: aws-ap-southeast-1-sg-06bbb9140d82b2c48",
        "securityGroup: aws-ap-southeast-1-sg-0a4a63bfd377b380a",
        "securityGroup: aws-ap-southeast-1-sg-b0c220cb",
        "securityGroup: aws-ap-southeast-1-sg-0fe660440ae781686",
        "securityGroup: aws-ap-southeast-1-sg-091258ba8927d10af",
        "securityGroup: aws-ap-southeast-1-sg-0feffc5f6d0254c6e",
        "securityGroup: aws-ap-southeast-1-sg-08d70e351cd3c22dd",
        "securityGroup: aws-ap-southeast-1-sg-0387c1df92db74a8c",
        "securityGroup: aws-ap-southeast-1-sg-0d320bce454968075",
        "securityGroup: aws-ap-southeast-1-sg-0442ac0f6ef8f523a",
        "securityGroup: aws-ap-southeast-1-sg-05d08d319497c092d",
        "sshKey: aws-ap-southeast-1-kimy-aws-singapore",
        "sshKey: aws-ap-southeast-1-ns01-aws-ap-southeast-1-yk1net-c9kiqgkb8khu9chfogn0",
        "sshKey: aws-ap-southeast-1-etcd-host-aws",
        "sshKey: aws-ap-southeast-1-ns01-aws-ap-southeast-1-yk0-c91rqbatiahu4g621ju0",
        "sshKey: aws-ap-southeast-1-sjh-aws-ap-southeast-1-jhseo-cb8gk9t6qs8fec6qe6bg",
        "sshKey: aws-ap-southeast-1-kimy-aws",
        "sshKey: aws-ap-southeast-1-ns01-aws-c6ff8u0vn0pcottrchpg",
        "sshKey: aws-ap-southeast-1-k8s-test-kimy-aws",
        "sshKey: aws-ap-southeast-1-ns01-aws-ap-southeast-1-net01perf-caao306mdlvelo0f4ob0",
        "sshKey: aws-ap-southeast-1-ns01-aws-c6d37c67p30lpq4g91r0",
        "sshKey: aws-ap-southeast-1-jhseo-220825",
        "sshKey: aws-ap-southeast-1-kimy-agent-aws",
        "sshKey: aws-ap-southeast-1-ns01-aws-c9fsnmcdss6vnm1747s0",
        "sshKey: aws-ap-southeast-1-ns01-aws-c8t767g9ih7nmfkhoctg",
        "sshKey: aws-ap-southeast-1-barista-a-c6benp0vn0pblsmh8vg0",
        "sshKey: aws-ap-southeast-1-ns01-aws-ap-southeast-1-shson02-caumci0rjs5on74e30pg",
        "sshKey: aws-ap-southeast-1-aws-ap-se-1-pcyk03",
        "sshKey: aws-ap-southeast-1-ns01-aws-ap-southeast-1-yk01perf-c9tmmorcp5hm4p4munt0",
        "sshKey: aws-ap-southeast-1-csp-key-shson",
        "sshKey: aws-ap-southeast-1-e1-aws-ap-c5psb8t43424jhjo3980",
        "sshKey: aws-ap-southeast-1-ns01-aws-c6g1ao0vn0pcottrcjng",
        "sshKey: aws-ap-southeast-1-e1-aws-ap-c6au8i5434207t772j70",
        "sshKey: aws-ap-southeast-1-aws-ap-southeast-1",
        "sshKey: aws-ap-southeast-1-kimy-aws-agent",
        "dataDisk: aws-ap-southeast-1-vol-04bba3429cb6d14ff",
        "dataDisk: aws-ap-southeast-1-vol-0e7a05407cfe93ee3"
      ]
    }
  }
  

• POST /registerCspResourcesAll
  Register CSP Native Resources (vNet, securityGroup, sshKey, vm) from all Clouds to CB-Tumblebug

• GET /inspectResourcesOverview
  Inspect Resources Overview (vNet, securityGroup, sshKey, vm) registered in CB-Tumblebug and CSP for all connections

(주의: 해당 API들은 WIP로, 시간 소요, 오류 발생 등 이슈가 있을 수 있으므로, 테스트는 CB-TB에 직접 등록한 자원 없이 깔끔한 상태에서 진행하고, 자원 정보가 정상적이지 않으면 DB 초기화 필요. 또한 등록을 해제하는 기능이 일부만 구현되어 있음을 참고.)