Search or ask Docker

Runtime

Runtime schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

Runtime describes an OCI compliant runtime.

The runtime is invoked by the daemon via the containerd daemon. OCI runtimes act as an interface to the Linux kernel namespaces, cgroups, and SELinux.

path

Type: string

Name and, optional, path, of the OCI executable binary.

If the path is omitted, the daemon searches the host's $PATH for the binary and uses the first result.

All schema constraints and annotations
{
  "description": "Name and, optional, path, of the OCI executable binary.\n\nIf the path is omitted, the daemon searches the host's `$PATH` for the\nbinary and uses the first result.\n",
  "example": "/usr/local/bin/my-oci-runtime",
  "type": "string"
}
runtimeArgs

Type: array

List of command-line arguments to pass to the runtime when invoked.
Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "description": "List of command-line arguments to pass to the runtime when invoked.\n",
  "example": [
    "--debug",
    "--systemd-cgroup=false"
  ],
  "items": {
    "type": "string"
  },
  "type": "array",
  "x-nullable": true
}
status

Type: object

Information specific to the runtime.

While this API specification does not define data provided by runtimes, the following well-known properties may be provided by runtimes:

org.opencontainers.runtime-spec.features: features structure as defined in the OCI Runtime Specification, in a JSON string representation.


Note: The information returned in this field, including the formatting of values and labels, should not be considered stable, and may change without notice.

All schema constraints and annotations
{
  "additionalProperties": {
    "type": "string"
  },
  "description": "Information specific to the runtime.\n\nWhile this API specification does not define data provided by runtimes,\nthe following well-known properties may be provided by runtimes:\n\n`org.opencontainers.runtime-spec.features`: features structure as defined\nin the [OCI Runtime Specification](https://github.com/opencontainers/runtime-spec/blob/main/features.md),\nin a JSON string representation.\n\n\u003cp\u003e\u003cbr /\u003e\u003c/p\u003e\n\n\u003e **Note**: The information returned in this field, including the\n\u003e formatting of values and labels, should not be considered stable,\n\u003e and may change without notice.\n",
  "example": {
    "org.opencontainers.runtime-spec.features": "{\"ociVersionMin\":\"1.0.0\",\"ociVersionMax\":\"1.1.0\",\"...\":\"...\"}"
  },
  "type": "object",
  "x-nullable": true
}
All schema constraints and annotations
{
  "description": "Runtime describes an [OCI compliant](https://github.com/opencontainers/runtime-spec)\nruntime.\n\nThe runtime is invoked by the daemon via the `containerd` daemon. OCI\nruntimes act as an interface to the Linux kernel namespaces, cgroups,\nand SELinux.\n",
  "properties": {
    "path": {
      "description": "Name and, optional, path, of the OCI executable binary.\n\nIf the path is omitted, the daemon searches the host's `$PATH` for the\nbinary and uses the first result.\n",
      "example": "/usr/local/bin/my-oci-runtime",
      "type": "string"
    },
    "runtimeArgs": {
      "description": "List of command-line arguments to pass to the runtime when invoked.\n",
      "example": [
        "--debug",
        "--systemd-cgroup=false"
      ],
      "items": {
        "type": "string"
      },
      "type": "array",
      "x-nullable": true
    },
    "status": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Information specific to the runtime.\n\nWhile this API specification does not define data provided by runtimes,\nthe following well-known properties may be provided by runtimes:\n\n`org.opencontainers.runtime-spec.features`: features structure as defined\nin the [OCI Runtime Specification](https://github.com/opencontainers/runtime-spec/blob/main/features.md),\nin a JSON string representation.\n\n\u003cp\u003e\u003cbr /\u003e\u003c/p\u003e\n\n\u003e **Note**: The information returned in this field, including the\n\u003e formatting of values and labels, should not be considered stable,\n\u003e and may change without notice.\n",
      "example": {
        "org.opencontainers.runtime-spec.features": "{\"ociVersionMin\":\"1.0.0\",\"ociVersionMax\":\"1.1.0\",\"...\":\"...\"}"
      },
      "type": "object",
      "x-nullable": true
    }
  },
  "type": "object"
}