docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

cf6fc379 fix had to be made in /apidocs/cloud-api-source 

Signed-off-by: Adrien Duermael <adrien@duermael.com>
This commit is contained in:
Adrien Duermael 2017-01-11 12:06:08 -08:00
parent cf6fc37931
commit b193b00826
14 changed files with 157 additions and 157 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
apidocs/cloud-api-source/source/includes/container.md
View File

@ -297,20 +297,20 @@ extra_hosts | List of container hostname mappings
secuirty_opt | Labeling scheme of this container secuirty_opt | Labeling scheme of this container
entrypoint | Entrypoint used on the container on launch entrypoint | Entrypoint used on the container on launch
run_command | Run command used on the container on launch run_command | Run command used on the container on launch
cpu_shares | The relative CPU priority of the container (see [Runtime Constraints on CPU and Memory](../../engine/reference/run/#runtime-constraints-on-cpu-and-memory) for more information) cpu_shares | The relative CPU priority of the container (see [Runtime Constraints on CPU and Memory](/engine/reference/run/#runtime-constraints-on-cpu-and-memory) for more information)
cpuset | CPUs in which execution is allowed cpuset | CPUs in which execution is allowed
memory | The memory limit of the container in MB (see [Runtime Constraints on CPU and Memory](../../engine/reference/run/#runtime-constraints-on-cpu-and-memory) for more information) memory | The memory limit of the container in MB (see [Runtime Constraints on CPU and Memory](/engine/reference/run/#runtime-constraints-on-cpu-and-memory) for more information)
memory_swap | Total memory limit (memory + swap) of the container in MB memory_swap | Total memory limit (memory + swap) of the container in MB
autorestart | Whether to restart the container automatically if it stops (see [Crash recovery](../../docker-cloud/apps/autorestart/) for more information) autorestart | Whether to restart the container automatically if it stops (see [Crash recovery](/docker-cloud/apps/autorestart/) for more information)
autodestroy | Whether to terminate the container automatically if it stops (see [Autodestroy](../../docker-cloud/apps/auto-destroy/) for more information) autodestroy | Whether to terminate the container automatically if it stops (see [Autodestroy](/docker-cloud/apps/auto-destroy/) for more information)
roles | List of Docker Cloud roles asigned to this container (see [API roles](../../docker-cloud/apps/api-roles/) for more information)) roles | List of Docker Cloud roles asigned to this container (see [API roles](/docker-cloud/apps/api-roles/) for more information))
linked_to_container | List of IP addresses of the linked containers (see table `Container Link attributes` below and [Service links](../../docker-cloud/apps/service-links/) for more information) linked_to_container | List of IP addresses of the linked containers (see table `Container Link attributes` below and [Service links](/docker-cloud/apps/service-links/) for more information)
link_variables | List of environment variables that would be exposed in any container that is linked to this one link_variables | List of environment variables that would be exposed in any container that is linked to this one
privileged | Whether the container has Docker's `privileged` flag set or not (see [Runtime privilege](../../engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration) for more information) privileged | Whether the container has Docker's `privileged` flag set or not (see [Runtime privilege](/engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration) for more information)
read_only | Whether the container filesystem is read-only or not read_only | Whether the container filesystem is read-only or not
private_ip | IP address of the container on the overlay network. This IP will be reachable from any other container. private_ip | IP address of the container on the overlay network. This IP will be reachable from any other container.
net | Network mode set on the container (see table `Network Modes` below, more information ../../reference/run/#network-settings) net | Network mode set on the container (see table `Network Modes` below, [more information](/engine/reference/run/#network-settings))
pid | PID (Process) Namespace mode for the container (more information ../../reference/run/#pid-settings-pid) pid | PID (Process) Namespace mode for the container ([more information](/engine/reference/run/#pid-settings-pid))
### Container Binding attributes ### Container Binding attributes

4
apidocs/cloud-api-source/source/includes/node.md
View File

@ -62,7 +62,7 @@ public_ip | The public IP allocated to the node
tunnel | If the node does not accept incoming connections to port 2375, the address of the reverse tunnel to access the docker daemon, or `null` otherwise tunnel | If the node does not accept incoming connections to port 2375, the address of the reverse tunnel to access the docker daemon, or `null` otherwise
deployed_datetime | The date and time when this node cluster was deployed deployed_datetime | The date and time when this node cluster was deployed
destroyed_datetime | The date and time when this node cluster was terminated (if applicable) destroyed_datetime | The date and time when this node cluster was terminated (if applicable)
tags | List of tags to identify the node when deploying services (see [Tags](../../docker-cloud/apps/deploy-tags/) for more information) tags | List of tags to identify the node when deploying services (see [Tags](/docker-cloud/apps/deploy-tags/) for more information)
nickname | A user-friendly name for the node (`external_fqdn` by default) nickname | A user-friendly name for the node (`external_fqdn` by default)
@ -276,7 +276,7 @@ Accept: application/json
docker-cloud node upgrade 7eaf7fff docker-cloud node upgrade 7eaf7fff
``` ```
Upgrades the docker daemon of the node. This will restart your containers on that node. See [Docker upgrade](../../docker-cloud/infrastructure/docker-upgrade/) for more information. Upgrades the docker daemon of the node. This will restart your containers on that node. See [Docker upgrade](/docker-cloud/infrastructure/docker-upgrade/) for more information.
### Endpoint Type ### Endpoint Type

4
apidocs/cloud-api-source/source/includes/nodecluster.md
View File

@ -60,7 +60,7 @@ target_num_nodes | The desired number of nodes for the node cluster
current_num_nodes | The actual number of nodes in the node cluster. This may differ from `target_num_nodes` if the node cluster is being deployed or scaled current_num_nodes | The actual number of nodes in the node cluster. This may differ from `target_num_nodes` if the node cluster is being deployed or scaled
deployed_datetime | The date and time when this node cluster was deployed deployed_datetime | The date and time when this node cluster was deployed
destroyed_datetime | The date and time when this node cluster was terminated (if applicable) destroyed_datetime | The date and time when this node cluster was terminated (if applicable)
tags | List of tags to identify the node cluster nodes when deploying services (see [Tags](../../docker-cloud/apps/deploy-tags/) for more information) tags | List of tags to identify the node cluster nodes when deploying services (see [Tags](/docker-cloud/apps/deploy-tags/) for more information)
provider_options | Provider-specific extra options for the deployment of the node (see `Provider options` table below for more information) provider_options | Provider-specific extra options for the deployment of the node (see `Provider options` table below for more information)
nickname | A user-friendly name for the node cluster (`name` by default) nickname | A user-friendly name for the node cluster (`name` by default)
@ -200,7 +200,7 @@ region | (required) The resource URI of the region where the node cluster is to
disk | (optional) The size of the volume to create where images and containers will be stored, in GB (default: `60`). Not available for Digital Ocean. To create Softlayer nodes you must select one of the following sizes (in GBs): 10, 20, 25, 30, 40, 50, 75, 100, 125, 150, 175, 200, 250, 300, 350, 400, 500, 750, 1000, 1500 or 2000 disk | (optional) The size of the volume to create where images and containers will be stored, in GB (default: `60`). Not available for Digital Ocean. To create Softlayer nodes you must select one of the following sizes (in GBs): 10, 20, 25, 30, 40, 50, 75, 100, 125, 150, 175, 200, 250, 300, 350, 400, 500, 750, 1000, 1500 or 2000
nickname | (optional) A user-friendly name for the node cluster (`name` by default) nickname | (optional) A user-friendly name for the node cluster (`name` by default)
target_num_nodes | (optional) The desired number of nodes for the node cluster (default: `1`) target_num_nodes | (optional) The desired number of nodes for the node cluster (default: `1`)
tags | (optional) List of tags of the node cluster to be used when deploying services see [Tags](../../docker-cloud/apps/deploy-tags/) for more information) (default: `[]`) tags | (optional) List of tags of the node cluster to be used when deploying services see [Tags](/docker-cloud/apps/deploy-tags/) for more information) (default: `[]`)
provider_options | Provider-specific extra options for the deployment of the node (see table `Provider options` above for more information) provider_options | Provider-specific extra options for the deployment of the node (see table `Provider options` above for more information)

58
apidocs/cloud-api-source/source/includes/service.md
View File

@ -185,8 +185,8 @@ image_name | The Docker image name and tag used for the service containers
name | A user provided name for the service. This name will be inherited by the service containers and will be used in endpoint URLs, environment variable names, etc. name | A user provided name for the service. This name will be inherited by the service containers and will be used in endpoint URLs, environment variable names, etc.
public_dns | An external FQDN that resolves to all IPs of the nodes where the service containers are running on (as an `A` record with multiple IP entries which will be used by clients in a [round-robin fashion](http://en.wikipedia.org/wiki/Round-robin_DNS)). If the service is not publishing any ports, this FQDN will fail to resolve. public_dns | An external FQDN that resolves to all IPs of the nodes where the service containers are running on (as an `A` record with multiple IP entries which will be used by clients in a [round-robin fashion](http://en.wikipedia.org/wiki/Round-robin_DNS)). If the service is not publishing any ports, this FQDN will fail to resolve.
state | The state of the service (see table `Service states` below) state | The state of the service (see table `Service states` below)
net | Network mode to set on the containers (see table `Network Modes` below, more information ../../docker-cloud/apps/service-links/) net | Network mode to set on the containers (see table `Network Modes` below, more information /docker-cloud/apps/service-links/)
pid | Set the PID (Process) Namespace mode for the containers (more information ../../reference/run/#pid-settings-pid) pid | Set the PID (Process) Namespace mode for the containers ([more information](/engine/reference/run/#pid-settings-pid))
synchronized | Flag indicating if the current service definition is synchronized with the current containers. synchronized | Flag indicating if the current service definition is synchronized with the current containers.
deployed_datetime | The date and time of the last deployment of the service (if applicable, `null` otherwise) deployed_datetime | The date and time of the last deployment of the service (if applicable, `null` otherwise)
started_datetime | The date and time of the last `start` operation on the service (if applicable, `null` otherwise) started_datetime | The date and time of the last `start` operation on the service (if applicable, `null` otherwise)
@ -218,23 +218,23 @@ extra_hosts | List of hostname mappings for containers of this service
secuirty_opt | Labeling scheme for containers of this service secuirty_opt | Labeling scheme for containers of this service
entrypoint | Entrypoint to be set on the containers launched as part of the service, which will override the image entrypoint entrypoint | Entrypoint to be set on the containers launched as part of the service, which will override the image entrypoint
run_command | Run command to be set on the containers launched as part of the service, which will override the image run command run_command | Run command to be set on the containers launched as part of the service, which will override the image run command
sequential_deployment | Whether the containers for this service should be deployed in sequence, linking each of them to the previous containers (see [Service scaling](../../docker-cloud/apps/service-scaling/) for more information) sequential_deployment | Whether the containers for this service should be deployed in sequence, linking each of them to the previous containers (see [Service scaling](/docker-cloud/apps/service-scaling/) for more information)
cpu_shares | The relative CPU priority of the containers of the service (see [Runtime Constraints on CPU and Memory](../../engine/reference/run/#runtime-constraints-on-cpu-and-memory) for more information) cpu_shares | The relative CPU priority of the containers of the service (see [Runtime Constraints on CPU and Memory](/engine/reference/run/#runtime-constraints-on-cpu-and-memory) for more information)
cpuset | CPUs in which to allow execution cpuset | CPUs in which to allow execution
memory | The memory limit of the containers of the service in MB (see [Runtime Constraints on CPU and Memory](../../engine/reference/run/#runtime-constraints-on-cpu-and-memory) for more information) memory | The memory limit of the containers of the service in MB (see [Runtime Constraints on CPU and Memory](/engine/reference/run/#runtime-constraints-on-cpu-and-memory) for more information)
memory_swap | Total memory limit (memory + swap) of the containers of the service in MB memory_swap | Total memory limit (memory + swap) of the containers of the service in MB
linked_from_service | A list of services that are linked to this one (see table `Related services attributes` below) linked_from_service | A list of services that are linked to this one (see table `Related services attributes` below)
linked_to_service | A list of services that the service is linked to (see table `Related services attributes` below) linked_to_service | A list of services that the service is linked to (see table `Related services attributes` below)
bindings | A list of volume bindings that the service has mounted (see table `Service binding attributes` below) bindings | A list of volume bindings that the service has mounted (see table `Service binding attributes` below)
autorestart | Whether to restart the containers of the service automatically if they stop (see [Crash recovery](../../docker-cloud/apps/autorestart/) for more information) autorestart | Whether to restart the containers of the service automatically if they stop (see [Crash recovery](/docker-cloud/apps/autorestart/) for more information)
autodestroy | Whether to terminate the containers of the service automatically if they stop (see [Autodestroy](../../docker-cloud/apps/auto-destroy/) for more information) autodestroy | Whether to terminate the containers of the service automatically if they stop (see [Autodestroy](/docker-cloud/apps/auto-destroy/) for more information)
roles | List of Docker Cloud roles assigned to this service (see [Service links](../../docker-cloud/apps/service-links/) for more information) roles | List of Docker Cloud roles assigned to this service (see [Service links](/docker-cloud/apps/service-links/) for more information)
link_variables | List of environment variables that would be exposed in the containers if they are linked to this service link_variables | List of environment variables that would be exposed in the containers if they are linked to this service
privileged | Whether to start the containers with Docker's `privileged` flag set or not, which allows containers to access all devices on the host among other things (see [Runtime privilege](../../engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration) for more information) privileged | Whether to start the containers with Docker's `privileged` flag set or not, which allows containers to access all devices on the host among other things (see [Runtime privilege](/engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration) for more information)
read_only | Whether the filesystem of every service container is read-only or not (`false` by default) read_only | Whether the filesystem of every service container is read-only or not (`false` by default)
deployment_strategy | Container distribution among nodes (see table `Deployment strategies` below and [Deployment strategies](../../docker-cloud/infrastructure/deployment-strategies/) for more information) deployment_strategy | Container distribution among nodes (see table `Deployment strategies` below and [Deployment strategies](/docker-cloud/infrastructure/deployment-strategies/) for more information)
tags | List of tags to be used to deploy the service (see [Tags](../../docker-cloud/apps/deploy-tags/) for more information) tags | List of tags to be used to deploy the service (see [Tags](/docker-cloud/apps/deploy-tags/) for more information)
autoredeploy | Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (see [Docker Cloud's private registry](../../docker-cloud/apps/auto-redeploy/) for more information) autoredeploy | Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (see [Docker Cloud's private registry](/docker-cloud/apps/auto-redeploy/) for more information)
nickname | A user-friendly name for the service (`name` by default) nickname | A user-friendly name for the service (`name` by default)
@ -417,14 +417,14 @@ container_ports | (optional) An array of objects with port information to be pub
container_envvars | (optional) An array of objects with environment variables to be added in the service containers on launch (overriding any image-defined environment variables), i.e. `[{"key": "DB_PASSWORD", "value": "mypass"}]` (default: `[]`) (See table `Service Environment Variable attributes` below) container_envvars | (optional) An array of objects with environment variables to be added in the service containers on launch (overriding any image-defined environment variables), i.e. `[{"key": "DB_PASSWORD", "value": "mypass"}]` (default: `[]`) (See table `Service Environment Variable attributes` below)
linked_to_service | (optional) An array of service resource URIs to link this service to, including the link name, i.e. `[{"to_service": "/api/app/v1/service/80ff1635-2d56-478d-a97f-9b59c720e513/", "name": "db"}]` (default: `[]`) (See table `Related services attributes` below) linked_to_service | (optional) An array of service resource URIs to link this service to, including the link name, i.e. `[{"to_service": "/api/app/v1/service/80ff1635-2d56-478d-a97f-9b59c720e513/", "name": "db"}]` (default: `[]`) (See table `Related services attributes` below)
bindings | (optional) An array of bindings this service has to mount, i.e. `[{"volumes_from": "/api/app/v1/service/80ff1635-2d56-478d-a97f-9b59c720e513/", "rewritable": true}]` (default: `[]`) (See table `Related bindings attributes` below) bindings | (optional) An array of bindings this service has to mount, i.e. `[{"volumes_from": "/api/app/v1/service/80ff1635-2d56-478d-a97f-9b59c720e513/", "rewritable": true}]` (default: `[]`) (See table `Related bindings attributes` below)
autorestart | (optional) Whether the containers for this service should be restarted if they stop, i.e. `ALWAYS` (default: `OFF`, possible values: `OFF`, `ON_FAILURE`, `ALWAYS`) (see [Crash recovery](../../docker-cloud/apps/autorestart/) for more information) autorestart | (optional) Whether the containers for this service should be restarted if they stop, i.e. `ALWAYS` (default: `OFF`, possible values: `OFF`, `ON_FAILURE`, `ALWAYS`) (see [Crash recovery](/docker-cloud/apps/autorestart/) for more information)
autodestroy | (optional) Whether the containers should be terminated if they stop, i.e. `OFF` (default: `OFF`, possible values: `OFF`, `ON_SUCCESS`, `ALWAYS`) (see [Autodestroy](../../docker-cloud/apps/auto-destroy/) for more information) autodestroy | (optional) Whether the containers should be terminated if they stop, i.e. `OFF` (default: `OFF`, possible values: `OFF`, `ON_SUCCESS`, `ALWAYS`) (see [Autodestroy](/docker-cloud/apps/auto-destroy/) for more information)
sequential_deployment | (optional) Whether the containers should be launched and scaled in sequence, i.e. `true` (default: `false`) (see [Service scaling](../../docker-cloud/apps/service-scaling/) for more information) sequential_deployment | (optional) Whether the containers should be launched and scaled in sequence, i.e. `true` (default: `false`) (see [Service scaling](/docker-cloud/apps/service-scaling/) for more information)
roles | (optional) A list of Docker Cloud API roles to grant the service, i.e. `["global"]` (default: `[]`, possible values: `global`) (see [Service links](../../docker-cloud/apps/service-links/) for more information) roles | (optional) A list of Docker Cloud API roles to grant the service, i.e. `["global"]` (default: `[]`, possible values: `global`) (see [Service links](/docker-cloud/apps/service-links/) for more information)
privileged | (optional) Whether to start the containers with Docker's `privileged` flag set or not, i.e. `false` (default: `false`) (see [Runtime privilege](../../engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration) for more information) privileged | (optional) Whether to start the containers with Docker's `privileged` flag set or not, i.e. `false` (default: `false`) (see [Runtime privilege](/engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration) for more information)
deployment_strategy | (optional) Container distribution among nodes (default: `EMPTIEST_NODE`, see table `Deployment strategies` above and [Deployment strategies](../../docker-cloud/infrastructure/deployment-strategies/) for more information) deployment_strategy | (optional) Container distribution among nodes (default: `EMPTIEST_NODE`, see table `Deployment strategies` above and [Deployment strategies](/docker-cloud/infrastructure/deployment-strategies/) for more information)
tags | (optional) A list of tags to be used to deploy the service (see [Tags](../../docker-cloud/apps/deploy-tags/) for more information) (default: `[]`) tags | (optional) A list of tags to be used to deploy the service (see [Tags](/docker-cloud/apps/deploy-tags/) for more information) (default: `[]`)
autoredeploy | (optional) Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (default: `false`) (see [Docker Cloud's private registry](../../docker-cloud/apps/auto-redeploy/) for more information) autoredeploy | (optional) Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (default: `false`) (see [Docker Cloud's private registry](/docker-cloud/apps/auto-redeploy/) for more information)
net | (optional) Set the network mode to the containers (default: `bridge`, possible values: `bridge`, `host`) net | (optional) Set the network mode to the containers (default: `bridge`, possible values: `bridge`, `host`)
pid | (optional) Set the PID (Process) Namespace mode for the containers (default: `none` value, possible values: `none`, `host`) pid | (optional) Set the PID (Process) Namespace mode for the containers (default: `none` value, possible values: `none`, `host`)
working_dir | (optional) Working directory for running binaries within a container of this service (default: `/`) working_dir | (optional) Working directory for running binaries within a container of this service (default: `/`)
@ -661,23 +661,23 @@ uuid | The UUID of the service to update
Parameter | Description Parameter | Description
--------- | ----------- --------- | -----------
autorestart | (optional) Whether the containers for this service should be restarted if they stop, i.e. `ALWAYS` (possible values: `OFF`, `ON_FAILURE`, `ALWAYS`) (see [Crash recovery](../../docker-cloud/apps/autorestart/) for more information) autorestart | (optional) Whether the containers for this service should be restarted if they stop, i.e. `ALWAYS` (possible values: `OFF`, `ON_FAILURE`, `ALWAYS`) (see [Crash recovery](/docker-cloud/apps/autorestart/) for more information)
autodestroy | (optional) Whether the containers should be terminated if they stop, i.e. `OFF` (possible values: `OFF`, `ON_SUCCESS`, `ALWAYS`) (see [Autodestroy](../../docker-cloud/apps/auto-destroy/) for more information) autodestroy | (optional) Whether the containers should be terminated if they stop, i.e. `OFF` (possible values: `OFF`, `ON_SUCCESS`, `ALWAYS`) (see [Autodestroy](/docker-cloud/apps/auto-destroy/) for more information)
container_envvars | (optional) An array of objects with environment variables to be added in the service containers on launch (overriding any image-defined environment variables), i.e. `[{"key": "DB_PASSWORD", "value": "mypass"}]` (See table `Service Environment Variable attributes`) container_envvars | (optional) An array of objects with environment variables to be added in the service containers on launch (overriding any image-defined environment variables), i.e. `[{"key": "DB_PASSWORD", "value": "mypass"}]` (See table `Service Environment Variable attributes`)
container_ports | (optional) An array of objects with port information to be published in the containers for this service, which will be added to the image port information, i.e. `[{"protocol": "tcp", "inner_port": 80, "outer_port": 80}]` (See table `Service Port attributes`) container_ports | (optional) An array of objects with port information to be published in the containers for this service, which will be added to the image port information, i.e. `[{"protocol": "tcp", "inner_port": 80, "outer_port": 80}]` (See table `Service Port attributes`)
cpu_shares | (optional) The relative CPU priority of the containers the service describes (see [Runtime Constraints on CPU and Memory](../../engine/reference/run/#runtime-constraints-on-cpu-and-memory) for more information) cpu_shares | (optional) The relative CPU priority of the containers the service describes (see [Runtime Constraints on CPU and Memory](/engine/reference/run/#runtime-constraints-on-cpu-and-memory) for more information)
entrypoint | (optional) The command prefix used to start the containers of this service, overriding the value specified in the image, i.e. `/usr/sbin/sshd` entrypoint | (optional) The command prefix used to start the containers of this service, overriding the value specified in the image, i.e. `/usr/sbin/sshd`
image | (optional) The image used to deploy this service in docker format, i.e. `tutum/hello-world`, `tutum/ubuntu:5.6`. If no tag is indicated, it will be set to `latest` by default image | (optional) The image used to deploy this service in docker format, i.e. `tutum/hello-world`, `tutum/ubuntu:5.6`. If no tag is indicated, it will be set to `latest` by default
linked_to_service | (optional) An array of service resource URIs to link this service to, including the link name, i.e. `[{"to_service": "/api/app/v1/service/80ff1635-2d56-478d-a97f-9b59c720e513/", "name": "db"}]` (See table `Related services attributes` below) linked_to_service | (optional) An array of service resource URIs to link this service to, including the link name, i.e. `[{"to_service": "/api/app/v1/service/80ff1635-2d56-478d-a97f-9b59c720e513/", "name": "db"}]` (See table `Related services attributes` below)
memory | (optional) The memory limit of the containers of the service in MB (see [Runtime Constraints on CPU and Memory](../../engine/reference/run/#runtime-constraints-on-cpu-and-memory) for more information) memory | (optional) The memory limit of the containers of the service in MB (see [Runtime Constraints on CPU and Memory](/engine/reference/run/#runtime-constraints-on-cpu-and-memory) for more information)
privileged | (optional) Whether to start the containers with Docker's `privileged` flag set or not, i.e. `false` (see [Runtime privilege](../../engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration) for more information) privileged | (optional) Whether to start the containers with Docker's `privileged` flag set or not, i.e. `false` (see [Runtime privilege](/engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration) for more information)
roles | (optional) A list of Docker Cloud API roles to grant the service, i.e. `["global"]` (possible values: `global`) (see [Service links](../../docker-cloud/apps/service-links/) for more information) roles | (optional) A list of Docker Cloud API roles to grant the service, i.e. `["global"]` (possible values: `global`) (see [Service links](/docker-cloud/apps/service-links/) for more information)
run_command | (optional) The command used to start the containers of this service, overriding the value specified in the image, i.e. `/run.sh` run_command | (optional) The command used to start the containers of this service, overriding the value specified in the image, i.e. `/run.sh`
sequential_deployment | (optional) Whether the containers should be launched and scaled in sequence, i.e. `true` (see [Service scaling](../../docker-cloud/apps/service-scaling/) for more information) sequential_deployment | (optional) Whether the containers should be launched and scaled in sequence, i.e. `true` (see [Service scaling](/docker-cloud/apps/service-scaling/) for more information)
tags | (optional) List of new tags the service will have. This operation replaces the tag list tags | (optional) List of new tags the service will have. This operation replaces the tag list
target_num_containers | (optional) The number of containers to scale this service to target_num_containers | (optional) The number of containers to scale this service to
deployment_strategy | (optional) Container distribution among nodes. A service cannot be updated to or from a deployment strategy of `EVERY_NODE`. (See table `Deployment strategies` above and [Deployment strategies](../../docker-cloud/infrastructure/deployment-strategies/) for more information) deployment_strategy | (optional) Container distribution among nodes. A service cannot be updated to or from a deployment strategy of `EVERY_NODE`. (See table `Deployment strategies` above and [Deployment strategies](/docker-cloud/infrastructure/deployment-strategies/) for more information)
autoredeploy | Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (see [Docker Cloud's private registry](../../docker-cloud/apps/auto-redeploy/) for more information) autoredeploy | Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (see [Docker Cloud's private registry](/docker-cloud/apps/auto-redeploy/) for more information)
net | (optional) Set the network mode to the containers (default: `bridge`, possible values: `bridge`, `host`) net | (optional) Set the network mode to the containers (default: `bridge`, possible values: `bridge`, `host`)
pid | (optional) Set the PID (Process) Namespace mode for the containers (default: `none` value, possible values: `none`, `host`) pid | (optional) Set the PID (Process) Namespace mode for the containers (default: `none` value, possible values: `none`, `host`)
working_dir | (optional) Working directory for running binaries within a container of this service (default: `/`) working_dir | (optional) Working directory for running binaries within a container of this service (default: `/`)

4
apidocs/cloud-api-source/source/includes/stack.md
View File

@ -157,7 +157,7 @@ Content-Type: application/json
docker-cloud stack create --name hello-world -f docker-compose.yml docker-cloud stack create --name hello-world -f docker-compose.yml
``` ```
Creates a new stack without starting it. Note that the JSON syntax is abstracted by both, the Docker Cloud CLI and our UI, in order to use [Stack YAML files](../../docker-cloud/apps/stack-yaml-reference/). Creates a new stack without starting it. Note that the JSON syntax is abstracted by both, the Docker Cloud CLI and our UI, in order to use [Stack YAML files](/docker-cloud/apps/stack-yaml-reference/).
### Endpoint Type ### Endpoint Type
@ -210,7 +210,7 @@ Accept: application/json
docker-cloud stack export 46aca402 docker-cloud stack export 46aca402
``` ```
Get a JSON representation of the stack following the [Stack YAML representation](../../docker-cloud/apps/stacks/). Get a JSON representation of the stack following the [Stack YAML representation](/docker-cloud/apps/stacks/).
### Endpoint Type ### Endpoint Type

2
apidocs/cloud-api-source/source/includes/tag.md
View File

@ -11,7 +11,7 @@
} }
``` ```
Tags are used to target the deployment of services to a specific set of nodes. [Learn more](../../docker-cloud/apps/deploy-tags/) Tags are used to target the deployment of services to a specific set of nodes. [Learn more](/docker-cloud/apps/deploy-tags/)
### Attributes ### Attributes

2
apidocs/cloud-api-source/source/includes/triggers.md
View File

@ -13,7 +13,7 @@
} }
``` ```
Triggers are URLs that will start a redeploy of the service whenever a `POST` request is sent to them. They require no authorization headers, so they should be treated as access tokens. Triggers can be revoked if they are leaked or no longer used for security purposes. See [Triggers](../../docker-cloud/apps/triggers/) for more information. Triggers are URLs that will start a redeploy of the service whenever a `POST` request is sent to them. They require no authorization headers, so they should be treated as access tokens. Triggers can be revoked if they are leaked or no longer used for security purposes. See [Triggers](/docker-cloud/apps/triggers/) for more information.
This is a [namespaced endpoint](#namespaced-endpoints). This is a [namespaced endpoint](#namespaced-endpoints).

2
apidocs/cloud-api-source/source/index.md
View File

@ -159,6 +159,6 @@ The Stream API requires the same authentication mechanism as the REST API:
> The CLI and the SDKs will detect this environment variable and automatically use it > The CLI and the SDKs will detect this environment variable and automatically use it
If you give an [API role](../../docker-cloud/apps/api-roles/) to a container, the environment variable `DOCKERCLOUD_AUTH` inside the container will have the contents of the `Authorization` header that you can use to authenticate against the REST or Stream APIs: If you give an [API role](/docker-cloud/apps/api-roles/) to a container, the environment variable `DOCKERCLOUD_AUTH` inside the container will have the contents of the `Authorization` header that you can use to authenticate against the REST or Stream APIs:
`curl -H "Authorization: $DOCKERCLOUD_AUTH" https://cloud.docker.com/api/app/v1/service/` `curl -H "Authorization: $DOCKERCLOUD_AUTH" https://cloud.docker.com/api/app/v1/service/`

4
apidocs/docker-cloud/includes/container.html
View File

@ -494,11 +494,11 @@
</tr> </tr>
<tr> <tr>
<td>net</td> <td>net</td>
<td>Network mode set on the container (see table <code class="prettyprint">Network Modes</code> below, more information /reference/run/#network-settings)</td> <td>Network mode set on the container (see table <code class="prettyprint">Network Modes</code> below, <a href="/engine/reference/run/#network-settings">more information</a>)</td>
</tr> </tr>
<tr> <tr>
<td>pid</td> <td>pid</td>
<td>PID (Process) Namespace mode for the container (more information /reference/run/#pid-settings-pid)</td> <td>PID (Process) Namespace mode for the container (<a href="/engine/reference/run/#pid-settings-pid">more information</a>)</td>
</tr> </tr>
</tbody></table> </tbody></table>

2
apidocs/docker-cloud/includes/service.html
View File

@ -248,7 +248,7 @@
</tr> </tr>
<tr> <tr>
<td>pid</td> <td>pid</td>
<td>Set the PID (Process) Namespace mode for the containers (more information /reference/run/#pid-settings-pid)</td> <td>Set the PID (Process) Namespace mode for the containers (<a href="/engine/reference/run/#pid-settings-pid">more information</a>)</td>
</tr> </tr>
<tr> <tr>
<td>synchronized</td> <td>synchronized</td>

92
apidocs/docker-cloud/index.html
View File

@ -176,7 +176,7 @@ set this globally, or specify it before each CLI command. To learn more, see the
<p>The CLI and the SDKs will detect this environment variable and automatically use it</p> <p>The CLI and the SDKs will detect this environment variable and automatically use it</p>
</blockquote> </blockquote>
<p>If you give an <a href="../../docker-cloud/apps/api-roles/">API role</a> to a container, the environment variable <code class="prettyprint">DOCKERCLOUD_AUTH</code> inside the container will have the contents of the <code class="prettyprint">Authorization</code> header that you can use to authenticate against the REST or Stream APIs:</p> <p>If you give an <a href="/docker-cloud/apps/api-roles/">API role</a> to a container, the environment variable <code class="prettyprint">DOCKERCLOUD_AUTH</code> inside the container will have the contents of the <code class="prettyprint">Authorization</code> header that you can use to authenticate against the REST or Stream APIs:</p>
<p><code class="prettyprint">curl -H &quot;Authorization: $DOCKERCLOUD_AUTH&quot; https://cloud.docker.com/api/app/v1/service/</code></p> <p><code class="prettyprint">curl -H &quot;Authorization: $DOCKERCLOUD_AUTH&quot; https://cloud.docker.com/api/app/v1/service/</code></p>
@ -1387,7 +1387,7 @@ set this globally, or specify it before each CLI command. To learn more, see the
</tr> </tr>
<tr> <tr>
<td>tags</td> <td>tags</td>
<td>List of tags to identify the node cluster nodes when deploying services (see <a href="../../docker-cloud/apps/deploy-tags/">Tags</a> for more information)</td> <td>List of tags to identify the node cluster nodes when deploying services (see <a href="/docker-cloud/apps/deploy-tags/">Tags</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>provider_options</td> <td>provider_options</td>
@ -1596,7 +1596,7 @@ set this globally, or specify it before each CLI command. To learn more, see the
</tr> </tr>
<tr> <tr>
<td>tags</td> <td>tags</td>
<td>(optional) List of tags of the node cluster to be used when deploying services see <a href="../../docker-cloud/apps/deploy-tags/">Tags</a> for more information) (default: <code class="prettyprint">[]</code>)</td> <td>(optional) List of tags of the node cluster to be used when deploying services see <a href="/docker-cloud/apps/deploy-tags/">Tags</a> for more information) (default: <code class="prettyprint">[]</code>)</td>
</tr> </tr>
<tr> <tr>
<td>provider_options</td> <td>provider_options</td>
@ -1954,7 +1954,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>tags</td> <td>tags</td>
<td>List of tags to identify the node when deploying services (see <a href="../../docker-cloud/apps/deploy-tags/">Tags</a> for more information)</td> <td>List of tags to identify the node when deploying services (see <a href="/docker-cloud/apps/deploy-tags/">Tags</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>nickname</td> <td>nickname</td>
@ -2208,7 +2208,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
<pre class="highlight shell"><code>docker-cloud node upgrade 7eaf7fff <pre class="highlight shell"><code>docker-cloud node upgrade 7eaf7fff
</code></pre> </code></pre>
<p>Upgrades the docker daemon of the node. This will restart your containers on that node. See <a href="../../docker-cloud/infrastructure/docker-upgrade/">Docker upgrade</a> for more information.</p> <p>Upgrades the docker daemon of the node. This will restart your containers on that node. See <a href="/docker-cloud/infrastructure/docker-upgrade/">Docker upgrade</a> for more information.</p>
<h3 id="endpoint-type">Endpoint Type</h3> <h3 id="endpoint-type">Endpoint Type</h3>
@ -2966,7 +2966,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
<pre class="highlight shell"><code>docker-cloud stack create --name hello-world -f docker-compose.yml <pre class="highlight shell"><code>docker-cloud stack create --name hello-world -f docker-compose.yml
</code></pre> </code></pre>
<p>Creates a new stack without starting it. Note that the JSON syntax is abstracted by both, the Docker Cloud CLI and our UI, in order to use <a href="../../docker-cloud/apps/stack-yaml-reference/">Stack YAML files</a>.</p> <p>Creates a new stack without starting it. Note that the JSON syntax is abstracted by both, the Docker Cloud CLI and our UI, in order to use <a href="/docker-cloud/apps/stack-yaml-reference/">Stack YAML files</a>.</p>
<h3 id="endpoint-type">Endpoint Type</h3> <h3 id="endpoint-type">Endpoint Type</h3>
@ -3024,7 +3024,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
<pre class="highlight shell"><code>docker-cloud stack <span class="nb">export </span>46aca402 <pre class="highlight shell"><code>docker-cloud stack <span class="nb">export </span>46aca402
</code></pre> </code></pre>
<p>Get a JSON representation of the stack following the <a href="../../docker-cloud/apps/stacks/">Stack YAML representation</a>.</p> <p>Get a JSON representation of the stack following the <a href="/docker-cloud/apps/stacks/">Stack YAML representation</a>.</p>
<h3 id="endpoint-type">Endpoint Type</h3> <h3 id="endpoint-type">Endpoint Type</h3>
@ -3607,11 +3607,11 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>net</td> <td>net</td>
<td>Network mode to set on the containers (see table <code class="prettyprint">Network Modes</code> below, more information ../../docker-cloud/apps/service-links/)</td> <td>Network mode to set on the containers (see table <code class="prettyprint">Network Modes</code> below, more information /docker-cloud/apps/service-links/)</td>
</tr> </tr>
<tr> <tr>
<td>pid</td> <td>pid</td>
<td>Set the PID (Process) Namespace mode for the containers (more information ../../reference/run/#pid-settings-pid)</td> <td>Set the PID (Process) Namespace mode for the containers (<a href="/engine/reference/run/#pid-settings-pid">more information</a>)</td>
</tr> </tr>
<tr> <tr>
<td>synchronized</td> <td>synchronized</td>
@ -3739,11 +3739,11 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>sequential_deployment</td> <td>sequential_deployment</td>
<td>Whether the containers for this service should be deployed in sequence, linking each of them to the previous containers (see <a href="../../docker-cloud/apps/service-scaling/">Service scaling</a> for more information)</td> <td>Whether the containers for this service should be deployed in sequence, linking each of them to the previous containers (see <a href="/docker-cloud/apps/service-scaling/">Service scaling</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>cpu_shares</td> <td>cpu_shares</td>
<td>The relative CPU priority of the containers of the service (see <a href="../../engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td> <td>The relative CPU priority of the containers of the service (see <a href="/engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>cpuset</td> <td>cpuset</td>
@ -3751,7 +3751,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>memory</td> <td>memory</td>
<td>The memory limit of the containers of the service in MB (see <a href="../../engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td> <td>The memory limit of the containers of the service in MB (see <a href="/engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>memory_swap</td> <td>memory_swap</td>
@ -3771,15 +3771,15 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>autorestart</td> <td>autorestart</td>
<td>Whether to restart the containers of the service automatically if they stop (see <a href="../../docker-cloud/apps/autorestart/">Crash recovery</a> for more information)</td> <td>Whether to restart the containers of the service automatically if they stop (see <a href="/docker-cloud/apps/autorestart/">Crash recovery</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>autodestroy</td> <td>autodestroy</td>
<td>Whether to terminate the containers of the service automatically if they stop (see <a href="../../docker-cloud/apps/auto-destroy/">Autodestroy</a> for more information)</td> <td>Whether to terminate the containers of the service automatically if they stop (see <a href="/docker-cloud/apps/auto-destroy/">Autodestroy</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>roles</td> <td>roles</td>
<td>List of Docker Cloud roles assigned to this service (see <a href="../../docker-cloud/apps/service-links/">Service links</a> for more information)</td> <td>List of Docker Cloud roles assigned to this service (see <a href="/docker-cloud/apps/service-links/">Service links</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>link_variables</td> <td>link_variables</td>
@ -3787,7 +3787,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>privileged</td> <td>privileged</td>
<td>Whether to start the containers with Docker&rsquo;s <code class="prettyprint">privileged</code> flag set or not, which allows containers to access all devices on the host among other things (see <a href="../../engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration">Runtime privilege</a> for more information)</td> <td>Whether to start the containers with Docker&rsquo;s <code class="prettyprint">privileged</code> flag set or not, which allows containers to access all devices on the host among other things (see <a href="/engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration">Runtime privilege</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>read_only</td> <td>read_only</td>
@ -3795,15 +3795,15 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>deployment_strategy</td> <td>deployment_strategy</td>
<td>Container distribution among nodes (see table <code class="prettyprint">Deployment strategies</code> below and <a href="../../docker-cloud/infrastructure/deployment-strategies/">Deployment strategies</a> for more information)</td> <td>Container distribution among nodes (see table <code class="prettyprint">Deployment strategies</code> below and <a href="/docker-cloud/infrastructure/deployment-strategies/">Deployment strategies</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>tags</td> <td>tags</td>
<td>List of tags to be used to deploy the service (see <a href="../../docker-cloud/apps/deploy-tags/">Tags</a> for more information)</td> <td>List of tags to be used to deploy the service (see <a href="/docker-cloud/apps/deploy-tags/">Tags</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>autoredeploy</td> <td>autoredeploy</td>
<td>Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (see <a href="../../docker-cloud/apps/auto-redeploy/">Docker Cloud&rsquo;s private registry</a> for more information)</td> <td>Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (see <a href="/docker-cloud/apps/auto-redeploy/">Docker Cloud&rsquo;s private registry</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>nickname</td> <td>nickname</td>
@ -4143,35 +4143,35 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>autorestart</td> <td>autorestart</td>
<td>(optional) Whether the containers for this service should be restarted if they stop, i.e. <code class="prettyprint">ALWAYS</code> (default: <code class="prettyprint">OFF</code>, possible values: <code class="prettyprint">OFF</code>, <code class="prettyprint">ON_FAILURE</code>, <code class="prettyprint">ALWAYS</code>) (see <a href="../../docker-cloud/apps/autorestart/">Crash recovery</a> for more information)</td> <td>(optional) Whether the containers for this service should be restarted if they stop, i.e. <code class="prettyprint">ALWAYS</code> (default: <code class="prettyprint">OFF</code>, possible values: <code class="prettyprint">OFF</code>, <code class="prettyprint">ON_FAILURE</code>, <code class="prettyprint">ALWAYS</code>) (see <a href="/docker-cloud/apps/autorestart/">Crash recovery</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>autodestroy</td> <td>autodestroy</td>
<td>(optional) Whether the containers should be terminated if they stop, i.e. <code class="prettyprint">OFF</code> (default: <code class="prettyprint">OFF</code>, possible values: <code class="prettyprint">OFF</code>, <code class="prettyprint">ON_SUCCESS</code>, <code class="prettyprint">ALWAYS</code>) (see <a href="../../docker-cloud/apps/auto-destroy/">Autodestroy</a> for more information)</td> <td>(optional) Whether the containers should be terminated if they stop, i.e. <code class="prettyprint">OFF</code> (default: <code class="prettyprint">OFF</code>, possible values: <code class="prettyprint">OFF</code>, <code class="prettyprint">ON_SUCCESS</code>, <code class="prettyprint">ALWAYS</code>) (see <a href="/docker-cloud/apps/auto-destroy/">Autodestroy</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>sequential_deployment</td> <td>sequential_deployment</td>
<td>(optional) Whether the containers should be launched and scaled in sequence, i.e. <code class="prettyprint">true</code> (default: <code class="prettyprint">false</code>) (see <a href="../../docker-cloud/apps/service-scaling/">Service scaling</a> for more information)</td> <td>(optional) Whether the containers should be launched and scaled in sequence, i.e. <code class="prettyprint">true</code> (default: <code class="prettyprint">false</code>) (see <a href="/docker-cloud/apps/service-scaling/">Service scaling</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>roles</td> <td>roles</td>
<td>(optional) A list of Docker Cloud API roles to grant the service, i.e. <code class="prettyprint">[&quot;global&quot;]</code> (default: <code class="prettyprint">[]</code>, possible values: <code class="prettyprint">global</code>) (see <a href="../../docker-cloud/apps/service-links/">Service links</a> for more information)</td> <td>(optional) A list of Docker Cloud API roles to grant the service, i.e. <code class="prettyprint">[&quot;global&quot;]</code> (default: <code class="prettyprint">[]</code>, possible values: <code class="prettyprint">global</code>) (see <a href="/docker-cloud/apps/service-links/">Service links</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>privileged</td> <td>privileged</td>
<td>(optional) Whether to start the containers with Docker&rsquo;s <code class="prettyprint">privileged</code> flag set or not, i.e. <code class="prettyprint">false</code> (default: <code class="prettyprint">false</code>) (see <a href="../../engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration">Runtime privilege</a> for more information)</td> <td>(optional) Whether to start the containers with Docker&rsquo;s <code class="prettyprint">privileged</code> flag set or not, i.e. <code class="prettyprint">false</code> (default: <code class="prettyprint">false</code>) (see <a href="/engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration">Runtime privilege</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>deployment_strategy</td> <td>deployment_strategy</td>
<td>(optional) Container distribution among nodes (default: <code class="prettyprint">EMPTIEST_NODE</code>, see table <code class="prettyprint">Deployment strategies</code> above and <a href="../../docker-cloud/infrastructure/deployment-strategies/">Deployment strategies</a> for more information)</td> <td>(optional) Container distribution among nodes (default: <code class="prettyprint">EMPTIEST_NODE</code>, see table <code class="prettyprint">Deployment strategies</code> above and <a href="/docker-cloud/infrastructure/deployment-strategies/">Deployment strategies</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>tags</td> <td>tags</td>
<td>(optional) A list of tags to be used to deploy the service (see <a href="../../docker-cloud/apps/deploy-tags/">Tags</a> for more information) (default: <code class="prettyprint">[]</code>)</td> <td>(optional) A list of tags to be used to deploy the service (see <a href="/docker-cloud/apps/deploy-tags/">Tags</a> for more information) (default: <code class="prettyprint">[]</code>)</td>
</tr> </tr>
<tr> <tr>
<td>autoredeploy</td> <td>autoredeploy</td>
<td>(optional) Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (default: <code class="prettyprint">false</code>) (see <a href="../../docker-cloud/apps/auto-redeploy/">Docker Cloud&rsquo;s private registry</a> for more information)</td> <td>(optional) Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (default: <code class="prettyprint">false</code>) (see <a href="/docker-cloud/apps/auto-redeploy/">Docker Cloud&rsquo;s private registry</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>net</td> <td>net</td>
@ -4487,11 +4487,11 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</thead><tbody> </thead><tbody>
<tr> <tr>
<td>autorestart</td> <td>autorestart</td>
<td>(optional) Whether the containers for this service should be restarted if they stop, i.e. <code class="prettyprint">ALWAYS</code> (possible values: <code class="prettyprint">OFF</code>, <code class="prettyprint">ON_FAILURE</code>, <code class="prettyprint">ALWAYS</code>) (see <a href="../../docker-cloud/apps/autorestart/">Crash recovery</a> for more information)</td> <td>(optional) Whether the containers for this service should be restarted if they stop, i.e. <code class="prettyprint">ALWAYS</code> (possible values: <code class="prettyprint">OFF</code>, <code class="prettyprint">ON_FAILURE</code>, <code class="prettyprint">ALWAYS</code>) (see <a href="/docker-cloud/apps/autorestart/">Crash recovery</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>autodestroy</td> <td>autodestroy</td>
<td>(optional) Whether the containers should be terminated if they stop, i.e. <code class="prettyprint">OFF</code> (possible values: <code class="prettyprint">OFF</code>, <code class="prettyprint">ON_SUCCESS</code>, <code class="prettyprint">ALWAYS</code>) (see <a href="../../docker-cloud/apps/auto-destroy/">Autodestroy</a> for more information)</td> <td>(optional) Whether the containers should be terminated if they stop, i.e. <code class="prettyprint">OFF</code> (possible values: <code class="prettyprint">OFF</code>, <code class="prettyprint">ON_SUCCESS</code>, <code class="prettyprint">ALWAYS</code>) (see <a href="/docker-cloud/apps/auto-destroy/">Autodestroy</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>container_envvars</td> <td>container_envvars</td>
@ -4503,7 +4503,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>cpu_shares</td> <td>cpu_shares</td>
<td>(optional) The relative CPU priority of the containers the service describes (see <a href="../../engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td> <td>(optional) The relative CPU priority of the containers the service describes (see <a href="/engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>entrypoint</td> <td>entrypoint</td>
@ -4519,15 +4519,15 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>memory</td> <td>memory</td>
<td>(optional) The memory limit of the containers of the service in MB (see <a href="../../engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td> <td>(optional) The memory limit of the containers of the service in MB (see <a href="/engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>privileged</td> <td>privileged</td>
<td>(optional) Whether to start the containers with Docker&rsquo;s <code class="prettyprint">privileged</code> flag set or not, i.e. <code class="prettyprint">false</code> (see <a href="../../engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration">Runtime privilege</a> for more information)</td> <td>(optional) Whether to start the containers with Docker&rsquo;s <code class="prettyprint">privileged</code> flag set or not, i.e. <code class="prettyprint">false</code> (see <a href="/engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration">Runtime privilege</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>roles</td> <td>roles</td>
<td>(optional) A list of Docker Cloud API roles to grant the service, i.e. <code class="prettyprint">[&quot;global&quot;]</code> (possible values: <code class="prettyprint">global</code>) (see <a href="../../docker-cloud/apps/service-links/">Service links</a> for more information)</td> <td>(optional) A list of Docker Cloud API roles to grant the service, i.e. <code class="prettyprint">[&quot;global&quot;]</code> (possible values: <code class="prettyprint">global</code>) (see <a href="/docker-cloud/apps/service-links/">Service links</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>run_command</td> <td>run_command</td>
@ -4535,7 +4535,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>sequential_deployment</td> <td>sequential_deployment</td>
<td>(optional) Whether the containers should be launched and scaled in sequence, i.e. <code class="prettyprint">true</code> (see <a href="../../docker-cloud/apps/service-scaling/">Service scaling</a> for more information)</td> <td>(optional) Whether the containers should be launched and scaled in sequence, i.e. <code class="prettyprint">true</code> (see <a href="/docker-cloud/apps/service-scaling/">Service scaling</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>tags</td> <td>tags</td>
@ -4547,11 +4547,11 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>deployment_strategy</td> <td>deployment_strategy</td>
<td>(optional) Container distribution among nodes. A service cannot be updated to or from a deployment strategy of <code class="prettyprint">EVERY_NODE</code>. (See table <code class="prettyprint">Deployment strategies</code> above and <a href="../../docker-cloud/infrastructure/deployment-strategies/">Deployment strategies</a> for more information)</td> <td>(optional) Container distribution among nodes. A service cannot be updated to or from a deployment strategy of <code class="prettyprint">EVERY_NODE</code>. (See table <code class="prettyprint">Deployment strategies</code> above and <a href="/docker-cloud/infrastructure/deployment-strategies/">Deployment strategies</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>autoredeploy</td> <td>autoredeploy</td>
<td>Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (see <a href="../../docker-cloud/apps/auto-redeploy/">Docker Cloud&rsquo;s private registry</a> for more information)</td> <td>Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (see <a href="/docker-cloud/apps/auto-redeploy/">Docker Cloud&rsquo;s private registry</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>net</td> <td>net</td>
@ -5239,7 +5239,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>cpu_shares</td> <td>cpu_shares</td>
<td>The relative CPU priority of the container (see <a href="../../engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td> <td>The relative CPU priority of the container (see <a href="/engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>cpuset</td> <td>cpuset</td>
@ -5247,7 +5247,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>memory</td> <td>memory</td>
<td>The memory limit of the container in MB (see <a href="../../engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td> <td>The memory limit of the container in MB (see <a href="/engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>memory_swap</td> <td>memory_swap</td>
@ -5255,19 +5255,19 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>autorestart</td> <td>autorestart</td>
<td>Whether to restart the container automatically if it stops (see <a href="../../docker-cloud/apps/autorestart/">Crash recovery</a> for more information)</td> <td>Whether to restart the container automatically if it stops (see <a href="/docker-cloud/apps/autorestart/">Crash recovery</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>autodestroy</td> <td>autodestroy</td>
<td>Whether to terminate the container automatically if it stops (see <a href="../../docker-cloud/apps/auto-destroy/">Autodestroy</a> for more information)</td> <td>Whether to terminate the container automatically if it stops (see <a href="/docker-cloud/apps/auto-destroy/">Autodestroy</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>roles</td> <td>roles</td>
<td>List of Docker Cloud roles asigned to this container (see <a href="../../docker-cloud/apps/api-roles/">API roles</a> for more information))</td> <td>List of Docker Cloud roles asigned to this container (see <a href="/docker-cloud/apps/api-roles/">API roles</a> for more information))</td>
</tr> </tr>
<tr> <tr>
<td>linked_to_container</td> <td>linked_to_container</td>
<td>List of IP addresses of the linked containers (see table <code class="prettyprint">Container Link attributes</code> below and <a href="../../docker-cloud/apps/service-links/">Service links</a> for more information)</td> <td>List of IP addresses of the linked containers (see table <code class="prettyprint">Container Link attributes</code> below and <a href="/docker-cloud/apps/service-links/">Service links</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>link_variables</td> <td>link_variables</td>
@ -5275,7 +5275,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>privileged</td> <td>privileged</td>
<td>Whether the container has Docker&rsquo;s <code class="prettyprint">privileged</code> flag set or not (see <a href="../../engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration">Runtime privilege</a> for more information)</td> <td>Whether the container has Docker&rsquo;s <code class="prettyprint">privileged</code> flag set or not (see <a href="/engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration">Runtime privilege</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>read_only</td> <td>read_only</td>
@ -5287,11 +5287,11 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>net</td> <td>net</td>
<td>Network mode set on the container (see table <code class="prettyprint">Network Modes</code> below, more information ../../reference/run/#network-settings)</td> <td>Network mode set on the container (see table <code class="prettyprint">Network Modes</code> below, <a href="/engine/reference/run/#network-settings">more information</a>)</td>
</tr> </tr>
<tr> <tr>
<td>pid</td> <td>pid</td>
<td>PID (Process) Namespace mode for the container (more information ../../reference/run/#pid-settings-pid)</td> <td>PID (Process) Namespace mode for the container (<a href="/engine/reference/run/#pid-settings-pid">more information</a>)</td>
</tr> </tr>
</tbody></table> </tbody></table>
@ -5954,7 +5954,7 @@ container.execute("ls", handler=msg_handler)
</span><span class="p">}</span><span class="w"> </span><span class="p">}</span><span class="w">
</span></code></pre> </span></code></pre>
<p>Triggers are URLs that will start a redeploy of the service whenever a <code class="prettyprint">POST</code> request is sent to them. They require no authorization headers, so they should be treated as access tokens. Triggers can be revoked if they are leaked or no longer used for security purposes. See <a href="../../docker-cloud/apps/triggers/">Triggers</a> for more information.</p> <p>Triggers are URLs that will start a redeploy of the service whenever a <code class="prettyprint">POST</code> request is sent to them. They require no authorization headers, so they should be treated as access tokens. Triggers can be revoked if they are leaked or no longer used for security purposes. See <a href="/docker-cloud/apps/triggers/">Triggers</a> for more information.</p>
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p> <p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>

22
apidocs/docker-cloud/javascripts/all.js
View File

File diff suppressed because one or more lines are too long

8
apidocs/docker-cloud/javascripts/all_nosearch.js
View File

File diff suppressed because one or more lines are too long

92
apidocs/layouts/single.html
View File

@ -176,7 +176,7 @@ set this globally, or specify it before each CLI command. To learn more, see the
<p>The CLI and the SDKs will detect this environment variable and automatically use it</p> <p>The CLI and the SDKs will detect this environment variable and automatically use it</p>
</blockquote> </blockquote>
<p>If you give an <a href="../../docker-cloud/apps/api-roles/">API role</a> to a container, the environment variable <code class="prettyprint">DOCKERCLOUD_AUTH</code> inside the container will have the contents of the <code class="prettyprint">Authorization</code> header that you can use to authenticate against the REST or Stream APIs:</p> <p>If you give an <a href="/docker-cloud/apps/api-roles/">API role</a> to a container, the environment variable <code class="prettyprint">DOCKERCLOUD_AUTH</code> inside the container will have the contents of the <code class="prettyprint">Authorization</code> header that you can use to authenticate against the REST or Stream APIs:</p>
<p><code class="prettyprint">curl -H &quot;Authorization: $DOCKERCLOUD_AUTH&quot; https://cloud.docker.com/api/app/v1/service/</code></p> <p><code class="prettyprint">curl -H &quot;Authorization: $DOCKERCLOUD_AUTH&quot; https://cloud.docker.com/api/app/v1/service/</code></p>
@ -1387,7 +1387,7 @@ set this globally, or specify it before each CLI command. To learn more, see the
</tr> </tr>
<tr> <tr>
<td>tags</td> <td>tags</td>
<td>List of tags to identify the node cluster nodes when deploying services (see <a href="../../docker-cloud/apps/deploy-tags/">Tags</a> for more information)</td> <td>List of tags to identify the node cluster nodes when deploying services (see <a href="/docker-cloud/apps/deploy-tags/">Tags</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>provider_options</td> <td>provider_options</td>
@ -1596,7 +1596,7 @@ set this globally, or specify it before each CLI command. To learn more, see the
</tr> </tr>
<tr> <tr>
<td>tags</td> <td>tags</td>
<td>(optional) List of tags of the node cluster to be used when deploying services see <a href="../../docker-cloud/apps/deploy-tags/">Tags</a> for more information) (default: <code class="prettyprint">[]</code>)</td> <td>(optional) List of tags of the node cluster to be used when deploying services see <a href="/docker-cloud/apps/deploy-tags/">Tags</a> for more information) (default: <code class="prettyprint">[]</code>)</td>
</tr> </tr>
<tr> <tr>
<td>provider_options</td> <td>provider_options</td>
@ -1954,7 +1954,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>tags</td> <td>tags</td>
<td>List of tags to identify the node when deploying services (see <a href="../../docker-cloud/apps/deploy-tags/">Tags</a> for more information)</td> <td>List of tags to identify the node when deploying services (see <a href="/docker-cloud/apps/deploy-tags/">Tags</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>nickname</td> <td>nickname</td>
@ -2208,7 +2208,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
<pre class="highlight shell"><code>docker-cloud node upgrade 7eaf7fff <pre class="highlight shell"><code>docker-cloud node upgrade 7eaf7fff
</code></pre> </code></pre>
<p>Upgrades the docker daemon of the node. This will restart your containers on that node. See <a href="../../docker-cloud/infrastructure/docker-upgrade/">Docker upgrade</a> for more information.</p> <p>Upgrades the docker daemon of the node. This will restart your containers on that node. See <a href="/docker-cloud/infrastructure/docker-upgrade/">Docker upgrade</a> for more information.</p>
<h3 id="endpoint-type">Endpoint Type</h3> <h3 id="endpoint-type">Endpoint Type</h3>
@ -2966,7 +2966,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
<pre class="highlight shell"><code>docker-cloud stack create --name hello-world -f docker-compose.yml <pre class="highlight shell"><code>docker-cloud stack create --name hello-world -f docker-compose.yml
</code></pre> </code></pre>
<p>Creates a new stack without starting it. Note that the JSON syntax is abstracted by both, the Docker Cloud CLI and our UI, in order to use <a href="../../docker-cloud/apps/stack-yaml-reference/">Stack YAML files</a>.</p> <p>Creates a new stack without starting it. Note that the JSON syntax is abstracted by both, the Docker Cloud CLI and our UI, in order to use <a href="/docker-cloud/apps/stack-yaml-reference/">Stack YAML files</a>.</p>
<h3 id="endpoint-type">Endpoint Type</h3> <h3 id="endpoint-type">Endpoint Type</h3>
@ -3024,7 +3024,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
<pre class="highlight shell"><code>docker-cloud stack <span class="nb">export </span>46aca402 <pre class="highlight shell"><code>docker-cloud stack <span class="nb">export </span>46aca402
</code></pre> </code></pre>
<p>Get a JSON representation of the stack following the <a href="../../docker-cloud/apps/stacks/">Stack YAML representation</a>.</p> <p>Get a JSON representation of the stack following the <a href="/docker-cloud/apps/stacks/">Stack YAML representation</a>.</p>
<h3 id="endpoint-type">Endpoint Type</h3> <h3 id="endpoint-type">Endpoint Type</h3>
@ -3607,11 +3607,11 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>net</td> <td>net</td>
<td>Network mode to set on the containers (see table <code class="prettyprint">Network Modes</code> below, more information ../../docker-cloud/apps/service-links/)</td> <td>Network mode to set on the containers (see table <code class="prettyprint">Network Modes</code> below, more information /docker-cloud/apps/service-links/)</td>
</tr> </tr>
<tr> <tr>
<td>pid</td> <td>pid</td>
<td>Set the PID (Process) Namespace mode for the containers (more information ../../reference/run/#pid-settings-pid)</td> <td>Set the PID (Process) Namespace mode for the containers (<a href="/engine/reference/run/#pid-settings-pid">more information</a>)</td>
</tr> </tr>
<tr> <tr>
<td>synchronized</td> <td>synchronized</td>
@ -3739,11 +3739,11 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>sequential_deployment</td> <td>sequential_deployment</td>
<td>Whether the containers for this service should be deployed in sequence, linking each of them to the previous containers (see <a href="../../docker-cloud/apps/service-scaling/">Service scaling</a> for more information)</td> <td>Whether the containers for this service should be deployed in sequence, linking each of them to the previous containers (see <a href="/docker-cloud/apps/service-scaling/">Service scaling</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>cpu_shares</td> <td>cpu_shares</td>
<td>The relative CPU priority of the containers of the service (see <a href="../../engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td> <td>The relative CPU priority of the containers of the service (see <a href="/engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>cpuset</td> <td>cpuset</td>
@ -3751,7 +3751,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>memory</td> <td>memory</td>
<td>The memory limit of the containers of the service in MB (see <a href="../../engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td> <td>The memory limit of the containers of the service in MB (see <a href="/engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>memory_swap</td> <td>memory_swap</td>
@ -3771,15 +3771,15 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>autorestart</td> <td>autorestart</td>
<td>Whether to restart the containers of the service automatically if they stop (see <a href="../../docker-cloud/apps/autorestart/">Crash recovery</a> for more information)</td> <td>Whether to restart the containers of the service automatically if they stop (see <a href="/docker-cloud/apps/autorestart/">Crash recovery</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>autodestroy</td> <td>autodestroy</td>
<td>Whether to terminate the containers of the service automatically if they stop (see <a href="../../docker-cloud/apps/auto-destroy/">Autodestroy</a> for more information)</td> <td>Whether to terminate the containers of the service automatically if they stop (see <a href="/docker-cloud/apps/auto-destroy/">Autodestroy</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>roles</td> <td>roles</td>
<td>List of Docker Cloud roles assigned to this service (see <a href="../../docker-cloud/apps/service-links/">Service links</a> for more information)</td> <td>List of Docker Cloud roles assigned to this service (see <a href="/docker-cloud/apps/service-links/">Service links</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>link_variables</td> <td>link_variables</td>
@ -3787,7 +3787,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>privileged</td> <td>privileged</td>
<td>Whether to start the containers with Docker&rsquo;s <code class="prettyprint">privileged</code> flag set or not, which allows containers to access all devices on the host among other things (see <a href="../../engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration">Runtime privilege</a> for more information)</td> <td>Whether to start the containers with Docker&rsquo;s <code class="prettyprint">privileged</code> flag set or not, which allows containers to access all devices on the host among other things (see <a href="/engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration">Runtime privilege</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>read_only</td> <td>read_only</td>
@ -3795,15 +3795,15 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>deployment_strategy</td> <td>deployment_strategy</td>
<td>Container distribution among nodes (see table <code class="prettyprint">Deployment strategies</code> below and <a href="../../docker-cloud/infrastructure/deployment-strategies/">Deployment strategies</a> for more information)</td> <td>Container distribution among nodes (see table <code class="prettyprint">Deployment strategies</code> below and <a href="/docker-cloud/infrastructure/deployment-strategies/">Deployment strategies</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>tags</td> <td>tags</td>
<td>List of tags to be used to deploy the service (see <a href="../../docker-cloud/apps/deploy-tags/">Tags</a> for more information)</td> <td>List of tags to be used to deploy the service (see <a href="/docker-cloud/apps/deploy-tags/">Tags</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>autoredeploy</td> <td>autoredeploy</td>
<td>Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (see <a href="../../docker-cloud/apps/auto-redeploy/">Docker Cloud&rsquo;s private registry</a> for more information)</td> <td>Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (see <a href="/docker-cloud/apps/auto-redeploy/">Docker Cloud&rsquo;s private registry</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>nickname</td> <td>nickname</td>
@ -4143,35 +4143,35 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>autorestart</td> <td>autorestart</td>
<td>(optional) Whether the containers for this service should be restarted if they stop, i.e. <code class="prettyprint">ALWAYS</code> (default: <code class="prettyprint">OFF</code>, possible values: <code class="prettyprint">OFF</code>, <code class="prettyprint">ON_FAILURE</code>, <code class="prettyprint">ALWAYS</code>) (see <a href="../../docker-cloud/apps/autorestart/">Crash recovery</a> for more information)</td> <td>(optional) Whether the containers for this service should be restarted if they stop, i.e. <code class="prettyprint">ALWAYS</code> (default: <code class="prettyprint">OFF</code>, possible values: <code class="prettyprint">OFF</code>, <code class="prettyprint">ON_FAILURE</code>, <code class="prettyprint">ALWAYS</code>) (see <a href="/docker-cloud/apps/autorestart/">Crash recovery</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>autodestroy</td> <td>autodestroy</td>
<td>(optional) Whether the containers should be terminated if they stop, i.e. <code class="prettyprint">OFF</code> (default: <code class="prettyprint">OFF</code>, possible values: <code class="prettyprint">OFF</code>, <code class="prettyprint">ON_SUCCESS</code>, <code class="prettyprint">ALWAYS</code>) (see <a href="../../docker-cloud/apps/auto-destroy/">Autodestroy</a> for more information)</td> <td>(optional) Whether the containers should be terminated if they stop, i.e. <code class="prettyprint">OFF</code> (default: <code class="prettyprint">OFF</code>, possible values: <code class="prettyprint">OFF</code>, <code class="prettyprint">ON_SUCCESS</code>, <code class="prettyprint">ALWAYS</code>) (see <a href="/docker-cloud/apps/auto-destroy/">Autodestroy</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>sequential_deployment</td> <td>sequential_deployment</td>
<td>(optional) Whether the containers should be launched and scaled in sequence, i.e. <code class="prettyprint">true</code> (default: <code class="prettyprint">false</code>) (see <a href="../../docker-cloud/apps/service-scaling/">Service scaling</a> for more information)</td> <td>(optional) Whether the containers should be launched and scaled in sequence, i.e. <code class="prettyprint">true</code> (default: <code class="prettyprint">false</code>) (see <a href="/docker-cloud/apps/service-scaling/">Service scaling</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>roles</td> <td>roles</td>
<td>(optional) A list of Docker Cloud API roles to grant the service, i.e. <code class="prettyprint">[&quot;global&quot;]</code> (default: <code class="prettyprint">[]</code>, possible values: <code class="prettyprint">global</code>) (see <a href="../../docker-cloud/apps/service-links/">Service links</a> for more information)</td> <td>(optional) A list of Docker Cloud API roles to grant the service, i.e. <code class="prettyprint">[&quot;global&quot;]</code> (default: <code class="prettyprint">[]</code>, possible values: <code class="prettyprint">global</code>) (see <a href="/docker-cloud/apps/service-links/">Service links</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>privileged</td> <td>privileged</td>
<td>(optional) Whether to start the containers with Docker&rsquo;s <code class="prettyprint">privileged</code> flag set or not, i.e. <code class="prettyprint">false</code> (default: <code class="prettyprint">false</code>) (see <a href="../../engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration">Runtime privilege</a> for more information)</td> <td>(optional) Whether to start the containers with Docker&rsquo;s <code class="prettyprint">privileged</code> flag set or not, i.e. <code class="prettyprint">false</code> (default: <code class="prettyprint">false</code>) (see <a href="/engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration">Runtime privilege</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>deployment_strategy</td> <td>deployment_strategy</td>
<td>(optional) Container distribution among nodes (default: <code class="prettyprint">EMPTIEST_NODE</code>, see table <code class="prettyprint">Deployment strategies</code> above and <a href="../../docker-cloud/infrastructure/deployment-strategies/">Deployment strategies</a> for more information)</td> <td>(optional) Container distribution among nodes (default: <code class="prettyprint">EMPTIEST_NODE</code>, see table <code class="prettyprint">Deployment strategies</code> above and <a href="/docker-cloud/infrastructure/deployment-strategies/">Deployment strategies</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>tags</td> <td>tags</td>
<td>(optional) A list of tags to be used to deploy the service (see <a href="../../docker-cloud/apps/deploy-tags/">Tags</a> for more information) (default: <code class="prettyprint">[]</code>)</td> <td>(optional) A list of tags to be used to deploy the service (see <a href="/docker-cloud/apps/deploy-tags/">Tags</a> for more information) (default: <code class="prettyprint">[]</code>)</td>
</tr> </tr>
<tr> <tr>
<td>autoredeploy</td> <td>autoredeploy</td>
<td>(optional) Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (default: <code class="prettyprint">false</code>) (see <a href="../../docker-cloud/apps/auto-redeploy/">Docker Cloud&rsquo;s private registry</a> for more information)</td> <td>(optional) Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (default: <code class="prettyprint">false</code>) (see <a href="/docker-cloud/apps/auto-redeploy/">Docker Cloud&rsquo;s private registry</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>net</td> <td>net</td>
@ -4487,11 +4487,11 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</thead><tbody> </thead><tbody>
<tr> <tr>
<td>autorestart</td> <td>autorestart</td>
<td>(optional) Whether the containers for this service should be restarted if they stop, i.e. <code class="prettyprint">ALWAYS</code> (possible values: <code class="prettyprint">OFF</code>, <code class="prettyprint">ON_FAILURE</code>, <code class="prettyprint">ALWAYS</code>) (see <a href="../../docker-cloud/apps/autorestart/">Crash recovery</a> for more information)</td> <td>(optional) Whether the containers for this service should be restarted if they stop, i.e. <code class="prettyprint">ALWAYS</code> (possible values: <code class="prettyprint">OFF</code>, <code class="prettyprint">ON_FAILURE</code>, <code class="prettyprint">ALWAYS</code>) (see <a href="/docker-cloud/apps/autorestart/">Crash recovery</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>autodestroy</td> <td>autodestroy</td>
<td>(optional) Whether the containers should be terminated if they stop, i.e. <code class="prettyprint">OFF</code> (possible values: <code class="prettyprint">OFF</code>, <code class="prettyprint">ON_SUCCESS</code>, <code class="prettyprint">ALWAYS</code>) (see <a href="../../docker-cloud/apps/auto-destroy/">Autodestroy</a> for more information)</td> <td>(optional) Whether the containers should be terminated if they stop, i.e. <code class="prettyprint">OFF</code> (possible values: <code class="prettyprint">OFF</code>, <code class="prettyprint">ON_SUCCESS</code>, <code class="prettyprint">ALWAYS</code>) (see <a href="/docker-cloud/apps/auto-destroy/">Autodestroy</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>container_envvars</td> <td>container_envvars</td>
@ -4503,7 +4503,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>cpu_shares</td> <td>cpu_shares</td>
<td>(optional) The relative CPU priority of the containers the service describes (see <a href="../../engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td> <td>(optional) The relative CPU priority of the containers the service describes (see <a href="/engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>entrypoint</td> <td>entrypoint</td>
@ -4519,15 +4519,15 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>memory</td> <td>memory</td>
<td>(optional) The memory limit of the containers of the service in MB (see <a href="../../engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td> <td>(optional) The memory limit of the containers of the service in MB (see <a href="/engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>privileged</td> <td>privileged</td>
<td>(optional) Whether to start the containers with Docker&rsquo;s <code class="prettyprint">privileged</code> flag set or not, i.e. <code class="prettyprint">false</code> (see <a href="../../engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration">Runtime privilege</a> for more information)</td> <td>(optional) Whether to start the containers with Docker&rsquo;s <code class="prettyprint">privileged</code> flag set or not, i.e. <code class="prettyprint">false</code> (see <a href="/engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration">Runtime privilege</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>roles</td> <td>roles</td>
<td>(optional) A list of Docker Cloud API roles to grant the service, i.e. <code class="prettyprint">[&quot;global&quot;]</code> (possible values: <code class="prettyprint">global</code>) (see <a href="../../docker-cloud/apps/service-links/">Service links</a> for more information)</td> <td>(optional) A list of Docker Cloud API roles to grant the service, i.e. <code class="prettyprint">[&quot;global&quot;]</code> (possible values: <code class="prettyprint">global</code>) (see <a href="/docker-cloud/apps/service-links/">Service links</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>run_command</td> <td>run_command</td>
@ -4535,7 +4535,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>sequential_deployment</td> <td>sequential_deployment</td>
<td>(optional) Whether the containers should be launched and scaled in sequence, i.e. <code class="prettyprint">true</code> (see <a href="../../docker-cloud/apps/service-scaling/">Service scaling</a> for more information)</td> <td>(optional) Whether the containers should be launched and scaled in sequence, i.e. <code class="prettyprint">true</code> (see <a href="/docker-cloud/apps/service-scaling/">Service scaling</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>tags</td> <td>tags</td>
@ -4547,11 +4547,11 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>deployment_strategy</td> <td>deployment_strategy</td>
<td>(optional) Container distribution among nodes. A service cannot be updated to or from a deployment strategy of <code class="prettyprint">EVERY_NODE</code>. (See table <code class="prettyprint">Deployment strategies</code> above and <a href="../../docker-cloud/infrastructure/deployment-strategies/">Deployment strategies</a> for more information)</td> <td>(optional) Container distribution among nodes. A service cannot be updated to or from a deployment strategy of <code class="prettyprint">EVERY_NODE</code>. (See table <code class="prettyprint">Deployment strategies</code> above and <a href="/docker-cloud/infrastructure/deployment-strategies/">Deployment strategies</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>autoredeploy</td> <td>autoredeploy</td>
<td>Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (see <a href="../../docker-cloud/apps/auto-redeploy/">Docker Cloud&rsquo;s private registry</a> for more information)</td> <td>Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (see <a href="/docker-cloud/apps/auto-redeploy/">Docker Cloud&rsquo;s private registry</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>net</td> <td>net</td>
@ -5239,7 +5239,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>cpu_shares</td> <td>cpu_shares</td>
<td>The relative CPU priority of the container (see <a href="../../engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td> <td>The relative CPU priority of the container (see <a href="/engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>cpuset</td> <td>cpuset</td>
@ -5247,7 +5247,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>memory</td> <td>memory</td>
<td>The memory limit of the container in MB (see <a href="../../engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td> <td>The memory limit of the container in MB (see <a href="/engine/reference/run/#runtime-constraints-on-cpu-and-memory">Runtime Constraints on CPU and Memory</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>memory_swap</td> <td>memory_swap</td>
@ -5255,19 +5255,19 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>autorestart</td> <td>autorestart</td>
<td>Whether to restart the container automatically if it stops (see <a href="../../docker-cloud/apps/autorestart/">Crash recovery</a> for more information)</td> <td>Whether to restart the container automatically if it stops (see <a href="/docker-cloud/apps/autorestart/">Crash recovery</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>autodestroy</td> <td>autodestroy</td>
<td>Whether to terminate the container automatically if it stops (see <a href="../../docker-cloud/apps/auto-destroy/">Autodestroy</a> for more information)</td> <td>Whether to terminate the container automatically if it stops (see <a href="/docker-cloud/apps/auto-destroy/">Autodestroy</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>roles</td> <td>roles</td>
<td>List of Docker Cloud roles asigned to this container (see <a href="../../docker-cloud/apps/api-roles/">API roles</a> for more information))</td> <td>List of Docker Cloud roles asigned to this container (see <a href="/docker-cloud/apps/api-roles/">API roles</a> for more information))</td>
</tr> </tr>
<tr> <tr>
<td>linked_to_container</td> <td>linked_to_container</td>
<td>List of IP addresses of the linked containers (see table <code class="prettyprint">Container Link attributes</code> below and <a href="../../docker-cloud/apps/service-links/">Service links</a> for more information)</td> <td>List of IP addresses of the linked containers (see table <code class="prettyprint">Container Link attributes</code> below and <a href="/docker-cloud/apps/service-links/">Service links</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>link_variables</td> <td>link_variables</td>
@ -5275,7 +5275,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>privileged</td> <td>privileged</td>
<td>Whether the container has Docker&rsquo;s <code class="prettyprint">privileged</code> flag set or not (see <a href="../../engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration">Runtime privilege</a> for more information)</td> <td>Whether the container has Docker&rsquo;s <code class="prettyprint">privileged</code> flag set or not (see <a href="/engine/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration">Runtime privilege</a> for more information)</td>
</tr> </tr>
<tr> <tr>
<td>read_only</td> <td>read_only</td>
@ -5287,11 +5287,11 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
</tr> </tr>
<tr> <tr>
<td>net</td> <td>net</td>
<td>Network mode set on the container (see table <code class="prettyprint">Network Modes</code> below, more information ../../reference/run/#network-settings)</td> <td>Network mode set on the container (see table <code class="prettyprint">Network Modes</code> below, <a href="/engine/reference/run/#network-settings">more information</a>)</td>
</tr> </tr>
<tr> <tr>
<td>pid</td> <td>pid</td>
<td>PID (Process) Namespace mode for the container (more information ../../reference/run/#pid-settings-pid)</td> <td>PID (Process) Namespace mode for the container (<a href="/engine/reference/run/#pid-settings-pid">more information</a>)</td>
</tr> </tr>
</tbody></table> </tbody></table>
@ -5954,7 +5954,7 @@ container.execute("ls", handler=msg_handler)
</span><span class="p">}</span><span class="w"> </span><span class="p">}</span><span class="w">
</span></code></pre> </span></code></pre>
<p>Triggers are URLs that will start a redeploy of the service whenever a <code class="prettyprint">POST</code> request is sent to them. They require no authorization headers, so they should be treated as access tokens. Triggers can be revoked if they are leaked or no longer used for security purposes. See <a href="../../docker-cloud/apps/triggers/">Triggers</a> for more information.</p> <p>Triggers are URLs that will start a redeploy of the service whenever a <code class="prettyprint">POST</code> request is sent to them. They require no authorization headers, so they should be treated as access tokens. Triggers can be revoked if they are leaked or no longer used for security purposes. See <a href="/docker-cloud/apps/triggers/">Triggers</a> for more information.</p>
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p> <p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>