mirror of https://github.com/docker/docs.git
Merge pull request #606 from bfirsh/swagger-api-docs
Automatically generate Engine API documentation
This commit is contained in:
Misty Stanley-Jones
Misty Stanley-Jones
commit
e9efceb8bd
|
|
@ -30,6 +30,7 @@ RUN svn co https://github.com/docker/docker/branches/$ENGINE_BRANCH/docs/referen
|
|||
&& wget -O allv/registry/configuration.md https://raw.githubusercontent.com/docker/distribution/$DISTRIBUTION_BRANCH/docs/configuration.md \
|
||||
&& rm -rf allv/apidocs/cloud-api-source \
|
||||
&& rm -rf allv/tests \
|
||||
&& wget -O allv/engine/api/v1.25/swagger.yaml https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/api/swagger.yaml \
|
||||
&& jekyll build -s allv -d allvbuild \
|
||||
&& find allvbuild/engine/reference -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/#g' \
|
||||
&& find allvbuild/engine/extend -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/#g' \
|
||||
|
|
|
|||
|
|
@ -5,6 +5,8 @@ toc:
|
|||
section:
|
||||
- path: /docker-id/
|
||||
title: Docker ID accounts
|
||||
- path: /docker-id/api-reference/
|
||||
title: API Reference
|
||||
- sectiontitle: Docker Engine
|
||||
section:
|
||||
- sectiontitle: Install
|
||||
|
|
@ -475,28 +477,30 @@ toc:
|
|||
title: volume rm
|
||||
- path: /engine/reference/commandline/wait/
|
||||
title: wait
|
||||
- sectiontitle: API Reference
|
||||
- sectiontitle: Engine API
|
||||
section:
|
||||
- path: /engine/api/v1.25/
|
||||
title: Reference
|
||||
- path: /engine/api/client-libraries/
|
||||
title: Client libraries
|
||||
- sectiontitle: Version history
|
||||
section:
|
||||
- path: /engine/reference/api/docker_remote_api/
|
||||
title: Remote API
|
||||
- path: /engine/reference/api/docker_remote_api_v1.24/
|
||||
title: Remote API v1.24
|
||||
- path: /engine/reference/api/docker_remote_api_v1.23/
|
||||
title: Remote API v1.23
|
||||
- path: /engine/reference/api/docker_remote_api_v1.22/
|
||||
title: Remote API v1.22
|
||||
- path: /engine/reference/api/docker_remote_api_v1.21/
|
||||
title: Remote API v1.21
|
||||
- path: /engine/reference/api/docker_remote_api_v1.20/
|
||||
title: Remote API v1.20
|
||||
- path: /engine/reference/api/docker_remote_api_v1.19/
|
||||
title: Remote API v1.19
|
||||
- path: /engine/reference/api/docker_remote_api_v1.18/
|
||||
title: Remote API v1.18
|
||||
- path: /engine/reference/api/remote_api_client_libraries/
|
||||
title: Remote API client libraries
|
||||
- path: /engine/reference/api/docker_io_accounts_api/
|
||||
title: docker.io accounts API
|
||||
- path: /engine/api/version-history/
|
||||
title: Overview
|
||||
- path: /engine/api/v1.24/
|
||||
title: v1.24 reference
|
||||
- path: /engine/api/v1.23/
|
||||
title: v1.23 reference
|
||||
- path: /engine/api/v1.22/
|
||||
title: v1.22 reference
|
||||
- path: /engine/api/v1.21/
|
||||
title: v1.21 reference
|
||||
- path: /engine/api/v1.20/
|
||||
title: v1.20 reference
|
||||
- path: /engine/api/v1.19/
|
||||
title: v1.19 reference
|
||||
- path: /engine/api/v1.18/
|
||||
title: v1.18 reference
|
||||
- path: /engine/migration/
|
||||
title: Migrate to Engine 1.10
|
||||
- path: /engine/breaking_changes/
|
||||
|
|
|
|||
|
|
@ -169,7 +169,7 @@ UCP allows you to deploy and manage "Dockerized" applications in production. An
|
|||
application is built using Docker objects, such as images and containers, and
|
||||
Docker resources, such as volumes and networks.
|
||||
|
||||
UCP deploys and manages these objects and resources using remote API calls to
|
||||
UCP deploys and manages these objects and resources using Engine API calls to
|
||||
the Engine daemons running on the nodes. For example, the `run` action may
|
||||
deploy an image in a Docker container. That image might define a service such as
|
||||
an Nginx web server or a database like Postgres.
|
||||
|
|
|
|||
|
|
@ -84,11 +84,11 @@ experiment a multi-node swarm. Check out the tutorial at [Get started with swarm
|
|||
|
||||
### How do I connect to the remote Docker Engine API?
|
||||
|
||||
You might need to provide the location of the remote API for Docker clients and development tools.
|
||||
You might need to provide the location of the Engine API for Docker clients and development tools.
|
||||
|
||||
On Docker for Mac, clients can connect to the Docker Engine through a Unix socket: `unix:///var/run/docker.sock`.
|
||||
|
||||
See also [Docker Remote API](/engine/reference/api/docker_remote_api.md) and Docker for Mac forums topic [Using pycharm Docker plugin..](https://forums.docker.com/t/using-pycharm-docker-plugin-with-docker-beta/8617).
|
||||
See also [Docker Engine API](/engine/reference/api/docker_remote_api.md) and Docker for Mac forums topic [Using pycharm Docker plugin..](https://forums.docker.com/t/using-pycharm-docker-plugin-with-docker-beta/8617).
|
||||
|
||||
If you are working with applications like [Apache Maven](https://maven.apache.org/) that expect settings for `DOCKER_HOST` and `DOCKER_CERT_PATH` environment variables, specify these to connect to Docker instances through Unix sockets. For example:
|
||||
|
||||
|
|
|
|||
|
|
@ -103,13 +103,13 @@ swarm mode](/engine/swarm/swarm-tutorial/index.md).
|
|||
|
||||
### How do I connect to the remote Docker Engine API?
|
||||
|
||||
You might need to provide the location of the remote API for Docker clients and development tools.
|
||||
You might need to provide the location of the Engine API for Docker clients and development tools.
|
||||
|
||||
On Docker for Windows, clients can connect to the Docker Engine through a **named pipe**: `npipe:////./pipe/docker_engine`, or **TCP socket** at this URL: `http://localhost:2375`.
|
||||
|
||||
This sets `DOCKER_HOST` and `DOCKER_CERT_PATH` environment variables to the given values (for the named pipe or TCP socket, whichever you use).
|
||||
|
||||
See also [Docker Remote API](/engine/reference/api/docker_remote_api.md) and the Docker for Windows forums topic [How to find the remote API](https://forums.docker.com/t/how-to-find-the-remote-api/20988).
|
||||
See also [Docker Engine API](/engine/reference/api/) and the Docker for Windows forums topic [How to find the remote API](https://forums.docker.com/t/how-to-find-the-remote-api/20988).
|
||||
|
||||
### Why doesn't `nodemon` pick up file changes in a container mounted on a shared drive?
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,277 @@
|
|||
---
|
||||
title: "docker.io accounts API"
|
||||
description: "API Documentation for docker.io accounts."
|
||||
keywords: "API, Docker, accounts, REST, documentation"
|
||||
redirect_from:
|
||||
- /reference/api/docker_io_accounts_api/
|
||||
- /engine/reference/api/docker_io_accounts_api/
|
||||
---
|
||||
|
||||
# Docker ID accounts API
|
||||
|
||||
The accounts API is an API for accessing and updating Docker ID accounts.
|
||||
|
||||
## Get a single user
|
||||
|
||||
`GET /api/v1.1/users/:username/`
|
||||
|
||||
Get profile info for the specified user.
|
||||
|
||||
Parameters:
|
||||
|
||||
- **username** – username of the user whose profile info is being
|
||||
requested.
|
||||
|
||||
Request Headers:
|
||||
|
||||
- **Authorization** – required authentication credentials of
|
||||
either type HTTP Basic or OAuth Bearer Token.
|
||||
|
||||
Status Codes:
|
||||
|
||||
- **200** – success, user data returned.
|
||||
- **401** – authentication error.
|
||||
- **403** – permission error, authenticated user must be the user
|
||||
whose data is being requested, OAuth access tokens must have
|
||||
`profile_read` scope.
|
||||
- **404** – the specified username does not exist.
|
||||
|
||||
**Example request**:
|
||||
|
||||
GET /api/v1.1/users/janedoe/ HTTP/1.1
|
||||
Host: www.docker.io
|
||||
Accept: application/json
|
||||
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
|
||||
|
||||
**Example response**:
|
||||
|
||||
HTTP/1.1 200 OK
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"id": 2,
|
||||
"username": "janedoe",
|
||||
"url": "https://www.docker.io/api/v1.1/users/janedoe/",
|
||||
"date_joined": "2014-02-12T17:58:01.431312Z",
|
||||
"type": "User",
|
||||
"full_name": "Jane Doe",
|
||||
"location": "San Francisco, CA",
|
||||
"company": "Success, Inc.",
|
||||
"profile_url": "https://docker.io/",
|
||||
"gravatar_url": "https://secure.gravatar.com/avatar/0212b397124be4acd4e7dea9aa357.jpg?s=80&r=g&d=mm"
|
||||
"email": "jane.doe@example.com",
|
||||
"is_active": true
|
||||
}
|
||||
|
||||
## Update a single user
|
||||
|
||||
`PATCH /api/v1.1/users/:username/`
|
||||
|
||||
Update profile info for the specified user.
|
||||
|
||||
Parameters:
|
||||
|
||||
- **username** – username of the user whose profile info is being
|
||||
updated.
|
||||
|
||||
Json Parameters:
|
||||
|
||||
- **full_name** (*string*) – (optional) the new name of the user.
|
||||
- **location** (*string*) – (optional) the new location.
|
||||
- **company** (*string*) – (optional) the new company of the user.
|
||||
- **profile_url** (*string*) – (optional) the new profile url.
|
||||
- **gravatar_email** (*string*) – (optional) the new Gravatar
|
||||
email address.
|
||||
|
||||
Request Headers:
|
||||
|
||||
- **Authorization** – required authentication credentials of
|
||||
either type HTTP Basic or OAuth Bearer Token.
|
||||
- **Content-Type** – MIME Type of post data. JSON, url-encoded
|
||||
form data, etc.
|
||||
|
||||
Status Codes:
|
||||
|
||||
- **200** – success, user data updated.
|
||||
- **400** – post data validation error.
|
||||
- **401** – authentication error.
|
||||
- **403** – permission error, authenticated user must be the user
|
||||
whose data is being updated, OAuth access tokens must have
|
||||
`profile_write` scope.
|
||||
- **404** – the specified username does not exist.
|
||||
|
||||
**Example request**:
|
||||
|
||||
PATCH /api/v1.1/users/janedoe/ HTTP/1.1
|
||||
Host: www.docker.io
|
||||
Accept: application/json
|
||||
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
|
||||
|
||||
{
|
||||
"location": "Private Island",
|
||||
"profile_url": "http://janedoe.com/",
|
||||
"company": "Retired",
|
||||
}
|
||||
|
||||
**Example response**:
|
||||
|
||||
HTTP/1.1 200 OK
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"id": 2,
|
||||
"username": "janedoe",
|
||||
"url": "https://www.docker.io/api/v1.1/users/janedoe/",
|
||||
"date_joined": "2014-02-12T17:58:01.431312Z",
|
||||
"type": "User",
|
||||
"full_name": "Jane Doe",
|
||||
"location": "Private Island",
|
||||
"company": "Retired",
|
||||
"profile_url": "http://janedoe.com/",
|
||||
"gravatar_url": "https://secure.gravatar.com/avatar/0212b397124be4acd4e7dea9aa357.jpg?s=80&r=g&d=mm"
|
||||
"email": "jane.doe@example.com",
|
||||
"is_active": true
|
||||
}
|
||||
|
||||
## List email addresses for a user
|
||||
|
||||
`GET /api/v1.1/users/:username/emails/`
|
||||
|
||||
List email info for the specified user.
|
||||
|
||||
Parameters:
|
||||
|
||||
- **username** – username of the user whose profile info is being
|
||||
updated.
|
||||
|
||||
Request Headers:
|
||||
|
||||
- **Authorization** – required authentication credentials of
|
||||
either type HTTP Basic or OAuth Bearer Token
|
||||
|
||||
Status Codes:
|
||||
|
||||
- **200** – success, user data updated.
|
||||
- **401** – authentication error.
|
||||
- **403** – permission error, authenticated user must be the user
|
||||
whose data is being requested, OAuth access tokens must have
|
||||
`email_read` scope.
|
||||
- **404** – the specified username does not exist.
|
||||
|
||||
**Example request**:
|
||||
|
||||
GET /api/v1.1/users/janedoe/emails/ HTTP/1.1
|
||||
Host: www.docker.io
|
||||
Accept: application/json
|
||||
Authorization: Bearer zAy0BxC1wDv2EuF3tGs4HrI6qJp6KoL7nM
|
||||
|
||||
**Example response**:
|
||||
|
||||
HTTP/1.1 200 OK
|
||||
Content-Type: application/json
|
||||
|
||||
[
|
||||
{
|
||||
"email": "jane.doe@example.com",
|
||||
"verified": true,
|
||||
"primary": true
|
||||
}
|
||||
]
|
||||
|
||||
## Add email address for a user
|
||||
|
||||
`POST /api/v1.1/users/:username/emails/`
|
||||
|
||||
Add a new email address to the specified user's account. The email
|
||||
address must be verified separately, a confirmation email is not
|
||||
automatically sent.
|
||||
|
||||
Json Parameters:
|
||||
|
||||
- **email** (*string*) – email address to be added.
|
||||
|
||||
Request Headers:
|
||||
|
||||
- **Authorization** – required authentication credentials of
|
||||
either type HTTP Basic or OAuth Bearer Token.
|
||||
- **Content-Type** – MIME Type of post data. JSON, url-encoded
|
||||
form data, etc.
|
||||
|
||||
Status Codes:
|
||||
|
||||
- **201** – success, new email added.
|
||||
- **400** – data validation error.
|
||||
- **401** – authentication error.
|
||||
- **403** – permission error, authenticated user must be the user
|
||||
whose data is being requested, OAuth access tokens must have
|
||||
`email_write` scope.
|
||||
- **404** – the specified username does not exist.
|
||||
|
||||
**Example request**:
|
||||
|
||||
POST /api/v1.1/users/janedoe/emails/ HTTP/1.1
|
||||
Host: www.docker.io
|
||||
Accept: application/json
|
||||
Content-Type: application/json
|
||||
Authorization: Bearer zAy0BxC1wDv2EuF3tGs4HrI6qJp6KoL7nM
|
||||
|
||||
{
|
||||
"email": "jane.doe+other@example.com"
|
||||
}
|
||||
|
||||
**Example response**:
|
||||
|
||||
HTTP/1.1 201 Created
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"email": "jane.doe+other@example.com",
|
||||
"verified": false,
|
||||
"primary": false
|
||||
}
|
||||
|
||||
## Delete email address for a user
|
||||
|
||||
`DELETE /api/v1.1/users/:username/emails/`
|
||||
|
||||
Delete an email address from the specified user's account. You
|
||||
cannot delete a user's primary email address.
|
||||
|
||||
Json Parameters:
|
||||
|
||||
- **email** (*string*) – email address to be deleted.
|
||||
|
||||
Request Headers:
|
||||
|
||||
- **Authorization** – required authentication credentials of
|
||||
either type HTTP Basic or OAuth Bearer Token.
|
||||
- **Content-Type** – MIME Type of post data. JSON, url-encoded
|
||||
form data, etc.
|
||||
|
||||
Status Codes:
|
||||
|
||||
- **204** – success, email address removed.
|
||||
- **400** – validation error.
|
||||
- **401** – authentication error.
|
||||
- **403** – permission error, authenticated user must be the user
|
||||
whose data is being requested, OAuth access tokens must have
|
||||
`email_write` scope.
|
||||
- **404** – the specified username or email address does not
|
||||
exist.
|
||||
|
||||
**Example request**:
|
||||
|
||||
DELETE /api/v1.1/users/janedoe/emails/ HTTP/1.1
|
||||
Host: www.docker.io
|
||||
Accept: application/json
|
||||
Content-Type: application/json
|
||||
Authorization: Bearer zAy0BxC1wDv2EuF3tGs4HrI6qJp6KoL7nM
|
||||
|
||||
{
|
||||
"email": "jane.doe+other@example.com"
|
||||
}
|
||||
|
||||
**Example response**:
|
||||
|
||||
HTTP/1.1 204 NO CONTENT
|
||||
Content-Length: 0
|
||||
|
|
@ -0,0 +1,131 @@
|
|||
---
|
||||
redirect_from:
|
||||
- /engine/reference/api/remote_api_client_libraries/
|
||||
- /reference/api/remote_api_client_libraries/
|
||||
description: Various client libraries available to use with the Docker Engine API
|
||||
keywords:
|
||||
- API, Docker, index, registry, REST, documentation, clients, C#, Erlang, Go, Groovy, Java, JavaScript, Perl, PHP, Python, Ruby, Rust, Scala
|
||||
title: Engine API client libraries
|
||||
---
|
||||
|
||||
These libraries make it easier to build applications on top of the Docker
|
||||
Engine with various programming languages. They have not been tested by the
|
||||
Docker maintainers for compatibility, so if you run into any issues, file them
|
||||
with the library maintainers.
|
||||
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="29%">
|
||||
<col width="23%">
|
||||
<col width="48%">
|
||||
</colgroup>
|
||||
<thead valign="bottom">
|
||||
<tr>
|
||||
<th class="head">Language/Framework</th>
|
||||
<th class="head">Name</th>
|
||||
<th class="head">Repository</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody valign = "top">
|
||||
<tr>
|
||||
<td>C#</td>
|
||||
<td>Docker.DotNet</td>
|
||||
<td><a class="reference external" href="https://github.com/ahmetalpbalkan/Docker.DotNet">https://github.com/ahmetalpbalkan/Docker.DotNet</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>C++</td>
|
||||
<td>lasote/docker_client</td>
|
||||
<td><a class="reference external" href="https://github.com/lasote/docker_client">https://github.com/lasote/docker_client</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Erlang</td>
|
||||
<td>erldocker</td>
|
||||
<td><a class="reference external" href="https://github.com/proger/erldocker">https://github.com/proger/erldocker</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Dart</td>
|
||||
<td>bwu_docker</td>
|
||||
<td><a class="reference external" href="https://github.com/bwu-dart/bwu_docker">https://github.com/bwu-dart/bwu_docker</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Go</td>
|
||||
<td>Docker Go client</td>
|
||||
<td><a class="reference external" href="https://godoc.org/github.com/docker/docker/client">https://godoc.org/github.com/docker/docker/client</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Gradle</td>
|
||||
<td>gradle-docker-plugin</td>
|
||||
<td><a class="reference external" href="https://github.com/gesellix/gradle-docker-plugin">https://github.com/gesellix/gradle-docker-plugin</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Groovy</td>
|
||||
<td>docker-client</td>
|
||||
<td><a class="reference external" href="https://github.com/gesellix/docker-client">https://github.com/gesellix/docker-client</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Haskell</td>
|
||||
<td>docker-hs</td>
|
||||
<td><a class="reference external" href="https://github.com/denibertovic/docker-hs">https://github.com/denibertovic/docker-hs</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>HTML (Web Components)</td>
|
||||
<td>docker-elements</td>
|
||||
<td><a class="reference external" href="https://github.com/kapalhq/docker-elements">https://github.com/kapalhq/docker-elements</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Java</td>
|
||||
<td>docker-java</td>
|
||||
<td><a class="reference external" href="https://github.com/docker-java/docker-java">https://github.com/docker-java/docker-java</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Java</td>
|
||||
<td>docker-client</td>
|
||||
<td><a class="reference external" href="https://github.com/spotify/docker-client">https://github.com/spotify/docker-client</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>NodeJS</td>
|
||||
<td>dockerode</td>
|
||||
<td><a class="reference external" href="https://github.com/apocas/dockerode">https://github.com/apocas/dockerode</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Perl</td>
|
||||
<td>Eixo::Docker</td>
|
||||
<td><a class="reference external" href="https://github.com/alambike/eixo-docker">https://github.com/alambike/eixo-docker</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>PHP</td>
|
||||
<td>Docker-PHP</td>
|
||||
<td><a class="reference external" href="https://github.com/docker-php/docker-php">https://github.com/docker-php/docker-php</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Python</td>
|
||||
<td>docker-py</td>
|
||||
<td><a class="reference external" href="https://github.com/docker/docker-py">https://github.com/docker/docker-py</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Ruby</td>
|
||||
<td>docker-api</td>
|
||||
<td><a class="reference external" href="https://github.com/swipely/docker-api">https://github.com/swipely/docker-api</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Rust</td>
|
||||
<td>docker-rust</td>
|
||||
<td><a class="reference external" href="https://github.com/abh1nav/docker-rust">https://github.com/abh1nav/docker-rust</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Rust</td>
|
||||
<td>shiplift</td>
|
||||
<td><a class="reference external" href="https://github.com/softprops/shiplift">https://github.com/softprops/shiplift</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Scala</td>
|
||||
<td>tugboat</td>
|
||||
<td><a class="reference external" href="https://github.com/softprops/tugboat">https://github.com/softprops/tugboat</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Scala</td>
|
||||
<td>reactive-docker</td>
|
||||
<td><a class="reference external" href="https://github.com/almoehi/reactive-docker">https://github.com/almoehi/reactive-docker</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
layout: null
|
||||
redirect_from:
|
||||
- /engine/api/
|
||||
- /engine/reference/api/
|
||||
- /engine/reference/api/docker_remote_api/
|
||||
- /engine/reference/api/docker_remote_api_v1.25/
|
||||
- /reference/api/
|
||||
---
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Docker Engine API v1.25 Reference</title>
|
||||
<!-- needed for adaptive design -->
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="description" content="Reference for the API served by Docker Engine.">
|
||||
|
||||
<!--
|
||||
ReDoc doesn't change outer page styles
|
||||
-->
|
||||
<style>
|
||||
body {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
api-logo {
|
||||
background-image: linear-gradient(0deg, #15A4D7 0%, #1488C6 100%);
|
||||
height: 100px;
|
||||
text-align: left !important;
|
||||
}
|
||||
api-logo img {
|
||||
width: 136px !important;
|
||||
margin: 32px 0 0 50px;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<redoc spec-url="swagger.yaml" hide-hostname="true" suppress-warnings="true" lazy-rendering></redoc>
|
||||
<script src="redoc.1.6.0.min.js"> </script>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -19,7 +19,7 @@ best way to start contributing to Kitematic is to review our doc on <a href="htt
|
|||
### How does Kitematic work with Docker?
|
||||
|
||||
Kitematic connects directly to a running instance of Docker and controls it via
|
||||
the Docker Remote API.
|
||||
the Docker Engine API.
|
||||
|
||||
### Which platforms does Kitematic support?
|
||||
|
||||
|
|
|
|||
|
|
@ -105,7 +105,7 @@ manager orchestrates and schedules containers on the entire cluster. The swarm
|
|||
manager rules a set of agents (also called nodes or Docker nodes).
|
||||
|
||||
Swarm agents are responsible for hosting containers. They are regular docker
|
||||
daemons and you can communicate with them using the Docker remote API.
|
||||
daemons and you can communicate with them using the Docker Engine API.
|
||||
|
||||
In this section, you create a swarm manager and two nodes.
|
||||
|
||||
|
|
|
|||
|
|
@ -157,9 +157,9 @@ Deprecated; Use `--engine-failure-retry` instead of `--engine-refresh-retry "<nu
|
|||
|
||||
Use `--heartbeat "<interval>s"` to specify the interval, in seconds, between heartbeats the manager sends to the primary manager. These heartbeats indicate that the manager is healthy and reachable. By default, the interval is 60 seconds.
|
||||
|
||||
### `--api-enable-cors`, `--cors` — Enable CORS headers in the remote API
|
||||
### `--api-enable-cors`, `--cors` — Enable CORS headers in the Engine API
|
||||
|
||||
Use `--api-enable-cors` or `--cors` to enable cross-origin resource sharing (CORS) headers in the remote API.
|
||||
Use `--api-enable-cors` or `--cors` to enable cross-origin resource sharing (CORS) headers in the Engine API.
|
||||
|
||||
### `--cluster-driver`, `-c` — Cluster driver to use
|
||||
|
||||
|
|
@ -198,4 +198,4 @@ Use `--discovery-opt <value>` to discovery options, such as paths to the TLS fil
|
|||
--discovery-opt kv.certfile=/path/to/mycert.pem \
|
||||
--discovery-opt kv.keyfile=/path/to/mykey.pem \
|
||||
|
||||
For more information, see [Use TLS with distributed key/value discovery](../discovery.md)
|
||||
For more information, see [Use TLS with distributed key/value discovery](../discovery.md)
|
||||
|
|
|
|||
|
|
@ -94,11 +94,11 @@ the Docker Engine daemon automatically trusts any certificates signed by the CA.
|
|||
certificate is in order (the certificate has not expired or been revoked etc.)
|
||||
the Docker Engine daemon accepts commands from this trusted Docker Engine CLI.
|
||||
|
||||
The Docker Engine CLI is simply a client that uses the Docker Engine Remote API to
|
||||
communicate with the Docker Engine daemon. Any client that uses this Docker Engine Remote API can use
|
||||
The Docker Engine CLI is simply a client that uses the Docker Engine API to
|
||||
communicate with the Docker Engine daemon. Any client that uses this Docker Engine API can use
|
||||
TLS. For example, Docker Engine clients such as 'Docker Universal Control Plane'
|
||||
(UCP) have TLS support built-in. Other, third party products, that use Docker Engine
|
||||
Remote API, can also be configured this way.
|
||||
API, can also be configured this way.
|
||||
|
||||
## TLS modes with Docker and Swarm
|
||||
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ title: Docker Swarm API
|
|||
The Docker Swarm API is mostly compatible with the [Docker Remote
|
||||
API](/engine/reference/api/docker_remote_api/). This
|
||||
document is an overview of the differences between the Swarm API and the Docker
|
||||
Remote API.
|
||||
Engine API.
|
||||
|
||||
## Missing endpoints
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue