mirror of https://github.com/docker/docs.git
Merge pull request #603 from londoncalling/vnext-compose-1.9.0-merge
Vnext compose 1.9.0 merge
This commit is contained in:
Victoria Bialas
GitHub
commit
272849d81e
|
|
@ -1,31 +0,0 @@
|
|||
# Files and directories here are not edited in the docker.github.io repo.
|
||||
# Instead, they are edited in the appropriate upstream repo and pulled
|
||||
# into this repo periodically. The intent is that if you submit a PR
|
||||
# with changes to these files or directories, a CI job will fail in the
|
||||
# PR, indicating that it should not be merged.
|
||||
|
||||
# If you need to edit these files or directories, submit a PR in one of the
|
||||
# following repos. The file will probably be located within the docs/ subdirectory.
|
||||
|
||||
# docker-trusted-registry: n/a, file an issue
|
||||
# engine: https://github.com/docker/docker
|
||||
# compose: https://github.com/docker/compose
|
||||
# notary: https://github.com/docker/notary
|
||||
# registry: https://github.com/docker/distribution
|
||||
# swarm: https://github.com/docker/swarm
|
||||
# ucp: n/a, file an issue
|
||||
|
||||
# Make sure directories have the trailing slash, keep the list alphabetical
|
||||
|
||||
apidocs/
|
||||
compose/reference/
|
||||
docker-trusted-registry/reference/
|
||||
engine/deprecated.md
|
||||
engine/extend/
|
||||
engine/reference/
|
||||
machine/reference/
|
||||
notary/reference/
|
||||
registry/configuration.md
|
||||
registry/spec/
|
||||
swarm/reference/
|
||||
ucp/reference/
|
||||
|
|
@ -0,0 +1 @@
|
|||
_data/.NOT_EDITED_HERE.yaml
|
||||
|
|
@ -9,6 +9,14 @@ let you know so that you can rebase it.
|
|||
>**Note**: To contribute code to Docker projects, see the
|
||||
[Contribution guidelines](opensource/project/who-written-for).
|
||||
|
||||
### Files not edited here
|
||||
|
||||
Files and directories listed in the `path:` keys in
|
||||
[`.NOT_EDITED_HERE.yaml`](/NOT_EDITED_HERE.yaml) are maintained in other
|
||||
repositories and should not be edited in this one. Pull requests against these
|
||||
files will be rejected. Make your edits to the files in the repository and path
|
||||
in the `source:` key in the YAML file.
|
||||
|
||||
### Quickstart
|
||||
|
||||
If you spot a problem while reading the documentation and want to try to fix it
|
||||
|
|
@ -79,10 +87,42 @@ The following `vnext` branches currently exist:
|
|||
docs for upcoming features in the [docker/kitematic](https://github.com/docker/kitematic/)
|
||||
project
|
||||
|
||||
## Collaborate on a pull request
|
||||
|
||||
Unless the PR author specifically disables it, you can push commits into another
|
||||
contributor's PR. You can do it from the command line by adding and fetching
|
||||
their remote, checking out their branch, and adding commits to it. Even easier,
|
||||
you can add commits from the Github web UI, by clicking the pencil icon for a
|
||||
given file in the **Files** view.
|
||||
|
||||
If a PR consists of multiple small addendum commits on top of a more significant
|
||||
one, the commit will usually be "squash-merged", so that only one commit is
|
||||
merged in. On occasion this is not appropriate and all commits will be kept
|
||||
separate when merging.
|
||||
|
||||
## Pull request guidelines
|
||||
|
||||
Help us review your PRs more quickly by following these guidelines.
|
||||
|
||||
- Try not to touch a large number of files in a single PR if possible.
|
||||
|
||||
- Don't change whitespace or line wrapping in parts of a file you are not
|
||||
editing for other reasons. Make sure your text editor is not configured to
|
||||
automatically reformat the whole file when saving.
|
||||
|
||||
- A Netlify test runs for each PR that is against one of our long-lived
|
||||
branches like `master` and the `vnext` branches, and deploys the result of
|
||||
your PR to a staging site. The URL will be available at the bottom of the PR
|
||||
in the **Conversation** view. Check the staging site for problems and fix them
|
||||
if necessary. Reviewers will check the staging site too.
|
||||
|
||||
If you can think of other ways we could streamline the review process, let us
|
||||
know.
|
||||
|
||||
## Style guide
|
||||
|
||||
If you have questions about how to write for Docker's documentation, please see
|
||||
the [style guide](https://docs.docker.com/opensource/doc-style/). The style guide provides
|
||||
guidance about grammar, syntax, formatting, styling, language, or tone. If
|
||||
something isn't clear in the guide, please submit an issue to let us know or
|
||||
submit a pull request to help us improve it.
|
||||
If you have questions about how to write for Docker's documentation, have a look
|
||||
at the [style guide](https://docs.docker.com/opensource/doc-style/). The style
|
||||
guide provides guidance about grammar, syntax, formatting, styling, language, or
|
||||
tone. If something isn't clear in the guide, please submit an issue to let us
|
||||
know or submit a pull request to help us improve it.
|
||||
|
|
|
|||
|
|
@ -1,33 +1,29 @@
|
|||
<!--Thanks for your contribution. See [CONTRIBUTING](CONTRIBUTING.md)
|
||||
for this project's contribution guidelines. -->
|
||||
|
||||
<!--DO NOT edit files and directories listed in .NOT_EDITED_HERE.txt.
|
||||
<!--DO NOT edit files and directories listed in .NOT_EDITED_HERE.yaml.
|
||||
These are maintained in upstream repos and changes here will be lost.-->
|
||||
|
||||
### Describe the proposed changes
|
||||
|
||||
<!-- Tell us what you did and why. You can leave this off if the PR title
|
||||
is descriptive. The commit message will be added to the end of this form.-->
|
||||
<!-- Tell us what you did and why.-->
|
||||
|
||||
### Project version
|
||||
### Unreleased project version
|
||||
|
||||
<!-- If this change only applies to a future version of a project (like
|
||||
Docker Engine 1.13), note that here and base your work on the `vnext-`
|
||||
branch for your project. -->
|
||||
<!-- If this change only applies to an unreleased version of a project, note
|
||||
that here and base your work on the `vnext-` branch for your project. -->
|
||||
|
||||
### Related issue
|
||||
|
||||
<!-- If this relates to an issue or PR in this repo, refer to it like
|
||||
#1234, or 'Fixes #1234' or 'Closes #1234'. -->
|
||||
<!-- Refer to related PRs or issues: #1234, or 'Fixes #1234' or 'Closes #1234'. -->
|
||||
|
||||
### Related issue or PR in another project
|
||||
|
||||
<!-- Links to issues or pull requests in other repositories if applicable. -->
|
||||
<!-- Full URLs to issues or pull requests in other Github projects -->
|
||||
|
||||
### Please take a look
|
||||
|
||||
<!-- At-mention specific individuals or groups who should take a
|
||||
look at this PR. For instance, @exampleuser123 -->
|
||||
<!-- At-mention specific individuals or groups, like @exampleuser123 -->
|
||||
|
||||
|
||||
<!-- To improve this template, edit .github/PULL_REQUEST_TEMPLATE.md. -->
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
2.3.1
|
||||
6
404.md
6
404.md
|
|
@ -22,14 +22,14 @@ if (forwardingURL.indexOf(".md") > -1)
|
|||
|
||||
// DOCS ARCHIVE CHECK
|
||||
{% for item in site.data.docsarchive.docker-compose %}
|
||||
if (forwardingURL.indexOf("/{{ item[0] }}") > -1)
|
||||
if (forwardingURL == "/{{ item[0] }}/")
|
||||
{
|
||||
console.log("Found via Docker Compose file for Acrhive")
|
||||
gonnaFwd = true;
|
||||
archive = true;
|
||||
// make it so redirects cascade; first, use the base URL, then append path
|
||||
baseURL = "{{ page.archiveserver }}:{{ item[1].ports[0] | replace:':4000','' }}";
|
||||
newURL = forwardingURL.replace("/{{ item[0] }}","");
|
||||
baseURL = "{{ site.url }}";
|
||||
newURL = forwardingURL;
|
||||
}{% endfor %}
|
||||
|
||||
if (archive==false) {
|
||||
|
|
|
|||
|
|
@ -0,0 +1,3 @@
|
|||
source "https://rubygems.org"
|
||||
|
||||
gem "github-pages", "104" #Update me once in a while: https://github.com/github/pages-gem/releases
|
||||
25
README.md
25
README.md
|
|
@ -32,7 +32,15 @@ help. If a reviewer realizes you have based your work on the wrong branch, we'll
|
|||
let you know so that you can rebase it.
|
||||
|
||||
>**Note**: To contribute code to Docker projects, see the
|
||||
[Contribution guidelines](opensource/project/who-written-for).
|
||||
[Contribution guidelines](https://docs.docker.com/opensource/project/who-written-for/).
|
||||
|
||||
### Files not edited here
|
||||
|
||||
Files and directories listed in the `path:` keys in
|
||||
[`.NOT_EDITED_HERE.yaml`](.NOT_EDITED_HERE.yaml) are maintained in other
|
||||
repositories and should not be edited in this one. Pull requests against these
|
||||
files will be rejected. Make your edits to the files in the repository and path
|
||||
in the `source:` key in the YAML file.
|
||||
|
||||
### Overall doc improvements
|
||||
|
||||
|
|
@ -93,8 +101,17 @@ The following `vnext` branches currently exist:
|
|||
docs for upcoming features in the [docker/kitematic](https://github.com/docker/kitematic/)
|
||||
project
|
||||
|
||||
## Per-PR staging on Github
|
||||
|
||||
## Staging
|
||||
For every PR against `master` and all the long-lived branches, a staged version
|
||||
of the site is built using Netlify. If the site builds, you will see
|
||||
**deploy/netlify — Deploy preview ready**. Otherwise, you will see an error.
|
||||
Click **Details** to review the staged site or the errors that prevented it from
|
||||
building. Review the staged site and amend your commit if necessary. Reviewers
|
||||
will also check the staged site before merging the PR, to protect the integrity
|
||||
of [docs.docker.com](http://docs.docker.com/).
|
||||
|
||||
## Staging locally
|
||||
|
||||
You have three options:
|
||||
|
||||
|
|
@ -107,7 +124,7 @@ You have three options:
|
|||
```
|
||||
|
||||
If you haven't got Docker Compose installed,
|
||||
[follow these installation instructions](/compose/install/).
|
||||
[follow these installation instructions](https://docs.docker.com/compose/install/).
|
||||
|
||||
The container runs in the background and incrementally rebuilds the site each
|
||||
time a file changes. You can keep your browser open to http://localhost:4000/
|
||||
|
|
@ -150,7 +167,7 @@ directly on docs.docker.com.
|
|||
## Style guide
|
||||
|
||||
If you have questions about how to write for Docker's documentation, please see
|
||||
the [style guide](/opensource/doc-style/). The style guide provides
|
||||
the [style guide](https://docs.docker.com/opensource/doc-style/). The style guide provides
|
||||
guidance about grammar, syntax, formatting, styling, language, or tone. If
|
||||
something isn't clear in the guide, please submit an issue to let us know or
|
||||
submit a pull request to help us improve it.
|
||||
|
|
|
|||
99
_config.yml
99
_config.yml
|
|
@ -13,13 +13,12 @@ url: https://docs.docker.com
|
|||
|
||||
gems:
|
||||
- jekyll-redirect-from
|
||||
- jekyll-gist
|
||||
- jekyll-seo-tag
|
||||
|
||||
webrick:
|
||||
headers:
|
||||
Cache-Control: 600
|
||||
|
||||
|
||||
defaults:
|
||||
-
|
||||
scope:
|
||||
|
|
@ -27,4 +26,98 @@ defaults:
|
|||
type: "pages"
|
||||
values:
|
||||
layout: docs
|
||||
archiveserver: "http://54.71.194.30"
|
||||
defaultassignee: johndmulhausen
|
||||
- scope:
|
||||
path: "compose"
|
||||
values:
|
||||
assignee: "londoncalling"
|
||||
- scope:
|
||||
path: "cs-engine"
|
||||
values:
|
||||
assignee: "joaofnfernandes"
|
||||
- scope:
|
||||
path: "datacenter"
|
||||
values:
|
||||
assignee: "joaofnfernandes"
|
||||
- scope:
|
||||
path: "docker-cloud"
|
||||
values:
|
||||
assignee: "sanscontext"
|
||||
- scope:
|
||||
path: "docker-for-mac"
|
||||
values:
|
||||
assignee: "londoncalling"
|
||||
- scope:
|
||||
path: "docker-for-windows"
|
||||
values:
|
||||
assignee: "londoncalling"
|
||||
- scope:
|
||||
path: "docker-hub"
|
||||
values:
|
||||
assignee: "sanscontext"
|
||||
- scope:
|
||||
path: "docker-store"
|
||||
values:
|
||||
assignee: "johndmulhausen"
|
||||
- scope:
|
||||
path: "engine"
|
||||
values:
|
||||
assignee: "mstanleyjones"
|
||||
- scope:
|
||||
path: "kitematic"
|
||||
values:
|
||||
assignee: "londoncalling"
|
||||
- scope:
|
||||
path: "machine"
|
||||
values:
|
||||
assignee: "londoncalling"
|
||||
- scope:
|
||||
path: "notary"
|
||||
values:
|
||||
assignee: "johndmulhausen"
|
||||
- scope:
|
||||
path: "registry"
|
||||
values:
|
||||
assignee: "joaofnfernandes"
|
||||
- scope:
|
||||
path: "swarm"
|
||||
values:
|
||||
assignee: "mstanleyjones"
|
||||
- scope:
|
||||
path: "toolbox"
|
||||
values:
|
||||
assignee: "londoncalling"
|
||||
-
|
||||
scope:
|
||||
path: "datacenter/dtr/2.0"
|
||||
values:
|
||||
hide_from_sitemap: true
|
||||
this_version: "2.0"
|
||||
latest_version: "2.1"
|
||||
-
|
||||
scope:
|
||||
path: "datacenter/ucp/1.1"
|
||||
values:
|
||||
hide_from_sitemap: true
|
||||
this_version: "1.1"
|
||||
latest_version: "2.0"
|
||||
-
|
||||
scope:
|
||||
path: "apidocs/v1.3.3"
|
||||
values:
|
||||
hide_from_sitemap: true
|
||||
-
|
||||
scope:
|
||||
path: "apidocs/v1.4.0"
|
||||
values:
|
||||
hide_from_sitemap: true
|
||||
-
|
||||
scope:
|
||||
path: "apidocs/v2.0.0"
|
||||
values:
|
||||
hide_from_sitemap: true
|
||||
-
|
||||
scope:
|
||||
path: "apidocs/v2.0.1"
|
||||
values:
|
||||
hide_from_sitemap: true
|
||||
|
|
|
|||
|
|
@ -0,0 +1,38 @@
|
|||
# Files and directories here are not edited in the docker.github.io repo.
|
||||
# Instead, they are edited in the appropriate upstream repo and pulled
|
||||
# into this repo periodically, or they are automatically generated. The intent
|
||||
# is that if you submit a PR with changes to these files or directories, a CI
|
||||
# job will fail in the PR, indicating that it should not be merged. THIS IS NOT
|
||||
# YET IMPLEMENTED!! The PR reviewer should make sure no files here are in the PR.
|
||||
|
||||
# If you need to edit these files or directories, submit a PR in the repo and
|
||||
# directory listed in "source" below.
|
||||
|
||||
# Make sure directories have the trailing slash, keep the list alphabetical
|
||||
|
||||
- path: apidocs/
|
||||
description: "Auto-generated API docs for Docker Cloud, DTR, UCP. File an issue."
|
||||
|
||||
- path: engine/deprecated.md
|
||||
description: Docker Engine deprecation reference
|
||||
source: https://github.com/docker/docker/docs/deprecated.md
|
||||
|
||||
- path: engine/extend/
|
||||
description: References for Docker Engine plugin system
|
||||
source: https://github.com/docker/docker/docs/extend/
|
||||
|
||||
- path: engine/reference/
|
||||
description: Docker Engine CLI and API references
|
||||
source: https://github.com/docker/docker/docs/reference/
|
||||
|
||||
- path: notary/reference/
|
||||
description: Reference docs for Docker Notary
|
||||
source: https://github.com/docker/notary/docs/reference/
|
||||
|
||||
- path: registry/configuration.md
|
||||
description: Reference docs for configuring Docker Registry
|
||||
source: https://github.com/docker/distribution/docs/configuration.md
|
||||
|
||||
- path: registry/spec/
|
||||
description: Docker Registry API references
|
||||
source: https://github.com/docker/distribution/docs/spec/
|
||||
651
_data/toc.yaml
651
_data/toc.yaml
|
|
@ -629,232 +629,210 @@ toc:
|
|||
title: CS Engine release notes
|
||||
- path: /cs-engine/release-notes/prior-release-notes/
|
||||
title: Prior CS Engine release notes
|
||||
- sectiontitle: Universal Control Plane
|
||||
- sectiontitle: Docker Datacenter
|
||||
section:
|
||||
- path: /ucp/overview/
|
||||
title: Universal Control Plane overview
|
||||
- path: /ucp/install-sandbox/
|
||||
title: Install DDC in a sandbox for evaluation
|
||||
- path: /ucp/install-sandbox-2/
|
||||
title: Evaluate DDC in a sandbox deployment
|
||||
- path: /ucp/architecture/
|
||||
title: Architecture
|
||||
- sectiontitle: Installation
|
||||
- path: /datacenter/try/
|
||||
title: Try Docker Datacenter
|
||||
- sectiontitle: Universal Control Plane 2.0
|
||||
section:
|
||||
- path: /ucp/installation/system-requirements/
|
||||
title: System requirements
|
||||
- path: /ucp/installation/plan-production-install/
|
||||
title: Plan a production installation
|
||||
- path: /ucp/installation/install-production/
|
||||
title: Install UCP for production
|
||||
- path: /ucp/installation/install-offline/
|
||||
title: Install offline
|
||||
- path: /ucp/installation/license/
|
||||
title: License UCP
|
||||
- path: /ucp/installation/upgrade/
|
||||
title: Upgrade UCP
|
||||
- path: /ucp/installation/uninstall/
|
||||
title: Uninstall UCP
|
||||
- sectiontitle: UCP tool reference
|
||||
- path: /datacenter/ucp/2.0/guides/
|
||||
title: Universal Control Plane overview
|
||||
- path: /datacenter/ucp/2.0/guides/architecture/
|
||||
title: Architecture
|
||||
- sectiontitle: Installation
|
||||
section:
|
||||
- path: /ucp/reference/backup/
|
||||
- path: /datacenter/ucp/2.0/guides/installation/system-requirements/
|
||||
title: System requirements
|
||||
- path: /datacenter/ucp/2.0/guides/installation/plan-production-install/
|
||||
title: Plan a production installation
|
||||
- path: /datacenter/ucp/2.0/guides/installation/
|
||||
title: Install UCP for production
|
||||
- path: /datacenter/ucp/2.0/guides/installation/install-offline/
|
||||
title: Install offline
|
||||
- path: /datacenter/ucp/2.0/guides/installation/license/
|
||||
title: License UCP
|
||||
- path: /datacenter/ucp/2.0/guides/installation/scale-your-cluster/
|
||||
title: Scale your cluster
|
||||
- path: /datacenter/ucp/2.0/guides/installation/upgrade/
|
||||
title: Upgrade UCP
|
||||
- path: /datacenter/ucp/2.0/guides/installation/uninstall/
|
||||
title: Uninstall UCP
|
||||
- sectiontitle: Access UCP
|
||||
section:
|
||||
- path: /datacenter/ucp/2.0/guides/access-ucp/
|
||||
title: Web-based access
|
||||
- path: /datacenter/ucp/2.0/guides/access-ucp/cli-based-access/
|
||||
title: CLI-based access
|
||||
- sectiontitle: Configuration
|
||||
section:
|
||||
- path: /datacenter/ucp/2.0/guides/configuration/
|
||||
title: Use externally-signed certificates
|
||||
- path: /datacenter/ucp/2.0/guides/configuration/configure-logs/
|
||||
title: Configure UCP logging
|
||||
- path: /datacenter/ucp/2.0/guides/configuration/integrate-with-dtr/
|
||||
title: Integrate with Docker Trusted Registry
|
||||
- path: /datacenter/ucp/2.0/guides/configuration/integrate-with-ldap/
|
||||
title: Integrate with LDAP
|
||||
- path: /datacenter/ucp/2.0/guides/configuration/route-hostnames/
|
||||
title: Route hostnames to services
|
||||
- sectiontitle: Monitor and troubleshoot
|
||||
section:
|
||||
- path: /datacenter/ucp/2.0/guides/monitor/
|
||||
title: Monitor your cluster
|
||||
- path: /datacenter/ucp/2.0/guides/monitor/troubleshoot/
|
||||
title: Troubleshoot your cluster
|
||||
- path: /datacenter/ucp/2.0/guides/monitor/troubleshoot-configurations/
|
||||
title: Troubleshoot cluster configurations
|
||||
- sectiontitle: High-availability
|
||||
section:
|
||||
- path: /datacenter/ucp/2.0/guides/high-availability/
|
||||
title: Set up high availability
|
||||
- path: /datacenter/ucp/2.0/guides/high-availability/backups-and-disaster-recovery/
|
||||
title: Backups and disaster recovery
|
||||
- sectiontitle: User management
|
||||
section:
|
||||
- path: /datacenter/ucp/2.0/guides/user-management/
|
||||
title: Authentication and authorization
|
||||
- path: /datacenter/ucp/2.0/guides/user-management/create-and-manage-users/
|
||||
title: Create and manage users
|
||||
- path: /datacenter/ucp/2.0/guides/user-management/create-and-manage-teams/
|
||||
title: Create and manage teams
|
||||
- path: /datacenter/ucp/2.0/guides/user-management/permission-levels/
|
||||
title: Permission levels
|
||||
- sectiontitle: Applications
|
||||
section:
|
||||
- path: /datacenter/ucp/2.0/guides/applications/
|
||||
title: Deploy an app from the UI
|
||||
- path: /datacenter/ucp/2.0/guides/applications/deploy-app-cli/
|
||||
title: Deploy an app from the CLI
|
||||
- sectiontitle: Content trust
|
||||
section:
|
||||
- path: /datacenter/ucp/2.0/guides/content-trust/
|
||||
title: Run only images you trust
|
||||
- path: /datacenter/ucp/2.0/guides/content-trust/manage-trusted-repositories/
|
||||
title: Manage trusted repositories
|
||||
- sectiontitle: CLI reference
|
||||
section:
|
||||
- path: /datacenter/ucp/2.0/reference/cli/
|
||||
title: docker/ucp overview
|
||||
- path: /datacenter/ucp/2.0/reference/cli/backup/
|
||||
title: backup
|
||||
- path: /ucp/reference/dump-certs/
|
||||
- path: /datacenter/ucp/2.0/reference/cli/dump-certs/
|
||||
title: dump-certs
|
||||
- path: /ucp/reference/engine-discovery/
|
||||
title: engine-discovery
|
||||
- path: /ucp/reference/fingerprint/
|
||||
- path: /datacenter/ucp/2.0/reference/cli/fingerprint/
|
||||
title: fingerprint
|
||||
- path: /ucp/reference/help/
|
||||
title: help
|
||||
- path: /ucp/reference/id/
|
||||
- path: /datacenter/ucp/2.0/reference/cli/id/
|
||||
title: id
|
||||
- path: /ucp/reference/images/
|
||||
- path: /datacenter/ucp/2.0/reference/cli/images/
|
||||
title: images
|
||||
- path: /ucp/reference/install/
|
||||
- path: /datacenter/ucp/2.0/reference/cli/install/
|
||||
title: install
|
||||
- path: /ucp/reference/join/
|
||||
title: join
|
||||
- path: /ucp/reference/regen-certs/
|
||||
title: regen-certs.md
|
||||
- path: /ucp/reference/restart/
|
||||
- path: /datacenter/ucp/2.0/reference/cli/restart/
|
||||
title: restart
|
||||
- path: /ucp/reference/restore/
|
||||
- path: /datacenter/ucp/2.0/reference/cli/restore/
|
||||
title: restore
|
||||
- path: /ucp/reference/stop/
|
||||
- path: /datacenter/ucp/2.0/reference/cli/stop/
|
||||
title: stop
|
||||
- path: /ucp/reference/support/
|
||||
- path: /datacenter/ucp/2.0/reference/cli/support/
|
||||
title: support
|
||||
- path: /ucp/reference/uninstall/
|
||||
title: uninstall
|
||||
- path: /ucp/reference/upgrade/
|
||||
- path: /datacenter/ucp/2.0/reference/cli/uninstall-ucp/
|
||||
title: uninstall-ucp
|
||||
- path: /datacenter/ucp/2.0/reference/cli/upgrade/
|
||||
title: upgrade
|
||||
- sectiontitle: Access UCP
|
||||
- path: /datacenter/ucp/2.0/guides/support/
|
||||
title: Get support
|
||||
- path: /datacenter/ucp/2.0/guides/release-notes/
|
||||
title: Release Notes
|
||||
- sectiontitle: Docker Trusted Registry 2.1
|
||||
section:
|
||||
- path: /ucp/access-ucp/web-based-access/
|
||||
title: Web-based access
|
||||
- path: /ucp/access-ucp/cli-based-access/
|
||||
title: CLI-based access
|
||||
- sectiontitle: Configuration
|
||||
section:
|
||||
- path: /ucp/configuration/use-externally-signed-certs/
|
||||
title: Use externally-signed certificates
|
||||
- path: /ucp/configuration/configure-logs/
|
||||
title: Configure UCP logging
|
||||
- path: /ucp/configuration/dtr-integration/
|
||||
title: Integrate with Docker Trusted Registry
|
||||
- path: /ucp/configuration/ldap-integration/
|
||||
title: Integrate with LDAP
|
||||
- path: /ucp/configuration/multi-host-networking/
|
||||
title: Set up container networking
|
||||
- sectiontitle: Monitor and troubleshoot
|
||||
section:
|
||||
- path: /ucp/monitor/monitor-ucp/
|
||||
title: Monitor your cluster
|
||||
- path: /ucp/monitor/troubleshoot-ucp/
|
||||
title: Troubleshoot your cluster
|
||||
- path: /ucp/monitor/troubleshoot-configurations/
|
||||
title: Troubleshoot cluster configurations
|
||||
- sectiontitle: High-availability
|
||||
section:
|
||||
- path: /ucp/high-availability/set-up-high-availability/
|
||||
title: Set up high availability
|
||||
- path: /ucp/high-availability/replicate-cas/
|
||||
title: Replicate CAs for high availability
|
||||
- path: /ucp/high-availability/backups-and-disaster-recovery/
|
||||
title: Backups and disaster recovery
|
||||
- sectiontitle: User management
|
||||
section:
|
||||
- path: /ucp/user-management/authentication-and-authorization/
|
||||
title: Authentication and authorization
|
||||
- path: /ucp/user-management/create-and-manage-users/
|
||||
title: Create and manage users
|
||||
- path: /ucp/user-management/create-and-manage-teams/
|
||||
title: Create and manage teams
|
||||
- path: /ucp/user-management/permission-levels/
|
||||
title: Permission levels
|
||||
- sectiontitle: Applications
|
||||
section:
|
||||
- path: /ucp/applications/deploy-app-ui/
|
||||
title: Deploy an app from the UI
|
||||
- path: /ucp/applications/deploy-app-cli/
|
||||
title: Deploy an app from the CLI
|
||||
- path: /ucp/support/
|
||||
title: Get support
|
||||
- path: /ucp/release_notes/
|
||||
title: Release Notes
|
||||
- sectiontitle: Docker Trusted Registry
|
||||
section:
|
||||
- path: /docker-trusted-registry/
|
||||
title: Docker Trusted Registry overview
|
||||
- path: /docker-trusted-registry/architecture/
|
||||
title: Architecture
|
||||
- sectiontitle: Installation
|
||||
section:
|
||||
- path: /docker-trusted-registry/install/system-requirements/
|
||||
title: System requirements
|
||||
- path: /docker-trusted-registry/install/
|
||||
title: Install Docker Trusted Registry
|
||||
- path: /docker-trusted-registry/install/install-dtr-offline/
|
||||
title: Install offline
|
||||
- path: /docker-trusted-registry/install/license/
|
||||
title: License DTR
|
||||
- sectiontitle: Upgrade
|
||||
- path: /datacenter/dtr/2.1/guides/
|
||||
title: Docker Trusted Registry overview
|
||||
- path: /datacenter/dtr/2.1/guides/architecture/
|
||||
title: Architecture
|
||||
- sectiontitle: Installation
|
||||
section:
|
||||
- path: /docker-trusted-registry/install/upgrade/upgrade-major/
|
||||
title: Upgrade from 1.4.3
|
||||
- path: /docker-trusted-registry/install/upgrade/
|
||||
title: Upgrade from 2.0.0
|
||||
- path: /docker-trusted-registry/install/uninstall/
|
||||
title: Uninstall
|
||||
- sectiontitle: docker/dtr image reference
|
||||
- path: /datacenter/dtr/2.1/guides/install/system-requirements/
|
||||
title: System requirements
|
||||
- path: /datacenter/dtr/2.1/guides/install/
|
||||
title: Install Docker Trusted Registry
|
||||
- path: /datacenter/dtr/2.1/guides/install/install-offline/
|
||||
title: Install offline
|
||||
- path: /datacenter/dtr/2.1/guides/install/license/
|
||||
title: License your deployment
|
||||
- path: /datacenter/dtr/2.1/guides/install/upgrade/
|
||||
title: Upgrade
|
||||
- path: /datacenter/dtr/2.1/guides/install/uninstall/
|
||||
title: Uninstall
|
||||
- sectiontitle: Configuration
|
||||
section:
|
||||
- path: /docker-trusted-registry/reference/
|
||||
title: Overview
|
||||
- path: /docker-trusted-registry/reference/backup/
|
||||
title: backup
|
||||
- path: /docker-trusted-registry/reference/dumpcerts/
|
||||
title: dumpcerts
|
||||
- path: /docker-trusted-registry/reference/images/
|
||||
title: images
|
||||
- path: /docker-trusted-registry/reference/install/
|
||||
title: install
|
||||
- path: /docker-trusted-registry/reference/join/
|
||||
title: join
|
||||
- path: /docker-trusted-registry/reference/migrate/
|
||||
title: migrate
|
||||
- path: /docker-trusted-registry/reference/reconfigure/
|
||||
title: reconfigure
|
||||
- path: /docker-trusted-registry/reference/remove/
|
||||
title: remove
|
||||
- path: /docker-trusted-registry/reference/restore/
|
||||
title: restore
|
||||
- path: /docker-trusted-registry/reference/upgrade/
|
||||
title: upgrade
|
||||
- sectiontitle: Configuration
|
||||
section:
|
||||
- path: /docker-trusted-registry/configure/configuration/
|
||||
title: Configuration overview
|
||||
- path: /docker-trusted-registry/configure/config-general/
|
||||
title: Configure general settings
|
||||
- path: /docker-trusted-registry/configure/config-security/
|
||||
title: Security configuration
|
||||
- path: /docker-trusted-registry/configure/config-storage/
|
||||
title: Storage configuration
|
||||
- sectiontitle: Monitor and troubleshoot
|
||||
section:
|
||||
- path: /docker-trusted-registry/monitor-troubleshoot/
|
||||
title: Monitor DTR
|
||||
- path: /docker-trusted-registry/monitor-troubleshoot/troubleshoot/
|
||||
title: Troubleshoot DTR
|
||||
- sectiontitle: High-availability
|
||||
section:
|
||||
- path: /docker-trusted-registry/high-availability/
|
||||
title: Set up high availability
|
||||
- path: /docker-trusted-registry/high-availability/backups-and-disaster-recovery/
|
||||
title: Backups and disaster recovery
|
||||
- sectiontitle: User management
|
||||
section:
|
||||
- path: /docker-trusted-registry/user-management/
|
||||
title: Authentication and authorization
|
||||
- path: /docker-trusted-registry/user-management/create-and-manage-users/
|
||||
title: Create and manage users
|
||||
- path: /docker-trusted-registry/user-management/create-and-manage-orgs/
|
||||
title: Create and manage organizations
|
||||
- path: /docker-trusted-registry/user-management/create-and-manage-teams/
|
||||
title: Create and manage teams
|
||||
- path: /docker-trusted-registry/user-management/permission-levels/
|
||||
title: Permission levels
|
||||
- sectiontitle: Repositories and images
|
||||
section:
|
||||
- path: /docker-trusted-registry/repos-and-images/
|
||||
title: Configure your Docker Engine
|
||||
- path: /docker-trusted-registry/repos-and-images/pull-an-image/
|
||||
title: Pull an image
|
||||
- path: /docker-trusted-registry/repos-and-images/push-an-image/
|
||||
title: Push an image
|
||||
- path: /docker-trusted-registry/repos-and-images/delete-an-image/
|
||||
title: Delete an image
|
||||
- sectiontitle: DTR APIs
|
||||
section:
|
||||
- path: /apidocs/overview/
|
||||
title: Overview
|
||||
- path: /apidocs/v1.3.3/
|
||||
title: v1.3.3 API
|
||||
- path: /apidocs/v1.4.0/
|
||||
title: v1.4.0 API
|
||||
- path: /apidocs/v2.0.0/
|
||||
title: v2.0.0 API
|
||||
- path: /apidocs/v2.0.1/
|
||||
title: v2.0.1 API
|
||||
- sectiontitle: Release notes
|
||||
section:
|
||||
- path: /docker-trusted-registry/release-notes/
|
||||
title: Trusted Registry release notes
|
||||
- path: /docker-trusted-registry/release-notes/prior-release-notes/
|
||||
title: Prior Trusted Registry release notes
|
||||
- path: /docker-trusted-registry/support/
|
||||
title: Get support
|
||||
- path: /datacenter/dtr/2.1/guides/configure/
|
||||
title: Use your own certificates
|
||||
- path: /datacenter/dtr/2.1/guides/configure/configure-storage/
|
||||
title: Storage configuration
|
||||
- sectiontitle: Monitor and troubleshoot
|
||||
section:
|
||||
- path: /datacenter/dtr/2.1/guides/monitor-troubleshoot/
|
||||
title: Monitor DTR
|
||||
- path: /datacenter/dtr/2.1/guides/monitor-troubleshoot/troubleshoot/
|
||||
title: Troubleshoot DTR
|
||||
- sectiontitle: High-availability
|
||||
section:
|
||||
- path: /datacenter/dtr/2.1/guides/high-availability/
|
||||
title: Set up high availability
|
||||
- path: /datacenter/dtr/2.1/guides/high-availability/backups-and-disaster-recovery/
|
||||
title: Backups and disaster recovery
|
||||
- sectiontitle: User management
|
||||
section:
|
||||
- path: /datacenter/dtr/2.1/guides/user-management/
|
||||
title: Authentication and authorization
|
||||
- path: /datacenter/dtr/2.1/guides/user-management/create-and-manage-users/
|
||||
title: Create and manage users
|
||||
- path: /datacenter/dtr/2.1/guides/user-management/create-and-manage-orgs/
|
||||
title: Create and manage organizations
|
||||
- path: /datacenter/dtr/2.1/guides/user-management/create-and-manage-teams/
|
||||
title: Create and manage teams
|
||||
- path: /datacenter/dtr/2.1/guides/user-management/permission-levels/
|
||||
title: Permission levels
|
||||
- sectiontitle: Repositories and images
|
||||
section:
|
||||
- path: /datacenter/dtr/2.1/guides/repos-and-images/
|
||||
title: Configure your Docker Engine
|
||||
- path: /datacenter/dtr/2.1/guides/repos-and-images/pull-an-image/
|
||||
title: Pull an image
|
||||
- path: /datacenter/dtr/2.1/guides/repos-and-images/push-an-image/
|
||||
title: Push an image
|
||||
- path: /datacenter/dtr/2.1/guides/repos-and-images/delete-an-image/
|
||||
title: Delete an image
|
||||
- sectiontitle: API and CLI reference
|
||||
section:
|
||||
- path: /datacenter/dtr/2.1/reference/api/
|
||||
title: API reference
|
||||
- sectiontitle: CLI reference
|
||||
section:
|
||||
- path: /datacenter/dtr/2.1/reference/cli/
|
||||
title: Overview
|
||||
- path: /datacenter/dtr/2.1/reference/cli/backup/
|
||||
title: backup
|
||||
- path: /datacenter/dtr/2.1/reference/cli/dumpcerts/
|
||||
title: dumpcerts
|
||||
- path: /datacenter/dtr/2.1/reference/cli/images/
|
||||
title: images
|
||||
- path: /datacenter/dtr/2.1/reference/cli/install/
|
||||
title: install
|
||||
- path: /datacenter/dtr/2.1/reference/cli/join/
|
||||
title: join
|
||||
- path: /datacenter/dtr/2.1/reference/cli/reconfigure/
|
||||
title: reconfigure
|
||||
- path: /datacenter/dtr/2.1/reference/cli/remove/
|
||||
title: remove
|
||||
- path: /datacenter/dtr/2.1/reference/cli/restore/
|
||||
title: restore
|
||||
- path: /datacenter/dtr/2.1/reference/cli/upgrade/
|
||||
title: upgrade
|
||||
- path: /datacenter/dtr/2.1/guides/release-notes/
|
||||
title: Release notes
|
||||
- path: /datacenter/dtr/2.1/guides/support/
|
||||
title: Get support
|
||||
- sectiontitle: Docker Cloud
|
||||
section:
|
||||
- path: /docker-cloud/overview/
|
||||
|
|
@ -1075,6 +1053,8 @@ toc:
|
|||
title: Amazon Web Services
|
||||
- path: /machine/drivers/digital-ocean/
|
||||
title: Digital Ocean
|
||||
- path: /machine/drivers/exoscale/
|
||||
title: Exoscale
|
||||
- path: /machine/drivers/generic/
|
||||
title: Generic
|
||||
- path: /machine/drivers/gce/
|
||||
|
|
@ -1097,15 +1077,13 @@ toc:
|
|||
title: VMware vCloud Air
|
||||
- path: /machine/drivers/vsphere/
|
||||
title: VMware vSphere
|
||||
- path: /machine/drivers/exoscale/
|
||||
title: exoscale
|
||||
- path: /machine/completion/
|
||||
title: Command-line Completion
|
||||
- sectiontitle: Docker Store
|
||||
section:
|
||||
- path: /docker-store/
|
||||
title: Docker Store Overview
|
||||
- path: /docker-store/
|
||||
- path: /docker-store/publish/
|
||||
title: Submit a product to Docker Store
|
||||
- path: /docker-store/faq/
|
||||
title: Docker Store FAQs
|
||||
|
|
@ -1367,5 +1345,252 @@ toc:
|
|||
title: Docker Release Notes
|
||||
- path: /engine/reference/glossary/
|
||||
title: Docker Glossary
|
||||
- title: Docs archive
|
||||
- sectiontitle: Docs archive
|
||||
section:
|
||||
- path: /docsarchive/
|
||||
title: View the docs archives
|
||||
- path: /v1.4
|
||||
title: v1.4
|
||||
- path: /v1.5
|
||||
title: v1.5
|
||||
- path: /v1.6
|
||||
title: v1.6
|
||||
- path: /v1.7
|
||||
title: v1.7
|
||||
- path: /v1.8
|
||||
title: v1.8
|
||||
- path: /v1.9
|
||||
title: v1.9
|
||||
- path: /v1.10
|
||||
title: v1.10
|
||||
- path: /v1.11
|
||||
title: v1.11
|
||||
- sectiontitle: Docker Datacenter archive
|
||||
section:
|
||||
- sectiontitle: Universal Control Plane 1.0
|
||||
section:
|
||||
- path: /datacenter/ucp/1.1/overview/
|
||||
title: Universal Control Plane overview
|
||||
- path: /datacenter/ucp/1.1/install-sandbox/
|
||||
title: Install DDC in a sandbox for evaluation
|
||||
- path: /datacenter/ucp/1.1/install-sandbox-2/
|
||||
title: Evaluate DDC in a sandbox deployment
|
||||
- path: /datacenter/ucp/1.1/architecture/
|
||||
title: Architecture
|
||||
- sectiontitle: Installation
|
||||
section:
|
||||
- path: /datacenter/ucp/1.1/installation/system-requirements/
|
||||
title: System requirements
|
||||
- path: /datacenter/ucp/1.1/installation/plan-production-install/
|
||||
title: Plan a production installation
|
||||
- path: /datacenter/ucp/1.1/installation/install-production/
|
||||
title: Install UCP for production
|
||||
- path: /datacenter/ucp/1.1/installation/install-offline/
|
||||
title: Install offline
|
||||
- path: /datacenter/ucp/1.1/installation/license/
|
||||
title: License UCP
|
||||
- path: /datacenter/ucp/1.1/installation/upgrade/
|
||||
title: Upgrade UCP
|
||||
- path: /datacenter/ucp/1.1/installation/uninstall/
|
||||
title: Uninstall UCP
|
||||
- sectiontitle: UCP tool reference
|
||||
section:
|
||||
- path: /datacenter/ucp/1.1/reference/backup/
|
||||
title: backup
|
||||
- path: /datacenter/ucp/1.1/reference/dump-certs/
|
||||
title: dump-certs
|
||||
- path: /datacenter/ucp/1.1/reference/engine-discovery/
|
||||
title: engine-discovery
|
||||
- path: /datacenter/ucp/1.1/reference/fingerprint/
|
||||
title: fingerprint
|
||||
- path: /datacenter/ucp/1.1/reference/help/
|
||||
title: help
|
||||
- path: /datacenter/ucp/1.1/reference/id/
|
||||
title: id
|
||||
- path: /datacenter/ucp/1.1/reference/images/
|
||||
title: images
|
||||
- path: /datacenter/ucp/1.1/reference/install/
|
||||
title: install
|
||||
- path: /datacenter/ucp/1.1/reference/join/
|
||||
title: join
|
||||
- path: /datacenter/ucp/1.1/reference/regen-certs/
|
||||
title: regen-certs.md
|
||||
- path: /datacenter/ucp/1.1/reference/restart/
|
||||
title: restart
|
||||
- path: /datacenter/ucp/1.1/reference/restore/
|
||||
title: restore
|
||||
- path: /datacenter/ucp/1.1/reference/stop/
|
||||
title: stop
|
||||
- path: /datacenter/ucp/1.1/reference/support/
|
||||
title: support
|
||||
- path: /datacenter/ucp/1.1/reference/uninstall/
|
||||
title: uninstall
|
||||
- path: /datacenter/ucp/1.1/reference/upgrade/
|
||||
title: upgrade
|
||||
- sectiontitle: Access UCP
|
||||
section:
|
||||
- path: /datacenter/ucp/1.1/access-ucp/web-based-access/
|
||||
title: Web-based access
|
||||
- path: /datacenter/ucp/1.1/access-ucp/cli-based-access/
|
||||
title: CLI-based access
|
||||
- sectiontitle: Configuration
|
||||
section:
|
||||
- path: /datacenter/ucp/1.1/configuration/use-externally-signed-certs/
|
||||
title: Use externally-signed certificates
|
||||
- path: /datacenter/ucp/1.1/configuration/configure-logs/
|
||||
title: Configure UCP logging
|
||||
- path: /datacenter/ucp/1.1/configuration/dtr-integration/
|
||||
title: Integrate with Docker Trusted Registry
|
||||
- path: /datacenter/ucp/1.1/configuration/ldap-integration/
|
||||
title: Integrate with LDAP
|
||||
- path: /datacenter/ucp/1.1/configuration/multi-host-networking/
|
||||
title: Set up container networking
|
||||
- sectiontitle: Monitor and troubleshoot
|
||||
section:
|
||||
- path: /datacenter/ucp/1.1/monitor/monitor-ucp/
|
||||
title: Monitor your cluster
|
||||
- path: /datacenter/ucp/1.1/monitor/troubleshoot-ucp/
|
||||
title: Troubleshoot your cluster
|
||||
- path: /datacenter/ucp/1.1/monitor/troubleshoot-configurations/
|
||||
title: Troubleshoot cluster configurations
|
||||
- sectiontitle: High-availability
|
||||
section:
|
||||
- path: /datacenter/ucp/1.1/high-availability/set-up-high-availability/
|
||||
title: Set up high availability
|
||||
- path: /datacenter/ucp/1.1/high-availability/replicate-cas/
|
||||
title: Replicate CAs for high availability
|
||||
- path: /datacenter/ucp/1.1/high-availability/backups-and-disaster-recovery/
|
||||
title: Backups and disaster recovery
|
||||
- sectiontitle: User management
|
||||
section:
|
||||
- path: /datacenter/ucp/1.1/user-management/authentication-and-authorization/
|
||||
title: Authentication and authorization
|
||||
- path: /datacenter/ucp/1.1/user-management/create-and-manage-users/
|
||||
title: Create and manage users
|
||||
- path: /datacenter/ucp/1.1/user-management/create-and-manage-teams/
|
||||
title: Create and manage teams
|
||||
- path: /datacenter/ucp/1.1/user-management/permission-levels/
|
||||
title: Permission levels
|
||||
- sectiontitle: Applications
|
||||
section:
|
||||
- path: /datacenter/ucp/1.1/applications/deploy-app-ui/
|
||||
title: Deploy an app from the UI
|
||||
- path: /datacenter/ucp/1.1/applications/deploy-app-cli/
|
||||
title: Deploy an app from the CLI
|
||||
- path: /datacenter/ucp/1.1/support/
|
||||
title: Get support
|
||||
- path: /datacenter/ucp/1.1/release_notes/
|
||||
title: Release Notes
|
||||
- sectiontitle: Docker Trusted Registry 2.0
|
||||
section:
|
||||
- path: /datacenter/dtr/2.0/
|
||||
title: Docker Trusted Registry overview
|
||||
- path: /datacenter/dtr/2.0/architecture/
|
||||
title: Architecture
|
||||
- sectiontitle: Installation
|
||||
section:
|
||||
- path: /datacenter/dtr/2.0/install/system-requirements/
|
||||
title: System requirements
|
||||
- path: /datacenter/dtr/2.0/install/
|
||||
title: Install Docker Trusted Registry
|
||||
- path: /datacenter/dtr/2.0/install/install-dtr-offline/
|
||||
title: Install offline
|
||||
- path: /datacenter/dtr/2.0/install/license/
|
||||
title: License DTR
|
||||
- sectiontitle: Upgrade
|
||||
section:
|
||||
- path: /datacenter/dtr/2.0/install/upgrade/upgrade-major/
|
||||
title: Upgrade from 1.4.3
|
||||
- path: /datacenter/dtr/2.0/install/upgrade/
|
||||
title: Upgrade from 2.0.0
|
||||
- path: /datacenter/dtr/2.0/install/uninstall/
|
||||
title: Uninstall
|
||||
- sectiontitle: docker/dtr image reference
|
||||
section:
|
||||
- path: /datacenter/dtr/2.0/reference/
|
||||
title: Overview
|
||||
- path: /datacenter/dtr/2.0/reference/backup/
|
||||
title: backup
|
||||
- path: /datacenter/dtr/2.0/reference/dumpcerts/
|
||||
title: dumpcerts
|
||||
- path: /datacenter/dtr/2.0/reference/images/
|
||||
title: images
|
||||
- path: /datacenter/dtr/2.0/reference/install/
|
||||
title: install
|
||||
- path: /datacenter/dtr/2.0/reference/join/
|
||||
title: join
|
||||
- path: /datacenter/dtr/2.0/reference/migrate/
|
||||
title: migrate
|
||||
- path: /datacenter/dtr/2.0/reference/reconfigure/
|
||||
title: reconfigure
|
||||
- path: /datacenter/dtr/2.0/reference/remove/
|
||||
title: remove
|
||||
- path: /datacenter/dtr/2.0/reference/restore/
|
||||
title: restore
|
||||
- path: /datacenter/dtr/2.0/reference/upgrade/
|
||||
title: upgrade
|
||||
- sectiontitle: Configuration
|
||||
section:
|
||||
- path: /datacenter/dtr/2.0/configure/configuration/
|
||||
title: Configuration overview
|
||||
- path: /datacenter/dtr/2.0/configure/config-general/
|
||||
title: Configure general settings
|
||||
- path: /datacenter/dtr/2.0/configure/config-security/
|
||||
title: Security configuration
|
||||
- path: /datacenter/dtr/2.0/configure/config-storage/
|
||||
title: Storage configuration
|
||||
- sectiontitle: Monitor and troubleshoot
|
||||
section:
|
||||
- path: /datacenter/dtr/2.0/monitor-troubleshoot/
|
||||
title: Monitor DTR
|
||||
- path: /datacenter/dtr/2.0/monitor-troubleshoot/troubleshoot/
|
||||
title: Troubleshoot DTR
|
||||
- sectiontitle: High-availability
|
||||
section:
|
||||
- path: /datacenter/dtr/2.0/high-availability/
|
||||
title: Set up high availability
|
||||
- path: /datacenter/dtr/2.0/high-availability/backups-and-disaster-recovery/
|
||||
title: Backups and disaster recovery
|
||||
- sectiontitle: User management
|
||||
section:
|
||||
- path: /datacenter/dtr/2.0/user-management/
|
||||
title: Authentication and authorization
|
||||
- path: /datacenter/dtr/2.0/user-management/create-and-manage-users/
|
||||
title: Create and manage users
|
||||
- path: /datacenter/dtr/2.0/user-management/create-and-manage-orgs/
|
||||
title: Create and manage organizations
|
||||
- path: /datacenter/dtr/2.0/user-management/create-and-manage-teams/
|
||||
title: Create and manage teams
|
||||
- path: /datacenter/dtr/2.0/user-management/permission-levels/
|
||||
title: Permission levels
|
||||
- sectiontitle: Repositories and images
|
||||
section:
|
||||
- path: /datacenter/dtr/2.0/repos-and-images/
|
||||
title: Configure your Docker Engine
|
||||
- path: /datacenter/dtr/2.0/repos-and-images/pull-an-image/
|
||||
title: Pull an image
|
||||
- path: /datacenter/dtr/2.0/repos-and-images/push-an-image/
|
||||
title: Push an image
|
||||
- path: /datacenter/dtr/2.0/repos-and-images/delete-an-image/
|
||||
title: Delete an image
|
||||
- sectiontitle: DTR APIs
|
||||
section:
|
||||
- path: /apidocs/overview/
|
||||
title: Overview
|
||||
- path: /apidocs/v1.3.3/
|
||||
title: v1.3.3 API
|
||||
- path: /apidocs/v1.4.0/
|
||||
title: v1.4.0 API
|
||||
- path: /apidocs/v2.0.0/
|
||||
title: v2.0.0 API
|
||||
- path: /apidocs/v2.0.1/
|
||||
title: v2.0.1 API
|
||||
- sectiontitle: Release notes
|
||||
section:
|
||||
- path: /datacenter/dtr/2.0/release-notes/
|
||||
title: Trusted Registry release notes
|
||||
- path: /datacenter/dtr/2.0/release-notes/prior-release-notes/
|
||||
title: Prior Trusted Registry release notes
|
||||
- path: /datacenter/dtr/2.0/support/
|
||||
title: Get support
|
||||
path: /docsarchive/
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
<meta name="robots" content="noindex" />
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
{% for item in tree %}{% if item.heading %}{% else %}{% if item.sectiontitle %}<li class="leaf menu-closed"><a href="/" class="expand-menu "><span class="menu-icon" aria-hidden="true"></span>{{ item.sectiontitle }}</a>
|
||||
{% for item in tree %}{% if item.heading %}{% else %}{% if item.sectiontitle %}<li class="leaf menu-closed"><a href="#" class="expand-menu "><span class="menu-icon" aria-hidden="true"></span>{{ item.sectiontitle }}</a>
|
||||
<ul class="nav-sub">
|
||||
{% assign tree = item.section %}{% include tree.html %}
|
||||
</ul>
|
||||
|
|
|
|||
|
|
@ -27,6 +27,12 @@ ng\:form {
|
|||
display: block;
|
||||
}
|
||||
</style>
|
||||
<script type="text/javascript">
|
||||
!function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","debug","page","once","off","on"];analytics.factory=function(t){return function(){var e=Array.prototype.slice.call(arguments);e.unshift(t);analytics.push(e);return analytics}};for(var t=0;t<analytics.methods.length;t++){var e=analytics.methods[t];analytics[e]=analytics.factory(e)}analytics.load=function(t){var e=document.createElement("script");e.type="text/javascript";e.async=!0;e.src=("https:"===document.location.protocol?"https://":"http://")+"cdn.segment.com/analytics.js/v1/"+t+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(e,n)};analytics.SNIPPET_VERSION="4.0.0";
|
||||
analytics.load("IWj9D0UpZHZdZUZX9jl98PcpBFWBnBMy");
|
||||
analytics.page();
|
||||
}}();
|
||||
</script>
|
||||
<script type="text/javascript" async="" src="/js/analytics.js"></script><script async="" src="/js/gtm.js"></script>
|
||||
<script type="text/javascript">window.NREUM||(NREUM={}),__nr_require=function(e,t,n){function r(n){if(!t[n]){var o=t[n]={exports:{}};e[n][0].call(o.exports,function(t){var o=e[n][1][t];return r(o||t)},o,o.exports)}return t[n].exports}if("function"==typeof __nr_require)return __nr_require;for(var o=0;o<n.length;o++)r(n[o]);return r}({1:[function(e,t,n){function r(e,t){return function(){o(e,[(new Date).getTime()].concat(a(arguments)),null,t)}}var o=e("handle"),i=e(2),a=e(3);"undefined"==typeof window.newrelic&&(newrelic=NREUM);var u=["setPageViewName","setCustomAttribute","finished","addToTrace","inlineHit"],c=["addPageAction"],f="api-";i(u,function(e,t){newrelic[t]=r(f+t,"api")}),i(c,function(e,t){newrelic[t]=r(f+t)}),t.exports=newrelic,newrelic.noticeError=function(e){"string"==typeof e&&(e=new Error(e)),o("err",[e,(new Date).getTime()])}},{}],2:[function(e,t,n){function r(e,t){var n=[],r="",i=0;for(r in e)o.call(e,r)&&(n[i]=t(r,e[r]),i+=1);return n}var o=Object.prototype.hasOwnProperty;t.exports=r},{}],3:[function(e,t,n){function r(e,t,n){t||(t=0),"undefined"==typeof n&&(n=e?e.length:0);for(var r=-1,o=n-t||0,i=Array(0>o?0:o);++r<o;)i[r]=e[t+r];return i}t.exports=r},{}],ee:[function(e,t,n){function r(){}function o(e){function t(e){return e&&e instanceof r?e:e?u(e,a,i):i()}function n(n,r,o){e&&e(n,r,o);for(var i=t(o),a=l(n),u=a.length,c=0;u>c;c++)a[c].apply(i,r);var s=f[g[n]];return s&&s.push([m,n,r,i]),i}function p(e,t){w[e]=l(e).concat(t)}function l(e){return w[e]||[]}function d(e){return s[e]=s[e]||o(n)}function v(e,t){c(e,function(e,n){t=t||"feature",g[n]=t,t in f||(f[t]=[])})}var w={},g={},m={on:p,emit:n,get:d,listeners:l,context:t,buffer:v};return m}function i(){return new r}var a="nr@context",u=e("gos"),c=e(2),f={},s={},p=t.exports=o();p.backlog=f},{}],gos:[function(e,t,n){function r(e,t,n){if(o.call(e,t))return e[t];var r=n();if(Object.defineProperty&&Object.keys)try{return Object.defineProperty(e,t,{value:r,writable:!0,enumerable:!1}),r}catch(i){}return e[t]=r,r}var o=Object.prototype.hasOwnProperty;t.exports=r},{}],handle:[function(e,t,n){function r(e,t,n,r){o.buffer([e],r),o.emit(e,t,n)}var o=e("ee").get("handle");t.exports=r,r.ee=o},{}],id:[function(e,t,n){function r(e){var t=typeof e;return!e||"object"!==t&&"function"!==t?-1:e===window?0:a(e,i,function(){return o++})}var o=1,i="nr@id",a=e("gos");t.exports=r},{}],loader:[function(e,t,n){function r(){if(!w++){var e=v.info=NREUM.info,t=s.getElementsByTagName("script")[0];if(e&&e.licenseKey&&e.applicationID&&t){c(l,function(t,n){e[t]||(e[t]=n)});var n="https"===p.split(":")[0]||e.sslForHttp;v.proto=n?"https://":"http://",u("mark",["onload",a()],null,"api");var r=s.createElement("script");r.src=v.proto+e.agent,t.parentNode.insertBefore(r,t)}}}function o(){"complete"===s.readyState&&i()}function i(){u("mark",["domContent",a()],null,"api")}function a(){return(new Date).getTime()}var u=e("handle"),c=e(2),f=window,s=f.document;NREUM.o={ST:setTimeout,CT:clearTimeout,XHR:f.XMLHttpRequest,REQ:f.Request,EV:f.Event,PR:f.Promise,MO:f.MutationObserver},e(1);var p=""+location,l={beacon:"bam.nr-data.net",errorBeacon:"bam.nr-data.net",agent:"js-agent.newrelic.com/nr-943.min.js"},d=window.XMLHttpRequest&&XMLHttpRequest.prototype&&XMLHttpRequest.prototype.addEventListener&&!/CriOS/.test(navigator.userAgent),v=t.exports={offset:a(),origin:p,features:{},xhrWrappable:d};s.addEventListener?(s.addEventListener("DOMContentLoaded",i,!1),f.addEventListener("load",r,!1)):(s.attachEvent("onreadystatechange",o),f.attachEvent("onload",r)),u("mark",["firstbyte",a()],null,"api");var w=0},{}]},{},["loader"]);</script>
|
||||
<meta property="og:type" content="website">
|
||||
|
|
@ -75,6 +81,8 @@ ng\:form {
|
|||
<link id="mktoForms2BaseStyle" rel="stylesheet" type="text/css" href="/css/forms2.css">
|
||||
<link id="mktoForms2ThemeStyle" rel="stylesheet" type="text/css" href="/css/forms2-theme-simple.css">
|
||||
{% seo %}
|
||||
{% if page.hide_from_sitemap %}<meta name="robots" content="noindex" />{% endif %}
|
||||
{% if page.this_version and page.latest_version %}<link rel="canonical" href="https://docs.docker.com{{ page.url | replace_first: page.this_version, page.latest_version }}" />{% endif %}
|
||||
</head>
|
||||
<body class="html front not-logged-in no-sidebars page-node page-node- page-node-1 node-type-front-page path-docker ng-scope short retina-display all_loaded" ng-app="Docker" ng-controller="DockerController" style="">
|
||||
<div class="off-canvas-wrap" data-offcanvas="" style="min-height: 548px;">
|
||||
|
|
@ -179,19 +187,22 @@ ng\:form {
|
|||
<div class="row">
|
||||
<div class="col-xs-12 col-sm-3 col-md-2 col-xl-2 docsidebarnav_section">
|
||||
<div class="region region-hero-sub"><ul class="nav-sub">
|
||||
|
||||
{% assign tree = site.data.toc.toc %}
|
||||
{% include tree.html %}
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div {% if page.notoc %} class="col-xs-12 col-sm-9 col-md-10" {% else %} class="col-xs-12 col-sm-9 col-md-8 col-xl-9" {% endif %} >
|
||||
<section class="section" id="DocumentationText">
|
||||
{% if page.title %}<h1>{{ page.title }}</h1>{% endif %}
|
||||
{% if page.advisory %}<blockquote><p><strong style="color:black">{{ site.data.advisories.texts[page.advisory] }}</strong></p></blockquote>{% endif %}
|
||||
{{ content }}
|
||||
{% if page.noratings != true %}
|
||||
<div style="text-align: center; margin-top: 50px">
|
||||
<img src="/images/chat.png" alt="chat icon" style="margin-right: 10px">
|
||||
<b>Feedback?</b> Questions? Suggestions?<br/>
|
||||
<a href="https://github.com/docker/docker.github.io/edit/master/{{ page.path }}" class="nomunge">Edit this page</a>,
|
||||
<a href="https://github.com/docker/docker.github.io/issues/new?title=Feedback for: {{ page.path }}&body=URL: [https://docs.docker.com/{{ page.path }}](https://docs.docker.com{{ page.url }})" class="nomunge">file a ticket</a>, or rate this page:
|
||||
<a href="https://github.com/docker/docker.github.io/issues/new?title=Feedback for: {{ page.path }}&assignee={% if page.assignee %}{{ page.assignee }}{% else %}{{ page.defaultassignee }}{% endif %}&body=File: [{{ page.path }}](https://docs.docker.com{{ page.url }})" class="nomunge">file a ticket</a>, or rate this page:
|
||||
<div id="pd_rating_holder_8453675"></div>
|
||||
<script type="text/javascript">
|
||||
PDRTJS_settings_8453675 = {
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
---
|
||||
title: All Page Links
|
||||
---
|
||||
# All Page Links
|
||||
|
||||
{% assign sorted_pages = site.pages | sort:"path" %}
|
||||
{% for thispage in sorted_pages %}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,5 @@
|
|||
# The files in this directory are read-only
|
||||
|
||||
The API docs for the products represented in this directory are generated
|
||||
internally by Docker using our source code. If you have feedback on these
|
||||
docs, the best way to let us know is to file an issue on GitHub.
|
||||
|
|
@ -10,19 +10,20 @@ If you find a typo or mismatch between the API and this documentation, please se
|
|||
|
||||
To run it locally:
|
||||
|
||||
git clone https://github.com/tutumcloud/cloud-api-docs.git
|
||||
make docs
|
||||
```none
|
||||
$ git clone https://github.com/docker/docker.github.io.git
|
||||
$ make release
|
||||
```
|
||||
|
||||
The documentation will be available in http://localhost:8000/
|
||||
|
||||
|
||||
## Updating the release HTML
|
||||
|
||||
As with the HTML generated by the DTR apidocs, the Docker Cloud documentation
|
||||
needs to be generated and the resulting HTML commited into this repository.
|
||||
needs to be generated and the resulting HTML committed to this repository.
|
||||
|
||||
After merging all PR's, run `make release`. This will place the updated HTML into
|
||||
the `build` directory in your local `cloud-api-docs` repo.
|
||||
After merging all PR's, run `make release`. This will place the updated HTML
|
||||
into the `apidocs/docker-cloud` directory.
|
||||
|
||||
Create a new Pull Request and get it merged. - now this repository is ready for the
|
||||
release process using `docker/docs.docker.com`.
|
||||
Create a new Pull Request and get it merged. - now this repository is ready for
|
||||
the release process using `docker/docs.docker.com`.
|
||||
|
|
|
|||
|
|
@ -13,11 +13,12 @@
|
|||
"can_be_canceled": false,
|
||||
"location": "New York, USA",
|
||||
"method": "POST",
|
||||
"object": "/api/infra/v1/cluster/eea638f4-b77a-4183-b241-22dbd7866f22/",
|
||||
"path": "/api/infra/v1/cluster/",
|
||||
"object": "/api/infra/v1/user_namespace/cluster/eea638f4-b77a-4183-b241-22dbd7866f22/",
|
||||
"path": "/api/infra/v1/user_namespace/cluster/",
|
||||
"resource_uri": "/api/audit/v1/action/6246c558-976c-4df6-ba60-eb1a344a17af/",
|
||||
"start_date": "Wed, 17 Sep 2014 08:26:22 +0000",
|
||||
"state": "Success",
|
||||
"user": "user_namespace",
|
||||
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_4) AppleWebKit/537.78.2 (KHTML, like Gecko) Version/7.0.6 Safari/537.78.2",
|
||||
"uuid": "6246c558-976c-4df6-ba60-eb1a344a17af"
|
||||
}
|
||||
|
|
@ -38,6 +39,7 @@ Simple API calls that do not require asynchronous execution will return immediat
|
|||
| action | Name of the operation performed/being performed |
|
||||
| method | HTTP method used to access the API |
|
||||
| path | HTTP path of the API accessed |
|
||||
| user | The user authenticated in the request that created the action |
|
||||
| user_agent | The user agent provided by the client when accessing the API endpoint |
|
||||
| start_date | Date and time when the API call was performed and the operation started processing |
|
||||
| end_date | Date and time when the API call finished processing |
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@
|
|||
"autorestart": "OFF",
|
||||
"bindings": [
|
||||
{
|
||||
"volume": "/api/infra/v1/volume/1863e34d-6a7d-4945-aefc-8f27a4ab1a9e/",
|
||||
"volume": "/api/infra/v1/user_namespace/volume/1863e34d-6a7d-4945-aefc-8f27a4ab1a9e/",
|
||||
"host_path": null,
|
||||
"container_path": "/data",
|
||||
"rewritable": true
|
||||
|
|
@ -140,7 +140,7 @@
|
|||
},
|
||||
{
|
||||
"key": "DB_DOCKERCLOUD_API_URL",
|
||||
"value": "https://cloud.docker.com/api/app/v1/service/c0fed1dc-c528-40c9-aa4c-dc00672ebcbf/"
|
||||
"value": "https://cloud.docker.com/api/app/v1/user_namespace/service/c0fed1dc-c528-40c9-aa4c-dc00672ebcbf/"
|
||||
}
|
||||
],
|
||||
"container_ports": [
|
||||
|
|
@ -188,9 +188,9 @@
|
|||
"endpoints": {
|
||||
"3306/tcp": "tcp://172.16.0.3:3306"
|
||||
},
|
||||
"from_container": "/api/app/v1/container/c1dd4e1e-1356-411c-8613-e15146633640/",
|
||||
"from_container": "/api/app/v1/user_namespace/container/c1dd4e1e-1356-411c-8613-e15146633640/",
|
||||
"name": "DB_1",
|
||||
"to_container": "/api/app/v1/container/ba434e1e-1234-411c-8613-e15146633640/"
|
||||
"to_container": "/api/app/v1/user_namespace/container/ba434e1e-1234-411c-8613-e15146633640/"
|
||||
}
|
||||
],
|
||||
"link_variables": {
|
||||
|
|
@ -226,20 +226,20 @@
|
|||
"memory_swap": 4096,
|
||||
"name": "wordpress-stackable",
|
||||
"net": "bridge",
|
||||
"node": "/api/infra/v1/node/9691c44e-3155-4ca2-958d-c9571aac0a14/",
|
||||
"node": "/api/infra/v1/user_namespace/node/9691c44e-3155-4ca2-958d-c9571aac0a14/",
|
||||
"pid": "none",
|
||||
"private_ip": "10.7.0.1",
|
||||
"privileged": false,
|
||||
"public_dns": "wordpress-stackable-1.admin.cont.dockerapp.io",
|
||||
"read_only": true,
|
||||
"resource_uri": "/api/app/v1/container/c1dd4e1e-1356-411c-8613-e15146633640/",
|
||||
"resource_uri": "/api/app/v1/user_namespace/container/c1dd4e1e-1356-411c-8613-e15146633640/",
|
||||
"roles": ["global"],
|
||||
"run_command": "/run-wordpress.sh",
|
||||
"security_opt": [
|
||||
"label:user:USER",
|
||||
"label:role:ROLE"
|
||||
],
|
||||
"service": "/api/app/v1/service/adeebc1b-1b81-4af0-b8f2-cefffc69d7fb/",
|
||||
"service": "/api/app/v1/user_namespace/service/adeebc1b-1b81-4af0-b8f2-cefffc69d7fb/",
|
||||
"started_datetime": "Thu, 16 Oct 2014 12:04:08 +0000",
|
||||
"state": "Running",
|
||||
"stdin_open": false,
|
||||
|
|
@ -255,6 +255,8 @@
|
|||
|
||||
A container is a representation of a Docker container in a node.
|
||||
|
||||
This is a [namespaced endpoint](#namespaced-endpoints).
|
||||
|
||||
### Attributes
|
||||
|
||||
Attribute | Description
|
||||
|
|
@ -420,7 +422,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/app/v1/container/`
|
||||
`GET /api/app/v1/[optional_namespace/]container/`
|
||||
|
||||
### Query Parameters
|
||||
|
||||
|
|
@ -472,7 +474,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/app/v1/container/(uuid)/`
|
||||
`GET /api/app/v1/[optional_namespace/]container/(uuid)/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -541,7 +543,7 @@ Available in Docker Cloud's **STREAM API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/app/v1/container/(uuid)/logs/`
|
||||
`GET /api/app/v1/[optional_namespace/]container/(uuid)/logs/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -600,7 +602,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/app/v1/container/(uuid)/start/`
|
||||
`POST /api/app/v1/[optional_namespace/]container/(uuid)/start/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -651,7 +653,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/app/v1/container/(uuid)/stop/`
|
||||
`POST /api/app/v1/[optional_namespace/]container/(uuid)/stop/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -704,7 +706,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/app/v1/container/(uuid)/redeploy/`
|
||||
`POST /api/app/v1/[optional_namespace/]container/(uuid)/redeploy/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -762,7 +764,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /api/app/v1/container/(uuid)/`
|
||||
`DELETE /api/app/v1/[optional_namespace/]container/(uuid)/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -819,7 +821,7 @@ Available in Docker Cloud's **STREAM API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/app/v1/container/(uuid)/exec/`
|
||||
`GET /api/app/v1/[optional_namespace/]container/(uuid)/exec/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
|
|||
|
|
@ -9,9 +9,9 @@
|
|||
"type": "action",
|
||||
"action": "update",
|
||||
"parents": [
|
||||
"/api/app/v1/container/0b0e3538-88df-4f07-9aed-3a3cc4175076/"
|
||||
"/api/app/v1/user_namespace/container/0b0e3538-88df-4f07-9aed-3a3cc4175076/"
|
||||
],
|
||||
"resource_uri": "/api/app/v1/action/49f0efe8-a704-4a10-b02f-f96344fabadd/",
|
||||
"resource_uri": "/api/app/v1/user_namespace/action/49f0efe8-a704-4a10-b02f-f96344fabadd/",
|
||||
"state": "Success",
|
||||
"uuid": "093ba3bb-08dd-48f0-8f12-4d3b85ef85b3",
|
||||
"datetime": "2016-02-01T16:47:28Z"
|
||||
|
|
@ -27,6 +27,7 @@ Docker Cloud events are generated every time any of the following objects is cre
|
|||
* Node
|
||||
* Action
|
||||
|
||||
This is a [namespaced endpoint](#namespaced-endpoints).
|
||||
|
||||
### Attributes
|
||||
|
||||
|
|
@ -117,4 +118,4 @@ Available in Docker Cloud's **STREAM API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/audit/v1/events/`
|
||||
`GET /api/audit/v1/[optional_namespace/]events/`
|
||||
|
|
|
|||
|
|
@ -19,11 +19,11 @@
|
|||
"last_seen": "Thu, 25 Sep 2014 13:14:44 +0000",
|
||||
"memory": 1792,
|
||||
"nickname": "fc1a5bb9-user.node.dockerapp.io",
|
||||
"node_cluster": "/api/infra/v1/nodecluster/d787a4b7-d525-4061-97a0-f423e8f1d229/",
|
||||
"node_type": "/api/infra/v1/nodetype/testing-provider/testing-type/",
|
||||
"node_cluster": "/api/infra/v1/user_namespace/nodecluster/d787a4b7-d525-4061-97a0-f423e8f1d229/",
|
||||
"node_type": "/api/infra/v1/user_namespace/nodetype/testing-provider/testing-type/",
|
||||
"public_ip": "10.45.2.11",
|
||||
"region": "/api/infra/v1/region/testing-provider/testing-region/",
|
||||
"resource_uri": "/api/infra/v1/node/fc1a5bb9-17f5-4819-b667-8c7cd819e949/",
|
||||
"resource_uri": "/api/infra/v1/user_namespace/node/fc1a5bb9-17f5-4819-b667-8c7cd819e949/",
|
||||
"state": "Deployed",
|
||||
"tags": [
|
||||
{"name": "tag_one"},
|
||||
|
|
@ -36,6 +36,8 @@
|
|||
|
||||
A node is a virtual machine provided by a cloud provider where containers can be deployed.
|
||||
|
||||
This is a [namespaced endpoint](#namespaced-endpoints).
|
||||
|
||||
### Attributes
|
||||
|
||||
Attribute | Description
|
||||
|
|
@ -123,7 +125,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/infra/v1/node/`
|
||||
`GET /api/infra/v1/[optional_namespace/]node/`
|
||||
|
||||
### Query Parameters
|
||||
|
||||
|
|
@ -177,7 +179,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/infra/v1/node/(uuid)/`
|
||||
`GET /api/infra/v1/[optional_namespace/]node/(uuid)/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -232,7 +234,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /api/infra/v1/node/(uuid)/`
|
||||
`PATCH /api/infra/v1/[optional_namespace/]node/(uuid)/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -290,7 +292,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/infra/v1/node/(uuid)/docker-upgrade/`
|
||||
`POST /api/infra/v1/[optional_namespace/]node/(uuid)/docker-upgrade/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -316,7 +318,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/infra/v1/node/(uuid)/health-check/`
|
||||
`POST /api/infra/v1/[optional_namespace/]node/(uuid)/health-check/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -367,7 +369,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /api/infra/v1/node/(uuid)/`
|
||||
`DELETE /api/infra/v1/[optional_namespace/]node/(uuid)/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
|
|||
|
|
@ -14,10 +14,10 @@
|
|||
"name": "TestCluster",
|
||||
"node_type": "/api/infra/v1/nodetype/aws/t2.micro/",
|
||||
"nodes": [
|
||||
"/api/infra/v1/node/75d20367-0948-4f10-8ba4-ffb4d16ed3c6/"
|
||||
"/api/infra/v1/user_namespace/node/75d20367-0948-4f10-8ba4-ffb4d16ed3c6/"
|
||||
],
|
||||
"region": "/api/infra/v1/region/aws/us-east-1/",
|
||||
"resource_uri": "/api/infra/v1/nodecluster/5516df0b-721e-4470-b350-741ff22e63a0/",
|
||||
"resource_uri": "/api/infra/v1/user_namespace/nodecluster/5516df0b-721e-4470-b350-741ff22e63a0/",
|
||||
"state": "Deployed",
|
||||
"tags": [
|
||||
{"name": "tag_one"},
|
||||
|
|
@ -41,6 +41,8 @@
|
|||
|
||||
A node cluster is a group of nodes that share the same provider, region and/or availability zone, and node type. They are on the same private network.
|
||||
|
||||
This is a [namespaced endpoint](#namespaced-endpoints).
|
||||
|
||||
|
||||
### Attributes
|
||||
|
||||
|
|
@ -128,7 +130,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/infra/v1/nodecluster/`
|
||||
`GET /api/infra/v1/[optional_namespace/]nodecluster/`
|
||||
|
||||
### Query Parameters
|
||||
|
||||
|
|
@ -186,7 +188,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/infra/v1/nodecluster/`
|
||||
`POST /api/infra/v1/[optional_namespace/]nodecluster/`
|
||||
|
||||
### JSON Parameters
|
||||
|
||||
|
|
@ -241,7 +243,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/infra/v1/nodecluster/(uuid)/`
|
||||
`GET /api/infra/v1/[optional_namespace/]nodecluster/(uuid)/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -287,7 +289,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/infra/v1/nodecluster/(uuid)/deploy/`
|
||||
`POST /api/infra/v1/[optional_namespace/]nodecluster/(uuid)/deploy/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -344,7 +346,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /api/infra/v1/nodecluster/(uuid)/`
|
||||
`PATCH /api/infra/v1/[optional_namespace/]nodecluster/(uuid)/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -401,7 +403,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /api/infra/v1/nodecluster/(uuid)/`
|
||||
`DELETE /api/infra/v1/[optional_namespace/]nodecluster/(uuid)/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
|
|||
|
|
@ -11,12 +11,14 @@
|
|||
"is_ssl": true,
|
||||
"name": "Docker Hub",
|
||||
"port": 443,
|
||||
"resource_uri": "/api/repo/v1/registry/registry-1.docker.io/",
|
||||
"resource_uri": "/api/repo/v1/user_namespace/registry/registry-1.docker.io/"
|
||||
}
|
||||
```
|
||||
|
||||
Represents a registry where repositories are hosted.
|
||||
|
||||
This is a [namespaced endpoint](#namespaced-endpoints).
|
||||
|
||||
|
||||
### Attributes
|
||||
|
||||
|
|
@ -47,7 +49,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/repo/v1/registry/`
|
||||
`GET /api/repo/v1/[optional_namespace/]registry/`
|
||||
|
||||
### Query Parameters
|
||||
|
||||
|
|
@ -76,7 +78,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/v1/registry/(host)/`
|
||||
`GET /api/v1/[optional_namespace/]registry/(host)/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
|
|||
|
|
@ -6,21 +6,23 @@
|
|||
|
||||
```json
|
||||
{
|
||||
"in_use": false,
|
||||
"name": "quay.io/tutum/ubuntu",
|
||||
"registry": "/api/repo/v1/registry/quay.io/",
|
||||
"resource_uri": "/api/repo/v1/repository/quay.io/tutum/ubuntu/",
|
||||
"in_use": false,
|
||||
"name": "my.registry.com/myrepo",
|
||||
"registry": "/api/repo/v1/user_namespace/registry/my.registry.com/",
|
||||
"resource_uri": "/api/repo/v1/user_namespace/repository/my.registry.com/myrepo/",
|
||||
}
|
||||
```
|
||||
|
||||
The `repository` endpoint is used to add and remove existing repositories on third party registries to be used in deployments and builds.
|
||||
|
||||
This is a [namespaced endpoint](#namespaced-endpoints).
|
||||
|
||||
### Attributes
|
||||
|
||||
Attribute | Description
|
||||
--------- | -----------
|
||||
resource_uri | A unique API endpoint that represents the repository
|
||||
name | Name of the repository, i.e. `quay.io/tutum/ubuntu`
|
||||
name | Name of the repository, i.e. `my.registry.com/myrepo`
|
||||
in_use | If the image is being used by any of your services
|
||||
registry | Resource URI of the registry where this image is hosted
|
||||
|
||||
|
|
@ -64,7 +66,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/repo/v1/repository/`
|
||||
`GET /api/repo/v1/[optional_namespace/]repository/`
|
||||
|
||||
### Query Parameters
|
||||
|
||||
|
|
@ -115,13 +117,13 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/repo/v1/repository/`
|
||||
`POST /api/repo/v1/[optional_namespace/]repository/`
|
||||
|
||||
### JSON Parameters
|
||||
|
||||
Parameter | Description
|
||||
--------- | -----------
|
||||
name | Name of the repository, i.e. 'quay.io/tutum/hello-world'
|
||||
name | Name of the repository, i.e. 'my.registry.com/myrepo'
|
||||
username | Username to authenticate with the third party registry
|
||||
password | Password to authenticate with the third party registry
|
||||
|
||||
|
|
@ -165,7 +167,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/repo/v1/repository/(name)/`
|
||||
`GET /api/repo/v1/[optional_namespace/]repository/(name)/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -207,7 +209,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /api/repo/v1/repository/(name)/`
|
||||
`PATCH /api/repo/v1/[optional_namespace/]repository/(name)/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -264,7 +266,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /api/repo/v1/repository/registry.local/user1/image1/`
|
||||
`DELETE /api/repo/v1/[optional_namespace/]repository/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@
|
|||
"host_path": null,
|
||||
"container_path": null,
|
||||
"rewritable": true,
|
||||
"volumes_from": "/api/app/v1/service/2f4f54e5-9d3b-4ac1-85ad-a2d4ff25a179/"
|
||||
"volumes_from": "/api/app/v1/user_namespace/service/2f4f54e5-9d3b-4ac1-85ad-a2d4ff25a179/"
|
||||
}
|
||||
],
|
||||
"cap_add": [
|
||||
|
|
@ -53,8 +53,8 @@
|
|||
}
|
||||
],
|
||||
"containers": [
|
||||
"/api/app/v1/container/6f8ee454-9dc3-4387-80c3-57aac1be3cc6/",
|
||||
"/api/app/v1/container/fdf9c116-7c08-4a60-b0ce-c54ca72c2f25/"
|
||||
"/api/app/v1/user_namespace/container/6f8ee454-9dc3-4387-80c3-57aac1be3cc6/",
|
||||
"/api/app/v1/user_namespace/container/fdf9c116-7c08-4a60-b0ce-c54ca72c2f25/"
|
||||
],
|
||||
"cpu_shares": 100,
|
||||
"cpuset": "0,1",
|
||||
|
|
@ -125,14 +125,14 @@
|
|||
"WORDPRESS_STACKABLE_PORT_80_TCP_ADDR": "wordpress-stackable-1.admin.cont.dockerapp.io",
|
||||
"WORDPRESS_STACKABLE_PORT_80_TCP_PORT": "49153",
|
||||
"WORDPRESS_STACKABLE_PORT_80_TCP_PROTO": "tcp",
|
||||
"WORDPRESS_STACKABLE_DOCKERCLOUD_API_URL": "https://cloud.docker.com/api/app/v1/service/adeebc1b-1b81-4af0-b8f2-cefffc69d7fb/"
|
||||
"WORDPRESS_STACKABLE_DOCKERCLOUD_API_URL": "https://cloud.docker.com/api/app/v1/user_namespace/service/adeebc1b-1b81-4af0-b8f2-cefffc69d7fb/"
|
||||
},
|
||||
"linked_from_service": [],
|
||||
"linked_to_service": [
|
||||
{
|
||||
"from_service": "/api/app/v1/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/",
|
||||
"from_service": "/api/app/v1/user_namespace/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/",
|
||||
"name": "DB",
|
||||
"to_service": "/api/app/v1/service/72f175bd-390b-46e3-9463-830aca32ce3e/"
|
||||
"to_service": "/api/app/v1/user_namespace/service/72f175bd-390b-46e3-9463-830aca32ce3e/"
|
||||
}
|
||||
],
|
||||
"mac_address": "02:42:ac:11:65:43",
|
||||
|
|
@ -143,7 +143,7 @@
|
|||
"privileged": false,
|
||||
"public_dns": "wordpress-stackable.admin.svc.dockerapp.io",
|
||||
"read_only": true,
|
||||
"resource_uri": "/api/app/v1/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/",
|
||||
"resource_uri": "/api/app/v1/user_namespace/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/",
|
||||
"roles": ["global"],
|
||||
"run_command": "/run-wordpress.sh",
|
||||
"running_num_containers": 1,
|
||||
|
|
@ -152,7 +152,7 @@
|
|||
"sequential_deployment": false,
|
||||
"started_datetime": "Mon, 13 Oct 2014 11:01:43 +0000",
|
||||
"state": "Partly running",
|
||||
"stack": "/api/app/v1/stack/46aca402-2109-4a70-a378-760cfed43816/",
|
||||
"stack": "/api/app/v1/user_namespace/stack/46aca402-2109-4a70-a378-760cfed43816/",
|
||||
"stdin_open": false,
|
||||
"stopped_datetime": null,
|
||||
"stopped_num_containers": 0,
|
||||
|
|
@ -173,6 +173,8 @@
|
|||
|
||||
A service is a template used to deploy one or more containers.
|
||||
|
||||
This is a [namespaced endpoint](#namespaced-endpoints).
|
||||
|
||||
### Attributes
|
||||
|
||||
Attribute | Description
|
||||
|
|
@ -346,7 +348,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/app/v1/service/`
|
||||
`GET /api/app/v1/[optional_namespace/]service/`
|
||||
|
||||
### Query Parameters
|
||||
|
||||
|
|
@ -400,7 +402,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/app/v1/service/`
|
||||
`POST /api/app/v1/[optional_namespace/]service/`
|
||||
|
||||
### JSON Parameters
|
||||
|
||||
|
|
@ -504,7 +506,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/app/v1/service/(uuid)/`
|
||||
`GET /api/app/v1/[optional_namespace/]service/(uuid)/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -575,7 +577,7 @@ Available in Docker Cloud's **STREAM API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/app/v1/service/(uuid)/logs/`
|
||||
`GET /api/app/v1/[optional_namespace/]service/(uuid)/logs/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -646,7 +648,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /api/app/v1/service/(uuid)/`
|
||||
`PATCH /api/app/v1/[optional_namespace/]service/(uuid)/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -724,7 +726,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/app/v1/service/(uuid)/start/`
|
||||
`POST /api/app/v1/[optional_namespace/]service/(uuid)/start/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -775,7 +777,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/app/v1/service/(uuid)/stop/`
|
||||
`POST /api/app/v1/[optional_namespace/]service/(uuid)/stop/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -814,7 +816,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/app/v1/service/(uuid)/scale/`
|
||||
`POST /api/app/v1/[optional_namespace/]service/(uuid)/scale/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -867,7 +869,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/app/v1/service/(uuid)/redeploy/`
|
||||
`POST /api/app/v1/[optional_namespace/]service/(uuid)/redeploy/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -924,7 +926,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /api/app/v1/service/(uuid)/`
|
||||
`DELETE /api/app/v1/[optional_namespace/]service/(uuid)/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
|
|||
|
|
@ -10,9 +10,9 @@
|
|||
"destroyed_datetime": null,
|
||||
"nickname": "deployment stack",
|
||||
"name": "dockercloud-app",
|
||||
"resource_uri": "/api/app/v1/stack/7fe7ec85-58be-4904-81da-de2219098d7c/",
|
||||
"resource_uri": "/api/app/v1/user_namespace/stack/7fe7ec85-58be-4904-81da-de2219098d7c/",
|
||||
"services": [
|
||||
"/api/app/v1/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/"
|
||||
"/api/app/v1/user_namespace/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/"
|
||||
],
|
||||
"state": "Running",
|
||||
"synchronized": true,
|
||||
|
|
@ -22,6 +22,8 @@
|
|||
|
||||
A stack is a logical grouping of closely related services, that may be linked with one another.
|
||||
|
||||
This is a [namespaced endpoint](#namespaced-endpoints).
|
||||
|
||||
### Attributes
|
||||
|
||||
Attribute | Description
|
||||
|
|
@ -91,7 +93,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/app/v1/stack/`
|
||||
`GET /api/app/v1/[optional_namespace/]stack/`
|
||||
|
||||
### Query Parameters
|
||||
|
||||
|
|
@ -163,7 +165,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/app/v1/stack/`
|
||||
`POST /api/app/v1/[optional_namespace/]stack/`
|
||||
|
||||
### JSON Parameters
|
||||
|
||||
|
|
@ -216,7 +218,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/app/v1/stack/(uuid)/export/`
|
||||
`GET /api/app/v1/[optional_namespace/]stack/(uuid)/export/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -265,7 +267,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/app/v1/stack/(uuid)/`
|
||||
`GET /api/app/v1/[optional_namespace/]stack/(uuid)/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -339,7 +341,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /api/app/v1/stack/(uuid)/`
|
||||
`PATCH /api/app/v1/[optional_namespace/]stack/(uuid)/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -398,7 +400,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/app/v1/stack/(uuid)/stop/`
|
||||
`POST /api/app/v1/[optional_namespace/]stack/(uuid)/stop/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -449,7 +451,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/app/v1/stack/(uuid)/start/`
|
||||
`POST /api/app/v1/[optional_namespace/]stack/(uuid)/start/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -502,7 +504,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/app/v1/stack/(uuid)/redeploy/`
|
||||
`POST /api/app/v1/[optional_namespace/]stack/(uuid)/redeploy/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -559,7 +561,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /api/app/v1/stack/(uuid)/`
|
||||
`DELETE /api/app/v1/[optional_namespace/]stack/(uuid)/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
|
|||
|
|
@ -6,15 +6,17 @@
|
|||
|
||||
```json
|
||||
{
|
||||
"url": "/api/app/v1/service/82d4a246-52d8-468d-903d-9da9ef05ff28/trigger/0224815a-c156-44e4-92d7-997c69354438/call/",
|
||||
"url": "/api/app/v1/user_namespace/service/82d4a246-52d8-468d-903d-9da9ef05ff28/trigger/0224815a-c156-44e4-92d7-997c69354438/call/",
|
||||
"operation": "REDEPLOY",
|
||||
"name": "docker_trigger",
|
||||
"resource_uri": "/api/app/v1/service/82d4a246-52d8-468d-903d-9da9ef05ff28/trigger/0224815a-c156-44e4-92d7-997c69354438/"
|
||||
"resource_uri": "/api/app/v1/user_namespace/service/82d4a246-52d8-468d-903d-9da9ef05ff28/trigger/0224815a-c156-44e4-92d7-997c69354438/"
|
||||
}
|
||||
```
|
||||
|
||||
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).
|
||||
|
||||
|
||||
### Attributes
|
||||
|
||||
|
|
@ -82,13 +84,13 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/app/v1/service/(uuid)/trigger/`
|
||||
`GET /api/app/v1/[optional_namespace/]service/(uuid)/trigger/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
--------- | -----------
|
||||
uuid | The UUID of the service the triggers are associated to
|
||||
uuid | The UUID of the service the triggers are associated to
|
||||
|
||||
|
||||
## Create a new trigger
|
||||
|
|
@ -142,7 +144,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/app/v1/service/(uuid)/trigger/`
|
||||
`POST /api/app/v1/[optional_namespace/]service/(uuid)/trigger/`
|
||||
|
||||
### JSON Parameters
|
||||
|
||||
|
|
@ -193,13 +195,13 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/app/v1/service/(uuid)/trigger/(trigger_uuid)/`
|
||||
`GET /api/app/v1/[optional_namespace/]service/(uuid)/trigger/(trigger_uuid)/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
--------- | -----------
|
||||
uuid | The UUID of the service the triggers are associated to
|
||||
uuid | The UUID of the service the triggers are associated to
|
||||
trigger_uuid | The UUID of the trigger to retrieve
|
||||
|
||||
## Delete a trigger
|
||||
|
|
@ -243,7 +245,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /api/app/v1/service/(uuid)/trigger/(trigger_uuid)/`
|
||||
`DELETE /api/app/v1/[optional_namespace/]service/(uuid)/trigger/(trigger_uuid)/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
@ -289,7 +291,7 @@ Available in Docker Cloud's **REST API**
|
|||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/app/v1/service/(uuid)/trigger/(trigger_uuid)/call/`
|
||||
`POST /api/app/v1/[optional_namespace/]service/(uuid)/trigger/(trigger_uuid)/call/`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
|
|
|||
|
|
@ -78,6 +78,25 @@ HTTP responses are given in JSON format, so the following `Accept` header is req
|
|||
|
||||
`Accept: application/json`
|
||||
|
||||
### Namespaced endpoints
|
||||
|
||||
Endpoints that are labeled as "namespaced" allow the users to operate over
|
||||
different namespaces, for example over an individual user namespace, or the
|
||||
namespace of an organization the user is a member of. A namespace identifies the
|
||||
owner of the resource.
|
||||
|
||||
The namespace is optional. If left blank, it defaults to the authenticated user
|
||||
in the request. The namespace is set before the resource in the URL schema:
|
||||
`https://cloud.docker.com/api/<subsystem>/<version>/(optional_namespace/)<resource>/`
|
||||
|
||||
Examples:
|
||||
|
||||
- The user `exampleuser` wants to operate on the node cluster list endpoint in their own namespace. They can use either of the following urls:
|
||||
- https://cloud.docker.com/api/infra/v1/nodecluster/ (namespace omitted, so will use the user authenticated in the request)
|
||||
- https://cloud.docker.com/api/infra/v1/exampleuser/nodecluster/
|
||||
- The user wants to operate on the node cluster list endpoint in an organization called `exampleorg` (which they have permission to see):
|
||||
- https://cloud.docker.com/api/infra/v1/exampleorg/nodecluster/
|
||||
|
||||
## Stream API
|
||||
|
||||
```python
|
||||
|
|
|
|||
|
|
@ -43,11 +43,12 @@
|
|||
</span><span class="nt">"can_be_canceled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"location"</span><span class="p">:</span><span class="w"> </span><span class="s2">"New York, USA"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"method"</span><span class="p">:</span><span class="w"> </span><span class="s2">"POST"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"object"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/cluster/eea638f4-b77a-4183-b241-22dbd7866f22/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"path"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/cluster/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"object"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/cluster/eea638f4-b77a-4183-b241-22dbd7866f22/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"path"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/cluster/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/audit/v1/action/6246c558-976c-4df6-ba60-eb1a344a17af/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"start_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Wed, 17 Sep 2014 08:26:22 +0000"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Success"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"user"</span><span class="p">:</span><span class="w"> </span><span class="s2">"user_namespace"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"user_agent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_4) AppleWebKit/537.78.2 (KHTML, like Gecko) Version/7.0.6 Safari/537.78.2"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"uuid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6246c558-976c-4df6-ba60-eb1a344a17af"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
|
|
@ -90,6 +91,10 @@
|
|||
<td style="text-align: left">HTTP path of the API accessed</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align: left">user</td>
|
||||
<td style="text-align: left">The user authenticated in the request that created the action</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align: left">user_agent</td>
|
||||
<td style="text-align: left">The user agent provided by the client when accessing the API endpoint</td>
|
||||
</tr>
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@
|
|||
</span><span class="nt">"autorestart"</span><span class="p">:</span><span class="w"> </span><span class="s2">"OFF"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"bindings"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="p">{</span><span class="w">
|
||||
</span><span class="nt">"volume"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/volume/1863e34d-6a7d-4945-aefc-8f27a4ab1a9e/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"volume"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/volume/1863e34d-6a7d-4945-aefc-8f27a4ab1a9e/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"host_path"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"container_path"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/data"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"rewritable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||||
|
|
@ -170,7 +170,7 @@
|
|||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="p">{</span><span class="w">
|
||||
</span><span class="nt">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DB_DOCKERCLOUD_API_URL"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://cloud.docker.com/api/app/v1/service/c0fed1dc-c528-40c9-aa4c-dc00672ebcbf/"</span><span class="w">
|
||||
</span><span class="nt">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://cloud.docker.com/api/app/v1/user_namespace/service/c0fed1dc-c528-40c9-aa4c-dc00672ebcbf/"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"container_ports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
|
|
@ -218,9 +218,9 @@
|
|||
</span><span class="nt">"endpoints"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="nt">"3306/tcp"</span><span class="p">:</span><span class="w"> </span><span class="s2">"tcp://172.16.0.3:3306"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nt">"from_container"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/container/c1dd4e1e-1356-411c-8613-e15146633640/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"from_container"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/container/c1dd4e1e-1356-411c-8613-e15146633640/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DB_1"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"to_container"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/container/ba434e1e-1234-411c-8613-e15146633640/"</span><span class="w">
|
||||
</span><span class="nt">"to_container"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/container/ba434e1e-1234-411c-8613-e15146633640/"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"link_variables"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
|
|
@ -256,20 +256,20 @@
|
|||
</span><span class="nt">"memory_swap"</span><span class="p">:</span><span class="w"> </span><span class="mi">4096</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wordpress-stackable"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"net"</span><span class="p">:</span><span class="w"> </span><span class="s2">"bridge"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/node/9691c44e-3155-4ca2-958d-c9571aac0a14/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/node/9691c44e-3155-4ca2-958d-c9571aac0a14/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"pid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"none"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"private_ip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.7.0.1"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"privileged"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"public_dns"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wordpress-stackable-1.admin.cont.dockerapp.io"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"read_only"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/container/c1dd4e1e-1356-411c-8613-e15146633640/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/container/c1dd4e1e-1356-411c-8613-e15146633640/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"roles"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"global"</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"run_command"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/run-wordpress.sh"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"security_opt"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"label:user:USER"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"label:role:ROLE"</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"service"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/adeebc1b-1b81-4af0-b8f2-cefffc69d7fb/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"service"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/adeebc1b-1b81-4af0-b8f2-cefffc69d7fb/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"started_datetime"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thu, 16 Oct 2014 12:04:08 +0000"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Running"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"stdin_open"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
|
|
@ -284,6 +284,8 @@
|
|||
|
||||
<p>A container is a representation of a Docker container in a node.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -707,7 +709,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/container/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]container/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -770,7 +772,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/container/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]container/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -838,7 +840,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/container/(uuid)/logs/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]container/(uuid)/logs/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -910,7 +912,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/container/(uuid)/start/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]container/(uuid)/start/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -960,7 +962,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/container/(uuid)/stop/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]container/(uuid)/stop/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -1011,7 +1013,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/container/(uuid)/redeploy/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]container/(uuid)/redeploy/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -1075,7 +1077,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/container/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/[optional_namespace/]container/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -1130,7 +1132,7 @@ container.execute("ls", handler=msg_handler)
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/container/(uuid)/exec/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]container/(uuid)/exec/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
|
|||
|
|
@ -39,9 +39,9 @@
|
|||
</span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"action"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"update"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"parents"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/container/0b0e3538-88df-4f07-9aed-3a3cc4175076/"</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/user_namespace/container/0b0e3538-88df-4f07-9aed-3a3cc4175076/"</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/action/49f0efe8-a704-4a10-b02f-f96344fabadd/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/action/49f0efe8-a704-4a10-b02f-f96344fabadd/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Success"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"uuid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"093ba3bb-08dd-48f0-8f12-4d3b85ef85b3"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"datetime"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-02-01T16:47:28Z"</span><span class="w">
|
||||
|
|
@ -59,6 +59,8 @@
|
|||
<li>Action</li>
|
||||
</ul>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -212,7 +214,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/audit/v1/events/</code></p>
|
||||
<p><code class="prettyprint">GET /api/audit/v1/[optional_namespace/]events/</code></p>
|
||||
|
||||
</div>
|
||||
<div class="dark-box">
|
||||
|
|
|
|||
|
|
@ -49,11 +49,11 @@
|
|||
</span><span class="nt">"last_seen"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thu, 25 Sep 2014 13:14:44 +0000"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"memory"</span><span class="p">:</span><span class="w"> </span><span class="mi">1792</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"nickname"</span><span class="p">:</span><span class="w"> </span><span class="s2">"fc1a5bb9-user.node.dockerapp.io"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node_cluster"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/nodecluster/d787a4b7-d525-4061-97a0-f423e8f1d229/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/nodetype/testing-provider/testing-type/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node_cluster"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/nodecluster/d787a4b7-d525-4061-97a0-f423e8f1d229/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/nodetype/testing-provider/testing-type/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"public_ip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.45.2.11"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"region"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/region/testing-provider/testing-region/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/node/fc1a5bb9-17f5-4819-b667-8c7cd819e949/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/node/fc1a5bb9-17f5-4819-b667-8c7cd819e949/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Deployed"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="p">{</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"tag_one"</span><span class="p">},</span><span class="w">
|
||||
|
|
@ -66,6 +66,8 @@
|
|||
|
||||
<p>A node is a virtual machine provided by a cloud provider where containers can be deployed.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -251,7 +253,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/infra/v1/node/</code></p>
|
||||
<p><code class="prettyprint">GET /api/infra/v1/[optional_namespace/]node/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -318,7 +320,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/infra/v1/node/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/infra/v1/[optional_namespace/]node/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -372,7 +374,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">PATCH /api/infra/v1/node/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">PATCH /api/infra/v1/[optional_namespace/]node/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -440,7 +442,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/infra/v1/node/(uuid)/docker-upgrade/</code></p>
|
||||
<p><code class="prettyprint">POST /api/infra/v1/[optional_namespace/]node/(uuid)/docker-upgrade/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -471,7 +473,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/infra/v1/node/(uuid)/health-check/</code></p>
|
||||
<p><code class="prettyprint">POST /api/infra/v1/[optional_namespace/]node/(uuid)/health-check/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -521,7 +523,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/infra/v1/node/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/infra/v1/[optional_namespace/]node/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
|
|||
|
|
@ -44,10 +44,10 @@
|
|||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"TestCluster"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/nodetype/aws/t2.micro/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"nodes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"/api/infra/v1/node/75d20367-0948-4f10-8ba4-ffb4d16ed3c6/"</span><span class="w">
|
||||
</span><span class="s2">"/api/infra/v1/user_namespace/node/75d20367-0948-4f10-8ba4-ffb4d16ed3c6/"</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"region"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/region/aws/us-east-1/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/nodecluster/5516df0b-721e-4470-b350-741ff22e63a0/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/nodecluster/5516df0b-721e-4470-b350-741ff22e63a0/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Deployed"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="p">{</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"tag_one"</span><span class="p">},</span><span class="w">
|
||||
|
|
@ -71,6 +71,8 @@
|
|||
|
||||
<p>A node cluster is a group of nodes that share the same provider, region and/or availability zone, and node type. They are on the same private network.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -233,7 +235,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/infra/v1/nodecluster/</code></p>
|
||||
<p><code class="prettyprint">GET /api/infra/v1/[optional_namespace/]nodecluster/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -302,7 +304,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/infra/v1/nodecluster/</code></p>
|
||||
<p><code class="prettyprint">POST /api/infra/v1/[optional_namespace/]nodecluster/</code></p>
|
||||
|
||||
<h3 id="json-parameters">JSON Parameters</h3>
|
||||
|
||||
|
|
@ -377,7 +379,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/infra/v1/nodecluster/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/infra/v1/[optional_namespace/]nodecluster/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -425,7 +427,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/infra/v1/nodecluster/(uuid)/deploy/</code></p>
|
||||
<p><code class="prettyprint">POST /api/infra/v1/[optional_namespace/]nodecluster/(uuid)/deploy/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -482,7 +484,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">PATCH /api/infra/v1/nodecluster/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">PATCH /api/infra/v1/[optional_namespace/]nodecluster/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -550,7 +552,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/infra/v1/nodecluster/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/infra/v1/[optional_namespace/]nodecluster/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
|
|||
|
|
@ -41,12 +41,14 @@
|
|||
</span><span class="nt">"is_ssl"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Docker Hub"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"port"</span><span class="p">:</span><span class="w"> </span><span class="mi">443</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/repo/v1/registry/registry-1.docker.io/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="err">}</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/repo/v1/user_namespace/registry/registry-1.docker.io/"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre>
|
||||
|
||||
<p>Represents a registry where repositories are hosted.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -96,7 +98,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/repo/v1/registry/</code></p>
|
||||
<p><code class="prettyprint">GET /api/repo/v1/[optional_namespace/]registry/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -139,7 +141,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/v1/registry/(host)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/v1/[optional_namespace/]registry/(host)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
|
|||
|
|
@ -36,15 +36,17 @@
|
|||
<p>Example</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="nt">"in_use"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"quay.io/tutum/ubuntu"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"registry"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/repo/v1/registry/quay.io/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/repo/v1/repository/quay.io/tutum/ubuntu/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"in_use"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"my.registry.com/myrepo"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"registry"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/repo/v1/user_namespace/registry/my.registry.com/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/repo/v1/user_namespace/repository/my.registry.com/myrepo/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="err">}</span><span class="w">
|
||||
</span></code></pre>
|
||||
|
||||
<p>The <code class="prettyprint">repository</code> endpoint is used to add and remove existing repositories on third party registries to be used in deployments and builds.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -59,7 +61,7 @@
|
|||
</tr>
|
||||
<tr>
|
||||
<td>name</td>
|
||||
<td>Name of the repository, i.e. <code class="prettyprint">quay.io/tutum/ubuntu</code></td>
|
||||
<td>Name of the repository, i.e. <code class="prettyprint">my.registry.com/myrepo</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>in_use</td>
|
||||
|
|
@ -102,7 +104,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/repo/v1/repository/</code></p>
|
||||
<p><code class="prettyprint">GET /api/repo/v1/[optional_namespace/]repository/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -155,7 +157,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/repo/v1/repository/</code></p>
|
||||
<p><code class="prettyprint">POST /api/repo/v1/[optional_namespace/]repository/</code></p>
|
||||
|
||||
<h3 id="json-parameters">JSON Parameters</h3>
|
||||
|
||||
|
|
@ -167,7 +169,7 @@
|
|||
</thead><tbody>
|
||||
<tr>
|
||||
<td>name</td>
|
||||
<td>Name of the repository, i.e. ‘quay.io/tutum/hello-world’</td>
|
||||
<td>Name of the repository, i.e. ‘my.registry.com/myrepo’</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>username</td>
|
||||
|
|
@ -210,7 +212,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/repo/v1/repository/(name)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/repo/v1/[optional_namespace/]repository/(name)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -253,7 +255,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">PATCH /api/repo/v1/repository/(name)/</code></p>
|
||||
<p><code class="prettyprint">PATCH /api/repo/v1/[optional_namespace/]repository/(name)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -319,7 +321,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/repo/v1/repository/registry.local/user1/image1/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/repo/v1/[optional_namespace/]repository/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@
|
|||
</span><span class="nt">"host_path"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"container_path"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"rewritable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"volumes_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/2f4f54e5-9d3b-4ac1-85ad-a2d4ff25a179/"</span><span class="w">
|
||||
</span><span class="nt">"volumes_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/2f4f54e5-9d3b-4ac1-85ad-a2d4ff25a179/"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"cap_add"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
|
|
@ -83,8 +83,8 @@
|
|||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"containers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/container/6f8ee454-9dc3-4387-80c3-57aac1be3cc6/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/container/fdf9c116-7c08-4a60-b0ce-c54ca72c2f25/"</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/user_namespace/container/6f8ee454-9dc3-4387-80c3-57aac1be3cc6/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/user_namespace/container/fdf9c116-7c08-4a60-b0ce-c54ca72c2f25/"</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"cpu_shares"</span><span class="p">:</span><span class="w"> </span><span class="mi">100</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"cpuset"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0,1"</span><span class="p">,</span><span class="w">
|
||||
|
|
@ -155,14 +155,14 @@
|
|||
</span><span class="nt">"WORDPRESS_STACKABLE_PORT_80_TCP_ADDR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wordpress-stackable-1.admin.cont.dockerapp.io"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"WORDPRESS_STACKABLE_PORT_80_TCP_PORT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"49153"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"WORDPRESS_STACKABLE_PORT_80_TCP_PROTO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"tcp"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"WORDPRESS_STACKABLE_DOCKERCLOUD_API_URL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://cloud.docker.com/api/app/v1/service/adeebc1b-1b81-4af0-b8f2-cefffc69d7fb/"</span><span class="w">
|
||||
</span><span class="nt">"WORDPRESS_STACKABLE_DOCKERCLOUD_API_URL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://cloud.docker.com/api/app/v1/user_namespace/service/adeebc1b-1b81-4af0-b8f2-cefffc69d7fb/"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nt">"linked_from_service"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
||||
</span><span class="nt">"linked_to_service"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="p">{</span><span class="w">
|
||||
</span><span class="nt">"from_service"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"from_service"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DB"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"to_service"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/72f175bd-390b-46e3-9463-830aca32ce3e/"</span><span class="w">
|
||||
</span><span class="nt">"to_service"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/72f175bd-390b-46e3-9463-830aca32ce3e/"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"mac_address"</span><span class="p">:</span><span class="w"> </span><span class="s2">"02:42:ac:11:65:43"</span><span class="p">,</span><span class="w">
|
||||
|
|
@ -173,7 +173,7 @@
|
|||
</span><span class="nt">"privileged"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"public_dns"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wordpress-stackable.admin.svc.dockerapp.io"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"read_only"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"roles"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"global"</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"run_command"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/run-wordpress.sh"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"running_num_containers"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
||||
|
|
@ -182,7 +182,7 @@
|
|||
</span><span class="nt">"sequential_deployment"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"started_datetime"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mon, 13 Oct 2014 11:01:43 +0000"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Partly running"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"stack"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/stack/46aca402-2109-4a70-a378-760cfed43816/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"stack"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/stack/46aca402-2109-4a70-a378-760cfed43816/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"stdin_open"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"stopped_datetime"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"stopped_num_containers"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||||
|
|
@ -202,6 +202,8 @@
|
|||
|
||||
<p>A service is a template used to deploy one or more containers.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -661,7 +663,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/service/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]service/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -724,7 +726,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/</code></p>
|
||||
|
||||
<h3 id="json-parameters">JSON Parameters</h3>
|
||||
|
||||
|
|
@ -939,7 +941,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/service/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]service/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -1009,7 +1011,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/service/(uuid)/logs/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]service/(uuid)/logs/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -1090,7 +1092,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">PATCH /api/app/v1/service/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">PATCH /api/app/v1/[optional_namespace/]service/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -1234,7 +1236,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/(uuid)/start/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/(uuid)/start/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -1284,7 +1286,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/(uuid)/stop/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/(uuid)/stop/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -1324,7 +1326,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/(uuid)/scale/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/(uuid)/scale/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -1376,7 +1378,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/(uuid)/redeploy/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/(uuid)/redeploy/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -1440,7 +1442,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/service/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/[optional_namespace/]service/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
|
|||
|
|
@ -40,9 +40,9 @@
|
|||
</span><span class="nt">"destroyed_datetime"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"nickname"</span><span class="p">:</span><span class="w"> </span><span class="s2">"deployment stack"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"dockercloud-app"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/stack/7fe7ec85-58be-4904-81da-de2219098d7c/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/stack/7fe7ec85-58be-4904-81da-de2219098d7c/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"services"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/"</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/user_namespace/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/"</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Running"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"synchronized"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
|
|
@ -52,6 +52,8 @@
|
|||
|
||||
<p>A stack is a logical grouping of closely related services, that may be linked with one another.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -175,7 +177,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/stack/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]stack/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -249,7 +251,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/stack/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]stack/</code></p>
|
||||
|
||||
<h3 id="json-parameters">JSON Parameters</h3>
|
||||
|
||||
|
|
@ -307,7 +309,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/stack/(uuid)/export/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]stack/(uuid)/export/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -354,7 +356,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/stack/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]stack/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -426,7 +428,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">PATCH /api/app/v1/stack/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">PATCH /api/app/v1/[optional_namespace/]stack/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -490,7 +492,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/stack/(uuid)/stop/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]stack/(uuid)/stop/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -540,7 +542,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/stack/(uuid)/start/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]stack/(uuid)/start/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -592,7 +594,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/stack/(uuid)/redeploy/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]stack/(uuid)/redeploy/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -656,7 +658,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/stack/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/[optional_namespace/]stack/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
|
|||
|
|
@ -36,15 +36,17 @@
|
|||
<p>Example</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="nt">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/82d4a246-52d8-468d-903d-9da9ef05ff28/trigger/0224815a-c156-44e4-92d7-997c69354438/call/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/82d4a246-52d8-468d-903d-9da9ef05ff28/trigger/0224815a-c156-44e4-92d7-997c69354438/call/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"operation"</span><span class="p">:</span><span class="w"> </span><span class="s2">"REDEPLOY"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"docker_trigger"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/82d4a246-52d8-468d-903d-9da9ef05ff28/trigger/0224815a-c156-44e4-92d7-997c69354438/"</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/82d4a246-52d8-468d-903d-9da9ef05ff28/trigger/0224815a-c156-44e4-92d7-997c69354438/"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</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>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -128,7 +130,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/service/(uuid)/trigger/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]service/(uuid)/trigger/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -187,7 +189,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/(uuid)/trigger/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/(uuid)/trigger/</code></p>
|
||||
|
||||
<h3 id="json-parameters">JSON Parameters</h3>
|
||||
|
||||
|
|
@ -243,7 +245,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/service/(uuid)/trigger/(trigger_uuid)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]service/(uuid)/trigger/(trigger_uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -296,7 +298,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/service/(uuid)/trigger/(trigger_uuid)/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/[optional_namespace/]service/(uuid)/trigger/(trigger_uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -346,7 +348,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/(uuid)/trigger/(trigger_uuid)/call/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/(uuid)/trigger/(trigger_uuid)/call/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
|
|||
|
|
@ -86,6 +86,33 @@
|
|||
|
||||
<p><code class="prettyprint">Accept: application/json</code></p>
|
||||
|
||||
<h3 id="namespaced-endpoints">Namespaced endpoints</h3>
|
||||
|
||||
<p>Endpoints that are labeled as “namespaced” allow the users to operate over
|
||||
different namespaces, for example over an individual user namespace, or the
|
||||
namespace of an organization the user is a member of. A namespace identifies the
|
||||
owner of the resource.</p>
|
||||
|
||||
<p>The namespace is optional. If left blank, it defaults to the authenticated user
|
||||
in the request. The namespace is set before the resource in the URL schema:
|
||||
<code class="prettyprint">https://cloud.docker.com/api/<subsystem>/<version>/(optional_namespace/)<resource>/</code></p>
|
||||
|
||||
<p>Examples:</p>
|
||||
|
||||
<ul>
|
||||
<li>The user <code class="prettyprint">exampleuser</code> wants to operate on the node cluster list endpoint in their own namespace. They can use either of the following urls:
|
||||
|
||||
<ul>
|
||||
<li>https://cloud.docker.com/api/infra/v1/nodecluster/ (namespace omitted, so will use the user authenticated in the request)</li>
|
||||
<li>https://cloud.docker.com/api/infra/v1/exampleuser/nodecluster/</li>
|
||||
</ul></li>
|
||||
<li>The user wants to operate on the node cluster list endpoint in an organization called <code class="prettyprint">exampleorg</code> (which they have permission to see):
|
||||
|
||||
<ul>
|
||||
<li>https://cloud.docker.com/api/infra/v1/exampleorg/nodecluster/</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="stream-api">Stream API</h2>
|
||||
<pre class="highlight python"><code><span class="kn">import</span> <span class="nn">websocket</span>
|
||||
<span class="kn">import</span> <span class="nn">base64</span>
|
||||
|
|
@ -155,11 +182,12 @@
|
|||
</span><span class="nt">"can_be_canceled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"location"</span><span class="p">:</span><span class="w"> </span><span class="s2">"New York, USA"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"method"</span><span class="p">:</span><span class="w"> </span><span class="s2">"POST"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"object"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/cluster/eea638f4-b77a-4183-b241-22dbd7866f22/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"path"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/cluster/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"object"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/cluster/eea638f4-b77a-4183-b241-22dbd7866f22/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"path"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/cluster/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/audit/v1/action/6246c558-976c-4df6-ba60-eb1a344a17af/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"start_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Wed, 17 Sep 2014 08:26:22 +0000"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Success"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"user"</span><span class="p">:</span><span class="w"> </span><span class="s2">"user_namespace"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"user_agent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_4) AppleWebKit/537.78.2 (KHTML, like Gecko) Version/7.0.6 Safari/537.78.2"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"uuid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6246c558-976c-4df6-ba60-eb1a344a17af"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
|
|
@ -202,6 +230,10 @@
|
|||
<td style="text-align: left">HTTP path of the API accessed</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align: left">user</td>
|
||||
<td style="text-align: left">The user authenticated in the request that created the action</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align: left">user_agent</td>
|
||||
<td style="text-align: left">The user agent provided by the client when accessing the API endpoint</td>
|
||||
</tr>
|
||||
|
|
@ -1255,10 +1287,10 @@
|
|||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"TestCluster"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/nodetype/aws/t2.micro/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"nodes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"/api/infra/v1/node/75d20367-0948-4f10-8ba4-ffb4d16ed3c6/"</span><span class="w">
|
||||
</span><span class="s2">"/api/infra/v1/user_namespace/node/75d20367-0948-4f10-8ba4-ffb4d16ed3c6/"</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"region"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/region/aws/us-east-1/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/nodecluster/5516df0b-721e-4470-b350-741ff22e63a0/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/nodecluster/5516df0b-721e-4470-b350-741ff22e63a0/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Deployed"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="p">{</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"tag_one"</span><span class="p">},</span><span class="w">
|
||||
|
|
@ -1282,6 +1314,8 @@
|
|||
|
||||
<p>A node cluster is a group of nodes that share the same provider, region and/or availability zone, and node type. They are on the same private network.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -1444,7 +1478,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/infra/v1/nodecluster/</code></p>
|
||||
<p><code class="prettyprint">GET /api/infra/v1/[optional_namespace/]nodecluster/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -1513,7 +1547,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/infra/v1/nodecluster/</code></p>
|
||||
<p><code class="prettyprint">POST /api/infra/v1/[optional_namespace/]nodecluster/</code></p>
|
||||
|
||||
<h3 id="json-parameters">JSON Parameters</h3>
|
||||
|
||||
|
|
@ -1588,7 +1622,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/infra/v1/nodecluster/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/infra/v1/[optional_namespace/]nodecluster/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -1636,7 +1670,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/infra/v1/nodecluster/(uuid)/deploy/</code></p>
|
||||
<p><code class="prettyprint">POST /api/infra/v1/[optional_namespace/]nodecluster/(uuid)/deploy/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -1693,7 +1727,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">PATCH /api/infra/v1/nodecluster/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">PATCH /api/infra/v1/[optional_namespace/]nodecluster/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -1761,7 +1795,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/infra/v1/nodecluster/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/infra/v1/[optional_namespace/]nodecluster/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -1798,11 +1832,11 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="nt">"last_seen"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thu, 25 Sep 2014 13:14:44 +0000"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"memory"</span><span class="p">:</span><span class="w"> </span><span class="mi">1792</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"nickname"</span><span class="p">:</span><span class="w"> </span><span class="s2">"fc1a5bb9-user.node.dockerapp.io"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node_cluster"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/nodecluster/d787a4b7-d525-4061-97a0-f423e8f1d229/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/nodetype/testing-provider/testing-type/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node_cluster"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/nodecluster/d787a4b7-d525-4061-97a0-f423e8f1d229/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/nodetype/testing-provider/testing-type/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"public_ip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.45.2.11"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"region"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/region/testing-provider/testing-region/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/node/fc1a5bb9-17f5-4819-b667-8c7cd819e949/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/node/fc1a5bb9-17f5-4819-b667-8c7cd819e949/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Deployed"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="p">{</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"tag_one"</span><span class="p">},</span><span class="w">
|
||||
|
|
@ -1815,6 +1849,8 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<p>A node is a virtual machine provided by a cloud provider where containers can be deployed.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -2000,7 +2036,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/infra/v1/node/</code></p>
|
||||
<p><code class="prettyprint">GET /api/infra/v1/[optional_namespace/]node/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -2067,7 +2103,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/infra/v1/node/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/infra/v1/[optional_namespace/]node/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -2121,7 +2157,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">PATCH /api/infra/v1/node/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">PATCH /api/infra/v1/[optional_namespace/]node/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -2189,7 +2225,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/infra/v1/node/(uuid)/docker-upgrade/</code></p>
|
||||
<p><code class="prettyprint">POST /api/infra/v1/[optional_namespace/]node/(uuid)/docker-upgrade/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -2220,7 +2256,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/infra/v1/node/(uuid)/health-check/</code></p>
|
||||
<p><code class="prettyprint">POST /api/infra/v1/[optional_namespace/]node/(uuid)/health-check/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -2270,7 +2306,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/infra/v1/node/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/infra/v1/[optional_namespace/]node/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -2299,12 +2335,14 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="nt">"is_ssl"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Docker Hub"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"port"</span><span class="p">:</span><span class="w"> </span><span class="mi">443</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/repo/v1/registry/registry-1.docker.io/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="err">}</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/repo/v1/user_namespace/registry/registry-1.docker.io/"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre>
|
||||
|
||||
<p>Represents a registry where repositories are hosted.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -2354,7 +2392,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/repo/v1/registry/</code></p>
|
||||
<p><code class="prettyprint">GET /api/repo/v1/[optional_namespace/]registry/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -2397,7 +2435,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/v1/registry/(host)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/v1/[optional_namespace/]registry/(host)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -2421,15 +2459,17 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
<p>Example</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="nt">"in_use"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"quay.io/tutum/ubuntu"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"registry"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/repo/v1/registry/quay.io/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/repo/v1/repository/quay.io/tutum/ubuntu/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"in_use"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"my.registry.com/myrepo"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"registry"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/repo/v1/user_namespace/registry/my.registry.com/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/repo/v1/user_namespace/repository/my.registry.com/myrepo/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="err">}</span><span class="w">
|
||||
</span></code></pre>
|
||||
|
||||
<p>The <code class="prettyprint">repository</code> endpoint is used to add and remove existing repositories on third party registries to be used in deployments and builds.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -2444,7 +2484,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</tr>
|
||||
<tr>
|
||||
<td>name</td>
|
||||
<td>Name of the repository, i.e. <code class="prettyprint">quay.io/tutum/ubuntu</code></td>
|
||||
<td>Name of the repository, i.e. <code class="prettyprint">my.registry.com/myrepo</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>in_use</td>
|
||||
|
|
@ -2487,7 +2527,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/repo/v1/repository/</code></p>
|
||||
<p><code class="prettyprint">GET /api/repo/v1/[optional_namespace/]repository/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -2540,7 +2580,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/repo/v1/repository/</code></p>
|
||||
<p><code class="prettyprint">POST /api/repo/v1/[optional_namespace/]repository/</code></p>
|
||||
|
||||
<h3 id="json-parameters">JSON Parameters</h3>
|
||||
|
||||
|
|
@ -2552,7 +2592,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</thead><tbody>
|
||||
<tr>
|
||||
<td>name</td>
|
||||
<td>Name of the repository, i.e. ‘quay.io/tutum/hello-world’</td>
|
||||
<td>Name of the repository, i.e. ‘my.registry.com/myrepo’</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>username</td>
|
||||
|
|
@ -2595,7 +2635,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/repo/v1/repository/(name)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/repo/v1/[optional_namespace/]repository/(name)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -2638,7 +2678,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">PATCH /api/repo/v1/repository/(name)/</code></p>
|
||||
<p><code class="prettyprint">PATCH /api/repo/v1/[optional_namespace/]repository/(name)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -2704,7 +2744,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/repo/v1/repository/registry.local/user1/image1/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/repo/v1/[optional_namespace/]repository/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -2732,9 +2772,9 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="nt">"destroyed_datetime"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"nickname"</span><span class="p">:</span><span class="w"> </span><span class="s2">"deployment stack"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"dockercloud-app"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/stack/7fe7ec85-58be-4904-81da-de2219098d7c/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/stack/7fe7ec85-58be-4904-81da-de2219098d7c/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"services"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/"</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/user_namespace/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/"</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Running"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"synchronized"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
|
|
@ -2744,6 +2784,8 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<p>A stack is a logical grouping of closely related services, that may be linked with one another.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -2867,7 +2909,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/stack/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]stack/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -2941,7 +2983,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/stack/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]stack/</code></p>
|
||||
|
||||
<h3 id="json-parameters">JSON Parameters</h3>
|
||||
|
||||
|
|
@ -2999,7 +3041,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/stack/(uuid)/export/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]stack/(uuid)/export/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -3046,7 +3088,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/stack/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]stack/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -3118,7 +3160,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">PATCH /api/app/v1/stack/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">PATCH /api/app/v1/[optional_namespace/]stack/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -3182,7 +3224,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/stack/(uuid)/stop/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]stack/(uuid)/stop/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -3232,7 +3274,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/stack/(uuid)/start/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]stack/(uuid)/start/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -3284,7 +3326,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/stack/(uuid)/redeploy/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]stack/(uuid)/redeploy/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -3348,7 +3390,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/stack/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/[optional_namespace/]stack/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -3392,7 +3434,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="nt">"host_path"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"container_path"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"rewritable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"volumes_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/2f4f54e5-9d3b-4ac1-85ad-a2d4ff25a179/"</span><span class="w">
|
||||
</span><span class="nt">"volumes_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/2f4f54e5-9d3b-4ac1-85ad-a2d4ff25a179/"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"cap_add"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
|
|
@ -3419,8 +3461,8 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"containers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/container/6f8ee454-9dc3-4387-80c3-57aac1be3cc6/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/container/fdf9c116-7c08-4a60-b0ce-c54ca72c2f25/"</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/user_namespace/container/6f8ee454-9dc3-4387-80c3-57aac1be3cc6/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/user_namespace/container/fdf9c116-7c08-4a60-b0ce-c54ca72c2f25/"</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"cpu_shares"</span><span class="p">:</span><span class="w"> </span><span class="mi">100</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"cpuset"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0,1"</span><span class="p">,</span><span class="w">
|
||||
|
|
@ -3491,14 +3533,14 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="nt">"WORDPRESS_STACKABLE_PORT_80_TCP_ADDR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wordpress-stackable-1.admin.cont.dockerapp.io"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"WORDPRESS_STACKABLE_PORT_80_TCP_PORT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"49153"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"WORDPRESS_STACKABLE_PORT_80_TCP_PROTO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"tcp"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"WORDPRESS_STACKABLE_DOCKERCLOUD_API_URL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://cloud.docker.com/api/app/v1/service/adeebc1b-1b81-4af0-b8f2-cefffc69d7fb/"</span><span class="w">
|
||||
</span><span class="nt">"WORDPRESS_STACKABLE_DOCKERCLOUD_API_URL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://cloud.docker.com/api/app/v1/user_namespace/service/adeebc1b-1b81-4af0-b8f2-cefffc69d7fb/"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nt">"linked_from_service"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
||||
</span><span class="nt">"linked_to_service"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="p">{</span><span class="w">
|
||||
</span><span class="nt">"from_service"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"from_service"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DB"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"to_service"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/72f175bd-390b-46e3-9463-830aca32ce3e/"</span><span class="w">
|
||||
</span><span class="nt">"to_service"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/72f175bd-390b-46e3-9463-830aca32ce3e/"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"mac_address"</span><span class="p">:</span><span class="w"> </span><span class="s2">"02:42:ac:11:65:43"</span><span class="p">,</span><span class="w">
|
||||
|
|
@ -3509,7 +3551,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="nt">"privileged"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"public_dns"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wordpress-stackable.admin.svc.dockerapp.io"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"read_only"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"roles"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"global"</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"run_command"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/run-wordpress.sh"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"running_num_containers"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
||||
|
|
@ -3518,7 +3560,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="nt">"sequential_deployment"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"started_datetime"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mon, 13 Oct 2014 11:01:43 +0000"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Partly running"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"stack"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/stack/46aca402-2109-4a70-a378-760cfed43816/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"stack"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/stack/46aca402-2109-4a70-a378-760cfed43816/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"stdin_open"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"stopped_datetime"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"stopped_num_containers"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||||
|
|
@ -3538,6 +3580,8 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<p>A service is a template used to deploy one or more containers.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -3997,7 +4041,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/service/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]service/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -4060,7 +4104,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/</code></p>
|
||||
|
||||
<h3 id="json-parameters">JSON Parameters</h3>
|
||||
|
||||
|
|
@ -4275,7 +4319,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/service/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]service/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -4345,7 +4389,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/service/(uuid)/logs/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]service/(uuid)/logs/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -4426,7 +4470,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">PATCH /api/app/v1/service/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">PATCH /api/app/v1/[optional_namespace/]service/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -4570,7 +4614,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/(uuid)/start/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/(uuid)/start/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -4620,7 +4664,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/(uuid)/stop/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/(uuid)/stop/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -4660,7 +4704,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/(uuid)/scale/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/(uuid)/scale/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -4712,7 +4756,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/(uuid)/redeploy/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/(uuid)/redeploy/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -4776,7 +4820,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/service/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/[optional_namespace/]service/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -4804,7 +4848,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="nt">"autorestart"</span><span class="p">:</span><span class="w"> </span><span class="s2">"OFF"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"bindings"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="p">{</span><span class="w">
|
||||
</span><span class="nt">"volume"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/volume/1863e34d-6a7d-4945-aefc-8f27a4ab1a9e/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"volume"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/volume/1863e34d-6a7d-4945-aefc-8f27a4ab1a9e/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"host_path"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"container_path"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/data"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"rewritable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||||
|
|
@ -4934,7 +4978,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="p">{</span><span class="w">
|
||||
</span><span class="nt">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DB_DOCKERCLOUD_API_URL"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://cloud.docker.com/api/app/v1/service/c0fed1dc-c528-40c9-aa4c-dc00672ebcbf/"</span><span class="w">
|
||||
</span><span class="nt">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://cloud.docker.com/api/app/v1/user_namespace/service/c0fed1dc-c528-40c9-aa4c-dc00672ebcbf/"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"container_ports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
|
|
@ -4982,9 +5026,9 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="nt">"endpoints"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="nt">"3306/tcp"</span><span class="p">:</span><span class="w"> </span><span class="s2">"tcp://172.16.0.3:3306"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nt">"from_container"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/container/c1dd4e1e-1356-411c-8613-e15146633640/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"from_container"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/container/c1dd4e1e-1356-411c-8613-e15146633640/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DB_1"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"to_container"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/container/ba434e1e-1234-411c-8613-e15146633640/"</span><span class="w">
|
||||
</span><span class="nt">"to_container"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/container/ba434e1e-1234-411c-8613-e15146633640/"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"link_variables"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
|
|
@ -5020,20 +5064,20 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="nt">"memory_swap"</span><span class="p">:</span><span class="w"> </span><span class="mi">4096</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wordpress-stackable"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"net"</span><span class="p">:</span><span class="w"> </span><span class="s2">"bridge"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/node/9691c44e-3155-4ca2-958d-c9571aac0a14/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/node/9691c44e-3155-4ca2-958d-c9571aac0a14/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"pid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"none"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"private_ip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.7.0.1"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"privileged"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"public_dns"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wordpress-stackable-1.admin.cont.dockerapp.io"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"read_only"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/container/c1dd4e1e-1356-411c-8613-e15146633640/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/container/c1dd4e1e-1356-411c-8613-e15146633640/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"roles"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"global"</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"run_command"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/run-wordpress.sh"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"security_opt"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"label:user:USER"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"label:role:ROLE"</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"service"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/adeebc1b-1b81-4af0-b8f2-cefffc69d7fb/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"service"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/adeebc1b-1b81-4af0-b8f2-cefffc69d7fb/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"started_datetime"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thu, 16 Oct 2014 12:04:08 +0000"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Running"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"stdin_open"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
|
|
@ -5048,6 +5092,8 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<p>A container is a representation of a Docker container in a node.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -5471,7 +5517,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/container/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]container/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -5534,7 +5580,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/container/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]container/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -5602,7 +5648,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/container/(uuid)/logs/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]container/(uuid)/logs/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -5674,7 +5720,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/container/(uuid)/start/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]container/(uuid)/start/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -5724,7 +5770,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/container/(uuid)/stop/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]container/(uuid)/stop/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -5775,7 +5821,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/container/(uuid)/redeploy/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]container/(uuid)/redeploy/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -5839,7 +5885,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/container/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/[optional_namespace/]container/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -5894,7 +5940,7 @@ container.execute("ls", handler=msg_handler)
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/container/(uuid)/exec/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]container/(uuid)/exec/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -5932,15 +5978,17 @@ container.execute("ls", handler=msg_handler)
|
|||
<p>Example</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="nt">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/82d4a246-52d8-468d-903d-9da9ef05ff28/trigger/0224815a-c156-44e4-92d7-997c69354438/call/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/82d4a246-52d8-468d-903d-9da9ef05ff28/trigger/0224815a-c156-44e4-92d7-997c69354438/call/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"operation"</span><span class="p">:</span><span class="w"> </span><span class="s2">"REDEPLOY"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"docker_trigger"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/82d4a246-52d8-468d-903d-9da9ef05ff28/trigger/0224815a-c156-44e4-92d7-997c69354438/"</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/82d4a246-52d8-468d-903d-9da9ef05ff28/trigger/0224815a-c156-44e4-92d7-997c69354438/"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</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>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -6024,7 +6072,7 @@ container.execute("ls", handler=msg_handler)
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/service/(uuid)/trigger/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]service/(uuid)/trigger/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -6083,7 +6131,7 @@ container.execute("ls", handler=msg_handler)
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/(uuid)/trigger/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/(uuid)/trigger/</code></p>
|
||||
|
||||
<h3 id="json-parameters">JSON Parameters</h3>
|
||||
|
||||
|
|
@ -6139,7 +6187,7 @@ container.execute("ls", handler=msg_handler)
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/service/(uuid)/trigger/(trigger_uuid)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]service/(uuid)/trigger/(trigger_uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -6192,7 +6240,7 @@ container.execute("ls", handler=msg_handler)
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/service/(uuid)/trigger/(trigger_uuid)/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/[optional_namespace/]service/(uuid)/trigger/(trigger_uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -6242,7 +6290,7 @@ container.execute("ls", handler=msg_handler)
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/(uuid)/trigger/(trigger_uuid)/call/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/(uuid)/trigger/(trigger_uuid)/call/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -6273,9 +6321,9 @@ container.execute("ls", handler=msg_handler)
|
|||
</span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"action"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"update"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"parents"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/container/0b0e3538-88df-4f07-9aed-3a3cc4175076/"</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/user_namespace/container/0b0e3538-88df-4f07-9aed-3a3cc4175076/"</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/action/49f0efe8-a704-4a10-b02f-f96344fabadd/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/action/49f0efe8-a704-4a10-b02f-f96344fabadd/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Success"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"uuid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"093ba3bb-08dd-48f0-8f12-4d3b85ef85b3"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"datetime"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-02-01T16:47:28Z"</span><span class="w">
|
||||
|
|
@ -6293,6 +6341,8 @@ container.execute("ls", handler=msg_handler)
|
|||
<li>Action</li>
|
||||
</ul>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -6446,7 +6496,7 @@ container.execute("ls", handler=msg_handler)
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/audit/v1/events/</code></p>
|
||||
<p><code class="prettyprint">GET /api/audit/v1/[optional_namespace/]events/</code></p>
|
||||
|
||||
<h1 id="errors">Errors</h1>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,17 +2,9 @@
|
|||
description: Learn how to use DTR APIs.
|
||||
keywords:
|
||||
- docker, registry, DTR, APIs
|
||||
menu:
|
||||
main:
|
||||
identifier: smn_dtrapi
|
||||
parent: workw_dtr
|
||||
weight: "100"
|
||||
title: DTR APIs
|
||||
type: _default
|
||||
---
|
||||
|
||||
# DTR APIs
|
||||
|
||||
This section includes the following topics:
|
||||
|
||||
* [API overview](overview.md)
|
||||
|
|
|
|||
|
|
@ -86,6 +86,33 @@
|
|||
|
||||
<p><code class="prettyprint">Accept: application/json</code></p>
|
||||
|
||||
<h3 id="namespaced-endpoints">Namespaced endpoints</h3>
|
||||
|
||||
<p>Endpoints that are labeled as “namespaced” allow the users to operate over
|
||||
different namespaces, for example over an individual user namespace, or the
|
||||
namespace of an organization the user is a member of. A namespace identifies the
|
||||
owner of the resource.</p>
|
||||
|
||||
<p>The namespace is optional. If left blank, it defaults to the authenticated user
|
||||
in the request. The namespace is set before the resource in the URL schema:
|
||||
<code class="prettyprint">https://cloud.docker.com/api/<subsystem>/<version>/(optional_namespace/)<resource>/</code></p>
|
||||
|
||||
<p>Examples:</p>
|
||||
|
||||
<ul>
|
||||
<li>The user <code class="prettyprint">exampleuser</code> wants to operate on the node cluster list endpoint in their own namespace. They can use either of the following urls:
|
||||
|
||||
<ul>
|
||||
<li>https://cloud.docker.com/api/infra/v1/nodecluster/ (namespace omitted, so will use the user authenticated in the request)</li>
|
||||
<li>https://cloud.docker.com/api/infra/v1/exampleuser/nodecluster/</li>
|
||||
</ul></li>
|
||||
<li>The user wants to operate on the node cluster list endpoint in an organization called <code class="prettyprint">exampleorg</code> (which they have permission to see):
|
||||
|
||||
<ul>
|
||||
<li>https://cloud.docker.com/api/infra/v1/exampleorg/nodecluster/</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="stream-api">Stream API</h2>
|
||||
<pre class="highlight python"><code><span class="kn">import</span> <span class="nn">websocket</span>
|
||||
<span class="kn">import</span> <span class="nn">base64</span>
|
||||
|
|
@ -155,11 +182,12 @@
|
|||
</span><span class="nt">"can_be_canceled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"location"</span><span class="p">:</span><span class="w"> </span><span class="s2">"New York, USA"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"method"</span><span class="p">:</span><span class="w"> </span><span class="s2">"POST"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"object"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/cluster/eea638f4-b77a-4183-b241-22dbd7866f22/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"path"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/cluster/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"object"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/cluster/eea638f4-b77a-4183-b241-22dbd7866f22/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"path"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/cluster/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/audit/v1/action/6246c558-976c-4df6-ba60-eb1a344a17af/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"start_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Wed, 17 Sep 2014 08:26:22 +0000"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Success"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"user"</span><span class="p">:</span><span class="w"> </span><span class="s2">"user_namespace"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"user_agent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_4) AppleWebKit/537.78.2 (KHTML, like Gecko) Version/7.0.6 Safari/537.78.2"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"uuid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6246c558-976c-4df6-ba60-eb1a344a17af"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
|
|
@ -202,6 +230,10 @@
|
|||
<td style="text-align: left">HTTP path of the API accessed</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align: left">user</td>
|
||||
<td style="text-align: left">The user authenticated in the request that created the action</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align: left">user_agent</td>
|
||||
<td style="text-align: left">The user agent provided by the client when accessing the API endpoint</td>
|
||||
</tr>
|
||||
|
|
@ -1255,10 +1287,10 @@
|
|||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"TestCluster"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/nodetype/aws/t2.micro/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"nodes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"/api/infra/v1/node/75d20367-0948-4f10-8ba4-ffb4d16ed3c6/"</span><span class="w">
|
||||
</span><span class="s2">"/api/infra/v1/user_namespace/node/75d20367-0948-4f10-8ba4-ffb4d16ed3c6/"</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"region"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/region/aws/us-east-1/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/nodecluster/5516df0b-721e-4470-b350-741ff22e63a0/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/nodecluster/5516df0b-721e-4470-b350-741ff22e63a0/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Deployed"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="p">{</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"tag_one"</span><span class="p">},</span><span class="w">
|
||||
|
|
@ -1282,6 +1314,8 @@
|
|||
|
||||
<p>A node cluster is a group of nodes that share the same provider, region and/or availability zone, and node type. They are on the same private network.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -1444,7 +1478,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/infra/v1/nodecluster/</code></p>
|
||||
<p><code class="prettyprint">GET /api/infra/v1/[optional_namespace/]nodecluster/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -1513,7 +1547,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/infra/v1/nodecluster/</code></p>
|
||||
<p><code class="prettyprint">POST /api/infra/v1/[optional_namespace/]nodecluster/</code></p>
|
||||
|
||||
<h3 id="json-parameters">JSON Parameters</h3>
|
||||
|
||||
|
|
@ -1588,7 +1622,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/infra/v1/nodecluster/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/infra/v1/[optional_namespace/]nodecluster/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -1636,7 +1670,7 @@
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/infra/v1/nodecluster/(uuid)/deploy/</code></p>
|
||||
<p><code class="prettyprint">POST /api/infra/v1/[optional_namespace/]nodecluster/(uuid)/deploy/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -1693,7 +1727,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">PATCH /api/infra/v1/nodecluster/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">PATCH /api/infra/v1/[optional_namespace/]nodecluster/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -1761,7 +1795,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/infra/v1/nodecluster/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/infra/v1/[optional_namespace/]nodecluster/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -1798,11 +1832,11 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="nt">"last_seen"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thu, 25 Sep 2014 13:14:44 +0000"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"memory"</span><span class="p">:</span><span class="w"> </span><span class="mi">1792</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"nickname"</span><span class="p">:</span><span class="w"> </span><span class="s2">"fc1a5bb9-user.node.dockerapp.io"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node_cluster"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/nodecluster/d787a4b7-d525-4061-97a0-f423e8f1d229/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/nodetype/testing-provider/testing-type/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node_cluster"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/nodecluster/d787a4b7-d525-4061-97a0-f423e8f1d229/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/nodetype/testing-provider/testing-type/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"public_ip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.45.2.11"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"region"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/region/testing-provider/testing-region/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/node/fc1a5bb9-17f5-4819-b667-8c7cd819e949/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/node/fc1a5bb9-17f5-4819-b667-8c7cd819e949/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Deployed"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="p">{</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"tag_one"</span><span class="p">},</span><span class="w">
|
||||
|
|
@ -1815,6 +1849,8 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<p>A node is a virtual machine provided by a cloud provider where containers can be deployed.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -2000,7 +2036,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/infra/v1/node/</code></p>
|
||||
<p><code class="prettyprint">GET /api/infra/v1/[optional_namespace/]node/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -2067,7 +2103,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/infra/v1/node/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/infra/v1/[optional_namespace/]node/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -2121,7 +2157,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">PATCH /api/infra/v1/node/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">PATCH /api/infra/v1/[optional_namespace/]node/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -2189,7 +2225,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/infra/v1/node/(uuid)/docker-upgrade/</code></p>
|
||||
<p><code class="prettyprint">POST /api/infra/v1/[optional_namespace/]node/(uuid)/docker-upgrade/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -2220,7 +2256,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/infra/v1/node/(uuid)/health-check/</code></p>
|
||||
<p><code class="prettyprint">POST /api/infra/v1/[optional_namespace/]node/(uuid)/health-check/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -2270,7 +2306,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/infra/v1/node/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/infra/v1/[optional_namespace/]node/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -2299,12 +2335,14 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="nt">"is_ssl"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Docker Hub"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"port"</span><span class="p">:</span><span class="w"> </span><span class="mi">443</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/repo/v1/registry/registry-1.docker.io/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="err">}</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/repo/v1/user_namespace/registry/registry-1.docker.io/"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre>
|
||||
|
||||
<p>Represents a registry where repositories are hosted.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -2354,7 +2392,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/repo/v1/registry/</code></p>
|
||||
<p><code class="prettyprint">GET /api/repo/v1/[optional_namespace/]registry/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -2397,7 +2435,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/v1/registry/(host)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/v1/[optional_namespace/]registry/(host)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -2421,15 +2459,17 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
<p>Example</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="nt">"in_use"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"quay.io/tutum/ubuntu"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"registry"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/repo/v1/registry/quay.io/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/repo/v1/repository/quay.io/tutum/ubuntu/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"in_use"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"my.registry.com/myrepo"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"registry"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/repo/v1/user_namespace/registry/my.registry.com/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/repo/v1/user_namespace/repository/my.registry.com/myrepo/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="err">}</span><span class="w">
|
||||
</span></code></pre>
|
||||
|
||||
<p>The <code class="prettyprint">repository</code> endpoint is used to add and remove existing repositories on third party registries to be used in deployments and builds.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -2444,7 +2484,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</tr>
|
||||
<tr>
|
||||
<td>name</td>
|
||||
<td>Name of the repository, i.e. <code class="prettyprint">quay.io/tutum/ubuntu</code></td>
|
||||
<td>Name of the repository, i.e. <code class="prettyprint">my.registry.com/myrepo</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>in_use</td>
|
||||
|
|
@ -2487,7 +2527,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/repo/v1/repository/</code></p>
|
||||
<p><code class="prettyprint">GET /api/repo/v1/[optional_namespace/]repository/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -2540,7 +2580,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/repo/v1/repository/</code></p>
|
||||
<p><code class="prettyprint">POST /api/repo/v1/[optional_namespace/]repository/</code></p>
|
||||
|
||||
<h3 id="json-parameters">JSON Parameters</h3>
|
||||
|
||||
|
|
@ -2552,7 +2592,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</thead><tbody>
|
||||
<tr>
|
||||
<td>name</td>
|
||||
<td>Name of the repository, i.e. ‘quay.io/tutum/hello-world’</td>
|
||||
<td>Name of the repository, i.e. ‘my.registry.com/myrepo’</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>username</td>
|
||||
|
|
@ -2595,7 +2635,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/repo/v1/repository/(name)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/repo/v1/[optional_namespace/]repository/(name)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -2638,7 +2678,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">PATCH /api/repo/v1/repository/(name)/</code></p>
|
||||
<p><code class="prettyprint">PATCH /api/repo/v1/[optional_namespace/]repository/(name)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -2704,7 +2744,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/repo/v1/repository/registry.local/user1/image1/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/repo/v1/[optional_namespace/]repository/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -2732,9 +2772,9 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="nt">"destroyed_datetime"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"nickname"</span><span class="p">:</span><span class="w"> </span><span class="s2">"deployment stack"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"dockercloud-app"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/stack/7fe7ec85-58be-4904-81da-de2219098d7c/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/stack/7fe7ec85-58be-4904-81da-de2219098d7c/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"services"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/"</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/user_namespace/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/"</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Running"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"synchronized"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
|
|
@ -2744,6 +2784,8 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<p>A stack is a logical grouping of closely related services, that may be linked with one another.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -2867,7 +2909,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/stack/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]stack/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -2941,7 +2983,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/stack/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]stack/</code></p>
|
||||
|
||||
<h3 id="json-parameters">JSON Parameters</h3>
|
||||
|
||||
|
|
@ -2999,7 +3041,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/stack/(uuid)/export/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]stack/(uuid)/export/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -3046,7 +3088,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/stack/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]stack/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -3118,7 +3160,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">PATCH /api/app/v1/stack/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">PATCH /api/app/v1/[optional_namespace/]stack/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -3182,7 +3224,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/stack/(uuid)/stop/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]stack/(uuid)/stop/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -3232,7 +3274,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/stack/(uuid)/start/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]stack/(uuid)/start/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -3284,7 +3326,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/stack/(uuid)/redeploy/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]stack/(uuid)/redeploy/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -3348,7 +3390,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/stack/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/[optional_namespace/]stack/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -3392,7 +3434,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="nt">"host_path"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"container_path"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"rewritable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"volumes_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/2f4f54e5-9d3b-4ac1-85ad-a2d4ff25a179/"</span><span class="w">
|
||||
</span><span class="nt">"volumes_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/2f4f54e5-9d3b-4ac1-85ad-a2d4ff25a179/"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"cap_add"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
|
|
@ -3419,8 +3461,8 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"containers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/container/6f8ee454-9dc3-4387-80c3-57aac1be3cc6/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/container/fdf9c116-7c08-4a60-b0ce-c54ca72c2f25/"</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/user_namespace/container/6f8ee454-9dc3-4387-80c3-57aac1be3cc6/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/user_namespace/container/fdf9c116-7c08-4a60-b0ce-c54ca72c2f25/"</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"cpu_shares"</span><span class="p">:</span><span class="w"> </span><span class="mi">100</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"cpuset"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0,1"</span><span class="p">,</span><span class="w">
|
||||
|
|
@ -3491,14 +3533,14 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="nt">"WORDPRESS_STACKABLE_PORT_80_TCP_ADDR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wordpress-stackable-1.admin.cont.dockerapp.io"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"WORDPRESS_STACKABLE_PORT_80_TCP_PORT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"49153"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"WORDPRESS_STACKABLE_PORT_80_TCP_PROTO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"tcp"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"WORDPRESS_STACKABLE_DOCKERCLOUD_API_URL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://cloud.docker.com/api/app/v1/service/adeebc1b-1b81-4af0-b8f2-cefffc69d7fb/"</span><span class="w">
|
||||
</span><span class="nt">"WORDPRESS_STACKABLE_DOCKERCLOUD_API_URL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://cloud.docker.com/api/app/v1/user_namespace/service/adeebc1b-1b81-4af0-b8f2-cefffc69d7fb/"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nt">"linked_from_service"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
||||
</span><span class="nt">"linked_to_service"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="p">{</span><span class="w">
|
||||
</span><span class="nt">"from_service"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"from_service"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DB"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"to_service"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/72f175bd-390b-46e3-9463-830aca32ce3e/"</span><span class="w">
|
||||
</span><span class="nt">"to_service"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/72f175bd-390b-46e3-9463-830aca32ce3e/"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"mac_address"</span><span class="p">:</span><span class="w"> </span><span class="s2">"02:42:ac:11:65:43"</span><span class="p">,</span><span class="w">
|
||||
|
|
@ -3509,7 +3551,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="nt">"privileged"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"public_dns"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wordpress-stackable.admin.svc.dockerapp.io"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"read_only"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/09cbcf8d-a727-40d9-b420-c8e18b7fa55b/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"roles"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"global"</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"run_command"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/run-wordpress.sh"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"running_num_containers"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
||||
|
|
@ -3518,7 +3560,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="nt">"sequential_deployment"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"started_datetime"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mon, 13 Oct 2014 11:01:43 +0000"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Partly running"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"stack"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/stack/46aca402-2109-4a70-a378-760cfed43816/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"stack"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/stack/46aca402-2109-4a70-a378-760cfed43816/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"stdin_open"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"stopped_datetime"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"stopped_num_containers"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||||
|
|
@ -3538,6 +3580,8 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<p>A service is a template used to deploy one or more containers.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -3997,7 +4041,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/service/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]service/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -4060,7 +4104,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/</code></p>
|
||||
|
||||
<h3 id="json-parameters">JSON Parameters</h3>
|
||||
|
||||
|
|
@ -4275,7 +4319,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/service/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]service/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -4345,7 +4389,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/service/(uuid)/logs/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]service/(uuid)/logs/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -4426,7 +4470,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">PATCH /api/app/v1/service/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">PATCH /api/app/v1/[optional_namespace/]service/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -4570,7 +4614,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/(uuid)/start/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/(uuid)/start/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -4620,7 +4664,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/(uuid)/stop/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/(uuid)/stop/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -4660,7 +4704,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/(uuid)/scale/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/(uuid)/scale/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -4712,7 +4756,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/(uuid)/redeploy/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/(uuid)/redeploy/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -4776,7 +4820,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/service/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/[optional_namespace/]service/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -4804,7 +4848,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="nt">"autorestart"</span><span class="p">:</span><span class="w"> </span><span class="s2">"OFF"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"bindings"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="p">{</span><span class="w">
|
||||
</span><span class="nt">"volume"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/volume/1863e34d-6a7d-4945-aefc-8f27a4ab1a9e/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"volume"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/volume/1863e34d-6a7d-4945-aefc-8f27a4ab1a9e/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"host_path"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"container_path"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/data"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"rewritable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||||
|
|
@ -4934,7 +4978,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="p">{</span><span class="w">
|
||||
</span><span class="nt">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DB_DOCKERCLOUD_API_URL"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://cloud.docker.com/api/app/v1/service/c0fed1dc-c528-40c9-aa4c-dc00672ebcbf/"</span><span class="w">
|
||||
</span><span class="nt">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://cloud.docker.com/api/app/v1/user_namespace/service/c0fed1dc-c528-40c9-aa4c-dc00672ebcbf/"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"container_ports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
|
|
@ -4982,9 +5026,9 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="nt">"endpoints"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="nt">"3306/tcp"</span><span class="p">:</span><span class="w"> </span><span class="s2">"tcp://172.16.0.3:3306"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="nt">"from_container"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/container/c1dd4e1e-1356-411c-8613-e15146633640/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"from_container"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/container/c1dd4e1e-1356-411c-8613-e15146633640/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DB_1"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"to_container"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/container/ba434e1e-1234-411c-8613-e15146633640/"</span><span class="w">
|
||||
</span><span class="nt">"to_container"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/container/ba434e1e-1234-411c-8613-e15146633640/"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"link_variables"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
|
|
@ -5020,20 +5064,20 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
</span><span class="nt">"memory_swap"</span><span class="p">:</span><span class="w"> </span><span class="mi">4096</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wordpress-stackable"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"net"</span><span class="p">:</span><span class="w"> </span><span class="s2">"bridge"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/node/9691c44e-3155-4ca2-958d-c9571aac0a14/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"node"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/infra/v1/user_namespace/node/9691c44e-3155-4ca2-958d-c9571aac0a14/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"pid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"none"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"private_ip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.7.0.1"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"privileged"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"public_dns"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wordpress-stackable-1.admin.cont.dockerapp.io"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"read_only"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/container/c1dd4e1e-1356-411c-8613-e15146633640/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/container/c1dd4e1e-1356-411c-8613-e15146633640/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"roles"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"global"</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"run_command"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/run-wordpress.sh"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"security_opt"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"label:user:USER"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"label:role:ROLE"</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"service"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/adeebc1b-1b81-4af0-b8f2-cefffc69d7fb/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"service"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/adeebc1b-1b81-4af0-b8f2-cefffc69d7fb/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"started_datetime"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thu, 16 Oct 2014 12:04:08 +0000"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Running"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"stdin_open"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||||
|
|
@ -5048,6 +5092,8 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<p>A container is a representation of a Docker container in a node.</p>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -5471,7 +5517,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/container/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]container/</code></p>
|
||||
|
||||
<h3 id="query-parameters">Query Parameters</h3>
|
||||
|
||||
|
|
@ -5534,7 +5580,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/container/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]container/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -5602,7 +5648,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/container/(uuid)/logs/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]container/(uuid)/logs/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -5674,7 +5720,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/container/(uuid)/start/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]container/(uuid)/start/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -5724,7 +5770,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/container/(uuid)/stop/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]container/(uuid)/stop/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -5775,7 +5821,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/container/(uuid)/redeploy/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]container/(uuid)/redeploy/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -5839,7 +5885,7 @@ docker-cloud tag <span class="nb">set</span> -t tag-2 7eaf7fff
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/container/(uuid)/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/[optional_namespace/]container/(uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -5894,7 +5940,7 @@ container.execute("ls", handler=msg_handler)
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/container/(uuid)/exec/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]container/(uuid)/exec/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -5932,15 +5978,17 @@ container.execute("ls", handler=msg_handler)
|
|||
<p>Example</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="nt">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/82d4a246-52d8-468d-903d-9da9ef05ff28/trigger/0224815a-c156-44e4-92d7-997c69354438/call/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/82d4a246-52d8-468d-903d-9da9ef05ff28/trigger/0224815a-c156-44e4-92d7-997c69354438/call/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"operation"</span><span class="p">:</span><span class="w"> </span><span class="s2">"REDEPLOY"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"docker_trigger"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/service/82d4a246-52d8-468d-903d-9da9ef05ff28/trigger/0224815a-c156-44e4-92d7-997c69354438/"</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/service/82d4a246-52d8-468d-903d-9da9ef05ff28/trigger/0224815a-c156-44e4-92d7-997c69354438/"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</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>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -6024,7 +6072,7 @@ container.execute("ls", handler=msg_handler)
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/service/(uuid)/trigger/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]service/(uuid)/trigger/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -6083,7 +6131,7 @@ container.execute("ls", handler=msg_handler)
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/(uuid)/trigger/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/(uuid)/trigger/</code></p>
|
||||
|
||||
<h3 id="json-parameters">JSON Parameters</h3>
|
||||
|
||||
|
|
@ -6139,7 +6187,7 @@ container.execute("ls", handler=msg_handler)
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/app/v1/service/(uuid)/trigger/(trigger_uuid)/</code></p>
|
||||
<p><code class="prettyprint">GET /api/app/v1/[optional_namespace/]service/(uuid)/trigger/(trigger_uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -6192,7 +6240,7 @@ container.execute("ls", handler=msg_handler)
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/service/(uuid)/trigger/(trigger_uuid)/</code></p>
|
||||
<p><code class="prettyprint">DELETE /api/app/v1/[optional_namespace/]service/(uuid)/trigger/(trigger_uuid)/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -6242,7 +6290,7 @@ container.execute("ls", handler=msg_handler)
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">POST /api/app/v1/service/(uuid)/trigger/(trigger_uuid)/call/</code></p>
|
||||
<p><code class="prettyprint">POST /api/app/v1/[optional_namespace/]service/(uuid)/trigger/(trigger_uuid)/call/</code></p>
|
||||
|
||||
<h3 id="path-parameters">Path Parameters</h3>
|
||||
|
||||
|
|
@ -6273,9 +6321,9 @@ container.execute("ls", handler=msg_handler)
|
|||
</span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"action"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"update"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"parents"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/container/0b0e3538-88df-4f07-9aed-3a3cc4175076/"</span><span class="w">
|
||||
</span><span class="s2">"/api/app/v1/user_namespace/container/0b0e3538-88df-4f07-9aed-3a3cc4175076/"</span><span class="w">
|
||||
</span><span class="p">],</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/action/49f0efe8-a704-4a10-b02f-f96344fabadd/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"resource_uri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/api/app/v1/user_namespace/action/49f0efe8-a704-4a10-b02f-f96344fabadd/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Success"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"uuid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"093ba3bb-08dd-48f0-8f12-4d3b85ef85b3"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nt">"datetime"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-02-01T16:47:28Z"</span><span class="w">
|
||||
|
|
@ -6293,6 +6341,8 @@ container.execute("ls", handler=msg_handler)
|
|||
<li>Action</li>
|
||||
</ul>
|
||||
|
||||
<p>This is a <a href="#namespaced-endpoints">namespaced endpoint</a>.</p>
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<table><thead>
|
||||
|
|
@ -6446,7 +6496,7 @@ container.execute("ls", handler=msg_handler)
|
|||
|
||||
<h3 id="http-request">HTTP Request</h3>
|
||||
|
||||
<p><code class="prettyprint">GET /api/audit/v1/events/</code></p>
|
||||
<p><code class="prettyprint">GET /api/audit/v1/[optional_namespace/]events/</code></p>
|
||||
|
||||
<h1 id="errors">Errors</h1>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,17 +2,9 @@
|
|||
description: Learn how to use DTR APIs.
|
||||
keywords:
|
||||
- docker, registry, DTR, APIs
|
||||
menu:
|
||||
main:
|
||||
identifier: dtr_api_overview
|
||||
parent: smn_dtrapi
|
||||
weight: 0
|
||||
title: Overview
|
||||
type: _default
|
||||
title: API overview
|
||||
---
|
||||
|
||||
# API Overview
|
||||
|
||||
Docker Trusted Registry has an experimental API that you can use to manage
|
||||
DTR repositories, permissions, and settings.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,17 +1,10 @@
|
|||
---
|
||||
advisory: experimental
|
||||
description: Description of Docker and Compose's experimental support for application
|
||||
bundles
|
||||
keywords:
|
||||
- documentation, docs, docker, compose, bundles, stacks
|
||||
menu:
|
||||
main:
|
||||
parent: workw_compose
|
||||
title: Docker Stacks and Distributed Application Bundles
|
||||
description: Description of Docker and Compose's experimental support for application bundles
|
||||
keywords: documentation, docs, docker, compose, bundles, stacks
|
||||
title: Docker stacks and distributed application bundles (experimental)
|
||||
---
|
||||
|
||||
# Docker Stacks and Distributed Application Bundles (experimental)
|
||||
|
||||
> **Note**: This is a copy of the [Docker Stacks and Distributed Application
|
||||
> Bundles](https://github.com/docker/docker/blob/v1.12.0-rc4/experimental/docker-stacks-and-bundles.md)
|
||||
> document in the [docker/docker repo](https://github.com/docker/docker).
|
||||
|
|
@ -206,4 +199,4 @@ A service has the following fields:
|
|||
</dl>
|
||||
|
||||
> **Note:** Some configuration options are not yet supported in the DAB format,
|
||||
> including volume mounts.
|
||||
> including volume mounts.
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Compose CLI reference
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, reference
|
||||
menu:
|
||||
main:
|
||||
parent: workw_compose
|
||||
weight: 88
|
||||
title: Command-line Completion
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, reference
|
||||
title: Command-line completion
|
||||
---
|
||||
|
||||
# Command-line Completion
|
||||
|
||||
Compose comes with [command completion](http://en.wikipedia.org/wiki/Command-line_completion)
|
||||
for the bash and zsh shell.
|
||||
|
||||
|
|
@ -65,4 +58,4 @@ Enjoy working with Compose faster and with less typos!
|
|||
- [Get started with Rails](rails.md)
|
||||
- [Get started with WordPress](wordpress.md)
|
||||
- [Command line reference](./reference/index.md)
|
||||
- [Compose file reference](compose-file.md)
|
||||
- [Compose file reference](compose-file.md)
|
||||
|
|
@ -1,18 +1,11 @@
|
|||
---
|
||||
aliases:
|
||||
- /compose/yml
|
||||
description: Compose file reference
|
||||
keywords:
|
||||
- fig, composition, compose, docker
|
||||
menu:
|
||||
main:
|
||||
parent: workw_compose
|
||||
weight: 70
|
||||
title: Compose File Reference
|
||||
keywords: fig, composition, compose, docker
|
||||
redirect_from:
|
||||
- /compose/yml
|
||||
title: Compose file reference
|
||||
---
|
||||
|
||||
# Compose file reference
|
||||
|
||||
The Compose file is a [YAML](http://yaml.org/) file defining
|
||||
[services](compose-file.md#service-configuration-reference),
|
||||
[networks](compose-file.md#network-configuration-reference) and
|
||||
|
|
@ -1316,4 +1309,4 @@ If you forget and use a single dollar sign (`$`), Compose interprets the value a
|
|||
- [Get started with Django](django.md)
|
||||
- [Get started with Rails](rails.md)
|
||||
- [Get started with WordPress](wordpress.md)
|
||||
- [Command line reference](./reference/index.md)
|
||||
- [Command line reference](./reference/index.md)
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Getting started with Docker Compose and Django
|
||||
keywords:
|
||||
- documentation, docs, docker, compose, orchestration, containers
|
||||
menu:
|
||||
main:
|
||||
parent: workw_compose
|
||||
weight: 4
|
||||
title: 'Quickstart: Compose and Django'
|
||||
keywords: documentation, docs, docker, compose, orchestration, containers
|
||||
title: "Quickstart: Compose and Django"
|
||||
---
|
||||
|
||||
# Quickstart: Docker Compose and Django
|
||||
|
||||
This quick-start guide demonstrates how to use Docker Compose to set up and run a simple Django/PostgreSQL app. Before starting, you'll need to have
|
||||
[Compose installed](install.md).
|
||||
|
||||
|
|
@ -96,7 +89,7 @@ In this step, you create a Django started project by building the image from the
|
|||
|
||||
2. Create the Django project using the `docker-compose` command.
|
||||
|
||||
$ docker-compose run web django-admin.py startproject composeexample .
|
||||
docker-compose run web django-admin.py startproject composeexample .
|
||||
|
||||
This instructs Compose to run `django-admin.py startproject composeeexample`
|
||||
in a container, using the `web` service's image and configuration. Because
|
||||
|
|
@ -190,4 +183,4 @@ In this section, you set up the database connection for Django.
|
|||
- [Get started with Rails](rails.md)
|
||||
- [Get started with WordPress](wordpress.md)
|
||||
- [Command line reference](./reference/index.md)
|
||||
- [Compose file reference](compose-file.md)
|
||||
- [Compose file reference](compose-file.md)
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Declaring default environment variables in file
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, environment, env file
|
||||
menu:
|
||||
main:
|
||||
parent: workw_compose
|
||||
weight: 10
|
||||
title: Environment file
|
||||
description: Declare default environment variables in a file
|
||||
keywords: fig, composition, compose, docker, orchestration, environment, env file
|
||||
title: Declare default environment variables in file
|
||||
---
|
||||
|
||||
# Environment file
|
||||
|
||||
Compose supports declaring default environment variables in an environment
|
||||
file named `.env` placed in the folder `docker-compose` command is executed from
|
||||
*(current working directory)*.
|
||||
|
|
@ -41,4 +34,4 @@ file, but can also be used to define the following
|
|||
|
||||
- [User guide](index.md)
|
||||
- [Command line reference](./reference/index.md)
|
||||
- [Compose file reference](compose-file.md)
|
||||
- [Compose file reference](compose-file.md)
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: How to set, use and manage environment variables in Compose
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, environment, variables, env file
|
||||
menu:
|
||||
main:
|
||||
parent: workw_compose
|
||||
weight: 10
|
||||
keywords: fig, composition, compose, docker, orchestration, environment, variables, env file
|
||||
title: Environment variables in Compose
|
||||
---
|
||||
|
||||
# Environment variables in Compose
|
||||
|
||||
There are multiple parts of Compose that deal with environment variables in one sense or another. This page should help you find the information you need.
|
||||
|
||||
|
||||
|
|
@ -57,11 +50,11 @@ You can pass multiple environment variables from an external file through to a s
|
|||
|
||||
Just like with `docker run -e`, you can set environment variables on a one-off container with `docker-compose run -e`:
|
||||
|
||||
$ docker-compose run -e DEBUG=1 web python console.py
|
||||
docker-compose run -e DEBUG=1 web python console.py
|
||||
|
||||
You can also pass a variable through from the shell by not giving it a value:
|
||||
|
||||
$ docker-compose run -e DEBUG web python console.py
|
||||
docker-compose run -e DEBUG web python console.py
|
||||
|
||||
The value of the `DEBUG` variable in the container will be taken from the value for the same variable in the shell in which Compose is run.
|
||||
|
||||
|
|
@ -90,7 +83,6 @@ When you run `docker-compose up`, the `web` service defined above uses the image
|
|||
Values in the shell take precedence over those specified in the `.env` file. If you set `TAG` to a different value in your shell, the substitution in `image` uses that instead:
|
||||
|
||||
$ export TAG=v2.0
|
||||
|
||||
$ docker-compose config
|
||||
version: '2.0'
|
||||
services:
|
||||
|
|
@ -101,7 +93,6 @@ Values in the shell take precedence over those specified in the `.env` file. If
|
|||
|
||||
Several environment variables are available for you to configure the Docker Compose command-line behaviour. They begin with `COMPOSE_` or `DOCKER_`, and are documented in [CLI Environment Variables](reference/envvars.md).
|
||||
|
||||
|
||||
## Environment variables created by links
|
||||
|
||||
When using the ['links' option](compose-file.md#links) in a [v1 Compose file](compose-file.md#version-1), environment variables will be created for each link. They are documented in the [Link environment variables reference](link-env-deprecated.md). Please note, however, that these variables are deprecated - you should just use the link alias as a hostname instead.
|
||||
When using the ['links' option](compose-file.md#links) in a [v1 Compose file](compose-file.md#version-1), environment variables will be created for each link. They are documented in the [Link environment variables reference](link-env-deprecated.md). Please note, however, that these variables are deprecated - you should just use the link alias as a hostname instead.
|
||||
|
|
@ -1,17 +1,9 @@
|
|||
---
|
||||
description: How to use Docker Compose's extends keyword to share configuration between
|
||||
files and projects
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, documentation, docs
|
||||
menu:
|
||||
main:
|
||||
parent: workw_compose
|
||||
weight: 20
|
||||
title: Extending Services in Compose
|
||||
description: How to use Docker Compose's extends keyword to share configuration between files and projects
|
||||
keywords: fig, composition, compose, docker, orchestration, documentation, docs
|
||||
title: Share Compose configurations between files and projects
|
||||
---
|
||||
|
||||
# Extending services and Compose files
|
||||
|
||||
Compose supports two methods of sharing common configuration:
|
||||
|
||||
1. Extending an entire Compose file by
|
||||
|
|
@ -351,4 +343,4 @@ In the case of `environment`, `labels`, `volumes` and `devices`, Compose
|
|||
- [Get started with Rails](rails.md)
|
||||
- [Get started with WordPress](wordpress.md)
|
||||
- [Command line reference](./reference/index.md)
|
||||
- [Compose file reference](compose-file.md)
|
||||
- [Compose file reference](compose-file.md)
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Docker Compose FAQ
|
||||
keywords: documentation, docs, docker, compose, faq
|
||||
menu:
|
||||
main:
|
||||
identifier: faq.compose
|
||||
parent: workw_compose
|
||||
weight: 90
|
||||
title: Frequently Asked Questions
|
||||
title: Frequently asked questions
|
||||
---
|
||||
|
||||
# Frequently asked questions
|
||||
|
||||
If you don’t see your question here, feel free to drop by `#docker-compose` on
|
||||
freenode IRC and ask the community.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Getting started with Docker Compose
|
||||
keywords:
|
||||
- documentation, docs, docker, compose, orchestration, containers
|
||||
menu:
|
||||
main:
|
||||
parent: workw_compose
|
||||
weight: -85
|
||||
title: Getting Started
|
||||
description: Get started with Docker Compose
|
||||
keywords: documentation, docs, docker, compose, orchestration, containers
|
||||
title: Get started with Docker Compose
|
||||
---
|
||||
|
||||
# Getting Started
|
||||
|
||||
On this page you build a simple Python web application running on Docker Compose. The
|
||||
application uses the Flask framework and increments a value in Redis. While the
|
||||
sample uses Python, the concepts demonstrated here should be understandable even
|
||||
|
|
@ -115,7 +108,23 @@ This Compose file defines two services, `web` and `redis`. The web service:
|
|||
* Mounts the project directory on the host to `/code` inside the container allowing you to modify the code without having to rebuild the image.
|
||||
* Links the web service to the Redis service.
|
||||
|
||||
The `redis` service uses the latest public [Redis](https://registry.hub.docker.com/_/redis/) image pulled from the Docker Hub registry.
|
||||
The `redis` service uses the latest public
|
||||
[Redis](https://registry.hub.docker.com/_/redis/) image pulled from the Docker
|
||||
Hub registry.
|
||||
|
||||
>**Tip:** If your project is outside of the `Users` directory (`cd ~`), then you
|
||||
need to share the drive or location of the Dockerfile and volume you are using.
|
||||
If you get runtime errors indicating an application file is not found, a volume
|
||||
mount is denied, or a service cannot start, try enabling file or drive sharing.
|
||||
Volume mounting requires shared drives for projects that live outside of
|
||||
`C:\Users` (Windows) or `/Users` (Mac), and is required for _any_ project on
|
||||
Docker for Windows that uses [Linux
|
||||
containers](/docker-for-windows/index.md#switch-between-windows-and-linux-containers-beta-feature).
|
||||
For more information, see [Shared
|
||||
Drives](../docker-for-windows/index.md#shared-drives) on Docker for Windows,
|
||||
[File sharing](../docker-for-mac/index.md#file-sharing) on Docker for Mac, and
|
||||
the general examples on how to [Manage data in
|
||||
containers](../engine/tutorials/dockervolumes.md).
|
||||
|
||||
## Step 4: Build and run your app with Compose
|
||||
|
||||
|
|
@ -170,14 +179,14 @@ The `docker-compose run` command allows you to run one-off commands for your
|
|||
services. For example, to see what environment variables are available to the
|
||||
`web` service:
|
||||
|
||||
$ docker-compose run web env
|
||||
docker-compose run web env
|
||||
|
||||
See `docker-compose --help` to see other available commands. You can also install [command completion](completion.md) for the bash and zsh shell, which will also show you available commands.
|
||||
|
||||
If you started Compose with `docker-compose up -d`, you'll probably want to stop
|
||||
your services once you've finished with them:
|
||||
|
||||
$ docker-compose stop
|
||||
docker-compose stop
|
||||
|
||||
At this point, you have seen the basics of how Compose works.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Introduction and Overview of Compose
|
||||
keywords:
|
||||
- documentation, docs, docker, compose, orchestration, containers
|
||||
menu:
|
||||
main:
|
||||
identifier: workw_compose
|
||||
weight: -70
|
||||
keywords: documentation, docs, docker, compose, orchestration, containers
|
||||
title: Docker Compose
|
||||
---
|
||||
|
||||
# Docker Compose
|
||||
|
||||
Compose is a tool for defining and running multi-container Docker applications. To learn more about Compose refer to the following documentation:
|
||||
|
||||
- [Compose Overview](overview.md)
|
||||
|
|
@ -26,4 +19,4 @@ Compose is a tool for defining and running multi-container Docker applications.
|
|||
|
||||
To see a detailed list of changes for past and current releases of Docker
|
||||
Compose, please refer to the
|
||||
[CHANGELOG](https://github.com/docker/compose/blob/master/CHANGELOG.md).
|
||||
[CHANGELOG](https://github.com/docker/compose/blob/master/CHANGELOG.md).
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: How to install Docker Compose
|
||||
keywords:
|
||||
- compose, orchestration, install, installation, docker, documentation
|
||||
menu:
|
||||
main:
|
||||
parent: workw_compose
|
||||
weight: -90
|
||||
title: Install Compose
|
||||
keywords: compose, orchestration, install, installation, docker, documentation
|
||||
title: Install Docker Compose
|
||||
---
|
||||
|
||||
# Install Docker Compose
|
||||
|
||||
You can run Compose on macOS, Windows and 64-bit Linux. To install it, you'll need to install Docker first.
|
||||
|
||||
To install Compose, do the following:
|
||||
|
|
@ -38,14 +31,14 @@ which the release page specifies, in your terminal.
|
|||
|
||||
The following is an example command illustrating the format:
|
||||
|
||||
curl -L "https://github.com/docker/compose/releases/download/1.8.1/docker-compose-$(uname -s)-$(uname -m)" > /usr/local/bin/docker-compose
|
||||
$ curl -L "https://github.com/docker/compose/releases/download/1.8.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
|
||||
|
||||
If you have problems installing with `curl`, see
|
||||
[Alternative Install Options](install.md#alternative-install-options).
|
||||
|
||||
5. Apply executable permissions to the binary:
|
||||
|
||||
$ chmod +x /usr/local/bin/docker-compose
|
||||
chmod +x /usr/local/bin/docker-compose
|
||||
|
||||
6. Optionally, install [command completion](completion.md) for the
|
||||
`bash` and `zsh` shell.
|
||||
|
|
@ -67,7 +60,7 @@ have python system packages that conflict with docker-compose dependencies. See
|
|||
the [virtualenv tutorial](http://docs.python-guide.org/en/latest/dev/virtualenvs/)
|
||||
to get started.
|
||||
|
||||
$ pip install docker-compose
|
||||
pip install docker-compose
|
||||
|
||||
> **Note:** pip version 6.0 or greater is required
|
||||
|
||||
|
|
@ -99,24 +92,22 @@ to run so that you don't end up with two sets of them. If you want to keep using
|
|||
your existing containers (for example, because they have data volumes you want
|
||||
to preserve) you can use compose 1.5.x to migrate them with the following command:
|
||||
|
||||
$ docker-compose migrate-to-labels
|
||||
docker-compose migrate-to-labels
|
||||
|
||||
Alternatively, if you're not worried about keeping them, you can remove them.
|
||||
Compose will just create new ones.
|
||||
|
||||
$ docker rm -f -v myapp_web_1 myapp_db_1 ...
|
||||
|
||||
docker rm -f -v myapp_web_1 myapp_db_1 ...
|
||||
|
||||
## Uninstallation
|
||||
|
||||
To uninstall Docker Compose if you installed using `curl`:
|
||||
|
||||
$ rm /usr/local/bin/docker-compose
|
||||
|
||||
rm /usr/local/bin/docker-compose
|
||||
|
||||
To uninstall Docker Compose if you installed using `pip`:
|
||||
|
||||
$ pip uninstall docker-compose
|
||||
pip uninstall docker-compose
|
||||
|
||||
>**Note**: If you get a "Permission denied" error using either of the above
|
||||
>methods, you probably do not have the proper permissions to remove
|
||||
|
|
|
|||
|
|
@ -1,18 +1,11 @@
|
|||
---
|
||||
aliases:
|
||||
- /compose/env
|
||||
description: Compose CLI reference
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, reference
|
||||
menu:
|
||||
main:
|
||||
parent: workw_compose
|
||||
weight: 89
|
||||
title: Link Environment Variables
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, reference
|
||||
redirect_from:
|
||||
- /compose/env
|
||||
title: Link environment variables (superseded)
|
||||
---
|
||||
|
||||
# Link environment variables reference
|
||||
|
||||
> **Note:** Environment variables are no longer the recommended method for connecting to linked services. Instead, you should use the link name (by default, the name of the linked service) as the hostname to connect to. See the [docker-compose.yml documentation](compose-file.md#links) for details.
|
||||
>
|
||||
> Environment variables will only be populated if you're using the [legacy version 1 Compose file format](compose-file.md#versioning).
|
||||
|
|
@ -46,4 +39,4 @@ Fully qualified container name, e.g. `DB_1_NAME=/myapp_web_1/myapp_db_1`
|
|||
- [User guide](index.md)
|
||||
- [Installing Compose](install.md)
|
||||
- [Command line reference](./reference/index.md)
|
||||
- [Compose file reference](compose-file.md)
|
||||
- [Compose file reference](compose-file.md)
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: How Compose sets up networking between containers
|
||||
keywords:
|
||||
- documentation, docs, docker, compose, orchestration, containers, networking
|
||||
menu:
|
||||
main:
|
||||
parent: workw_compose
|
||||
weight: 21
|
||||
keywords: documentation, docs, docker, compose, orchestration, containers, networking
|
||||
title: Networking in Compose
|
||||
---
|
||||
|
||||
# Networking in Compose
|
||||
|
||||
> **Note:** This document only applies if you're using [version 2 of the Compose file format](compose-file.md#versioning). Networking features are not supported for version 1 (legacy) Compose files.
|
||||
|
||||
By default Compose sets up a single
|
||||
|
|
@ -150,4 +143,4 @@ If you want your containers to join a pre-existing network, use the [`external`
|
|||
external:
|
||||
name: my-pre-existing-network
|
||||
|
||||
Instead of attempting to create a network called `[projectname]_default`, Compose will look for a network called `my-pre-existing-network` and connect your app's containers to it.
|
||||
Instead of attempting to create a network called `[projectname]_default`, Compose will look for a network called `my-pre-existing-network` and connect your app's containers to it.
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Introduction and Overview of Compose
|
||||
keywords:
|
||||
- documentation, docs, docker, compose, orchestration, containers
|
||||
menu:
|
||||
main:
|
||||
parent: workw_compose
|
||||
weight: -99
|
||||
keywords: documentation, docs, docker, compose, orchestration, containers
|
||||
title: Overview of Docker Compose
|
||||
---
|
||||
|
||||
# Overview of Docker Compose
|
||||
|
||||
Compose is a tool for defining and running multi-container Docker applications.
|
||||
With Compose, you use a Compose file to configure your application's services.
|
||||
Then, using a single command, you create and start all the services
|
||||
|
|
@ -184,4 +177,4 @@ individuals, we have a number of open channels for communication.
|
|||
|
||||
* To contribute code or documentation changes: please submit a [pull request on Github](https://github.com/docker/compose/pulls).
|
||||
|
||||
For more information and resources, please visit the [Getting Help project page](/opensource/get-help/).
|
||||
For more information and resources, please visit the [Getting Help project page](/opensource/get-help/).
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Guide to using Docker Compose in production
|
||||
keywords:
|
||||
- documentation, docs, docker, compose, orchestration, containers, production
|
||||
menu:
|
||||
main:
|
||||
parent: workw_compose
|
||||
weight: 22
|
||||
title: Using Compose in Production
|
||||
keywords: documentation, docs, docker, compose, orchestration, containers, production
|
||||
title: Using Compose in production
|
||||
---
|
||||
|
||||
## Using Compose in production
|
||||
|
||||
When you define your app with Compose in development, you can use this
|
||||
definition to run your application in different environments such as CI,
|
||||
staging, and production.
|
||||
|
|
@ -41,7 +34,7 @@ can be applied over the original `docker-compose.yml` to create a new configurat
|
|||
Once you've got a second configuration file, tell Compose to use it with the
|
||||
`-f` option:
|
||||
|
||||
$ docker-compose -f docker-compose.yml -f production.yml up -d
|
||||
docker-compose -f docker-compose.yml -f production.yml up -d
|
||||
|
||||
See [Using multiple compose files](extends.md#different-environments) for a more
|
||||
complete example.
|
||||
|
|
@ -84,4 +77,4 @@ Read more about the Compose/Swarm integration in the
|
|||
|
||||
- [Installing Compose](install.md)
|
||||
- [Command line reference](./reference/index.md)
|
||||
- [Compose file reference](compose-file.md)
|
||||
- [Compose file reference](compose-file.md)
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Getting started with Docker Compose and Rails
|
||||
keywords:
|
||||
- documentation, docs, docker, compose, orchestration, containers
|
||||
menu:
|
||||
main:
|
||||
parent: workw_compose
|
||||
weight: 5
|
||||
title: 'Quickstart: Compose and Rails'
|
||||
keywords: documentation, docs, docker, compose, orchestration, containers
|
||||
title: "Quickstart: Compose and Rails"
|
||||
---
|
||||
|
||||
## Quickstart: Docker Compose and Rails
|
||||
|
||||
This Quickstart guide will show you how to use Docker Compose to set up and run a Rails/PostgreSQL app. Before starting, you'll need to have [Compose installed](install.md).
|
||||
|
||||
### Define the project
|
||||
|
|
@ -41,7 +34,7 @@ Next, create a bootstrap `Gemfile` which just loads Rails. It'll be overwritten
|
|||
|
||||
You'll need an empty `Gemfile.lock` in order to build our `Dockerfile`.
|
||||
|
||||
$ touch Gemfile.lock
|
||||
touch Gemfile.lock
|
||||
|
||||
Finally, `docker-compose.yml` is where the magic happens. This file describes
|
||||
the services that comprise your app (a database and a web app), how to get each
|
||||
|
|
@ -68,7 +61,7 @@ to link them together and expose the web app's port.
|
|||
With those three files in place, you can now generate the Rails skeleton app
|
||||
using `docker-compose run`:
|
||||
|
||||
$ docker-compose run web rails new . --force --database=postgresql --skip-bundle
|
||||
docker-compose run web rails new . --force --database=postgresql --skip-bundle
|
||||
|
||||
First, Compose will build the image for the `web` service using the `Dockerfile`. Then it'll run `rails new` inside a new container, using that image. Once it's done, you should have generated a fresh app:
|
||||
|
||||
|
|
@ -112,8 +105,7 @@ Now that you've got a new `Gemfile`, you need to build the image again. (This,
|
|||
and changes to the Dockerfile itself, should be the only times you'll need to
|
||||
rebuild.)
|
||||
|
||||
$ docker-compose build
|
||||
|
||||
docker-compose build
|
||||
|
||||
### Connect the database
|
||||
|
||||
|
|
@ -139,7 +131,7 @@ Replace the contents of `config/database.yml` with the following:
|
|||
|
||||
You can now boot the app with:
|
||||
|
||||
$ docker-compose up
|
||||
docker-compose up
|
||||
|
||||
If all's well, you should see some PostgreSQL output, and then—after a few
|
||||
seconds—the familiar refrain:
|
||||
|
|
@ -150,7 +142,7 @@ seconds—the familiar refrain:
|
|||
|
||||
Finally, you need to create the database. In another terminal, run:
|
||||
|
||||
$ docker-compose run web rake db:create
|
||||
docker-compose run web rake db:create
|
||||
|
||||
That's it. Your app should now be running on port 3000 on your Docker daemon. If you're using [Docker Machine](/machine/overview.md), then `docker-machine ip MACHINE_VM` returns the Docker host IP address.
|
||||
|
||||
|
|
@ -171,4 +163,4 @@ up`.
|
|||
- [Get started with Django](django.md)
|
||||
- [Get started with WordPress](wordpress.md)
|
||||
- [Command line reference](./reference/index.md)
|
||||
- [Compose file reference](compose-file.md)
|
||||
- [Compose file reference](compose-file.md)
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: build
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, build
|
||||
menu:
|
||||
main:
|
||||
identifier: build.compose
|
||||
parent: smn_compose_cli
|
||||
title: build
|
||||
description: docker-compose build
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, build
|
||||
title: docker-compose build
|
||||
---
|
||||
|
||||
# build
|
||||
|
||||
```
|
||||
Usage: build [options] [SERVICE...]
|
||||
|
||||
|
|
@ -22,4 +15,4 @@ Options:
|
|||
|
||||
Services are built once and then tagged as `project_service`, e.g.,
|
||||
`composetest_db`. If you change a service's Dockerfile or the contents of its
|
||||
build directory, run `docker-compose build` to rebuild it.
|
||||
build directory, run `docker-compose build` to rebuild it.
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Create a distributed application bundle from the Compose file.
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, bundle
|
||||
menu:
|
||||
main:
|
||||
identifier: bundle.compose
|
||||
parent: smn_compose_cli
|
||||
title: bundle
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, bundle
|
||||
title: docker-compose bundle
|
||||
---
|
||||
|
||||
# bundle
|
||||
|
||||
```
|
||||
Usage: bundle [options]
|
||||
|
||||
|
|
@ -28,4 +21,4 @@ Images must have digests stored, which requires interaction with a
|
|||
Docker registry. If digests aren't stored for all images, you can fetch
|
||||
them with `docker-compose pull` or `docker-compose push`. To push images
|
||||
automatically when bundling, pass `--push-images`. Only services with
|
||||
a `build` option specified will have their images pushed.
|
||||
a `build` option specified will have their images pushed.
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Config validates and view the compose file.
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, config
|
||||
menu:
|
||||
main:
|
||||
identifier: config.compose
|
||||
parent: smn_compose_cli
|
||||
title: config
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, config
|
||||
title: docker-compose config
|
||||
---
|
||||
|
||||
# config
|
||||
|
||||
```:
|
||||
Usage: config [options]
|
||||
|
||||
|
|
@ -20,4 +13,4 @@ Options:
|
|||
--services Print the service names, one per line.
|
||||
```
|
||||
|
||||
Validate and view the compose file.
|
||||
Validate and view the compose file.
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Create creates containers for a service.
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, create
|
||||
menu:
|
||||
main:
|
||||
identifier: create.compose
|
||||
parent: smn_compose_cli
|
||||
title: create
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, create
|
||||
title: docker-compose create
|
||||
---
|
||||
|
||||
# create
|
||||
|
||||
```
|
||||
Creates containers for a service.
|
||||
|
||||
|
|
@ -23,4 +16,4 @@ Options:
|
|||
Incompatible with --force-recreate.
|
||||
--no-build Don't build an image, even if it's missing.
|
||||
--build Build images before creating containers.
|
||||
```
|
||||
```
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: down
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, down
|
||||
menu:
|
||||
main:
|
||||
identifier: down.compose
|
||||
parent: smn_compose_cli
|
||||
title: down
|
||||
description: docker-compose down
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, down
|
||||
title: docker-compose down
|
||||
---
|
||||
|
||||
# down
|
||||
|
||||
```
|
||||
Usage: down [options]
|
||||
|
||||
|
|
@ -35,4 +28,4 @@ By default, the only things removed are:
|
|||
- Networks defined in the `networks` section of the Compose file
|
||||
- The default network, if one is used
|
||||
|
||||
Networks and volumes defined as `external` are never removed.
|
||||
Networks and volumes defined as `external` are never removed.
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: CLI Environment Variables
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, reference
|
||||
menu:
|
||||
main:
|
||||
parent: smn_compose_cli
|
||||
weight: -1
|
||||
title: CLI Environment Variables
|
||||
description: Compose CLI environment variables
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, reference
|
||||
title: Compose CLI environment variables
|
||||
---
|
||||
|
||||
# CLI Environment Variables
|
||||
|
||||
Several environment variables are available for you to configure the Docker Compose command-line behaviour.
|
||||
|
||||
Variables starting with `DOCKER_` are the same as those used to configure the
|
||||
|
|
@ -94,4 +87,4 @@ Users of Docker Machine and Docker Toolbox on Windows should always set this.
|
|||
- [User guide](../index.md)
|
||||
- [Installing Compose](../install.md)
|
||||
- [Compose file reference](../compose-file.md)
|
||||
- [Environment file](../env-file.md)
|
||||
- [Environment file](../env-file.md)
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Receive real time events from containers.
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, events
|
||||
menu:
|
||||
main:
|
||||
identifier: events.compose
|
||||
parent: smn_compose_cli
|
||||
title: events
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, events
|
||||
title: docker-compose events
|
||||
---
|
||||
|
||||
# events
|
||||
|
||||
```
|
||||
Usage: events [options] [SERVICE...]
|
||||
|
||||
|
|
@ -31,4 +24,4 @@ format:
|
|||
"image": "alpine:edge",
|
||||
"time": "2015-11-20T18:01:03.615550",
|
||||
}
|
||||
```
|
||||
```
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: exec
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, exec
|
||||
menu:
|
||||
main:
|
||||
identifier: exec.compose
|
||||
parent: smn_compose_cli
|
||||
title: exec
|
||||
description: docker-compose exec
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, exec
|
||||
title: docker-compose exec
|
||||
---
|
||||
|
||||
# exec
|
||||
|
||||
```
|
||||
Usage: exec [options] SERVICE COMMAND [ARGS...]
|
||||
|
||||
|
|
@ -26,4 +19,4 @@ Options:
|
|||
|
||||
This is equivalent of `docker exec`. With this subcommand you can run arbitrary
|
||||
commands in your services. Commands are by default allocating a TTY, so you can
|
||||
do e.g. `docker-compose exec web sh` to get an interactive prompt.
|
||||
do e.g. `docker-compose exec web sh` to get an interactive prompt.
|
||||
|
|
@ -1,18 +1,11 @@
|
|||
---
|
||||
description: help
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, help
|
||||
menu:
|
||||
main:
|
||||
identifier: help.compose
|
||||
parent: smn_compose_cli
|
||||
title: help
|
||||
description: docker-compose help
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, help
|
||||
title: docker-compose help
|
||||
---
|
||||
|
||||
# help
|
||||
|
||||
```
|
||||
Usage: help COMMAND
|
||||
```
|
||||
|
||||
Displays help and usage instructions for a command.
|
||||
Displays help and usage instructions for a command.
|
||||
|
|
@ -1,17 +1,9 @@
|
|||
---
|
||||
description: Compose CLI reference
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, reference
|
||||
menu:
|
||||
main:
|
||||
identifier: smn_compose_cli
|
||||
parent: workw_compose
|
||||
weight: 80
|
||||
title: Command-line Reference
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, reference
|
||||
title: Compose command-line reference
|
||||
---
|
||||
|
||||
## Compose command-line reference
|
||||
|
||||
The following pages describe the usage information for the [docker-compose](overview.md) subcommands. You can also see this information by running `docker-compose [SUBCOMMAND] --help` from the command line.
|
||||
|
||||
* [docker-compose](overview.md)
|
||||
|
|
@ -39,4 +31,4 @@ The following pages describe the usage information for the [docker-compose](over
|
|||
## Where to go next
|
||||
|
||||
* [CLI environment variables](envvars.md)
|
||||
* [docker-compose Command](overview.md)
|
||||
* [docker-compose Command](overview.md)
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Forces running containers to stop.
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, kill
|
||||
menu:
|
||||
main:
|
||||
identifier: kill.compose
|
||||
parent: smn_compose_cli
|
||||
title: kill
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, kill
|
||||
title: docker-compose kill
|
||||
---
|
||||
|
||||
# kill
|
||||
|
||||
```
|
||||
Usage: kill [options] [SERVICE...]
|
||||
|
||||
|
|
@ -21,4 +14,4 @@ Options:
|
|||
Forces running containers to stop by sending a `SIGKILL` signal. Optionally the
|
||||
signal can be passed, for example:
|
||||
|
||||
$ docker-compose kill -s SIGINT
|
||||
docker-compose kill -s SIGINT
|
||||
|
|
|
|||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Displays log output from services.
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, logs
|
||||
menu:
|
||||
main:
|
||||
identifier: logs.compose
|
||||
parent: smn_compose_cli
|
||||
title: logs
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, logs
|
||||
title: docker-compose logs
|
||||
---
|
||||
|
||||
# logs
|
||||
|
||||
```
|
||||
Usage: logs [options] [SERVICE...]
|
||||
|
||||
|
|
@ -22,4 +15,4 @@ Options:
|
|||
for each container.
|
||||
```
|
||||
|
||||
Displays log output from services.
|
||||
Displays log output from services.
|
||||
|
|
@ -1,18 +1,11 @@
|
|||
---
|
||||
aliases:
|
||||
- /compose/reference/docker-compose/
|
||||
description: Overview of docker-compose CLI
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, docker-compose
|
||||
menu:
|
||||
main:
|
||||
parent: smn_compose_cli
|
||||
weight: -2
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, docker-compose
|
||||
redirect_from:
|
||||
- /compose/reference/docker-compose/
|
||||
title: Overview of docker-compose CLI
|
||||
---
|
||||
|
||||
# Overview of docker-compose CLI
|
||||
|
||||
This page provides the usage information for the `docker-compose` Command.
|
||||
You can also see this information by running `docker-compose --help` from the
|
||||
command line.
|
||||
|
|
@ -124,4 +117,4 @@ envvars.md#compose-project-name)
|
|||
|
||||
## Where to go next
|
||||
|
||||
* [CLI environment variables](envvars.md)
|
||||
* [CLI environment variables](envvars.md)
|
||||
|
|
@ -1,18 +1,11 @@
|
|||
---
|
||||
description: Pauses running containers for a service.
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, pause
|
||||
menu:
|
||||
main:
|
||||
identifier: pause.compose
|
||||
parent: smn_compose_cli
|
||||
title: pause
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, pause
|
||||
title: docker-compose pause
|
||||
---
|
||||
|
||||
# pause
|
||||
|
||||
```
|
||||
Usage: pause [SERVICE...]
|
||||
```
|
||||
|
||||
Pauses running containers of a service. They can be unpaused with `docker-compose unpause`.
|
||||
Pauses running containers of a service. They can be unpaused with `docker-compose unpause`.
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Prints the public port for a port binding.s
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, port
|
||||
menu:
|
||||
main:
|
||||
identifier: port.compose
|
||||
parent: smn_compose_cli
|
||||
title: port
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, port
|
||||
title: docker-compose port
|
||||
---
|
||||
|
||||
# port
|
||||
|
||||
```
|
||||
Usage: port [options] SERVICE PRIVATE_PORT
|
||||
|
||||
|
|
@ -20,4 +13,4 @@ Options:
|
|||
instances of a service [default: 1]
|
||||
```
|
||||
|
||||
Prints the public port for a port binding.
|
||||
Prints the public port for a port binding.
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Lists containers.
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, ps
|
||||
menu:
|
||||
main:
|
||||
identifier: ps.compose
|
||||
parent: smn_compose_cli
|
||||
title: ps
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, ps
|
||||
title: docker-compose ps
|
||||
---
|
||||
|
||||
# ps
|
||||
|
||||
```none
|
||||
Usage: ps [options] [SERVICE...]
|
||||
|
||||
|
|
@ -22,8 +15,8 @@ Lists containers.
|
|||
|
||||
```bash
|
||||
$ docker-compose ps
|
||||
Name Command State Ports
|
||||
Name Command State Ports
|
||||
--------------------------------------------------------------------------------------------
|
||||
mywordpress_db_1 docker-entrypoint.sh mysqld Up 3306/tcp
|
||||
mywordpress_db_1 docker-entrypoint.sh mysqld Up 3306/tcp
|
||||
mywordpress_wordpress_1 /entrypoint.sh apache2-for ... Restarting 0.0.0.0:8000->80/tcp
|
||||
```
|
||||
```
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Pulls service images.
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, pull
|
||||
menu:
|
||||
main:
|
||||
identifier: pull.compose
|
||||
parent: smn_compose_cli
|
||||
title: pull
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, pull
|
||||
title: docker-compose pull
|
||||
---
|
||||
|
||||
# pull
|
||||
|
||||
```
|
||||
Usage: pull [options] [SERVICE...]
|
||||
|
||||
|
|
@ -18,4 +11,4 @@ Options:
|
|||
--ignore-pull-failures Pull what it can and ignores images with pull failures.
|
||||
```
|
||||
|
||||
Pulls service images.
|
||||
Pulls service images.
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Pushes service images.
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, push
|
||||
menu:
|
||||
main:
|
||||
identifier: push.compose
|
||||
parent: smn_compose_cli
|
||||
title: push
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, push
|
||||
title: docker-compose push
|
||||
---
|
||||
|
||||
# push
|
||||
|
||||
```
|
||||
Usage: push [options] [SERVICE...]
|
||||
|
||||
|
|
@ -18,4 +11,4 @@ Options:
|
|||
--ignore-push-failures Push what it can and ignores images with push failures.
|
||||
```
|
||||
|
||||
Pushes images for services.
|
||||
Pushes images for services.
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Restarts Docker Compose services.
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, restart
|
||||
menu:
|
||||
main:
|
||||
identifier: restart.compose
|
||||
parent: smn_compose_cli
|
||||
title: restart
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, restart
|
||||
title: docker-compose restart
|
||||
---
|
||||
|
||||
# restart
|
||||
|
||||
```
|
||||
Usage: restart [options] [SERVICE...]
|
||||
|
||||
|
|
@ -18,4 +11,4 @@ Options:
|
|||
-t, --timeout TIMEOUT Specify a shutdown timeout in seconds. (default: 10)
|
||||
```
|
||||
|
||||
Restarts services.
|
||||
Restarts services.
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Removes stopped service containers.
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, rm
|
||||
menu:
|
||||
main:
|
||||
identifier: rm.compose
|
||||
parent: smn_compose_cli
|
||||
title: rm
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, rm
|
||||
title: docker-compose rm
|
||||
---
|
||||
|
||||
# rm
|
||||
|
||||
```
|
||||
Usage: rm [options] [SERVICE...]
|
||||
|
||||
|
|
@ -26,4 +19,4 @@ Removes stopped service containers.
|
|||
By default, anonymous volumes attached to containers will not be removed. You
|
||||
can override this with `-v`. To list all volumes, use `docker volume ls`.
|
||||
|
||||
Any data which is not in a volume will be lost.
|
||||
Any data which is not in a volume will be lost.
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Runs a one-off command on a service.
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, run
|
||||
menu:
|
||||
main:
|
||||
identifier: run.compose
|
||||
parent: smn_compose_cli
|
||||
title: run
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, run
|
||||
title: docker-compose run
|
||||
---
|
||||
|
||||
# run
|
||||
|
||||
```
|
||||
Usage: run [options] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]
|
||||
|
||||
|
|
@ -31,26 +24,26 @@ Options:
|
|||
|
||||
Runs a one-time command against a service. For example, the following command starts the `web` service and runs `bash` as its command.
|
||||
|
||||
$ docker-compose run web bash
|
||||
docker-compose run web bash
|
||||
|
||||
Commands you use with `run` start in new containers with the same configuration as defined by the service' configuration. This means the container has the same volumes, links, as defined in the configuration file. There two differences though.
|
||||
Commands you use with `run` start in new containers with the same configuration as defined by the service' configuration. This means the container has the same volumes, links, as defined in the configuration file. There are two differences though.
|
||||
|
||||
First, the command passed by `run` overrides the command defined in the service configuration. For example, if the `web` service configuration is started with `bash`, then `docker-compose run web python app.py` overrides it with `python app.py`.
|
||||
|
||||
The second difference is the `docker-compose run` command does not create any of the ports specified in the service configuration. This prevents the port collisions with already open ports. If you *do want* the service's ports created and mapped to the host, specify the `--service-ports` flag:
|
||||
|
||||
$ docker-compose run --service-ports web python manage.py shell
|
||||
docker-compose run --service-ports web python manage.py shell
|
||||
|
||||
Alternatively manual port mapping can be specified. Same as when running Docker's `run` command - using `--publish` or `-p` options:
|
||||
|
||||
$ docker-compose run --publish 8080:80 -p 2022:22 -p 127.0.0.1:2021:21 web python manage.py shell
|
||||
docker-compose run --publish 8080:80 -p 2022:22 -p 127.0.0.1:2021:21 web python manage.py shell
|
||||
|
||||
If you start a service configured with links, the `run` command first checks to see if the linked service is running and starts the service if it is stopped. Once all the linked services are running, the `run` executes the command you passed it. So, for example, you could run:
|
||||
|
||||
$ docker-compose run db psql -h db -U docker
|
||||
docker-compose run db psql -h db -U docker
|
||||
|
||||
This would open up an interactive PostgreSQL shell for the linked `db` container.
|
||||
|
||||
If you do not want the `run` command to start linked containers, specify the `--no-deps` flag:
|
||||
|
||||
$ docker-compose run --no-deps web python manage.py shell
|
||||
docker-compose run --no-deps web python manage.py shell
|
||||
|
|
|
|||
|
|
@ -1,15 +1,9 @@
|
|||
---
|
||||
description: Sets the number of containers to run for a service.
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, scale
|
||||
menu:
|
||||
main:
|
||||
parent: smn_compose_cli
|
||||
title: scale
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, scale
|
||||
title: docker-compose scale
|
||||
---
|
||||
|
||||
# scale
|
||||
|
||||
```
|
||||
Usage: scale [SERVICE=NUM...]
|
||||
```
|
||||
|
|
@ -18,4 +12,4 @@ Sets the number of containers to run for a service.
|
|||
|
||||
Numbers are specified as arguments in the form `service=num`. For example:
|
||||
|
||||
$ docker-compose scale web=2 worker=3
|
||||
docker-compose scale web=2 worker=3
|
||||
|
|
|
|||
|
|
@ -1,18 +1,11 @@
|
|||
---
|
||||
description: Starts existing containers for a service.
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, start
|
||||
menu:
|
||||
main:
|
||||
identifier: start.compose
|
||||
parent: smn_compose_cli
|
||||
title: start
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, start
|
||||
title: docker-compose start
|
||||
---
|
||||
|
||||
# start
|
||||
|
||||
```
|
||||
Usage: start [SERVICE...]
|
||||
```
|
||||
|
||||
Starts existing containers for a service.
|
||||
Starts existing containers for a service.
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: 'Stops running containers without removing them. '
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, stop
|
||||
menu:
|
||||
main:
|
||||
identifier: stop.compose
|
||||
parent: smn_compose_cli
|
||||
title: stop
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, stop
|
||||
title: docker-compose stop
|
||||
---
|
||||
|
||||
# stop
|
||||
|
||||
```
|
||||
Usage: stop [options] [SERVICE...]
|
||||
|
||||
|
|
@ -19,4 +12,4 @@ Options:
|
|||
```
|
||||
|
||||
Stops running containers without removing them. They can be started again with
|
||||
`docker-compose start`.
|
||||
`docker-compose start`.
|
||||
|
|
@ -1,18 +1,11 @@
|
|||
---
|
||||
description: Unpauses paused containers for a service.
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, unpause
|
||||
menu:
|
||||
main:
|
||||
identifier: unpause.compose
|
||||
parent: smn_compose_cli
|
||||
title: unpause
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, unpause
|
||||
title: docker-compose unpause
|
||||
---
|
||||
|
||||
# unpause
|
||||
|
||||
```
|
||||
Usage: unpause [SERVICE...]
|
||||
```
|
||||
|
||||
Unpauses paused containers of a service.
|
||||
Unpauses paused containers of a service.
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Builds, (re)creates, starts, and attaches to containers for a service.
|
||||
keywords:
|
||||
- fig, composition, compose, docker, orchestration, cli, up
|
||||
menu:
|
||||
main:
|
||||
identifier: up.compose
|
||||
parent: smn_compose_cli
|
||||
title: up
|
||||
keywords: fig, composition, compose, docker, orchestration, cli, up
|
||||
title: docker-compose up
|
||||
---
|
||||
|
||||
# up
|
||||
|
||||
```
|
||||
Usage: up [options] [SERVICE...]
|
||||
|
||||
|
|
@ -52,4 +45,4 @@ volumes). To prevent Compose from picking up changes, use the `--no-recreate`
|
|||
flag.
|
||||
|
||||
If you want to force Compose to stop and recreate all containers, use the
|
||||
`--force-recreate` flag.
|
||||
`--force-recreate` flag.
|
||||
|
|
@ -1,15 +1,9 @@
|
|||
---
|
||||
description: How to control service startup order in Docker Compose
|
||||
keywords: documentation, docs, docker, compose, startup, order
|
||||
menu:
|
||||
main:
|
||||
parent: workw_compose
|
||||
weight: 90
|
||||
title: Controlling startup order
|
||||
title: Controlling startup order in Compose
|
||||
---
|
||||
|
||||
# Controlling startup order in Compose
|
||||
|
||||
You can control the order of service startup with the
|
||||
[depends_on](compose-file.md#depends-on) option. Compose always starts
|
||||
containers in dependency order, where dependencies are determined by
|
||||
|
|
@ -56,7 +50,7 @@ script:
|
|||
- Alternatively, write your own wrapper script to perform a more application-specific health
|
||||
check. For example, you might want to wait until Postgres is definitely
|
||||
ready to accept commands:
|
||||
|
||||
|
||||
wait-for-postgres.sh
|
||||
|
||||
#!/bin/bash
|
||||
|
|
|
|||
|
|
@ -1,15 +1,9 @@
|
|||
---
|
||||
description: How to use Compose and Swarm together to deploy apps to multi-host clusters
|
||||
keywords:
|
||||
- documentation, docs, docker, compose, orchestration, containers, swarm
|
||||
menu:
|
||||
main:
|
||||
parent: workw_compose
|
||||
title: Using Compose with Swarm
|
||||
keywords: documentation, docs, docker, compose, orchestration, containers, swarm
|
||||
title: Use Compose with Swarm
|
||||
---
|
||||
|
||||
# Using Compose with Swarm
|
||||
|
||||
Docker Compose and [Docker Swarm](/swarm/overview.md) aim to have full integration, meaning
|
||||
you can point a Compose app at a Swarm cluster and have it all just work as if
|
||||
you were using a single Docker host.
|
||||
|
|
@ -34,7 +28,6 @@ set up a Swarm cluster with [Docker Machine](/machine/overview.md) and the overl
|
|||
$ eval "$(docker-machine env --swarm <name of swarm master machine>)"
|
||||
$ docker-compose up
|
||||
|
||||
|
||||
## Limitations
|
||||
|
||||
### Building images
|
||||
|
|
@ -142,7 +135,6 @@ There are two viable workarounds for this problem:
|
|||
$ docker-compose rm -f web
|
||||
$ docker-compose up web
|
||||
|
||||
|
||||
## Scheduling containers
|
||||
|
||||
### Automatic scheduling
|
||||
|
|
@ -165,16 +157,16 @@ environment variables, so you can use Compose's `environment` option to set
|
|||
them.
|
||||
|
||||
# Schedule containers on a specific node
|
||||
labels:
|
||||
environment:
|
||||
- "constraint:node==node-1"
|
||||
|
||||
# Schedule containers on a node that has the 'storage' label set to 'ssd'
|
||||
labels:
|
||||
environment:
|
||||
- "constraint:storage==ssd"
|
||||
|
||||
# Schedule containers where the 'redis' image is already pulled
|
||||
labels:
|
||||
environment:
|
||||
- "affinity:image==redis"
|
||||
|
||||
For the full set of available filters and expressions, see the [Swarm
|
||||
documentation](/swarm/scheduler/filter.md).
|
||||
documentation](/swarm/scheduler/filter.md).
|
||||
|
|
@ -1,16 +1,9 @@
|
|||
---
|
||||
description: Getting started with Compose and WordPress
|
||||
keywords:
|
||||
- documentation, docs, docker, compose, orchestration, containers
|
||||
menu:
|
||||
main:
|
||||
parent: workw_compose
|
||||
weight: 6
|
||||
title: 'Quickstart: Compose and WordPress'
|
||||
keywords: documentation, docs, docker, compose, orchestration, containers
|
||||
title: "Quickstart: Compose and WordPress"
|
||||
---
|
||||
|
||||
# Quickstart: Docker Compose and WordPress
|
||||
|
||||
You can use Docker Compose to easily run WordPress in an isolated environment built
|
||||
with Docker containers. This quick-start guide demonstrates how to use Compose to set up and run WordPress. Before starting, you'll need to have
|
||||
[Compose installed](install.md).
|
||||
|
|
@ -27,7 +20,7 @@ with Docker containers. This quick-start guide demonstrates how to use Compose t
|
|||
|
||||
For example, if you named your directory `my_wordpress`:
|
||||
|
||||
$ cd my_wordpress/
|
||||
cd my_wordpress/
|
||||
|
||||
3. Create a `docker-compose.yml` file that will start your
|
||||
`Wordpress` blog and a separate `MySQL` instance with a volume
|
||||
|
|
@ -104,7 +97,6 @@ At this point, WordPress should be running on port `8000` of your Docker Host, a
|
|||
|
||||
|
||||
|
||||
|
||||
## More Compose documentation
|
||||
|
||||
- [User guide](index.md)
|
||||
|
|
@ -113,4 +105,4 @@ At this point, WordPress should be running on port `8000` of your Docker Host, a
|
|||
- [Get started with Django](django.md)
|
||||
- [Get started with Rails](rails.md)
|
||||
- [Command line reference](./reference/index.md)
|
||||
- [Compose file reference](compose-file.md)
|
||||
- [Compose file reference](compose-file.md)
|
||||
|
|
@ -1,20 +1,13 @@
|
|||
---
|
||||
aliases:
|
||||
- /docker-trusted-registry/cs-engine/
|
||||
description: Learn more about the Commercially Supported Docker Engine.
|
||||
keywords:
|
||||
- docker, engine, documentation
|
||||
menu:
|
||||
main:
|
||||
identifier: menu_csengine
|
||||
weight: -65
|
||||
title: CS Docker Engine
|
||||
keywords: docker, engine, documentation
|
||||
redirect_from:
|
||||
- /docker-trusted-registry/cs-engine/
|
||||
title: Commercially Supported Docker Engine
|
||||
---
|
||||
|
||||
# Docker CS Engine
|
||||
|
||||
This section includes the following topics:
|
||||
|
||||
* [Install CS Docker Engine](install.md)
|
||||
* [Upgrade](upgrade.md)
|
||||
* [Release notes](release-notes/release-notes.md)
|
||||
* [Release notes](release-notes/release-notes.md)
|
||||
|
|
@ -1,30 +1,22 @@
|
|||
---
|
||||
aliases:
|
||||
description: Learn how to install the commercially supported version of Docker Engine.
|
||||
keywords: docker, engine, dtr, install
|
||||
redirect_from:
|
||||
- /docker-trusted-registry/install/engine-ami-launch/
|
||||
- /docker-trusted-registry/install/install-csengine/
|
||||
- /docker-trusted-registry/cs-engine/install/
|
||||
description: Learn how to install the commercially supported version of Docker Engine.
|
||||
keywords:
|
||||
- docker, engine, dtr, install
|
||||
menu:
|
||||
main:
|
||||
identifier: csengine_install
|
||||
parent: menu_csengine
|
||||
weight: 0
|
||||
title: Install CS Docker Engine
|
||||
title: Install Commercially Supported Docker Engine
|
||||
---
|
||||
|
||||
# Install CS Docker Engine
|
||||
|
||||
Follow these instructions to install CS Docker Engine, the commercially
|
||||
supported version of Docker Engine.
|
||||
|
||||
CS Docker Engine can be installed on the following operating systems:
|
||||
|
||||
|
||||
* [CentOS 7.1/7.2 & RHEL 7.0/7.1/7.2 (YUM-based systems)](install.md#install-on-centos-7-1-7-2-rhel-7-0-7-1-7-2-yum-based-systems)
|
||||
* [Ubuntu 14.04 LTS](install.md#install-on-ubuntu-14-04-lts)
|
||||
* [SUSE Linux Enterprise 12](install.md#install-on-suse-linux-enterprise-12-3)
|
||||
* [CentOS 7.1/7.2 & RHEL 7.0/7.1/7.2 (YUM-based systems)](install.md#install-on-centos-7172--rhel-707172-yum-based-systems)
|
||||
* [Ubuntu 14.04 LTS](install.md#install-on-ubuntu-1404-lts)
|
||||
* [SUSE Linux Enterprise 12](install.md#install-on-suse-linux-enterprise-123)
|
||||
|
||||
|
||||
## Install on CentOS 7.1/7.2 & RHEL 7.0/7.1/7.2 (YUM-based systems)
|
||||
|
|
@ -63,27 +55,31 @@ to update its RHEL kernel.
|
|||
$ sudo yum install docker-engine
|
||||
```
|
||||
|
||||
6. Enable the Docker daemon as a service and start it.
|
||||
6. Configure devicemapper:
|
||||
|
||||
By default, the `devicemapper` graph driver does not come pre-configured in a production ready state. Follow the documented step by step instructions to [configure devicemapper with direct-lvm for production](../../engine/userguide/storagedriver/device-mapper-driver/#/for-a-direct-lvm-mode-configuration) in order to achieve the best performance and reliability for your environment.
|
||||
|
||||
7. Enable the Docker daemon as a service and start it.
|
||||
|
||||
```bash
|
||||
$ sudo systemctl enable docker.service
|
||||
$ sudo systemctl start docker.service
|
||||
```
|
||||
|
||||
7. Confirm the Docker daemon is running:
|
||||
8. Confirm the Docker daemon is running:
|
||||
|
||||
```bash
|
||||
$ sudo docker info
|
||||
```
|
||||
|
||||
8. Optionally, add non-sudo access to the Docker socket by adding your user
|
||||
9. Optionally, add non-sudo access to the Docker socket by adding your user
|
||||
to the `docker` group.
|
||||
|
||||
```bash
|
||||
$ sudo usermod -a -G docker $USER
|
||||
```
|
||||
|
||||
9. Log out and log back in to have your new permissions take effect.
|
||||
10. Log out and log back in to have your new permissions take effect.
|
||||
|
||||
## Install on Ubuntu 14.04 LTS
|
||||
|
||||
|
|
|
|||
|
|
@ -1,18 +1,10 @@
|
|||
---
|
||||
aliases:
|
||||
- /docker-trusted-registry/cs-engine/release-notes/
|
||||
description: The release notes for CS Docker Engine.
|
||||
keywords:
|
||||
- docker, engine, release notes
|
||||
menu:
|
||||
main:
|
||||
identifier: menu_csengine_release_notes
|
||||
parent: menu_csengine
|
||||
weight: 100
|
||||
title: Release notes
|
||||
keywords: docker, engine, release notes
|
||||
redirect_from:
|
||||
- /docker-trusted-registry/cs-engine/release-notes/
|
||||
title: Commercially Supported Docker Engine release notes
|
||||
---
|
||||
|
||||
# Docker CS Engine release notes
|
||||
|
||||
* [Release notes](release-notes.md)
|
||||
* [Prior release notes](prior-release-notes.md)
|
||||
* [Prior release notes](prior-release-notes.md)
|
||||
|
|
@ -1,21 +1,12 @@
|
|||
---
|
||||
aliases:
|
||||
description: Archived release notes for commercially supported Docker Engine
|
||||
keywords: docker, documentation, about, technology, understanding, enterprise, hub, registry, release, commercially supported Docker Engine
|
||||
redirect_from:
|
||||
- /docker-trusted-registry/cse-prior-release-notes/
|
||||
- /docker-trusted-registry/cs-engine/release-notes/prior-release-notes/
|
||||
description: Archived release notes for commercially supported Docker Engine
|
||||
keywords:
|
||||
- docker, documentation, about, technology, understanding, enterprise, hub, registry,release,
|
||||
commercially supported Docker Engine
|
||||
menu:
|
||||
main:
|
||||
identifier: csengine_prior_release_notes
|
||||
parent: menu_csengine_release_notes
|
||||
weight: 10
|
||||
title: Prior CS Engine release notes
|
||||
title: Release notes archive for Commercially Supported Docker Engine.
|
||||
---
|
||||
|
||||
# CS Engine release notes archive
|
||||
|
||||
This document contains the previous versions of the commercially supported
|
||||
Docker Engine release notes. It includes issues, fixes, and new features.
|
||||
|
||||
|
|
@ -341,4 +332,4 @@ Because this addition is preventative, no CVE-ID is requested.
|
|||
(23 Apr 2015)
|
||||
|
||||
First release, see the [Docker Engine 1.6.0 Release notes](/v1.6/release-notes/)
|
||||
for more details.
|
||||
for more details.
|
||||
|
|
@ -1,21 +1,12 @@
|
|||
---
|
||||
aliases:
|
||||
description: Commercially supported Docker Engine release notes
|
||||
keywords: docker, documentation, about, technology, understanding, enterprise, hub, registry, Commercially Supported Docker Engine, release notes
|
||||
redirect_from:
|
||||
- /docker-trusted-registry/cse-release-notes/
|
||||
- /docker-trusted-registry/cs-engine/release-notes/release-notes/
|
||||
description: Commercially supported Docker Engine release notes
|
||||
keywords:
|
||||
- docker, documentation, about, technology, understanding, enterprise, hub, registry,
|
||||
Commercially Supported Docker Engine, release notes
|
||||
menu:
|
||||
main:
|
||||
identifier: csengine_release_notes
|
||||
parent: menu_csengine_release_notes
|
||||
weight: 0
|
||||
title: CS Engine release notes
|
||||
title: Commercially Supported Engine release notes
|
||||
---
|
||||
|
||||
# Commercially supported Engine release notes
|
||||
|
||||
This document describes the latest changes, additions, known issues, and fixes
|
||||
for the commercially supported Docker Engine (CS Engine).
|
||||
|
||||
|
|
@ -30,6 +21,16 @@ cannot be adopted as quickly for consistency and compatibility reasons.
|
|||
These notes refer to the current and immediately prior releases of the
|
||||
CS Engine. For notes on older versions, see the [CS Engine prior release notes archive](prior-release-notes.md).
|
||||
|
||||
## CS Engine 1.12.3-cs4
|
||||
(11 Nov 2016)
|
||||
|
||||
This releases addresses the following issues:
|
||||
|
||||
* [#27370](https://github.com/docker/docker/issues/27370) Fix `--net-alias` for
|
||||
`--attachable` networks
|
||||
* [#28051](https://github.com/docker/docker/issues/28051) Fix an issue removing
|
||||
a `--attachable` network by ID.
|
||||
|
||||
## CS Engine 1.12.3-cs3
|
||||
(27 Oct 2016)
|
||||
|
||||
|
|
@ -112,4 +113,4 @@ https://github.com/docker/docker/issues/22486
|
|||
## CS Engine 1.11.1-cs1
|
||||
(27 April 2016)
|
||||
|
||||
In this release the CS Engine is supported on RHEL 7.2 OS
|
||||
In this release the CS Engine is supported on RHEL 7.2 OS
|
||||
|
|
@ -1,19 +1,11 @@
|
|||
---
|
||||
aliases:
|
||||
- /docker-trusted-registry/cs-engine/upgrade/
|
||||
description: Learn how to install the commercially supported version of Docker Engine.
|
||||
keywords:
|
||||
- docker, engine, dtr, upgrade
|
||||
menu:
|
||||
main:
|
||||
identifier: csengine_upgrade
|
||||
parent: menu_csengine
|
||||
weight: 10
|
||||
title: Upgrade
|
||||
keywords: docker, engine, dtr, upgrade
|
||||
redirect_from:
|
||||
- /docker-trusted-registry/cs-engine/upgrade/
|
||||
title: Upgrade Commercially Supported Docker Engine
|
||||
---
|
||||
|
||||
# Upgrade CS Docker Engine
|
||||
|
||||
This article explains how to upgrade your CS Docker Engine.
|
||||
|
||||
The upgrade process depends on the version that is currently installed and the
|
||||
|
|
@ -270,4 +262,4 @@ Use these instructions to update APT-based systems.
|
|||
|
||||
```bash
|
||||
$ sudo apt-get upgrade docker-engine
|
||||
```
|
||||
```
|
||||
|
|
@ -1,17 +1,11 @@
|
|||
---
|
||||
description: Learn about the architecture of Docker Trusted Registry.
|
||||
keywords:
|
||||
- docker, registry, dtr, architecture
|
||||
menu:
|
||||
main:
|
||||
identifier: dtr_architecture
|
||||
parent: workw_dtr
|
||||
weight: 20
|
||||
title: Architecture
|
||||
keywords: docker, registry, dtr, architecture
|
||||
redirect_from:
|
||||
- /docker-trusted-registry/architecture/
|
||||
title: DTR architecture
|
||||
---
|
||||
|
||||
# DTR architecture
|
||||
|
||||
Docker Trusted Registry (DTR) is a Dockerized application that runs on a Docker
|
||||
Universal Control Plane cluster.
|
||||
|
||||
|
|
@ -84,4 +78,4 @@ DTR, and join them to create a cluster.
|
|||
## Where to go next
|
||||
|
||||
* [System requirements](install/system-requirements.md)
|
||||
* [Install DTR](install/index.md)
|
||||
* [Install DTR](install/index.md)
|
||||
|
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 25 KiB |
|
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 29 KiB |
|
Before Width: | Height: | Size: 73 KiB After Width: | Height: | Size: 73 KiB |
|
|
@ -1,19 +1,13 @@
|
|||
---
|
||||
description: Configure general settings for Docker Trusted Registry
|
||||
keywords:
|
||||
- docker, documentation, about, technology, understanding, enterprise, hub, general,
|
||||
domain name, HTTP, HTTPS ports, Notary, registry
|
||||
menu:
|
||||
main:
|
||||
identifier: dtr_configure_general
|
||||
parent: workw_dtr_configure
|
||||
weight: 3
|
||||
keywords: docker, documentation, about, technology, understanding, enterprise, hub, general, domain name, HTTP, HTTPS ports, Notary, registry
|
||||
redirect_from:
|
||||
- /docker-trusted-registry/configure/config-general/
|
||||
title: Configure general settings
|
||||
---
|
||||
|
||||
# Configure general settings
|
||||
|
||||
This document describes the general settings you need to configure including using Trusted Content through setting up your Notary server.
|
||||
This document describes the general settings you need to configure including
|
||||
using Trusted Content through setting up your Notary server.
|
||||
|
||||
## Configure your domain name and port settings
|
||||
|
||||
|
|
@ -53,4 +47,4 @@ already.
|
|||
|
||||
## See also
|
||||
|
||||
* [Configure storage settings](config-storage.md)
|
||||
* [Configure storage settings](config-storage.md)
|
||||
|
|
@ -1,18 +1,11 @@
|
|||
---
|
||||
description: Security configuration for Docker Trusted Registry
|
||||
keywords:
|
||||
- docker, documentation, about, technology, understanding, configuration, security,
|
||||
enterprise, hub, registry
|
||||
menu:
|
||||
main:
|
||||
identifier: dtr_configure_security
|
||||
parent: workw_dtr_configure
|
||||
weight: 4
|
||||
keywords: docker, documentation, about, technology, understanding, configuration, security, enterprise, hub, registry
|
||||
redirect_from:
|
||||
- /docker-trusted-registry/configure/config-security/
|
||||
title: Security configuration
|
||||
---
|
||||
|
||||
# Security configuration
|
||||
|
||||
This document describes the security settings you need to configure.
|
||||
|
||||
* *SSL Certificate*: Used to enter the hash (string) from the SSL Certificate.
|
||||
|
|
@ -20,13 +13,17 @@ This cert must be accompanied by its private key, entered below.
|
|||
* *SSL Private Key*: The hash from the private key associated with the provided
|
||||
SSL Certificate (as a standard x509 key pair).
|
||||
|
||||
In order to run, the Trusted Registry requires encrypted communications through HTTPS/SSL between (a) the Trusted Registry and your Docker Engine(s), and (b) between your web browser and the Trusted Registry admin server. There are a few options for setting this up:
|
||||
In order to run, the Trusted Registry requires encrypted communications through
|
||||
HTTPS/SSL between (a) the Trusted Registry and your Docker Engine(s), and (b)
|
||||
between your web browser and the Trusted Registry admin server. There are a few
|
||||
options for setting this up:
|
||||
|
||||
1. You can use the self-signed certificate Docker Trusted Registry generates by default.
|
||||
2. You can generate your own certificates using a public service or your enterprise's infrastructure. See the [Generating SSL certificates](config-security.md#generating-ssl-certificates) section for the options available.
|
||||
|
||||
If you are generating your own certificates, you can install them by following the instructions for
|
||||
[Adding your own registry certificates to Docker Trusted Registry](config-security.md#adding-your-own-registry-certificates-to-dtr).
|
||||
If you are generating your own certificates, you can install them by following
|
||||
the instructions for [Adding your own registry certificates to Docker Trusted
|
||||
Registry](config-security.md#adding-your-own-registry-certificates-to-dtr).
|
||||
|
||||
However, if you choose to use the Trusted Registry-generated certificates, or
|
||||
the certificates you generate yourself are not trusted by your client Docker
|
||||
|
|
@ -66,9 +63,9 @@ set up your Trusted Registry server to use them.
|
|||
Certificate" edit box, and the previously generated Private key into the "SSL
|
||||
Private Key" edit box.
|
||||
|
||||
2. Click Save, and then wait for the Trusted Registry Admin site to restart
|
||||
and reload. It should now be using the new certificate. Once the Security page has reloaded, it displays `#` hashes instead of the
|
||||
certificate text you pasted.
|
||||
2. Click Save, and then wait for the Trusted Registry Admin site to restart and
|
||||
reload. It should now be using the new certificate. Once the Security page has
|
||||
reloaded, it displays `#` hashes instead of the certificate text you pasted.
|
||||
|
||||
If your certificate is signed by a chain of Certificate Authorities that are
|
||||
already trusted by your Docker daemon servers, you can skip the following
|
||||
|
|
@ -172,7 +169,8 @@ Docker daemon to run in "insecure" mode. This is done by adding an extra flag,
|
|||
`--insecure-registry host-ip|domain-name`, to your client Docker daemon startup
|
||||
flags. You'll need to restart the Docker daemon for the change to take effect.
|
||||
|
||||
This flag means that the communications between your Docker client and the Trusted Registry server are still encrypted, but the client Docker daemon is not
|
||||
This flag means that the communications between your Docker client and the
|
||||
Trusted Registry server are still encrypted, but the client Docker daemon is not
|
||||
confirming that the Registry connection is not being hijacked or diverted.
|
||||
|
||||
If you enter a "Domain Name" into the Security settings, it needs to be DNS
|
||||
|
|
@ -228,4 +226,4 @@ Then restart the Docker daemon with `sudo /etc/init.d/docker restart`.
|
|||
|
||||
## See also
|
||||
|
||||
* [Configure storage options](config-storage.md)
|
||||
* [Configure storage options](config-storage.md)
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue