Schema
Type:
object
ArgsEscaped
Type:
boolean
All schema constraints and annotations
{
"default": false,
"description": "Command is already escaped (Windows only)",
"example": false,
"type": "boolean",
"x-nullable": true
}Cmd
Type:
array
Array item
Type:
string
All schema constraints and annotations
{
"type": "string"
}All schema constraints and annotations
{
"description": "Command to run specified as a string or an array of strings.\n",
"example": [
"/bin/sh"
],
"items": {
"type": "string"
},
"type": "array"
}Entrypoint
Type:
array
The entry point for the container as a string or an array of strings.
If the array consists of exactly one empty string ([""]) then the
entry point is reset to system default (i.e., the entry point used by
docker when there is no ENTRYPOINT instruction in the Dockerfile).
Array item
Type:
string
All schema constraints and annotations
{
"type": "string"
}All schema constraints and annotations
{
"description": "The entry point for the container as a string or an array of strings.\n\nIf the array consists of exactly one empty string (`[\"\"]`) then the\nentry point is reset to system default (i.e., the entry point used by\ndocker when there is no `ENTRYPOINT` instruction in the `Dockerfile`).\n",
"example": [],
"items": {
"type": "string"
},
"type": "array"
}Env
Type:
array
["VAR=value", ...]. A variable without = is removed from the
environment, rather than to have an empty value.Array item
Type:
string
All schema constraints and annotations
{
"type": "string"
}All schema constraints and annotations
{
"description": "A list of environment variables to set inside the container in the\nform `[\"VAR=value\", ...]`. A variable without `=` is removed from the\nenvironment, rather than to have an empty value.\n",
"example": [
"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
],
"items": {
"type": "string"
},
"type": "array"
}ExposedPorts
Type:
object
An object mapping ports to an empty object in the form:
{"<port>/<tcp|udp|sctp>": {}}
All schema constraints and annotations
{
"additionalProperties": {
"default": {},
"enum": [
{}
],
"type": "object"
},
"description": "An object mapping ports to an empty object in the form:\n\n`{\"\u003cport\u003e/\u003ctcp|udp|sctp\u003e\": {}}`\n",
"example": {
"443/tcp": {},
"80/tcp": {}
},
"type": "object",
"x-nullable": true
}Healthcheck
Schema:
HealthConfig
Labels
Type:
object
All schema constraints and annotations
{
"additionalProperties": {
"type": "string"
},
"description": "User-defined key/value metadata.",
"example": {
"com.example.some-label": "some-value",
"com.example.some-other-label": "some-other-value"
},
"type": "object"
}OnBuild
Type:
array
ONBUILD metadata that were defined in the image's Dockerfile.Array item
Type:
string
All schema constraints and annotations
{
"type": "string"
}All schema constraints and annotations
{
"description": "`ONBUILD` metadata that were defined in the image's `Dockerfile`.\n",
"example": [],
"items": {
"type": "string"
},
"type": "array",
"x-nullable": true
}Shell
Type:
array
RUN, CMD, and ENTRYPOINT uses a shell.Array item
Type:
string
All schema constraints and annotations
{
"type": "string"
}All schema constraints and annotations
{
"description": "Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.\n",
"example": [
"/bin/sh",
"-c"
],
"items": {
"type": "string"
},
"type": "array",
"x-nullable": true
}StopSignal
Type:
string
All schema constraints and annotations
{
"description": "Signal to stop a container as a string or unsigned integer.\n",
"example": "SIGTERM",
"type": "string",
"x-nullable": true
}User
Type:
string
All schema constraints and annotations
{
"description": "The user that commands are run as inside the container.",
"example": "web:web",
"type": "string"
}Volumes
Type:
object
All schema constraints and annotations
{
"additionalProperties": {
"default": {},
"enum": [
{}
],
"type": "object"
},
"description": "An object mapping mount point paths inside the container to empty\nobjects.\n",
"example": {
"/app/config": {},
"/app/data": {}
},
"type": "object"
}WorkingDir
Type:
string
All schema constraints and annotations
{
"description": "The working directory for commands to run in.",
"example": "/public/",
"type": "string"
}All schema constraints and annotations
{
"description": "Configuration of the image. These fields are used as defaults\nwhen starting a container from the image.\n",
"properties": {
"ArgsEscaped": {
"default": false,
"description": "Command is already escaped (Windows only)",
"example": false,
"type": "boolean",
"x-nullable": true
},
"Cmd": {
"description": "Command to run specified as a string or an array of strings.\n",
"example": [
"/bin/sh"
],
"items": {
"type": "string"
},
"type": "array"
},
"Entrypoint": {
"description": "The entry point for the container as a string or an array of strings.\n\nIf the array consists of exactly one empty string (`[\"\"]`) then the\nentry point is reset to system default (i.e., the entry point used by\ndocker when there is no `ENTRYPOINT` instruction in the `Dockerfile`).\n",
"example": [],
"items": {
"type": "string"
},
"type": "array"
},
"Env": {
"description": "A list of environment variables to set inside the container in the\nform `[\"VAR=value\", ...]`. A variable without `=` is removed from the\nenvironment, rather than to have an empty value.\n",
"example": [
"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
],
"items": {
"type": "string"
},
"type": "array"
},
"ExposedPorts": {
"additionalProperties": {
"default": {},
"enum": [
{}
],
"type": "object"
},
"description": "An object mapping ports to an empty object in the form:\n\n`{\"\u003cport\u003e/\u003ctcp|udp|sctp\u003e\": {}}`\n",
"example": {
"443/tcp": {},
"80/tcp": {}
},
"type": "object",
"x-nullable": true
},
"Healthcheck": {
"$ref": "#/components/schemas/HealthConfig"
},
"Labels": {
"additionalProperties": {
"type": "string"
},
"description": "User-defined key/value metadata.",
"example": {
"com.example.some-label": "some-value",
"com.example.some-other-label": "some-other-value"
},
"type": "object"
},
"OnBuild": {
"description": "`ONBUILD` metadata that were defined in the image's `Dockerfile`.\n",
"example": [],
"items": {
"type": "string"
},
"type": "array",
"x-nullable": true
},
"Shell": {
"description": "Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.\n",
"example": [
"/bin/sh",
"-c"
],
"items": {
"type": "string"
},
"type": "array",
"x-nullable": true
},
"StopSignal": {
"description": "Signal to stop a container as a string or unsigned integer.\n",
"example": "SIGTERM",
"type": "string",
"x-nullable": true
},
"User": {
"description": "The user that commands are run as inside the container.",
"example": "web:web",
"type": "string"
},
"Volumes": {
"additionalProperties": {
"default": {},
"enum": [
{}
],
"type": "object"
},
"description": "An object mapping mount point paths inside the container to empty\nobjects.\n",
"example": {
"/app/config": {},
"/app/data": {}
},
"type": "object"
},
"WorkingDir": {
"description": "The working directory for commands to run in.",
"example": "/public/",
"type": "string"
}
},
"type": "object"
}