Quick provisioning using mciDynamic

[seokho-son]

1) CB-TB의 MCI 동적 생성 방법

​POST /ns​/{nsId}​/mciDynamic 를 활용하면, 별도의 작업 없이 빠르게 클라우드 인프라 생성이 가능하다.

• 요청값은 상세하게 지정도 가능하지만, 꼭 필요한 항목은 아래와 같다.

{
  "name": "mci01",
  "vm": [
    {
      "commonImage": "aws+ap-northeast-2+ubuntu18.04",
      "commonSpec": "aws+ap-northeast-2+t2.small"
    }
  ]
}

• commonSpec 및 commonImage 는 provider+region+keyword 형태로 구성되며 init.sh 를 통해서 이미 오브젝트로 등록된 스펙 및 이미지를 입력할 수 있다.

• MCI Dynamic 을 통해서 MCI 를 생성하면, 내부적으로 공용 Network, SG, SSHKey 등이 생성됨 (내부적으로는 POST
  /ns/{nsId}/sharedResource를 활용)

commonSpec ID 획득 방법

• 각 VM 요구사항의 commonSpec ID를 조회하기 위해서는 POST /mciRecommendVm를 활용한다.

• mciRecommendVm를 통해서 VM Spec 을 조회하는 방법은 가이드를 통해서 확인할 수 있다.

예를 들어,

{
  "filter": {
    "policy": [
      {
        "condition": [
          {
            "operand": "4",
            "operator": "<="
          }
        ],
        "metric": "vCPU"
      }
    ]
  },
  "limit": "5",
  "priority": {
    "policy": [
      {
        "metric": "location",
        "parameter": [
          {
            "key": "coordinateClose",
            "val": [
              "44.146838/-116.411403"
            ]
          }
        ],
        "weight": "0.3"
      }
    ]
  }
}

로 요청하는 경우, 아래와 같이, 필터링 및 우선순위 처리된 리스트를 확인할 수 있다.

[
  {
    "namespace": "system-purpose-common-ns",
    "id": "gcp+us-west1+g2-standard-4",
    "name": "gcp+us-west1+g2-standard-4",
    "connectionName": "gcp-us-west1",
    "providerName": "gcp",
    "regionName": "us-west1",
    "cspSpecName": "g2-standard-4",
    "vCPU": 4,
    "memoryGiB": 16,
    "acceleratorModel": "NVIDIA L4",
    "acceleratorCount": 1,
    "acceleratorMemoryGB": 24,
    "acceleratorType": "gpu",
    "costPerHour": 0.0322,
    "orderInFilteredResult": 1,
    "evaluationScore01": 33.85,
    "evaluationScore02": 0,
    "evaluationScore03": 0,
    "evaluationScore04": 0,
    "evaluationScore05": 0,
    "evaluationScore06": 0,
    "evaluationScore07": 0,
    "evaluationScore08": 0,
    "evaluationScore09": 1,
    "evaluationScore10": 408.63455,
    "rootDiskType": "default",
    "rootDiskSize": "default"
  },
  {
    "namespace": "system-purpose-common-ns",
    "id": "gcp+us-west1+g1-small",
    "name": "gcp+us-west1+g1-small",
    "connectionName": "gcp-us-west1",
    "providerName": "gcp",
    "regionName": "us-west1",
    "cspSpecName": "g1-small",
    "vCPU": 1,
    "memoryGiB": 1.6992188,
    "costPerHour": 0.0322,
    "orderInFilteredResult": 1,
    "evaluationScore01": 34.07,
    "evaluationScore02": 0,
    "evaluationScore03": 0,
    "evaluationScore04": 0,
    "evaluationScore05": 0,
    "evaluationScore06": 0,
    "evaluationScore07": 0,
    "evaluationScore08": 0,
    "evaluationScore09": 1,
    "evaluationScore10": 408.63455,
    "rootDiskType": "default",
    "rootDiskSize": "default"
  },
  {

여기서, 원하는 spec의 ID를 선정하여 mciDynamic 요청문에 활용하면 된다.

commonImage ID 획득 방법

• ​POST /mciDynamicCheckRequest를 통해서 commonSpec를 선정했을 때, 가용한 commonImage를 찾을 수 있다.

예를 들어,

{
  "commonSpec": [
    "aws+ap-northeast-2+t2.small",
    "gcp+us-west1+g1-small"
  ]
}

를 입력하여 요청한 경우, 아래와 같은 응답을 받을 수 있으며,

details

{
  "reqCheck": [
    {
      "connectionConfigCandidates": [
        "aws-ap-northeast-2"
      ],
      "spec": {
        "namespace": "system-purpose-common-ns",
        "id": "aws+ap-northeast-2+t2.small",
        "name": "aws+ap-northeast-2+t2.small",
        "connectionName": "aws-ap-northeast-2",
        "providerName": "aws",
        "regionName": "ap-northeast-2",
        "cspSpecName": "t2.small",
        "vCPU": 1,
        "memoryGiB": 2,
        "costPerHour": 0.0288,
        "evaluationScore01": 59.57,
        "evaluationScore02": 0,
        "evaluationScore03": 0,
        "evaluationScore04": 0,
        "evaluationScore05": 0,
        "evaluationScore06": 0,
        "evaluationScore07": 0,
        "evaluationScore08": 0,
        "evaluationScore09": 0,
        "evaluationScore10": 0,
        "rootDiskType": "default",
        "rootDiskSize": "default"
      },
      "image": [
        {
          "namespace": "system-purpose-common-ns",
          "id": "aws+ap-northeast-2+ubuntu22.04",
          "name": "aws+ap-northeast-2+ubuntu22.04",
          "connectionName": "aws-ap-northeast-2",
          "cspImageId": "ami-058165de3b7202099",
          "cspImageName": "ubuntu/images/hvm-ssd/ubuntu-jammy-22.04-amd64-server-20220609",
          "description": "Canonical, Ubuntu, 22.04 LTS, amd64 jammy image build on 2022-06-09",
          "creationDate": "2022-06-09T12:20:05.000Z",
          "guestOS": "Ubuntu22.04",
          "status": "available",
          "keyValueList": [
            {
              "key": "CreationDate",
              "value": "2022-06-09T12:20:05.000Z"
            },
            {
              "key": "Architecture",
              "value": "x86_64"
            },
            {
              "key": "OwnerId",
              "value": "099720109477"
            },
            {
              "key": "ImageType",
              "value": "machine"
            },
            {
              "key": "ImageLocation",
              "value": "amazon/ubuntu/images/hvm-ssd/ubuntu-jammy-22.04-amd64-server-20220609"
            },
            {
              "key": "VirtualizationType",
              "value": "hvm"
            },
            {
              "key": "Public",
              "value": "true"
            },
            {
              "key": "PlatformDetails",
              "value": "Linux/UNIX"
            },
            {
              "key": "Name",
              "value": "ubuntu/images/hvm-ssd/ubuntu-jammy-22.04-amd64-server-20220609"
            },
            {
              "key": "Description",
              "value": "Canonical, Ubuntu, 22.04 LTS, amd64 jammy image build on 2022-06-09"
            },
            {
              "key": "ImageOwnerAlias",
              "value": "amazon"
            },
            {
              "key": "RootDeviceName",
              "value": "/dev/sda1"
            },
            {
              "key": "RootDeviceType",
              "value": "ebs"
            },
            {
              "key": "EnaSupport",
              "value": "true"
            }
          ]
        },
        {
          "namespace": "system-purpose-common-ns",
          "id": "aws+ap-northeast-2+ubuntu18.04",
          "name": "aws+ap-northeast-2+ubuntu18.04",
          "connectionName": "aws-ap-northeast-2",
          "cspImageId": "ami-00379ec40a3e30f87",
          "cspImageName": "ubuntu/images/hvm-ssd/ubuntu-bionic-18.04-amd64-server-20191002",
          "description": "Canonical, Ubuntu, 18.04 LTS, amd64 bionic image build on 2019-10-02",
          "creationDate": "2019-10-02T23:28:50.000Z",
          "guestOS": "Ubuntu18.04",
          "status": "available",
          "keyValueList": [
            {
              "key": "CreationDate",
              "value": "2019-10-02T23:28:50.000Z"
            },
            {
              "key": "Architecture",
              "value": "x86_64"
            },
            {
              "key": "OwnerId",
              "value": "099720109477"
            },
            {
              "key": "ImageType",
              "value": "machine"
            },
            {
              "key": "ImageLocation",
              "value": "amazon/ubuntu/images/hvm-ssd/ubuntu-bionic-18.04-amd64-server-20191002"
            },
            {
              "key": "VirtualizationType",
              "value": "hvm"
            },
            {
              "key": "Public",
              "value": "true"
            },
            {
              "key": "PlatformDetails",
              "value": "Linux/UNIX"
            },
            {
              "key": "Name",
              "value": "ubuntu/images/hvm-ssd/ubuntu-bionic-18.04-amd64-server-20191002"
            },
            {
              "key": "Description",
              "value": "Canonical, Ubuntu, 18.04 LTS, amd64 bionic image build on 2019-10-02"
            },
            {
              "key": "ImageOwnerAlias",
              "value": "amazon"
            },
            {
              "key": "RootDeviceName",
              "value": "/dev/sda1"
            },
            {
              "key": "RootDeviceType",
              "value": "ebs"
            },
            {
              "key": "EnaSupport",
              "value": "true"
            }
          ]
        }
      ],
      "region": {
        "regionId": "ap-northeast-2",
        "regionName": "ap-northeast-2",
        "description": "Asia Pacific (Seoul)",
        "location": {
          "display": "South Korea (Seoul)",
          "latitude": 37.36,
          "longitude": 126.78
        },
        "zones": [
          "ap-northeast-2a",
          "ap-northeast-2b",
          "ap-northeast-2c",
          "ap-northeast-2d"
        ]
      },
      "systemMessage": ""
    },
    {
      "connectionConfigCandidates": [
        "gcp-us-west1"
      ],
      "spec": {
        "namespace": "system-purpose-common-ns",
        "id": "gcp+us-west1+g1-small",
        "name": "gcp+us-west1+g1-small",
        "connectionName": "gcp-us-west1",
        "providerName": "gcp",
        "regionName": "us-west1",
        "cspSpecName": "g1-small",
        "vCPU": 1,
        "memoryGiB": 1.6992188,
        "costPerHour": 0.0322,
        "evaluationScore01": 34.07,
        "evaluationScore02": 0,
        "evaluationScore03": 0,
        "evaluationScore04": 0,
        "evaluationScore05": 0,
        "evaluationScore06": 0,
        "evaluationScore07": 0,
        "evaluationScore08": 0,
        "evaluationScore09": 0,
        "evaluationScore10": 0,
        "rootDiskType": "default",
        "rootDiskSize": "default"
      },
      "image": [
        {
          "namespace": "system-purpose-common-ns",
          "id": "gcp+us-west1+debian10",
          "name": "gcp+us-west1+debian10",
          "connectionName": "gcp-us-west1",
          "cspImageId": "https://www.googleapis.com/compute/v1/projects/debian-cloud/global/images/debian-10-buster-v20221102",
          "cspImageName": "debian-10-buster-v20221102",
          "guestOS": "Debian10",
          "status": "READY",
...
          ]
        }
      ],
      "region": {
        "regionId": "us-west1",
        "regionName": "us-west1",
        "description": "Dalles Oregon USA",
        "location": {
          "display": "The Dalles Oregon USA",
          "latitude": 45.5946,
          "longitude": -121.1787
        },
        "zones": [
          "us-west1-a",
          "us-west1-b",
          "us-west1-c"
        ]
      },
      "systemMessage": ""
    }
  ]
}

• image 항목에 가용한 image 리스트가 리턴되므로, 이 중에서 선정하여 commonImage 로 활용하면 된다.
• commonImage 는 provider+region+keyword 형태의 ID값으로 요청 가능하며, Ubuntu22.04 와 같은 형태로 guestOS의 명칭으로 지정할 수도 있다.

MCI dynamic 생성 결과 (예시)

• 요청

{
  "name": "mci01",
  "vm": [
    {
      "commonImage": "aws+ap-northeast-2+ubuntu18.04",
      "commonSpec": "aws+ap-northeast-2+t2.small"
    }
  ]
}

• 결과

  details

  {
    "id": "mci01",
    "name": "mci01",
    "status": "Running:1 (R:1/1)",
    "statusCount": {
      "countTotal": 1,
      "countCreating": 0,
      "countRunning": 1,
      "countFailed": 0,
      "countSuspended": 0,
      "countRebooting": 0,
      "countTerminated": 0,
      "countSuspending": 0,
      "countResuming": 0,
      "countTerminating": 0,
      "countUndefined": 0
    },
    "targetStatus": "Running",
    "targetAction": "Create",
    "installMonAgent": "",
    "configureCloudAdaptiveNetwork": "",
    "label": "",
    "systemLabel": "",
    "systemMessage": "",
    "description": "",
    "vm": [
      {
        "id": "cp2uunj4la0bcnaes2jg-1",
        "name": "cp2uunj4la0bcnaes2jg-1",
        "idByCSP": "",
        "subGroupId": "cp2uunj4la0bcnaes2jg",
        "location": {
          "display": "South Korea (Seoul)",
          "latitude": 37.36,
          "longitude": 126.78
        },
        "status": "Running",
        "targetStatus": "None",
        "targetAction": "None",
        "monAgentStatus": "notInstalled",
        "networkAgentStatus": "notInstalled",
        "systemMessage": "",
        "createdTime": "2024-05-16 20:35:49",
        "label": "",
        "description": "",
        "region": {
          "Region": "ap-northeast-2",
          "Zone": "ap-northeast-2a"
        },
        "publicIP": "54.180.202.182",
        "sshPort": "22",
        "publicDNS": "",
        "privateIP": "10.34.27.173",
        "privateDNS": "ip-10-34-27-173.ap-northeast-2.compute.internal",
        "rootDiskType": "gp2",
        "rootDiskSize": "8",
        "rootDeviceName": "/dev/sda1",
        "connectionName": "aws-ap-northeast-2",
        "connectionConfig": {
          "configName": "aws-ap-northeast-2",
          "providerName": "aws",
          "driverName": "aws-driver-v1.0.so",
          "credentialName": "aws",
          "credentialHolder": "admin",
          "regionZoneInfoName": "aws-ap-northeast-2",
          "regionZoneInfo": {
            "assignedRegion": "ap-northeast-2",
            "assignedZone": "ap-northeast-2a"
          },
          "regionDetail": {
            "regionId": "ap-northeast-2",
            "regionName": "ap-northeast-2",
            "description": "Asia Pacific (Seoul)",
            "location": {
              "display": "South Korea (Seoul)",
              "latitude": 37.36,
              "longitude": 126.78
            },
            "zones": [
              "ap-northeast-2a",
              "ap-northeast-2b",
              "ap-northeast-2c",
              "ap-northeast-2d"
            ]
          },
          "regionRepresentative": true,
          "verified": true
        },
        "specId": "aws+ap-northeast-2+t2.small",
        "imageId": "aws+ap-northeast-2+ubuntu18.04",
        "vNetId": "ns01-systemdefault-aws-ap-northeast-2",
        "subnetId": "ns01-systemdefault-aws-ap-northeast-2",
        "securityGroupIds": [
          "ns01-systemdefault-aws-ap-northeast-2"
        ],
        "dataDiskIds": null,
        "sshKeyId": "ns01-systemdefault-aws-ap-northeast-2",
        "vmUserAccount": "cb-user",
        "cspViewVmDetail": {
          "Name": "",
          "ImageName": "",
          "VPCName": "",
          "SubnetName": "",
          "SecurityGroupNames": null,
          "KeyPairName": "",
          "CSPid": "",
          "DataDiskNames": null,
          "VMSpecName": "t2.small",
          "VMUserId": "cb-user",
          "VMUserPasswd": "",
          "RootDiskType": "gp2",
          "RootDiskSize": "8",
          "ImageType": "PublicImage",
          "IId": {
            "NameId": "ns01-mci01-cp2uunj4la0bcnaes2jg-1",
            "SystemId": "i-033b1687032b349f7"
          },
          "ImageIId": {
            "NameId": "ami-00379ec40a3e30f87",
            "SystemId": "ami-00379ec40a3e30f87"
          },
          "VpcIID": {
            "NameId": "ns01-ns01-systemdefault-aws-ap-northeast-2",
            "SystemId": "vpc-0392e7b31242d0af6"
          },
          "SubnetIID": {
            "NameId": "ns01-systemdefault-aws-ap-northeast-2",
            "SystemId": "subnet-07a26100fc456d168"
          },
          "SecurityGroupIIds": [
            {
              "NameId": "ns01-ns01-systemdefault-aws-ap-northeast-2",
              "SystemId": "sg-0ff9b70c6c836bcd4"
            }
          ],
          "KeyPairIId": {
            "NameId": "ns01-ns01-systemdefault-aws-ap-northeast-2",
            "SystemId": "ns01-ns01-systemdefault-aws-ap-northeast-2-cp2uunbq10mauac3e6a0"
          },
          "DataDiskIIDs": [],
          "StartTime": "2024-05-16T11:34:58Z",
          "Region": {
            "Region": "ap-northeast-2",
            "Zone": "ap-northeast-2a"
          },
          "NetworkInterface": "eni-attach-04c2c96c2dfc94dfe",
          "PublicIP": "54.180.202.182",
          "PublicDNS": "",
          "PrivateIP": "10.34.27.173",
          "PrivateDNS": "ip-10-34-27-173.ap-northeast-2.compute.internal",
          "RootDeviceName": "/dev/sda1",
          "SSHAccessPoint": "54.180.202.182:22",
          "KeyValueList": [
            {
              "key": "State",
              "value": "running"
            },
            {
              "key": "Architecture",
              "value": "x86_64"
            },
            {
              "key": "VpcId",
              "value": "vpc-0392e7b31242d0af6"
            },
            {
              "key": "SubnetId",
              "value": "subnet-07a26100fc456d168"
            },
            {
              "key": "KeyName",
              "value": "ns01-ns01-systemdefault-aws-ap-northeast-2-cp2uunbq10mauac3e6a0"
            },
            {
              "key": "VirtualizationType",
              "value": "hvm"
            }
          ]
        }
      }
    ],
    "newVmList": null
  }
  

2) MCI 상태 조회

• ​GET /ns​/{nsId}​/mci​/{mciId}의 옵션 status를 활용하면, 각 VM 및 MCI의 전체 상태(라이프사이클) 정보를 획득할 수 있다.

3) MCI 활용

• MCI 원격 커맨드: ​POST /ns​/{nsId}​/cmd​/mci​/{mciId}를 통해서, MCI (또는 subGroup, 개별 VM) 단위로 내부의 VM에 동일한 SSH 원격 커맨드를 실행할 수 있다.

• MCI 내부 SSH 접속: ​GET /ns​/{nsId}​/mci​/{mciId}의 옵션 accessInfo를 활용하면, 각 VM의 SSH 접속 정보를 획득할 수 있다.

• MCI 원격 파일 전송: How to transfer a file to a MC-Infra (VMs) #1832

4) MCI 종료 및 삭제

• MCI 종료(멤버 VM들을 종료): ​GET /ns​/{nsId}​/control​/mci​/{mciId} (옵션: terminate)

• MCI 삭제(MCI 오브젝트의 삭제): ​DELETE /ns​/{nsId}​/mci​/{mciId}

5) MCI Dynamic에 의해서 자동 생성된 자원 정리

• MCI Dynamic 을 통해서 MCI 를 생성하면, 내부적으로 공용 Network, SG, SSHKey 등이 생성됨
• 공용 자원을 더 이상 사용하지 않으면,
  ​DELETE /ns​/{nsId}​/sharedResources 를 사용하여, 해당 자원들을 정리 필요.