Skip to content

Commit

Permalink
Rename Remote API to Engine API
Browse files Browse the repository at this point in the history
See moby/moby#28319

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
  • Loading branch information
bfirsh committed Nov 16, 2016
1 parent 1862692 commit d43ec54
Show file tree
Hide file tree
Showing 23 changed files with 67 additions and 75 deletions.
18 changes: 9 additions & 9 deletions _data/toc.yaml
Expand Up @@ -464,23 +464,23 @@ toc:
- sectiontitle: API Reference
section:
- path: /engine/reference/api/docker_remote_api/
title: Remote API
title: Engine API
- path: /engine/reference/api/docker_remote_api_v1.24/
title: Remote API v1.24
title: Engine API v1.24
- path: /engine/reference/api/docker_remote_api_v1.23/
title: Remote API v1.23
title: Engine API v1.23
- path: /engine/reference/api/docker_remote_api_v1.22/
title: Remote API v1.22
title: Engine API v1.22
- path: /engine/reference/api/docker_remote_api_v1.21/
title: Remote API v1.21
title: Engine API v1.21
- path: /engine/reference/api/docker_remote_api_v1.20/
title: Remote API v1.20
title: Engine API v1.20
- path: /engine/reference/api/docker_remote_api_v1.19/
title: Remote API v1.19
title: Engine API v1.19
- path: /engine/reference/api/docker_remote_api_v1.18/
title: Remote API v1.18
title: Engine API v1.18
- path: /engine/reference/api/remote_api_client_libraries/
title: Remote API client libraries
title: Engine API client libraries
- path: /engine/migration/
title: Migrate to Engine 1.10
- path: /engine/breaking_changes/
Expand Down
2 changes: 1 addition & 1 deletion datacenter/ucp/1.1/install-sandbox-2.md
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docker-for-mac/faqs.md
Expand Up @@ -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:

Expand Down Expand Up @@ -156,4 +156,4 @@ consume any resources unless Docker.app connects to it, so it's safe to ignore.

### Can I pass through a USB device to a container?

Unfortunately it is not possible to pass through a USB device (or a serial port) to a container. For use cases requiring this, we recommend the use of [Docker Toolbox](/toolbox/overview.md).
Unfortunately it is not possible to pass through a USB device (or a serial port) to a container. For use cases requiring this, we recommend the use of [Docker Toolbox](/toolbox/overview.md).
6 changes: 3 additions & 3 deletions docker-for-windows/faqs.md
Expand Up @@ -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?

Expand Down Expand Up @@ -182,4 +182,4 @@ in [Troubleshooting](troubleshoot.md).
You might decide that you do not need Toolbox now that you have Docker for Windows, and want to uninstall it. For
details on how to perform a clean uninstall of Toolbox on Windows, see [How to
uninstall Toolbox](/toolbox/toolbox_install_windows.md#how-to-uninstall-toolbox)
in the Toolbox Windows topics.
in the Toolbox Windows topics.
4 changes: 2 additions & 2 deletions engine/extend/plugins_authorization.md
Expand Up @@ -13,7 +13,7 @@ experimental status, 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
Expand Down Expand Up @@ -60,7 +60,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.
Expand Down
2 changes: 1 addition & 1 deletion engine/reference/api/README.md
Expand Up @@ -4,7 +4,7 @@ published: false

This directory holds the authoritative specifications of APIs defined and implemented by Docker. Currently this includes:

* The remote API by which a docker node can be queried over HTTP
* The Engine API by which a docker node can be queried over HTTP
* The registry API by which a docker node can download and upload
images for storage and sharing
* The index search API by which a docker node can search the public
Expand Down
18 changes: 9 additions & 9 deletions engine/reference/api/docker_remote_api.md
Expand Up @@ -4,10 +4,10 @@ redirect_from:
description: API Documentation for Docker
keywords:
- API, Docker, rcli, REST, documentation
title: Docker Remote API
title: Docker Engine API
---

Docker's Remote API uses an open schema model. In this model, unknown
Docker's Engine API uses an open schema model. In this model, unknown
properties in incoming messages are ignored. Client applications need to take
this behavior into account to ensure they do not break when talking to newer
Docker daemons.
Expand Down Expand Up @@ -109,7 +109,7 @@ This section lists each version from latest to oldest. Each listing includes a

### v1.24 API changes

[Docker Remote API v1.24](docker_remote_api_v1.24.md) documentation
[Docker Engine API v1.24](docker_remote_api_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.
Expand Down Expand Up @@ -141,7 +141,7 @@ This section lists each version from latest to oldest. Each listing includes a

### v1.23 API changes

[Docker Remote API v1.23](docker_remote_api_v1.23.md) documentation
[Docker Engine API v1.23](docker_remote_api_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.
Expand All @@ -163,7 +163,7 @@ This section lists each version from latest to oldest. Each listing includes a

### v1.22 API changes

[Docker Remote API v1.22](docker_remote_api_v1.22.md) documentation
[Docker Engine API v1.22](docker_remote_api_v1.22.md) documentation

* `POST /container/(name)/update` updates the resources of a container.
* `GET /containers/json` supports filter `isolation` on Windows.
Expand Down Expand Up @@ -197,7 +197,7 @@ This section lists each version from latest to oldest. Each listing includes a

### v1.21 API changes

[Docker Remote API v1.21](docker_remote_api_v1.21.md) documentation
[Docker Engine API v1.21](docker_remote_api_v1.21.md) documentation

* `GET /volumes` lists volumes from all volume drivers.
* `POST /volumes/create` to create a volume.
Expand Down Expand Up @@ -231,7 +231,7 @@ This section lists each version from latest to oldest. Each listing includes a

### v1.20 API changes

[Docker Remote API v1.20](docker_remote_api_v1.20.md) documentation
[Docker Engine API v1.20](docker_remote_api_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
Expand All @@ -243,7 +243,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](docker_remote_api_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
Expand All @@ -259,7 +259,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](docker_remote_api_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.
Expand Down
5 changes: 2 additions & 3 deletions engine/reference/api/docker_remote_api_v1.18.md
Expand Up @@ -4,12 +4,11 @@ redirect_from:
description: API Documentation for Docker
keywords:
- API, Docker, rcli, REST, documentation
title: Docker Remote API v1.18
title: 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`
Expand Down Expand Up @@ -2140,7 +2139,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

Expand Down
5 changes: 2 additions & 3 deletions engine/reference/api/docker_remote_api_v1.19.md
Expand Up @@ -4,12 +4,11 @@ redirect_from:
description: API Documentation for Docker
keywords:
- API, Docker, rcli, REST, documentation
title: Docker Remote API v1.19
title: 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`
Expand Down Expand Up @@ -2220,7 +2219,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

Expand Down
5 changes: 2 additions & 3 deletions engine/reference/api/docker_remote_api_v1.20.md
Expand Up @@ -4,12 +4,11 @@ redirect_from:
description: API Documentation for Docker
keywords:
- API, Docker, rcli, REST, documentation
title: Docker Remote API v1.20
title: 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`
Expand Down Expand Up @@ -2375,7 +2374,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

Expand Down
5 changes: 2 additions & 3 deletions engine/reference/api/docker_remote_api_v1.21.md
Expand Up @@ -4,12 +4,11 @@ redirect_from:
description: API Documentation for Docker
keywords:
- API, Docker, rcli, REST, documentation
title: Docker Remote API v1.21
title: 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`
Expand Down Expand Up @@ -2953,7 +2952,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

Expand Down
5 changes: 2 additions & 3 deletions engine/reference/api/docker_remote_api_v1.22.md
Expand Up @@ -4,12 +4,11 @@ redirect_from:
description: API Documentation for Docker
keywords:
- API, Docker, rcli, REST, documentation
title: Docker Remote API v1.22
title: 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`
Expand Down Expand Up @@ -3288,7 +3287,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

Expand Down
5 changes: 2 additions & 3 deletions engine/reference/api/docker_remote_api_v1.23.md
Expand Up @@ -4,12 +4,11 @@ redirect_from:
description: API Documentation for Docker
keywords:
- API, Docker, rcli, REST, documentation
title: Docker Remote API v1.23
title: 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`
Expand Down Expand Up @@ -3405,7 +3404,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

Expand Down
7 changes: 3 additions & 4 deletions engine/reference/api/docker_remote_api_v1.24.md
Expand Up @@ -4,12 +4,11 @@ redirect_from:
description: API Documentation for Docker
keywords:
- API, Docker, rcli, REST, documentation
title: Docker Remote API v1.24
title: 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`
Expand All @@ -18,7 +17,7 @@ title: Docker Remote API v1.24

# 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"
Expand Down Expand Up @@ -5263,7 +5262,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

Expand Down
7 changes: 3 additions & 4 deletions engine/reference/api/docker_remote_api_v1.25.md
Expand Up @@ -5,12 +5,11 @@ description: API Documentation for Docker
published: false
keywords:
- API, Docker, rcli, REST, documentation
title: Docker Remote API v1.25
title: Docker Engine API v1.25
---

# 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`
Expand All @@ -19,7 +18,7 @@ title: Docker Remote API v1.25

# 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"
Expand Down Expand Up @@ -6135,7 +6134,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

Expand Down
4 changes: 2 additions & 2 deletions engine/reference/api/index.md
Expand Up @@ -7,5 +7,5 @@ keywords:
title: API reference
---

* [Docker Remote API](docker_remote_api.md)
* [Docker Remote API client libraries](remote_api_client_libraries.md)
* [Docker Engine API](docker_remote_api.md)
* [Docker Engine API client libraries](remote_api_client_libraries.md)

0 comments on commit d43ec54

Please sign in to comment.