Search or ask Docker

OCIPlatform

OCIPlatform schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

Describes the platform which the image in the manifest runs on, as defined in the OCI Image Index Specification.
architecture

Type: string

The CPU architecture, for example amd64 or ppc64.
All schema constraints and annotations
{
  "description": "The CPU architecture, for example `amd64` or `ppc64`.\n",
  "example": "arm",
  "type": "string"
}
os

Type: string

The operating system, for example linux or windows.
All schema constraints and annotations
{
  "description": "The operating system, for example `linux` or `windows`.\n",
  "example": "windows",
  "type": "string"
}
os.features

Type: array

Optional field specifying an array of strings, each listing a required OS feature (for example on Windows win32k).
Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "description": "Optional field specifying an array of strings, each listing a required\nOS feature (for example on Windows `win32k`).\n",
  "example": [
    "win32k"
  ],
  "items": {
    "type": "string"
  },
  "type": "array"
}
os.version

Type: string

Optional field specifying the operating system version, for example on Windows 10.0.19041.1165.
All schema constraints and annotations
{
  "description": "Optional field specifying the operating system version, for example on\nWindows `10.0.19041.1165`.\n",
  "example": "10.0.19041.1165",
  "type": "string"
}
variant

Type: string

Optional field specifying a variant of the CPU, for example v7 to specify ARMv7 when architecture is arm.
All schema constraints and annotations
{
  "description": "Optional field specifying a variant of the CPU, for example `v7` to\nspecify ARMv7 when architecture is `arm`.\n",
  "example": "v7",
  "type": "string"
}
All schema constraints and annotations
{
  "description": "Describes the platform which the image in the manifest runs on, as defined\nin the [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).\n",
  "properties": {
    "architecture": {
      "description": "The CPU architecture, for example `amd64` or `ppc64`.\n",
      "example": "arm",
      "type": "string"
    },
    "os": {
      "description": "The operating system, for example `linux` or `windows`.\n",
      "example": "windows",
      "type": "string"
    },
    "os.features": {
      "description": "Optional field specifying an array of strings, each listing a required\nOS feature (for example on Windows `win32k`).\n",
      "example": [
        "win32k"
      ],
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "os.version": {
      "description": "Optional field specifying the operating system version, for example on\nWindows `10.0.19041.1165`.\n",
      "example": "10.0.19041.1165",
      "type": "string"
    },
    "variant": {
      "description": "Optional field specifying a variant of the CPU, for example `v7` to\nspecify ARMv7 when architecture is `arm`.\n",
      "example": "v7",
      "type": "string"
    }
  },
  "type": "object",
  "x-go-name": "Platform",
  "x-nullable": true
}