Merge pull request #31203 from yongtang/02202017-Swagger-ContainerSpec
Add missing fields in Swagger docs
(cherry picked from commit 19cd2aa389)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Victor Vieux
Sebastiaan van Stijn
parent
cecae2c5ad
commit
c984bbf871
1 changed files with 55 additions and 27 deletions
|
|
@ -468,6 +468,31 @@ definitions:
|
|||
type: "integer"
|
||||
format: "int64"
|
||||
|
||||
HealthConfig:
|
||||
description: "A test to perform to check that the container is healthy."
|
||||
type: "object"
|
||||
properties:
|
||||
Test:
|
||||
description: |
|
||||
The test to perform. Possible values are:
|
||||
|
||||
- `{}` inherit healthcheck from image or parent image
|
||||
- `{"NONE"}` disable healthcheck
|
||||
- `{"CMD", args...}` exec arguments directly
|
||||
- `{"CMD-SHELL", command}` run command with system's default shell
|
||||
type: "array"
|
||||
items:
|
||||
type: "string"
|
||||
Interval:
|
||||
description: "The time to wait between checks in nanoseconds. 0 means inherit."
|
||||
type: "integer"
|
||||
Timeout:
|
||||
description: "The time to wait before considering the check to have hung. 0 means inherit."
|
||||
type: "integer"
|
||||
Retries:
|
||||
description: "The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit."
|
||||
type: "integer"
|
||||
|
||||
HostConfig:
|
||||
description: "Container configuration that depends on the host we are running on"
|
||||
allOf:
|
||||
|
|
@ -727,29 +752,7 @@ definitions:
|
|||
items:
|
||||
type: "string"
|
||||
Healthcheck:
|
||||
description: "A test to perform to check that the container is healthy."
|
||||
type: "object"
|
||||
properties:
|
||||
Test:
|
||||
description: |
|
||||
The test to perform. Possible values are:
|
||||
|
||||
- `{}` inherit healthcheck from image or parent image
|
||||
- `{"NONE"}` disable healthcheck
|
||||
- `{"CMD", args...}` exec arguments directly
|
||||
- `{"CMD-SHELL", command}` run command with system's default shell
|
||||
type: "array"
|
||||
items:
|
||||
type: "string"
|
||||
Interval:
|
||||
description: "The time to wait between checks in nanoseconds. 0 means inherit."
|
||||
type: "integer"
|
||||
Timeout:
|
||||
description: "The time to wait before considering the check to have hung. 0 means inherit."
|
||||
type: "integer"
|
||||
Retries:
|
||||
description: "The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit."
|
||||
type: "integer"
|
||||
$ref: "#/definitions/HealthConfig"
|
||||
ArgsEscaped:
|
||||
description: "Command is already escaped (Windows only)"
|
||||
type: "boolean"
|
||||
|
|
@ -1837,6 +1840,11 @@ definitions:
|
|||
Image:
|
||||
description: "The image name to use for the container."
|
||||
type: "string"
|
||||
Labels:
|
||||
description: "User-defined key/value data."
|
||||
type: "object"
|
||||
additionalProperties:
|
||||
type: "string"
|
||||
Command:
|
||||
description: "The command to be run in the image."
|
||||
type: "array"
|
||||
|
|
@ -1847,6 +1855,9 @@ definitions:
|
|||
type: "array"
|
||||
items:
|
||||
type: "string"
|
||||
Hostname:
|
||||
description: "The hostname to use for the container, as a valid RFC 1123 hostname."
|
||||
type: "string"
|
||||
Env:
|
||||
description: "A list of environment variables in the form `VAR=value`."
|
||||
type: "array"
|
||||
|
|
@ -1858,14 +1869,20 @@ definitions:
|
|||
User:
|
||||
description: "The user inside the container."
|
||||
type: "string"
|
||||
Labels:
|
||||
description: "User-defined key/value data."
|
||||
type: "object"
|
||||
additionalProperties:
|
||||
Groups:
|
||||
type: "array"
|
||||
description: "A list of additional groups that the container process will run as."
|
||||
items:
|
||||
type: "string"
|
||||
TTY:
|
||||
description: "Whether a pseudo-TTY should be allocated."
|
||||
type: "boolean"
|
||||
OpenStdin:
|
||||
description: "Open `stdin`"
|
||||
type: "boolean"
|
||||
ReadOnly:
|
||||
description: "Mount the container's root filesystem as read only."
|
||||
type: "boolean"
|
||||
Mounts:
|
||||
description: "Specification for mounts to be added to containers created as part of the service."
|
||||
type: "array"
|
||||
|
|
@ -1875,6 +1892,17 @@ definitions:
|
|||
description: "Amount of time to wait for the container to terminate before forcefully killing it."
|
||||
type: "integer"
|
||||
format: "int64"
|
||||
HealthCheck:
|
||||
$ref: "#/definitions/HealthConfig"
|
||||
Hosts:
|
||||
type: "array"
|
||||
description: |
|
||||
A list of hostnames/IP mappings to add to the container's `/etc/hosts` file.
|
||||
The format of extra hosts on swarmkit is specified in:
|
||||
http://man7.org/linux/man-pages/man5/hosts.5.html
|
||||
IP_address canonical_hostname [aliases...]
|
||||
items:
|
||||
type: "string"
|
||||
DNSConfig:
|
||||
description: "Specification for DNS related configurations in resolver configuration file (`resolv.conf`)."
|
||||
type: "object"
|
||||
|
|
|
|||
Loading…
Reference in a new issue