diff --git a/apidocs/cloud-api-source/source/includes/container.md b/apidocs/cloud-api-source/source/includes/container.md index bcf4e51e43..41be23b5a8 100644 --- a/apidocs/cloud-api-source/source/includes/container.md +++ b/apidocs/cloud-api-source/source/includes/container.md @@ -297,20 +297,20 @@ extra_hosts | List of container hostname mappings secuirty_opt | Labeling scheme of this container entrypoint | Entrypoint 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 -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 -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) -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) +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) +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) 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 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) -pid | PID (Process) Namespace mode for the container (more information ../../reference/run/#pid-settings-pid) +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](/engine/reference/run/#pid-settings-pid)) ### Container Binding attributes diff --git a/apidocs/cloud-api-source/source/includes/node.md b/apidocs/cloud-api-source/source/includes/node.md index 1abba0af9a..71293c0e62 100644 --- a/apidocs/cloud-api-source/source/includes/node.md +++ b/apidocs/cloud-api-source/source/includes/node.md @@ -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 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) -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) @@ -276,7 +276,7 @@ Accept: application/json 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 diff --git a/apidocs/cloud-api-source/source/includes/nodecluster.md b/apidocs/cloud-api-source/source/includes/nodecluster.md index b9f422a67f..f5b6b079c2 100644 --- a/apidocs/cloud-api-source/source/includes/nodecluster.md +++ b/apidocs/cloud-api-source/source/includes/nodecluster.md @@ -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 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) -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) 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 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`) -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) diff --git a/apidocs/cloud-api-source/source/includes/service.md b/apidocs/cloud-api-source/source/includes/service.md index 3659998797..8b77b1ec04 100644 --- a/apidocs/cloud-api-source/source/includes/service.md +++ b/apidocs/cloud-api-source/source/includes/service.md @@ -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. 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) -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) +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](/engine/reference/run/#pid-settings-pid)) 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) 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 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 -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) +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) 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 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) 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) -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) +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) +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 -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) -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) -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) +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) +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) @@ -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) 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) -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) -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) -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) -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) +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) +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) +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) +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) 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`) 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 --------- | ----------- -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) +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) 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`) -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` 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) -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) -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) +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) +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` -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 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) -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) +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) 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`) working_dir | (optional) Working directory for running binaries within a container of this service (default: `/`) diff --git a/apidocs/cloud-api-source/source/includes/stack.md b/apidocs/cloud-api-source/source/includes/stack.md index e87a066257..bf1bbae5a0 100644 --- a/apidocs/cloud-api-source/source/includes/stack.md +++ b/apidocs/cloud-api-source/source/includes/stack.md @@ -157,7 +157,7 @@ Content-Type: application/json 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 @@ -210,7 +210,7 @@ Accept: application/json 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 diff --git a/apidocs/cloud-api-source/source/includes/tag.md b/apidocs/cloud-api-source/source/includes/tag.md index 914afaa62b..ccd334ede5 100644 --- a/apidocs/cloud-api-source/source/includes/tag.md +++ b/apidocs/cloud-api-source/source/includes/tag.md @@ -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 diff --git a/apidocs/cloud-api-source/source/includes/triggers.md b/apidocs/cloud-api-source/source/includes/triggers.md index 2223d71a7e..768eb9ec87 100644 --- a/apidocs/cloud-api-source/source/includes/triggers.md +++ b/apidocs/cloud-api-source/source/includes/triggers.md @@ -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). diff --git a/apidocs/cloud-api-source/source/index.md b/apidocs/cloud-api-source/source/index.md index 20dd077ff5..014c2c4c5f 100644 --- a/apidocs/cloud-api-source/source/index.md +++ b/apidocs/cloud-api-source/source/index.md @@ -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 -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/` diff --git a/apidocs/docker-cloud/includes/container.html b/apidocs/docker-cloud/includes/container.html index 41b18264d3..5fcb44f79e 100644 --- a/apidocs/docker-cloud/includes/container.html +++ b/apidocs/docker-cloud/includes/container.html @@ -494,11 +494,11 @@
Network Modes
below, more information /reference/run/#network-settings)Network Modes
below, more information)The CLI and the SDKs will detect this environment variable and automatically use it
-If you give an API role 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 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/
[]
)[]
)docker-cloud node upgrade 7eaf7fff
-Upgrades the docker daemon of the node. This will restart your containers on that node. See Docker upgrade for more information.
+Upgrades the docker daemon of the node. This will restart your containers on that node. See Docker upgrade for more information.
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.
+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 stack export 46aca402
-Get a JSON representation of the stack following the Stack YAML representation.
+Get a JSON representation of the stack following the Stack YAML representation.
Network Modes
below, more information ../../docker-cloud/apps/service-links/)Network Modes
below, more information /docker-cloud/apps/service-links/)privileged
flag set or not, which allows containers to access all devices on the host among other things (see Runtime privilege for more information)privileged
flag set or not, which allows containers to access all devices on the host among other things (see Runtime privilege for more information)Deployment strategies
below and Deployment strategies for more information)Deployment strategies
below and Deployment strategies for more information)ALWAYS
(default: OFF
, possible values: OFF
, ON_FAILURE
, ALWAYS
) (see Crash recovery for more information)ALWAYS
(default: OFF
, possible values: OFF
, ON_FAILURE
, ALWAYS
) (see Crash recovery for more information)OFF
(default: OFF
, possible values: OFF
, ON_SUCCESS
, ALWAYS
) (see Autodestroy for more information)OFF
(default: OFF
, possible values: OFF
, ON_SUCCESS
, ALWAYS
) (see Autodestroy for more information)true
(default: false
) (see Service scaling for more information)true
(default: false
) (see Service scaling for more information)["global"]
(default: []
, possible values: global
) (see Service links for more information)["global"]
(default: []
, possible values: global
) (see Service links for more information)privileged
flag set or not, i.e. false
(default: false
) (see Runtime privilege for more information)privileged
flag set or not, i.e. false
(default: false
) (see Runtime privilege for more information)EMPTIEST_NODE
, see table Deployment strategies
above and Deployment strategies for more information)EMPTIEST_NODE
, see table Deployment strategies
above and Deployment strategies for more information)[]
)[]
)false
) (see Docker Cloud’s private registry for more information)false
) (see Docker Cloud’s private registry for more information)ALWAYS
(possible values: OFF
, ON_FAILURE
, ALWAYS
) (see Crash recovery for more information)ALWAYS
(possible values: OFF
, ON_FAILURE
, ALWAYS
) (see Crash recovery for more information)OFF
(possible values: OFF
, ON_SUCCESS
, ALWAYS
) (see Autodestroy for more information)OFF
(possible values: OFF
, ON_SUCCESS
, ALWAYS
) (see Autodestroy for more information)privileged
flag set or not, i.e. false
(see Runtime privilege for more information)privileged
flag set or not, i.e. false
(see Runtime privilege for more information)["global"]
(possible values: global
) (see Service links for more information)["global"]
(possible values: global
) (see Service links for more information)true
(see Service scaling for more information)true
(see Service scaling for more information)EVERY_NODE
. (See table Deployment strategies
above and Deployment strategies for more information)EVERY_NODE
. (See table Deployment strategies
above and Deployment strategies for more information)Container Link attributes
below and Service links for more information)Container Link attributes
below and Service links for more information)privileged
flag set or not (see Runtime privilege for more information)privileged
flag set or not (see Runtime privilege for more information)Network Modes
below, more information ../../reference/run/#network-settings)Network Modes
below, 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 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 for more information.
This is a namespaced endpoint.
diff --git a/apidocs/docker-cloud/javascripts/all.js b/apidocs/docker-cloud/javascripts/all.js index a0773c13f0..a7bf81a395 100644 --- a/apidocs/docker-cloud/javascripts/all.js +++ b/apidocs/docker-cloud/javascripts/all.js @@ -1,4 +1,4 @@ -!function(){if("ontouchstart"in window){var e,t,n,i,o,r,s={};e=function(e,t){return Math.abs(e[0]-t[0])>5||Math.abs(e[1]-t[1])>5},t=function(e){this.startXY=[e.touches[0].clientX,e.touches[0].clientY],this.threshold=!1},n=function(t){return this.threshold?!1:void(this.threshold=e(this.startXY,[t.touches[0].clientX,t.touches[0].clientY]))},i=function(t){if(!this.threshold&&!e(this.startXY,[t.changedTouches[0].clientX,t.changedTouches[0].clientY])){var n=t.changedTouches[0],i=document.createEvent("MouseEvents");i.initMouseEvent("click",!0,!0,window,0,n.screenX,n.screenY,n.clientX,n.clientY,!1,!1,!1,!1,0,null),i.simulated=!0,t.target.dispatchEvent(i)}},o=function(e){var t=Date.now(),n=t-s.time,i=e.clientX,o=e.clientY,a=[Math.abs(s.x-i),Math.abs(s.y-o)],c=r(e.target,"A")||e.target,h=c.nodeName,l="A"===h,u=window.navigator.standalone&&l&&e.target.getAttribute("href");return s.time=t,s.x=i,s.y=o,(!e.simulated&&(500>n||1500>n&&a[0]<50&&a[1]<50)||u)&&(e.preventDefault(),e.stopPropagation(),!u)?!1:(u&&(window.location=c.getAttribute("href")),void(c&&c.classList&&(c.classList.add("energize-focus"),window.setTimeout(function(){c.classList.remove("energize-focus")},150))))},r=function(e,t){for(var n=e;n!==document.body;){if(!n||n.nodeName===t)return n;n=n.parentNode}return null},document.addEventListener("touchstart",t,!1),document.addEventListener("touchmove",n,!1),document.addEventListener("touchend",i,!1),document.addEventListener("click",o,!0)}}(),/* +!function(){if("ontouchstart"in window){var e,t,n,i,o,s,r={};e=function(e,t){return Math.abs(e[0]-t[0])>5||Math.abs(e[1]-t[1])>5},t=function(e){this.startXY=[e.touches[0].clientX,e.touches[0].clientY],this.threshold=!1},n=function(t){return this.threshold?!1:void(this.threshold=e(this.startXY,[t.touches[0].clientX,t.touches[0].clientY]))},i=function(t){if(!this.threshold&&!e(this.startXY,[t.changedTouches[0].clientX,t.changedTouches[0].clientY])){var n=t.changedTouches[0],i=document.createEvent("MouseEvents");i.initMouseEvent("click",!0,!0,window,0,n.screenX,n.screenY,n.clientX,n.clientY,!1,!1,!1,!1,0,null),i.simulated=!0,t.target.dispatchEvent(i)}},o=function(e){var t=Date.now(),n=t-r.time,i=e.clientX,o=e.clientY,a=[Math.abs(r.x-i),Math.abs(r.y-o)],c=s(e.target,"A")||e.target,h=c.nodeName,l="A"===h,u=window.navigator.standalone&&l&&e.target.getAttribute("href");return r.time=t,r.x=i,r.y=o,(!e.simulated&&(500>n||1500>n&&a[0]<50&&a[1]<50)||u)&&(e.preventDefault(),e.stopPropagation(),!u)?!1:(u&&(window.location=c.getAttribute("href")),void(c&&c.classList&&(c.classList.add("energize-focus"),window.setTimeout(function(){c.classList.remove("energize-focus")},150))))},s=function(e,t){for(var n=e;n!==document.body;){if(!n||n.nodeName===t)return n;n=n.parentNode}return null},document.addEventListener("touchstart",t,!1),document.addEventListener("touchmove",n,!1),document.addEventListener("touchend",i,!1),document.addEventListener("click",o,!0)}}(),/* Copyright 2008-2013 Concur Technologies, Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may @@ -13,7 +13,7 @@ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ -function(e){"use strict";function t(t){if(t&&""!==t){$(".lang-selector a").removeClass("active"),$(".lang-selector a[data-language-name='"+t+"']").addClass("active");for(var n=0;nThe CLI and the SDKs will detect this environment variable and automatically use it
-If you give an API role 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 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/
[]
)[]
)docker-cloud node upgrade 7eaf7fff
-Upgrades the docker daemon of the node. This will restart your containers on that node. See Docker upgrade for more information.
+Upgrades the docker daemon of the node. This will restart your containers on that node. See Docker upgrade for more information.
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.
+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 stack export 46aca402
-Get a JSON representation of the stack following the Stack YAML representation.
+Get a JSON representation of the stack following the Stack YAML representation.
Network Modes
below, more information ../../docker-cloud/apps/service-links/)Network Modes
below, more information /docker-cloud/apps/service-links/)privileged
flag set or not, which allows containers to access all devices on the host among other things (see Runtime privilege for more information)privileged
flag set or not, which allows containers to access all devices on the host among other things (see Runtime privilege for more information)Deployment strategies
below and Deployment strategies for more information)Deployment strategies
below and Deployment strategies for more information)ALWAYS
(default: OFF
, possible values: OFF
, ON_FAILURE
, ALWAYS
) (see Crash recovery for more information)ALWAYS
(default: OFF
, possible values: OFF
, ON_FAILURE
, ALWAYS
) (see Crash recovery for more information)OFF
(default: OFF
, possible values: OFF
, ON_SUCCESS
, ALWAYS
) (see Autodestroy for more information)OFF
(default: OFF
, possible values: OFF
, ON_SUCCESS
, ALWAYS
) (see Autodestroy for more information)true
(default: false
) (see Service scaling for more information)true
(default: false
) (see Service scaling for more information)["global"]
(default: []
, possible values: global
) (see Service links for more information)["global"]
(default: []
, possible values: global
) (see Service links for more information)privileged
flag set or not, i.e. false
(default: false
) (see Runtime privilege for more information)privileged
flag set or not, i.e. false
(default: false
) (see Runtime privilege for more information)EMPTIEST_NODE
, see table Deployment strategies
above and Deployment strategies for more information)EMPTIEST_NODE
, see table Deployment strategies
above and Deployment strategies for more information)[]
)[]
)false
) (see Docker Cloud’s private registry for more information)false
) (see Docker Cloud’s private registry for more information)ALWAYS
(possible values: OFF
, ON_FAILURE
, ALWAYS
) (see Crash recovery for more information)ALWAYS
(possible values: OFF
, ON_FAILURE
, ALWAYS
) (see Crash recovery for more information)OFF
(possible values: OFF
, ON_SUCCESS
, ALWAYS
) (see Autodestroy for more information)OFF
(possible values: OFF
, ON_SUCCESS
, ALWAYS
) (see Autodestroy for more information)privileged
flag set or not, i.e. false
(see Runtime privilege for more information)privileged
flag set or not, i.e. false
(see Runtime privilege for more information)["global"]
(possible values: global
) (see Service links for more information)["global"]
(possible values: global
) (see Service links for more information)true
(see Service scaling for more information)true
(see Service scaling for more information)EVERY_NODE
. (See table Deployment strategies
above and Deployment strategies for more information)EVERY_NODE
. (See table Deployment strategies
above and Deployment strategies for more information)Container Link attributes
below and Service links for more information)Container Link attributes
below and Service links for more information)privileged
flag set or not (see Runtime privilege for more information)privileged
flag set or not (see Runtime privilege for more information)Network Modes
below, more information ../../reference/run/#network-settings)Network Modes
below, 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 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 for more information.
This is a namespaced endpoint.