Public Image Info Guide - cloud-barista/cb-spider GitHub Wiki

Public Image Info Guide

Language: English | 한국어

1. CB-Spider Public Image Info Overview

Users can set a Public Image ID to request VM creation that conforms to the properties (architecture, OS, etc.) of that image.
The relationship between Public Image information provided by CB-Spider and the OS information of VMs created from those images is shown in the diagram below.
Users can utilize the abstracted CB-Spider Public Image information to request VMs with their desired OS environment (e.g., Arm, Ubuntu 22.04).

2. CB-Spider Public Image Info API Specification

Users can retrieve Public Image information in JSON format via the following CB-Spider REST API:
```
GET /vmimage        - List Public Images
GET /vmimage/{Name} - Get Public Image
```

The information included in the returned JSON result is as follows:

Field	Description	Example Values
IId(NameId, SystemId)	Image ID information managed and provided by the CSP(NameId=SystemId)	● `ami-00edcba5512df4d24`, `img-pi0ii46r`, etc.
OSArchitecture	OS Architecture of the VM created from the image	● One of: `arm32`, `arm64`, `arm64_mac`, `x86_32`, `x86_32_mac`, `x86_64`, `x86_64_mac` ● `NA`: value not provided by the CSP
OSPlatform	OS Platform of the VM created from the image	● `Linux/UNIX` or `Windows` ● `NA`: value not provided by the CSP
OSDistribution	OS Distribution of the VM created from the image	● CSP-defined values such as `Deep Learning Base Neuron AMI (Ubuntu 22.04)`
OSDiskType	OS Disk Type of the VM created from the image	● `ebs`, `Common BlockStorage 1`, etc. ● `NA`: value not provided by the CSP
OSDiskSizeGB	OS Disk Size or minimum size of the VM created from the image; may include temporary disk space required by the OS depending on the CSP	● `10`, `30`, etc. ● `-1`: value not provided by the CSP
ImageStatus	Current availability status of the image	● `Available` or `Unavailable` ● `NA`: value not provided by the CSP
KeyValueList	Original image information provided by the CSP in Key/Value List format	● "KeyValueList" : [ { "Key" : "Architecture", "Value" : "x86_64" }, { "Key" : "Hypervisor", "Value" : "xen" }, …

3. CB-Spider Public Image Info API Example

Example API call and response for AWS image ami-00edcba5512df4d24:

curl -sX 'GET' 'http://localhost:1024/spider/vmimage/ami-00edcba5512df4d24?ConnectionName=aws-config01' | json_pp

{
   "IId" : {
      "NameId" : "ami-00edcba5512df4d24",
      "SystemId" : "ami-00edcba5512df4d24"
   },
   "ImageStatus" : "Available",
   "OSArchitecture" : "x86_64",
   "OSDiskSizeGB" : "-1",
   "OSDiskType" : "ebs",
   "OSDistribution" : "Deep Learning Base Neuron AMI (Ubuntu 22.04) 20241101",
   "OSPlatform" : "Linux/UNIX",
   "KeyValueList" : [
      {
         "Key" : "Architecture",
         "Value" : "x86_64"
      },
      {
         "Key" : "BlockDeviceMappings",
         "Value" : "{DeviceName:/dev/sda1,Ebs:{DeleteOnTermination:true,Encrypted:false,Iops:3000,KmsKeyId:null,OutpostArn:null,SnapshotId:snap-0b054f1cb9fd1bf5d,Throughput:125,VolumeSize:35,VolumeType:gp3},NoDevice:null,VirtualName:null}; {DeviceName:/dev/sdb,Ebs:null,NoDevice:null,VirtualName:ephemeral0}; {DeviceName:/dev/sdc,Ebs:null,NoDevice:null,VirtualName:ephemeral1}"
      },
      {
         "Key" : "State",
         "Value" : "available"
      },
      …
   ]
}

4. CB-Spider Public Image Info AdminWeb Example

Select the target CSP and request Image information as shown below.
Example of AWS Image Info provided: