DB Spec Info Guide

DB Spec Info Guide

Language: English | 한국어

1. CB-Spider DB Spec Info Overview

• Users can set a DB Spec Name for a given DB Engine (mysql, mariadb, postgresql) to request creation of a DB Instance that conforms to the properties of that spec (VCpu, Memory, Storage size range, etc.).
• The DB Spec information provided by CB-Spider is used as-is for the DBSpec field (e.g. db.t3.medium) when requesting DB Instance creation, as described in the RDBMS Management Guide.
• Users can utilize the abstracted CB-Spider DB Spec information to determine their desired DB Instance specification (number of CPUs, memory size, storage size range, etc.) before requesting DB Instance creation.

2. CB-Spider DB Spec Info API Specification

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

  GET /dbspec            - List DB Specs
  GET /dbspec/{Name}     - Get DB Spec
  GET /dborgspec         - List Original DB Specs
  GET /dborgspec/{Name}  - Get Original DB Spec
  

  • All APIs require the ConnectionName (Connection name) and DBEngine (mysql | mariadb | postgresql) query parameters.

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

  Field	Description	Example Values
  Region	Region Name where the DB Spec is available	● us-east-1, ap-northeast-2, etc.
  DBEngine	DB engine this spec applies to	● mysql, mariadb, postgresql
  Name	DB Spec (instance class/flavor) Name managed and provided by the CSP	● db.t3.medium, db.r5.24xlarge, etc.
  VCpu	CPU resource info of the DB Instance created from the spec, consisting of Count and ClockGHz (frequency)	● {2, 3.1}, {96, 3.1}, etc. ● -1: value not provided by the CSP, or there is no objective basis to derive it from the same CSP spec name
  MemSizeMiB	Memory size of the DB Instance created from the spec	● 4096, 786432, etc. ● -1: value not provided by the CSP
  StorageSizeRangeGB	The Min/Max Storage size range the caller may request when creating a DB Instance with this spec, NOT a disk built into the spec, but a constraint on the storage size selectable at creation time	● {20, 65536}, etc. ● {-1, -1}: no per-spec constraint known (falls back to RDBMSMetaInfo's StorageSizeRangeGB)
  DataSource DataSourceNotes	Indicates whether each field's value was obtained live from the CSP API (API) or is a fixed/unconvertible value (Static), with the reason recorded in DataSourceNotes when Static, a field with no entry is treated as API	● "DataSource" : { "VCpu.Count" : "Static" } ● "DataSourceNotes" : { "VCpu.Count" : "..." }
  KeyValueList	CSP-specific extra information related to the DB Spec, in Key/Value List format, e.g. mapped EC2 Instance Type, IOPS, Architecture, reference price	● "KeyValueList" : [ { "Key" : "EC2InstanceType", "Value" : "t3.medium" } ]

3. CB-Spider DB Spec Info API Example

• Example API call and response for AWS RDS mysql engine's db.t3.medium DB Spec:

  curl -u admin:your-secure-password -sX 'GET' 'http://localhost:1024/spider/dbspec/db.t3.medium?ConnectionName=aws-config01&DBEngine=mysql' | json_pp
  

  {
     "DBEngine" : "mysql",
     "KeyValueList" : [
        {
           "Key" : "EC2InstanceType",
           "Value" : "t3.medium"
        }
     ],
     "MemSizeMiB" : "4096",
     "Name" : "db.t3.medium",
     "Region" : "ap-southeast-2",
     "StorageSizeRangeGB" : {
        "Max" : 17592,
        "Min" : 5
     },
     "VCpu" : {
        "ClockGHz" : "2.5",
        "Count" : "2"
     }
  }
  

• Example where a field is treated as fixed (Static) because the CSP API only exposes it at the engine level rather than per SKU, as with Azure Database for MySQL's Standard_B12ms DB Spec:

  curl -u admin:your-secure-password -sX 'GET' 'http://localhost:1024/spider/dbspec/Standard_B12ms?ConnectionName=azure-northeu-config&DBEngine=mysql' | json_pp
  

  {
     "DBEngine" : "mysql",
     "DataSource" : {
        "StorageSizeRangeGB" : "Static"
     },
     "DataSourceNotes" : {
        "StorageSizeRangeGB" : "The capabilitySets response's per-SKU details carry no storage-range field; storage size is a single engine-wide range for this CSP, not tied to a specific SKU. See RDBMSMetaInfo.StorageSizeRangeGB instead."
     },
     "KeyValueList" : [
        {
           "Key" : "SupportedIops",
           "Value" : "3800"
        }
     ],
     "MemSizeMiB" : "49152",
     "Name" : "Standard_B12ms",
     "Region" : "northeurope",
     "StorageSizeRangeGB" : {
        "Max" : 0,
        "Min" : 0
     },
     "VCpu" : {
        "ClockGHz" : "-1",
        "Count" : "12"
     }
  }
  

4. CB-Spider DB Spec Info AdminWeb Example

• After accessing AdminWeb (http://localhost:1024/spider/adminweb), select Connection from the left menu and choose the target Connection Config (e.g. aws-config01).
• Click DBSpec among the icon menu (Region, Price, Quota, Image, VMSpec, DBSpec) at the top right of the screen.
• Selecting mysql / mariadb / postgresql from the DB Engine dropdown next to the Search Keyword box retrieves the DB Spec list for the selected Connection's Region/DB Engine combination, shown as a table with the following columns.