Rename Remote API to Engine API

See https://github.com/docker/docker/issues/28319

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
This commit is contained in:
Ben Firshman 2016-11-16 15:33:01 +00:00 committed by Misty Stanley-Jones
parent 3344f16999
commit 2f3218c2c4
9 changed files with 23 additions and 23 deletions

View File

@ -480,23 +480,23 @@ toc:
- sectiontitle: API Reference - sectiontitle: API Reference
section: section:
- path: /engine/reference/api/docker_remote_api/ - path: /engine/reference/api/docker_remote_api/
title: Remote API title: Engine API
- path: /engine/reference/api/docker_remote_api_v1.24/ - 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/ - 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/ - 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/ - 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/ - 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/ - 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/ - 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/ - path: /engine/reference/api/remote_api_client_libraries/
title: Remote API client libraries title: Engine API client libraries
- path: /engine/migration/ - path: /engine/migration/
title: Migrate to Engine 1.10 title: Migrate to Engine 1.10
- path: /engine/breaking_changes/ - path: /engine/breaking_changes/

View File

@ -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 application is built using Docker objects, such as images and containers, and
Docker resources, such as volumes and networks. 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 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 deploy an image in a Docker container. That image might define a service such as
an Nginx web server or a database like Postgres. an Nginx web server or a database like Postgres.

View File

@ -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? ### 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`. 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: 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:

View File

@ -103,13 +103,13 @@ swarm mode](/engine/swarm/swarm-tutorial/index.md).
### How do I connect to the remote Docker Engine API? ### 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`. 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). 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? ### Why doesn't `nodemon` pick up file changes in a container mounted on a shared drive?

View File

@ -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? ### How does Kitematic work with Docker?
Kitematic connects directly to a running instance of Docker and controls it via 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? ### Which platforms does Kitematic support?

View File

@ -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). manager rules a set of agents (also called nodes or Docker nodes).
Swarm agents are responsible for hosting containers. They are regular docker 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. In this section, you create a swarm manager and two nodes.

View File

@ -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. 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 ### `--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.certfile=/path/to/mycert.pem \
--discovery-opt kv.keyfile=/path/to/mykey.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)

View File

@ -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.) 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 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 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 Remote API can use 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' 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 (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 ## TLS modes with Docker and Swarm

View File

@ -12,7 +12,7 @@ title: Docker Swarm API
The Docker Swarm API is mostly compatible with the [Docker Remote The Docker Swarm API is mostly compatible with the [Docker Remote
API](/engine/reference/api/docker_remote_api/). This API](/engine/reference/api/docker_remote_api/). This
document is an overview of the differences between the Swarm API and the Docker document is an overview of the differences between the Swarm API and the Docker
Remote API. Engine API.
## Missing endpoints ## Missing endpoints