com.publicdomainrelay.temp.compute.vm Documentation (EN)

main record

Descibes a virtual machine

Record Key tid Timestamp-based ID

Properties

cpus integer Required

Number of vCPUs requested.

minimum: 1

disk string Required

Disk request, e.g. '10G'.

location ref #location Optional

No description available.

mem string Required

Memory request, e.g. '512M', '4G'.

network string Required

Network throughput / quota, e.g. '500G'.

role string Required

RBAC role the compute should run under. The requester's did:plc may set this freely, so agents must use their own accounts since we scope roles under accounts.

user_data string Required

cloud-init user data to bootstrap the compute.

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "cpus",
      "mem",
      "disk",
      "network",
      "role",
      "user_data"
    ],
    "properties": {
      "mem": {
        "type": "string",
        "description": "Memory request, e.g. '512M', '4G'."
      },
      "cpus": {
        "type": "integer",
        "minimum": 1,
        "description": "Number of vCPUs requested."
      },
      "disk": {
        "type": "string",
        "description": "Disk request, e.g. '10G'."
      },
      "role": {
        "type": "string",
        "description": "RBAC role the compute should run under. The requester's did:plc may set this freely, so agents must use their own accounts since we scope roles under accounts."
      },
      "network": {
        "type": "string",
        "description": "Network throughput / quota, e.g. '500G'."
      },
      "location": {
        "ref": "#location",
        "type": "ref"
      },
      "user_data": {
        "type": "string",
        "description": "cloud-init user data to bootstrap the compute."
      }
    }
  },
  "description": "Descibes a virtual machine"
}

location object

Geographic placement constraint for the requested compute.

Properties

country string Optional

ISO 3166-1 alpha-3 country code or human-readable country name.

region string Optional

Region within the country, e.g. 'west'.

View raw schema

{
  "type": "object",
  "properties": {
    "region": {
      "type": "string",
      "description": "Region within the country, e.g. 'west'."
    },
    "country": {
      "type": "string",
      "description": "ISO 3166-1 alpha-3 country code or human-readable country name."
    }
  },
  "description": "Geographic placement constraint for the requested compute."
}