VM Spec Info Guide - cloud-barista/cb-spider GitHub Wiki

VM Spec Info Guide

Language: English | 한국어

1. CB-Spider VM Spec Info Overview

  • Users can set a VM Spec Name to request VM creation that conforms to the properties of that spec (vCPU, memory size, etc.).

  • The relationship between VM Spec information provided by CB-Spider and the information of VMs created from those specs is shown in the diagram below.

  • Users can utilize the abstracted CB-Spider VM Spec information to request VMs with their desired environment (number of CPUs, memory size, etc.).

2. CB-Spider VM Spec Info API Specification

  • Users can retrieve VM Spec information in JSON format via the following CB-Spider REST API:

    GET /vmspec            - List VM Specs
    GET /vmspec/{Name}     - Get VM Spec
    GET /vmorgspec         - List Original VM Specs
    GET /vmorgspec/{Name}  - Get Original VM Spec
    
  • The information included in the returned JSON result is as follows:

    Field Description Example Values
    Name VM Spec Name managed and provided by the CSP t2.micro, Standard_D2a_v4, etc.
    Region Region Name where the VM Spec is available us-east-1, northeurope, etc.
    VCpu CPU resource info of the VM created from the spec, consisting of Count and ClockGHz (frequency) {2, 2.5}, {32, 3.0}, etc.-1: value not provided by the CSP
    MemSizeMiB Memory size of the VM created from the spec 1024, 16384, etc.
    DiskSizeGB Root Disk size of the VM created from the spec; may include temporary disk space depending on the CSP 8, 100, etc.-1: value not provided by the CSP
    Gpu GPU info available to the VM created from the spec, consisting of Count, Mfr (manufacturer), Model, MemSizeGB (per GPU), TotalMemSizeGB (total GPU memory) {2, NVIDIA, Tesla T4, 16, 32}, {8, NVIDIA, H100, 85, 687}, etc.NA | -1: value not provided by the CSP
    KeyValueList Original VM Spec information from the CSP in Key/Value List format ● "KeyValueList" : [ { "Key" : "AutoRecoverySupported", "Value" : "false" }, { "Key" : "Hypervisor", "Value" : "nitro" },

3. CB-Spider VM Spec Info API Example

  • Example API call and response for AWS g6e.48xlarge VM Spec:

    curl -sX 'GET' 'http://localhost:1024/spider/vmspec/g6e.48xlarge?ConnectionName=aws-config01' | json_pp
    
    {
          "Name" : "g6e.48xlarge",
          "Region" : "us-east-2",
          "VCpu" : {
                "ClockGHz" : "3.4",
                "Count" : "192"
             },
          "MemSizeMib" : "1572864",
          "DiskSizeGB" : "-1",
          "Gpu" : [
                {
                   "Count" : "8",
                   "MemSizeGB" : "384",
                   "Mfr" : "NVIDIA",
                   "Model" : "L40S",
                   "TotalMemSizeGB" : "3072"
                }
             ],
             "KeyValueList" : [
                   {
                      "Key" : "AutoRecoverySupported",
                      "Value" : "false"
                   },
                   {
                      "Key" : "GpuInfo",
                      "Value" : "{Gpus:[{Count:8,Manufacturer:NVIDIA,MemoryInfo:{SizeInMiB:366211},Name:L40S}],TotalGpuMemoryInMiB:2929688}"
                   },
                   …
             ]
    }
    

4. CB-Spider VM Spec Info AdminWeb Example

  • Select the target CSP and request VM Spec information as shown below.

  • Example of AWS VM Spec Info provided: