toolshed/docker-cli
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename Remote API to Engine API

Browse Source 
Implementation of https://github.com/docker/docker/issues/28319

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
Upstream-commit: f0d55cd081c6e8ad2a8222c787d54f9aae15723f
Component: engine
This commit is contained in:
Ben Firshman
2016-11-22 12:49:38 +00:00
parent 7e2e397a31
commit e5912f7d7e
33 changed files with 92 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files
components/engine/docs/api/v1.18.md
+3 -4
View File
@@ -1,5 +1,5 @@
---
title: "Remote API v1.18"
title: "Engine API v1.18"
description: "API Documentation for Docker"
keywords: "API, Docker, rcli, REST, documentation"
redirect_from:
@@ -16,11 +16,10 @@ redirect_from:
will be rejected.
-->
# Docker Remote API v1.18
# Docker Engine API v1.18
# 1. Brief introduction
- The Remote API has replaced `rcli`.
- The daemon listens on `unix:///var/run/docker.sock` but you can
[Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
- The API tends to be REST, but for some complex commands, like `attach`
@@ -2151,7 +2150,7 @@ This might change in the future.
## 3.3 CORS Requests
To set cross origin requests to the remote api please give values to
To set cross origin requests to the Engine API please give values to
`--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
default or blank means CORS disabled
components/engine/docs/api/v1.19.md
+3 -4
View File
@@ -1,5 +1,5 @@
---
title: "Remote API v1.19"
title: "Engine API v1.19"
description: "API Documentation for Docker"
keywords: "API, Docker, rcli, REST, documentation"
redirect_from:
@@ -16,11 +16,10 @@ redirect_from:
will be rejected.
-->
# Docker Remote API v1.19
# Docker Engine API v1.19
## 1. Brief introduction
- The Remote API has replaced `rcli`.
- The daemon listens on `unix:///var/run/docker.sock` but you can
[Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
- The API tends to be REST. However, for some complex commands, like `attach`
@@ -2233,7 +2232,7 @@ from **200 OK** to **101 UPGRADED** and resends the same headers.
## 3.3 CORS Requests
To set cross origin requests to the remote api please give values to
To set cross origin requests to the Engine API please give values to
`--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
default or blank means CORS disabled
components/engine/docs/api/v1.20.md
+3 -4
View File
@@ -1,5 +1,5 @@
---
title: "Remote API v1.20"
title: "Engine API v1.20"
description: "API Documentation for Docker"
keywords: "API, Docker, rcli, REST, documentation"
redirect_from:
@@ -16,11 +16,10 @@ redirect_from:
will be rejected.
-->
# Docker Remote API v1.20
# Docker Engine API v1.20
# 1. Brief introduction
- The Remote API has replaced `rcli`.
- The daemon listens on `unix:///var/run/docker.sock` but you can
[Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
- The API tends to be REST. However, for some complex commands, like `attach`
@@ -2386,7 +2385,7 @@ from **200 OK** to **101 UPGRADED** and resends the same headers.
## 3.3 CORS Requests
To set cross origin requests to the remote api please give values to
To set cross origin requests to the Engine API please give values to
`--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
default or blank means CORS disabled
components/engine/docs/api/v1.21.md
+3 -4
View File
@@ -1,5 +1,5 @@
---
title: "Remote API v1.21"
title: "Engine API v1.21"
description: "API Documentation for Docker"
keywords: "API, Docker, rcli, REST, documentation"
redirect_from:
@@ -16,11 +16,10 @@ redirect_from:
will be rejected.
-->
# Docker Remote API v1.21
# Docker Engine API v1.21
## 1. Brief introduction
- The Remote API has replaced `rcli`.
- The daemon listens on `unix:///var/run/docker.sock` but you can
[Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
- The API tends to be REST. However, for some complex commands, like `attach`
@@ -2964,7 +2963,7 @@ from **200 OK** to **101 UPGRADED** and resends the same headers.
## 3.3 CORS Requests
To set cross origin requests to the remote api please give values to
To set cross origin requests to the Engine API please give values to
`--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
default or blank means CORS disabled
components/engine/docs/api/v1.22.md
+3 -4
View File
@@ -1,5 +1,5 @@
---
title: "Remote API v1.22"
title: "Engine API v1.22"
description: "API Documentation for Docker"
keywords: "API, Docker, rcli, REST, documentation"
redirect_from:
@@ -16,11 +16,10 @@ redirect_from:
will be rejected.
-->
# Docker Remote API v1.22
# Docker Engine API v1.22
# 1. Brief introduction
- The Remote API has replaced `rcli`.
- The daemon listens on `unix:///var/run/docker.sock` but you can
[Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
- The API tends to be REST. However, for some complex commands, like `attach`
@@ -3302,7 +3301,7 @@ from **200 OK** to **101 UPGRADED** and resends the same headers.
## 3.3 CORS Requests
To set cross origin requests to the remote api please give values to
To set cross origin requests to the Engine API please give values to
`--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
default or blank means CORS disabled
components/engine/docs/api/v1.23.md
+3 -4
View File
@@ -1,5 +1,5 @@
---
title: "Remote API v1.23"
title: "Engine API v1.23"
description: "API Documentation for Docker"
keywords: "API, Docker, rcli, REST, documentation"
redirect_from:
@@ -16,11 +16,10 @@ redirect_from:
will be rejected.
-->
# Docker Remote API v1.23
# Docker Engine API v1.23
## 1. Brief introduction
- The Remote API has replaced `rcli`.
- The daemon listens on `unix:///var/run/docker.sock` but you can
[Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
- The API tends to be REST. However, for some complex commands, like `attach`
@@ -3419,7 +3418,7 @@ from **200 OK** to **101 UPGRADED** and resends the same headers.
## 3.3 CORS Requests
To set cross origin requests to the remote api please give values to
To set cross origin requests to the Engine API please give values to
`--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
default or blank means CORS disabled
components/engine/docs/api/v1.24.md
+4 -5
View File
@@ -1,5 +1,5 @@
---
title: "Remote API v1.24"
title: "Engine API v1.24"
description: "API Documentation for Docker"
keywords: "API, Docker, rcli, REST, documentation"
redirect_from:
@@ -16,11 +16,10 @@ redirect_from:
will be rejected.
-->
# Docker Remote API v1.24
# Docker Engine API v1.24
# 1. Brief introduction
- The Remote API has replaced `rcli`.
- The daemon listens on `unix:///var/run/docker.sock` but you can
[Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
- The API tends to be REST. However, for some complex commands, like `attach`
@@ -29,7 +28,7 @@ redirect_from:
# 2. Errors
The Remote API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format:
The Engine API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format:
{
"message": "page not found"
@@ -5277,7 +5276,7 @@ from **200 OK** to **101 UPGRADED** and resends the same headers.
## 4.3 CORS Requests
To set cross origin requests to the remote api please give values to
To set cross origin requests to the Engine API please give values to
`--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
default or blank means CORS disabled
components/engine/docs/api/version-history.md
+10 -11
View File
@@ -1,5 +1,5 @@
---
title: "Remote API version history"
title: "Engine API version history"
description: "Documentation of changes that have been made to Engine API."
keywords: "API, Docker, rcli, REST, documentation"
---
@@ -15,12 +15,11 @@ keywords: "API, Docker, rcli, REST, documentation"
## v1.26 API changes
[Docker Remote API v1.26](docker_remote_api_v1.26.md) documentation
[Docker Engine API v1.26](v1.26/) documentation
## v1.25 API changes
[Docker Remote API v1.25](docker_remote_api_v1.25.md) documentation
[Docker Engine API v1.25](v1.25.md) documentation
* The API version is now required in all API calls. Instead of just requesting, for example, the URL `/containers/json`, you must now request `/v1.25/containers/json`.
* `GET /version` now returns `MinAPIVersion`.
@@ -81,7 +80,7 @@ keywords: "API, Docker, rcli, REST, documentation"
## v1.24 API changes
[Docker Remote API v1.24](docker_remote_api_v1.24.md) documentation
[Docker Engine API v1.24](v1.24.md) documentation
* `POST /containers/create` now takes `StorageOpt` field.
* `GET /info` now returns `SecurityOptions` field, showing if `apparmor`, `seccomp`, or `selinux` is supported.
@@ -113,7 +112,7 @@ keywords: "API, Docker, rcli, REST, documentation"
## v1.23 API changes
[Docker Remote API v1.23](docker_remote_api_v1.23.md) documentation
[Docker Engine API v1.23](v1.23.md) documentation
* `GET /containers/json` returns the state of the container, one of `created`, `restarting`, `running`, `paused`, `exited` or `dead`.
* `GET /containers/json` returns the mount points for the container.
@@ -135,7 +134,7 @@ keywords: "API, Docker, rcli, REST, documentation"
## v1.22 API changes
[Docker Remote API v1.22](docker_remote_api_v1.22.md) documentation
[Docker Engine API v1.22](v1.22.md) documentation
* `POST /container/(name)/update` updates the resources of a container.
* `GET /containers/json` supports filter `isolation` on Windows.
@@ -169,7 +168,7 @@ keywords: "API, Docker, rcli, REST, documentation"
## v1.21 API changes
[Docker Remote API v1.21](docker_remote_api_v1.21.md) documentation
[Docker Engine API v1.21](v1.21.md) documentation
* `GET /volumes` lists volumes from all volume drivers.
* `POST /volumes/create` to create a volume.
@@ -204,7 +203,7 @@ keywords: "API, Docker, rcli, REST, documentation"
## v1.20 API changes
[Docker Remote API v1.20](docker_remote_api_v1.20.md) documentation
[Docker Engine API v1.20](v1.20.md) documentation
* `GET /containers/(id)/archive` get an archive of filesystem content from a container.
* `PUT /containers/(id)/archive` upload an archive of content to be extracted to
@@ -216,7 +215,7 @@ list of additional groups that the container process will run as.
## v1.19 API changes
[Docker Remote API v1.19](docker_remote_api_v1.19.md) documentation
[Docker Engine API v1.19](v1.19.md) documentation
* When the daemon detects a version mismatch with the client, usually when
the client is newer than the daemon, an HTTP 400 is now returned instead
@@ -232,7 +231,7 @@ end point now returns the new boolean fields `CpuCfsPeriod`, `CpuCfsQuota`, and
## v1.18 API changes
[Docker Remote API v1.18](docker_remote_api_v1.18.md) documentation
[Docker Engine API v1.18](v1.18.md) documentation
* `GET /version` now returns `Os`, `Arch` and `KernelVersion`.
* `POST /containers/create` and `POST /containers/(id)/start`allow you to set ulimit settings for use in the container.
components/engine/docs/extend/plugins_authorization.md
+2 -2
View File
@@ -22,7 +22,7 @@ refer to [Docker Engine plugin system](index.md).
Docker's out-of-the-box authorization model is all or nothing. Any user with
permission to access the Docker daemon can run any Docker client command. The
same is true for callers using Docker's remote API to contact the daemon. If you
same is true for callers using Docker's Engine API to contact the daemon. If you
require greater access control, you can create authorization plugins and add
them to your Docker daemon configuration. Using an authorization plugin, a
Docker administrator can configure granular access policies for managing access
@@ -69,7 +69,7 @@ can be ordered. Each request to the daemon passes in order through the chain.
Only when all the plugins grant access to the resource, is the access granted.
When an HTTP request is made to the Docker daemon through the CLI or via the
remote API, the authentication subsystem passes the request to the installed
Engine API, the authentication subsystem passes the request to the installed
authentication plugin(s). The request contains the user (caller) and command
context. The plugin is responsible for deciding whether to allow or deny the
request.
components/engine/docs/reference/commandline/dockerd.md
+6 -6
View File
@@ -24,7 +24,7 @@ A self-sufficient runtime for containers.
Options:
--add-runtime value Register an additional OCI compatible runtime (default [])
--api-cors-header string Set CORS headers in the remote API
--api-cors-header string Set CORS headers in the Engine API
--authorization-plugin value Authorization plugins to load (default [])
--bip string Specify network bridge IP
-b, --bridge string Attach containers to a network bridge
@@ -101,7 +101,7 @@ To run the daemon with debug output, use `dockerd -D`.
## Daemon socket option
The Docker daemon can listen for [Docker Remote API](../api/docker_remote_api.md)
The Docker daemon can listen for [Docker Engine API](../api/)
requests via three different types of Socket: `unix`, `tcp`, and `fd`.
By default, a `unix` domain socket (or IPC socket) is created at
@@ -905,7 +905,7 @@ path. Consult with your Docker administrator to get information about the
plugins available to you.
Once a plugin is installed, requests made to the `daemon` through the command
line or Docker's remote API are allowed or denied by the plugin. If you have
line or Docker's Engine API are allowed or denied by the plugin. If you have
multiple plugins installed, at least one must allow the request for it to
complete.
@@ -1094,11 +1094,11 @@ the `--cgroup-parent` option on the daemon.
## Daemon Metrics
The `--metrics-addr` option takes a tcp address to serve the metrics API.
This feature is still experimental, therefore, the daemon must be running in experimental
This feature is still experimental, therefore, the daemon must be running in experimental
mode for this feature to work.
To serve the metrics API on localhost:1337 you would specify `--metrics-addr 127.0.0.1:1337`
allowing you to make requests on the API at `127.0.0.1:1337/metrics` to receive metrics in the
allowing you to make requests on the API at `127.0.0.1:1337/metrics` to receive metrics in the
[prometheus](https://prometheus.io/docs/instrumenting/exposition_formats/) format.
If you are running a prometheus server you can add this address to your scrape configs
@@ -1113,7 +1113,7 @@ scrape_configs:
```
Please note that this feature is still marked as experimental as metrics and metric
names could change while this feature is still in experimental. Please provide
names could change while this feature is still in experimental. Please provide
feedback on what you would like to see collected in the API.
## Daemon configuration file