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 25, 2016
1 parent 6eac97e commit c88be30
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 28 deletions.
18 changes: 9 additions & 9 deletions _data/toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -472,23 +472,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
Original file line number Diff line number Diff line change
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
4 changes: 2 additions & 2 deletions docker-for-mac/faqs.md
Original file line number Diff line number Diff line change
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
6 changes: 3 additions & 3 deletions docker-for-windows/faqs.md
Original file line number Diff line number Diff line change
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 kitematic/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,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?

Expand Down Expand Up @@ -59,4 +59,4 @@ kitematic@docker.com or to open an issue on GitHub.
## Next Steps

For information about known issues in the current release of Kitematic, take a
look at the [Known issues](./known-issues.md).
look at the [Known issues](./known-issues.md).
4 changes: 2 additions & 2 deletions swarm/install-w-machine.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,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.
Expand Down Expand Up @@ -257,4 +257,4 @@ At this point, you've installed Docker Swarm by pulling the latest image of
it from Docker Hub. Then, you built and ran a swarm on your local machine
using VirtualBox. If you want, you can onto read an [overview of Docker Swarm
features](index.md). Alternatively, you can develop a more in-depth view of Swarm by
[manually installing Swarm](install-manual.md) on a network.
[manually installing Swarm](install-manual.md) on a network.
6 changes: 3 additions & 3 deletions swarm/reference/manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
8 changes: 4 additions & 4 deletions swarm/secure-swarm-tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,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

Expand Down Expand Up @@ -157,4 +157,4 @@ facing production workloads exposed to untrusted networks.
## Related information

* [Configure Docker Swarm for TLS](configure-tls.md)
* [Docker security](/engine/security/security/)
* [Docker security](/engine/security/security/)
4 changes: 2 additions & 2 deletions swarm/swarm-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,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

Expand Down Expand Up @@ -178,4 +178,4 @@ $ docker run --rm -it yourprivateimage:latest
- [Docker Swarm overview](/swarm/)
- [Discovery options](/swarm/discovery/)
- [Scheduler strategies](/swarm/scheduler/strategy/)
- [Scheduler filters](/swarm/scheduler/filter/)
- [Scheduler filters](/swarm/scheduler/filter/)

0 comments on commit c88be30

Please sign in to comment.