Browse code

Rename Remote API to Engine API

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

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
(cherry picked from commit f0d55cd081c6e8ad2a8222c787d54f9aae15723f)
Signed-off-by: Victor Vieux <victorvieux@gmail.com>

Ben Firshman authored on 2016/11/16 04:45:20
Showing 33 changed files
... ...
@@ -10,18 +10,18 @@ consumes:
10 10
   - "text/plain"
11 11
 basePath: "/v1.25"
12 12
 info:
13
-  title: "Docker Remote API"
13
+  title: "Docker Engine API"
14 14
   version: "1.25"
15 15
   x-logo:
16 16
     url: "https://docs.docker.com/images/logo-docker-main.png"
17 17
   description: |
18
-    The Docker API is an HTTP REST API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API.
18
+    The Engine API is an HTTP REST API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API.
19 19
 
20
-    Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. [There is example of using `curl` to run a container in the SDK documentation.](#TODO)
20
+    Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls.
21 21
 
22 22
     # Errors
23 23
 
24
-    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:
24
+    The 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:
25 25
 
26 26
     ```
27 27
     {
... ...
@@ -1262,7 +1262,7 @@ definitions:
1262 1262
         x-nullable: false
1263 1263
 
1264 1264
   Plugin:
1265
-    description: "A plugin for the Remote API"
1265
+    description: "A plugin for the Engine API"
1266 1266
     type: "object"
1267 1267
     required: [Settings, Enabled, Config, Name, Tag]
1268 1268
     properties:
... ...
@@ -356,7 +356,7 @@ type SecretRequestOption struct {
356 356
 	Mode   os.FileMode
357 357
 }
358 358
 
359
-// SwarmUnlockKeyResponse contains the response for Remote API:
359
+// SwarmUnlockKeyResponse contains the response for Engine API:
360 360
 // GET /swarm/unlockkey
361 361
 type SwarmUnlockKeyResponse struct {
362 362
 	// UnlockKey is the unlock key in ASCII-armored format.
... ...
@@ -3,7 +3,7 @@ package types
3 3
 // This file was generated by the swagger tool.
4 4
 // Editing this file might prove futile when you re-run the swagger generate command
5 5
 
6
-// Plugin A plugin for the Remote API
6
+// Plugin A plugin for the Engine API
7 7
 // swagger:model Plugin
8 8
 type Plugin struct {
9 9
 
... ...
@@ -5,7 +5,7 @@ import (
5 5
 	"fmt"
6 6
 )
7 7
 
8
-// PluginsListResponse contains the response for the remote API
8
+// PluginsListResponse contains the response for the Engine API
9 9
 type PluginsListResponse []*Plugin
10 10
 
11 11
 const (
... ...
@@ -17,14 +17,14 @@ import (
17 17
 	"github.com/docker/go-connections/nat"
18 18
 )
19 19
 
20
-// ContainerChange contains response of Remote API:
20
+// ContainerChange contains response of Engine API:
21 21
 // GET "/containers/{name:.*}/changes"
22 22
 type ContainerChange struct {
23 23
 	Kind int
24 24
 	Path string
25 25
 }
26 26
 
27
-// ImageHistory contains response of Remote API:
27
+// ImageHistory contains response of Engine API:
28 28
 // GET "/images/{name:.*}/history"
29 29
 type ImageHistory struct {
30 30
 	ID        string `json:"Id"`
... ...
@@ -35,7 +35,7 @@ type ImageHistory struct {
35 35
 	Comment   string
36 36
 }
37 37
 
38
-// ImageDelete contains response of Remote API:
38
+// ImageDelete contains response of Engine API:
39 39
 // DELETE "/images/{name:.*}"
40 40
 type ImageDelete struct {
41 41
 	Untagged string `json:",omitempty"`
... ...
@@ -56,7 +56,7 @@ type RootFS struct {
56 56
 	BaseLayer string   `json:",omitempty"`
57 57
 }
58 58
 
59
-// ImageInspect contains response of Remote API:
59
+// ImageInspect contains response of Engine API:
60 60
 // GET "/images/{name:.*}/json"
61 61
 type ImageInspect struct {
62 62
 	ID              string `json:"Id"`
... ...
@@ -79,7 +79,7 @@ type ImageInspect struct {
79 79
 	RootFS          RootFS
80 80
 }
81 81
 
82
-// Container contains response of Remote API:
82
+// Container contains response of Engine API:
83 83
 // GET "/containers/json"
84 84
 type Container struct {
85 85
 	ID         string `json:"Id"`
... ...
@@ -101,7 +101,7 @@ type Container struct {
101 101
 	Mounts          []MountPoint
102 102
 }
103 103
 
104
-// CopyConfig contains request body of Remote API:
104
+// CopyConfig contains request body of Engine API:
105 105
 // POST "/containers/"+containerID+"/copy"
106 106
 type CopyConfig struct {
107 107
 	Resource string
... ...
@@ -118,28 +118,28 @@ type ContainerPathStat struct {
118 118
 	LinkTarget string      `json:"linkTarget"`
119 119
 }
120 120
 
121
-// ContainerStats contains response of Remote API:
121
+// ContainerStats contains response of Engine API:
122 122
 // GET "/stats"
123 123
 type ContainerStats struct {
124 124
 	Body   io.ReadCloser `json:"body"`
125 125
 	OSType string        `json:"ostype"`
126 126
 }
127 127
 
128
-// ContainerProcessList contains response of Remote API:
128
+// ContainerProcessList contains response of Engine API:
129 129
 // GET "/containers/{name:.*}/top"
130 130
 type ContainerProcessList struct {
131 131
 	Processes [][]string
132 132
 	Titles    []string
133 133
 }
134 134
 
135
-// Ping contains response of Remote API:
135
+// Ping contains response of Engine API:
136 136
 // GET "/_ping"
137 137
 type Ping struct {
138 138
 	APIVersion   string
139 139
 	Experimental bool
140 140
 }
141 141
 
142
-// Version contains response of Remote API:
142
+// Version contains response of Engine API:
143 143
 // GET "/version"
144 144
 type Version struct {
145 145
 	Version       string
... ...
@@ -161,7 +161,7 @@ type Commit struct {
161 161
 	Expected string
162 162
 }
163 163
 
164
-// Info contains response of Remote API:
164
+// Info contains response of Engine API:
165 165
 // GET "/info"
166 166
 type Info struct {
167 167
 	ID                 string
... ...
@@ -339,7 +339,7 @@ type ContainerNode struct {
339 339
 	Labels    map[string]string
340 340
 }
341 341
 
342
-// ContainerJSONBase contains response of Remote API:
342
+// ContainerJSONBase contains response of Engine API:
343 343
 // GET "/containers/{name:.*}/json"
344 344
 type ContainerJSONBase struct {
345 345
 	ID              string `json:"Id"`
... ...
@@ -500,7 +500,7 @@ type Runtime struct {
500 500
 	Args []string `json:"runtimeArgs,omitempty"`
501 501
 }
502 502
 
503
-// DiskUsage contains response of Remote API:
503
+// DiskUsage contains response of Engine API:
504 504
 // GET "/system/df"
505 505
 type DiskUsage struct {
506 506
 	LayersSize int64
... ...
@@ -509,49 +509,49 @@ type DiskUsage struct {
509 509
 	Volumes    []*Volume
510 510
 }
511 511
 
512
-// ImagesPruneConfig contains the configuration for Remote API:
512
+// ImagesPruneConfig contains the configuration for Engine API:
513 513
 // POST "/images/prune"
514 514
 type ImagesPruneConfig struct {
515 515
 	DanglingOnly bool
516 516
 }
517 517
 
518
-// ContainersPruneConfig contains the configuration for Remote API:
518
+// ContainersPruneConfig contains the configuration for Engine API:
519 519
 // POST "/images/prune"
520 520
 type ContainersPruneConfig struct {
521 521
 }
522 522
 
523
-// VolumesPruneConfig contains the configuration for Remote API:
523
+// VolumesPruneConfig contains the configuration for Engine API:
524 524
 // POST "/images/prune"
525 525
 type VolumesPruneConfig struct {
526 526
 }
527 527
 
528
-// NetworksPruneConfig contains the configuration for Remote API:
528
+// NetworksPruneConfig contains the configuration for Engine API:
529 529
 // POST "/networks/prune"
530 530
 type NetworksPruneConfig struct {
531 531
 }
532 532
 
533
-// ContainersPruneReport contains the response for Remote API:
533
+// ContainersPruneReport contains the response for Engine API:
534 534
 // POST "/containers/prune"
535 535
 type ContainersPruneReport struct {
536 536
 	ContainersDeleted []string
537 537
 	SpaceReclaimed    uint64
538 538
 }
539 539
 
540
-// VolumesPruneReport contains the response for Remote API:
540
+// VolumesPruneReport contains the response for Engine API:
541 541
 // POST "/volumes/prune"
542 542
 type VolumesPruneReport struct {
543 543
 	VolumesDeleted []string
544 544
 	SpaceReclaimed uint64
545 545
 }
546 546
 
547
-// ImagesPruneReport contains the response for Remote API:
547
+// ImagesPruneReport contains the response for Engine API:
548 548
 // POST "/images/prune"
549 549
 type ImagesPruneReport struct {
550 550
 	ImagesDeleted  []ImageDelete
551 551
 	SpaceReclaimed uint64
552 552
 }
553 553
 
554
-// NetworksPruneReport contains the response for Remote API:
554
+// NetworksPruneReport contains the response for Engine API:
555 555
 // POST "/networks/prune"
556 556
 type NetworksPruneReport struct {
557 557
 	NetworksDeleted []string
... ...
@@ -1,4 +1,4 @@
1
-## Go client for the Docker Remote API
1
+# Go client for the Docker Engine API
2 2
 
3 3
 The `docker` command uses this package to communicate with the daemon. It can also be used by your own Go applications to do anything the command-line interface does – running containers, pulling images, managing swarms, etc.
4 4
 
... ...
@@ -1,12 +1,12 @@
1 1
 /*
2
-Package client is a Go client for the Docker Remote API.
2
+Package client is a Go client for the Docker Engine API.
3 3
 
4 4
 The "docker" command uses this package to communicate with the daemon. It can also
5 5
 be used by your own Go applications to do anything the command-line interface does
6 6
 – running containers, pulling images, managing swarms, etc.
7 7
 
8
-For more information about the Remote API, see the documentation:
9
-https://docs.docker.com/engine/reference/api/docker_remote_api/
8
+For more information about the Engine API, see the documentation:
9
+https://docs.docker.com/engine/reference/api/
10 10
 
11 11
 Usage
12 12
 
... ...
@@ -70,7 +70,7 @@ func (DetachError) Error() string {
70 70
 type CommonContainer struct {
71 71
 	StreamConfig *stream.Config
72 72
 	// embed for Container to support states directly.
73
-	*State          `json:"State"` // Needed for remote api version <= 1.11
73
+	*State          `json:"State"` // Needed for Engine API version <= 1.11
74 74
 	Root            string         `json:"-"` // Path to the "home" of the container, including metadata.
75 75
 	BaseFS          string         `json:"-"` // Path to the graphdriver mountpoint
76 76
 	RWLayer         layer.RWLayer  `json:"-"`
... ...
@@ -43,7 +43,7 @@ function __fish_print_docker_repositories --description 'Print a list of docker
43 43
 end
44 44
 
45 45
 # common options
46
-complete -c docker -f -n '__fish_docker_no_subcommand' -l api-cors-header -d "Set CORS headers in the remote API. Default is cors disabled"
46
+complete -c docker -f -n '__fish_docker_no_subcommand' -l api-cors-header -d "Set CORS headers in the Engine API. Default is cors disabled"
47 47
 complete -c docker -f -n '__fish_docker_no_subcommand' -s b -l bridge -d 'Attach containers to a pre-existing network bridge'
48 48
 complete -c docker -f -n '__fish_docker_no_subcommand' -l bip -d "Use this CIDR notation address for the network bridge's IP, not compatible with -b"
49 49
 complete -c docker -f -n '__fish_docker_no_subcommand' -s D -l debug -d 'Enable debug mode'
... ...
@@ -2200,7 +2200,7 @@ __docker_subcommand() {
2200 2200
             _arguments $(__docker_arguments) \
2201 2201
                 $opts_help \
2202 2202
                 "($help)*--add-runtime=[Register an additional OCI compatible runtime]:runtime:__docker_complete_runtimes" \
2203
-                "($help)--api-cors-header=[CORS headers in the remote API]:CORS headers: " \
2203
+                "($help)--api-cors-header=[CORS headers in the Engine API]:CORS headers: " \
2204 2204
                 "($help)*--authorization-plugin=[Authorization plugins to load]" \
2205 2205
                 "($help -b --bridge)"{-b=,--bridge=}"[Attach containers to a network bridge]:bridge:_net_interfaces" \
2206 2206
                 "($help)--bip=[Network bridge IP]:IP address: " \
... ...
@@ -18,7 +18,7 @@ meaning you can use Vagrant to control Docker containers.
18 18
 * [docker-provider](https://github.com/fgrehm/docker-provider)
19 19
 * [vagrant-shell](https://github.com/destructuring/vagrant-shell)
20 20
 
21
-## Setting up Vagrant-docker with the Remote API
21
+## Setting up Vagrant-docker with the Engine API
22 22
 
23 23
 The initial Docker upstart script will not work because it runs on `127.0.0.1`, which is not accessible to the host machine. Instead, we need to change the script to connect to `0.0.0.0`. To do this, modify `/etc/init/docker.conf` to look like this:
24 24
 
... ...
@@ -185,7 +185,7 @@ func (config *Config) InstallCommonFlags(flags *pflag.FlagSet) {
185 185
 	flags.StringVar(&config.ClusterAdvertise, "cluster-advertise", "", "Address or interface name to advertise")
186 186
 	flags.StringVar(&config.ClusterStore, "cluster-store", "", "URL of the distributed storage backend")
187 187
 	flags.Var(opts.NewNamedMapOpts("cluster-store-opts", config.ClusterOpts, nil), "cluster-store-opt", "Set cluster store options")
188
-	flags.StringVar(&config.CorsHeaders, "api-cors-header", "", "Set CORS headers in the remote API")
188
+	flags.StringVar(&config.CorsHeaders, "api-cors-header", "", "Set CORS headers in the Engine API")
189 189
 	flags.IntVar(&maxConcurrentDownloads, "max-concurrent-downloads", defaultMaxConcurrentDownloads, "Set the max concurrent downloads for each pull")
190 190
 	flags.IntVar(&maxConcurrentUploads, "max-concurrent-uploads", defaultMaxConcurrentUploads, "Set the max concurrent uploads for each push")
191 191
 	flags.IntVar(&config.ShutdownTimeout, "shutdown-timeout", defaultShutdownTimeout, "Set the default shutdown timeout")
... ...
@@ -77,7 +77,7 @@ func (config *Config) InstallFlags(flags *pflag.FlagSet) {
77 77
 	flags.StringVar(&config.bridgeConfig.FixedCIDRv6, "fixed-cidr-v6", "", "IPv6 subnet for fixed IPs")
78 78
 	flags.BoolVar(&config.bridgeConfig.EnableUserlandProxy, "userland-proxy", true, "Use userland proxy for loopback traffic")
79 79
 	flags.StringVar(&config.bridgeConfig.UserlandProxyPath, "userland-proxy-path", "", "Path to the userland proxy binary")
80
-	flags.BoolVar(&config.EnableCors, "api-enable-cors", false, "Enable CORS headers in the remote API, this is deprecated by --api-cors-header")
80
+	flags.BoolVar(&config.EnableCors, "api-enable-cors", false, "Enable CORS headers in the Engine API, this is deprecated by --api-cors-header")
81 81
 	flags.MarkDeprecated("api-enable-cors", "Please use --api-cors-header")
82 82
 	flags.StringVar(&config.CgroupParent, "cgroup-parent", "", "Set parent cgroup for all containers")
83 83
 	flags.StringVar(&config.RemappedRoot, "userns-remap", "", "User/Group setting for user namespaces")
... ...
@@ -221,7 +221,7 @@ func (daemon *Daemon) setRWLayer(container *container.Container) error {
221 221
 }
222 222
 
223 223
 // VolumeCreate creates a volume with the specified name, driver, and opts
224
-// This is called directly from the remote API
224
+// This is called directly from the Engine API
225 225
 func (daemon *Daemon) VolumeCreate(name, driverName string, opts, labels map[string]string) (*types.Volume, error) {
226 226
 	if name == "" {
227 227
 		name = stringid.GenerateNonCryptoID()
... ...
@@ -140,7 +140,7 @@ func (daemon *Daemon) cleanupContainer(container *container.Container, forceRemo
140 140
 
141 141
 // VolumeRm removes the volume with the given name.
142 142
 // If the volume is referenced by a container it is not removed
143
-// This is called directly from the remote API
143
+// This is called directly from the Engine API
144 144
 func (daemon *Daemon) VolumeRm(name string, force bool) error {
145 145
 	err := daemon.volumeRm(name)
146 146
 	if err == nil || force {
... ...
@@ -27,7 +27,7 @@ const termProcessTimeout = 10
27 27
 func (d *Daemon) registerExecCommand(container *container.Container, config *exec.Config) {
28 28
 	// Storing execs in container in order to kill them gracefully whenever the container is stopped or removed.
29 29
 	container.ExecCommands.Add(config.ID, config)
30
-	// Storing execs in daemon for easy access via remote API.
30
+	// Storing execs in daemon for easy access via Engine API.
31 31
 	d.execCommands.Add(config.ID, config)
32 32
 }
33 33
 
... ...
@@ -23,7 +23,7 @@ func (daemon *Daemon) ContainerStats(ctx context.Context, prefixOrName string, c
23 23
 	if runtime.GOOS == "solaris" {
24 24
 		return fmt.Errorf("%+v does not support stats", runtime.GOOS)
25 25
 	}
26
-	// Remote API version (used for backwards compatibility)
26
+	// Engine API version (used for backwards compatibility)
27 27
 	apiVersion := config.Version
28 28
 
29 29
 	container, err := daemon.GetContainer(prefixOrName)
... ...
@@ -26,7 +26,7 @@ var (
26 26
 
27 27
 type mounts []container.Mount
28 28
 
29
-// volumeToAPIType converts a volume.Volume to the type used by the remote API
29
+// volumeToAPIType converts a volume.Volume to the type used by the Engine API
30 30
 func volumeToAPIType(v volume.Volume) *types.Volume {
31 31
 	tv := &types.Volume{
32 32
 		Name:   v.Name(),
... ...
@@ -1,5 +1,5 @@
1 1
 ---
2
-title: "Remote API v1.18"
2
+title: "Engine API v1.18"
3 3
 description: "API Documentation for Docker"
4 4
 keywords: "API, Docker, rcli, REST, documentation"
5 5
 redirect_from:
... ...
@@ -16,11 +16,10 @@ redirect_from:
16 16
      will be rejected.
17 17
 -->
18 18
 
19
-# Docker Remote API v1.18
19
+# Docker Engine API v1.18
20 20
 
21 21
 # 1. Brief introduction
22 22
 
23
- - The Remote API has replaced `rcli`.
24 23
  - The daemon listens on `unix:///var/run/docker.sock` but you can
25 24
    [Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
26 25
  - The API tends to be REST, but for some complex commands, like `attach`
... ...
@@ -2151,7 +2150,7 @@ This might change in the future.
2151 2151
 
2152 2152
 ## 3.3 CORS Requests
2153 2153
 
2154
-To set cross origin requests to the remote api please give values to
2154
+To set cross origin requests to the Engine API please give values to
2155 2155
 `--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
2156 2156
 default or blank means CORS disabled
2157 2157
 
... ...
@@ -1,5 +1,5 @@
1 1
 ---
2
-title: "Remote API v1.19"
2
+title: "Engine API v1.19"
3 3
 description: "API Documentation for Docker"
4 4
 keywords: "API, Docker, rcli, REST, documentation"
5 5
 redirect_from:
... ...
@@ -16,11 +16,10 @@ redirect_from:
16 16
      will be rejected.
17 17
 -->
18 18
 
19
-# Docker Remote API v1.19
19
+# Docker Engine API v1.19
20 20
 
21 21
 ## 1. Brief introduction
22 22
 
23
- - The Remote API has replaced `rcli`.
24 23
  - The daemon listens on `unix:///var/run/docker.sock` but you can
25 24
    [Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
26 25
  - 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.
2233 2233
 
2234 2234
 ## 3.3 CORS Requests
2235 2235
 
2236
-To set cross origin requests to the remote api please give values to
2236
+To set cross origin requests to the Engine API please give values to
2237 2237
 `--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
2238 2238
 default or blank means CORS disabled
2239 2239
 
... ...
@@ -1,5 +1,5 @@
1 1
 ---
2
-title: "Remote API v1.20"
2
+title: "Engine API v1.20"
3 3
 description: "API Documentation for Docker"
4 4
 keywords: "API, Docker, rcli, REST, documentation"
5 5
 redirect_from:
... ...
@@ -16,11 +16,10 @@ redirect_from:
16 16
      will be rejected.
17 17
 -->
18 18
 
19
-# Docker Remote API v1.20
19
+# Docker Engine API v1.20
20 20
 
21 21
 # 1. Brief introduction
22 22
 
23
- - The Remote API has replaced `rcli`.
24 23
  - The daemon listens on `unix:///var/run/docker.sock` but you can
25 24
    [Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
26 25
  - 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.
2386 2386
 
2387 2387
 ## 3.3 CORS Requests
2388 2388
 
2389
-To set cross origin requests to the remote api please give values to
2389
+To set cross origin requests to the Engine API please give values to
2390 2390
 `--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
2391 2391
 default or blank means CORS disabled
2392 2392
 
... ...
@@ -1,5 +1,5 @@
1 1
 ---
2
-title: "Remote API v1.21"
2
+title: "Engine API v1.21"
3 3
 description: "API Documentation for Docker"
4 4
 keywords: "API, Docker, rcli, REST, documentation"
5 5
 redirect_from:
... ...
@@ -16,11 +16,10 @@ redirect_from:
16 16
      will be rejected.
17 17
 -->
18 18
 
19
-# Docker Remote API v1.21
19
+# Docker Engine API v1.21
20 20
 
21 21
 ## 1. Brief introduction
22 22
 
23
- - The Remote API has replaced `rcli`.
24 23
  - The daemon listens on `unix:///var/run/docker.sock` but you can
25 24
    [Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
26 25
  - 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.
2964 2964
 
2965 2965
 ## 3.3 CORS Requests
2966 2966
 
2967
-To set cross origin requests to the remote api please give values to
2967
+To set cross origin requests to the Engine API please give values to
2968 2968
 `--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
2969 2969
 default or blank means CORS disabled
2970 2970
 
... ...
@@ -1,5 +1,5 @@
1 1
 ---
2
-title: "Remote API v1.22"
2
+title: "Engine API v1.22"
3 3
 description: "API Documentation for Docker"
4 4
 keywords: "API, Docker, rcli, REST, documentation"
5 5
 redirect_from:
... ...
@@ -16,11 +16,10 @@ redirect_from:
16 16
      will be rejected.
17 17
 -->
18 18
 
19
-# Docker Remote API v1.22
19
+# Docker Engine API v1.22
20 20
 
21 21
 # 1. Brief introduction
22 22
 
23
- - The Remote API has replaced `rcli`.
24 23
  - The daemon listens on `unix:///var/run/docker.sock` but you can
25 24
    [Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
26 25
  - 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.
3302 3302
 
3303 3303
 ## 3.3 CORS Requests
3304 3304
 
3305
-To set cross origin requests to the remote api please give values to
3305
+To set cross origin requests to the Engine API please give values to
3306 3306
 `--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
3307 3307
 default or blank means CORS disabled
3308 3308
 
... ...
@@ -1,5 +1,5 @@
1 1
 ---
2
-title: "Remote API v1.23"
2
+title: "Engine API v1.23"
3 3
 description: "API Documentation for Docker"
4 4
 keywords: "API, Docker, rcli, REST, documentation"
5 5
 redirect_from:
... ...
@@ -16,11 +16,10 @@ redirect_from:
16 16
      will be rejected.
17 17
 -->
18 18
 
19
-# Docker Remote API v1.23
19
+# Docker Engine API v1.23
20 20
 
21 21
 ## 1. Brief introduction
22 22
 
23
- - The Remote API has replaced `rcli`.
24 23
  - The daemon listens on `unix:///var/run/docker.sock` but you can
25 24
    [Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
26 25
  - 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.
3419 3419
 
3420 3420
 ## 3.3 CORS Requests
3421 3421
 
3422
-To set cross origin requests to the remote api please give values to
3422
+To set cross origin requests to the Engine API please give values to
3423 3423
 `--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
3424 3424
 default or blank means CORS disabled
3425 3425
 
... ...
@@ -1,5 +1,5 @@
1 1
 ---
2
-title: "Remote API v1.24"
2
+title: "Engine API v1.24"
3 3
 description: "API Documentation for Docker"
4 4
 keywords: "API, Docker, rcli, REST, documentation"
5 5
 redirect_from:
... ...
@@ -16,11 +16,10 @@ redirect_from:
16 16
      will be rejected.
17 17
 -->
18 18
 
19
-# Docker Remote API v1.24
19
+# Docker Engine API v1.24
20 20
 
21 21
 # 1. Brief introduction
22 22
 
23
- - The Remote API has replaced `rcli`.
24 23
  - The daemon listens on `unix:///var/run/docker.sock` but you can
25 24
    [Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
26 25
  - The API tends to be REST. However, for some complex commands, like `attach`
... ...
@@ -29,7 +28,7 @@ redirect_from:
29 29
 
30 30
 # 2. Errors
31 31
 
32
-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:
32
+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:
33 33
 
34 34
     {
35 35
         "message": "page not found"
... ...
@@ -5277,7 +5276,7 @@ from **200 OK** to **101 UPGRADED** and resends the same headers.
5277 5277
 
5278 5278
 ## 4.3 CORS Requests
5279 5279
 
5280
-To set cross origin requests to the remote api please give values to
5280
+To set cross origin requests to the Engine API please give values to
5281 5281
 `--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
5282 5282
 default or blank means CORS disabled
5283 5283
 
... ...
@@ -1,5 +1,5 @@
1 1
 ---
2
-title: "Remote API version history"
2
+title: "Engine API version history"
3 3
 description: "Documentation of changes that have been made to Engine API."
4 4
 keywords: "API, Docker, rcli, REST, documentation"
5 5
 ---
... ...
@@ -15,7 +15,7 @@ keywords: "API, Docker, rcli, REST, documentation"
15 15
 
16 16
 ## v1.25 API changes
17 17
 
18
-[Docker Remote API v1.25](docker_remote_api_v1.25.md) documentation
18
+[Docker Engine API v1.25](v1.25.md) documentation
19 19
 
20 20
 * 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`.
21 21
 * `GET /version` now returns `MinAPIVersion`.
... ...
@@ -76,7 +76,7 @@ keywords: "API, Docker, rcli, REST, documentation"
76 76
 
77 77
 ## v1.24 API changes
78 78
 
79
-[Docker Remote API v1.24](docker_remote_api_v1.24.md) documentation
79
+[Docker Engine API v1.24](v1.24.md) documentation
80 80
 
81 81
 * `POST /containers/create` now takes `StorageOpt` field.
82 82
 * `GET /info` now returns `SecurityOptions` field, showing if `apparmor`, `seccomp`, or `selinux` is supported.
... ...
@@ -108,7 +108,7 @@ keywords: "API, Docker, rcli, REST, documentation"
108 108
 
109 109
 ## v1.23 API changes
110 110
 
111
-[Docker Remote API v1.23](docker_remote_api_v1.23.md) documentation
111
+[Docker Engine API v1.23](v1.23.md) documentation
112 112
 
113 113
 * `GET /containers/json` returns the state of the container, one of `created`, `restarting`, `running`, `paused`, `exited` or `dead`.
114 114
 * `GET /containers/json` returns the mount points for the container.
... ...
@@ -130,7 +130,7 @@ keywords: "API, Docker, rcli, REST, documentation"
130 130
 
131 131
 ## v1.22 API changes
132 132
 
133
-[Docker Remote API v1.22](docker_remote_api_v1.22.md) documentation
133
+[Docker Engine API v1.22](v1.22.md) documentation
134 134
 
135 135
 * `POST /container/(name)/update` updates the resources of a container.
136 136
 * `GET /containers/json` supports filter `isolation` on Windows.
... ...
@@ -164,7 +164,7 @@ keywords: "API, Docker, rcli, REST, documentation"
164 164
 
165 165
 ## v1.21 API changes
166 166
 
167
-[Docker Remote API v1.21](docker_remote_api_v1.21.md) documentation
167
+[Docker Engine API v1.21](v1.21.md) documentation
168 168
 
169 169
 * `GET /volumes` lists volumes from all volume drivers.
170 170
 * `POST /volumes/create` to create a volume.
... ...
@@ -199,7 +199,7 @@ keywords: "API, Docker, rcli, REST, documentation"
199 199
 
200 200
 ## v1.20 API changes
201 201
 
202
-[Docker Remote API v1.20](docker_remote_api_v1.20.md) documentation
202
+[Docker Engine API v1.20](v1.20.md) documentation
203 203
 
204 204
 * `GET /containers/(id)/archive` get an archive of filesystem content from a container.
205 205
 * `PUT /containers/(id)/archive` upload an archive of content to be extracted to
... ...
@@ -211,7 +211,7 @@ list of additional groups that the container process will run as.
211 211
 
212 212
 ## v1.19 API changes
213 213
 
214
-[Docker Remote API v1.19](docker_remote_api_v1.19.md) documentation
214
+[Docker Engine API v1.19](v1.19.md) documentation
215 215
 
216 216
 * When the daemon detects a version mismatch with the client, usually when
217 217
 the client is newer than the daemon, an HTTP 400 is now returned instead
... ...
@@ -227,7 +227,7 @@ end point now returns the new boolean fields `CpuCfsPeriod`, `CpuCfsQuota`, and
227 227
 
228 228
 ## v1.18 API changes
229 229
 
230
-[Docker Remote API v1.18](docker_remote_api_v1.18.md) documentation
230
+[Docker Engine API v1.18](v1.18.md) documentation
231 231
 
232 232
 * `GET /version` now returns `Os`, `Arch` and `KernelVersion`.
233 233
 * `POST /containers/create` and `POST /containers/(id)/start`allow you to  set ulimit settings for use in the container.
... ...
@@ -22,7 +22,7 @@ refer to [Docker Engine plugin system](index.md).
22 22
 
23 23
 Docker's out-of-the-box authorization model is all or nothing. Any user with
24 24
 permission to access the Docker daemon can run any Docker client command. The
25
-same is true for callers using Docker's remote API to contact the daemon. If you
25
+same is true for callers using Docker's Engine API to contact the daemon. If you
26 26
 require greater access control, you can create authorization plugins and add
27 27
 them to your Docker daemon configuration. Using an authorization plugin, a
28 28
 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.
69 69
 Only when all the plugins grant access to the resource, is the access granted.
70 70
 
71 71
 When an HTTP request is made to the Docker daemon through the CLI or via the
72
-remote API, the authentication subsystem passes the request to the installed
72
+Engine API, the authentication subsystem passes the request to the installed
73 73
 authentication plugin(s). The request contains the user (caller) and command
74 74
 context. The plugin is responsible for deciding whether to allow or deny the
75 75
 request.
... ...
@@ -24,7 +24,7 @@ A self-sufficient runtime for containers.
24 24
 Options:
25 25
 
26 26
       --add-runtime value                     Register an additional OCI compatible runtime (default [])
27
-      --api-cors-header string                Set CORS headers in the remote API
27
+      --api-cors-header string                Set CORS headers in the Engine API
28 28
       --authorization-plugin value            Authorization plugins to load (default [])
29 29
       --bip string                            Specify network bridge IP
30 30
   -b, --bridge string                         Attach containers to a network bridge
... ...
@@ -101,7 +101,7 @@ To run the daemon with debug output, use `dockerd -D`.
101 101
 
102 102
 ## Daemon socket option
103 103
 
104
-The Docker daemon can listen for [Docker Remote API](../api/docker_remote_api.md)
104
+The Docker daemon can listen for [Docker Engine API](../api/)
105 105
 requests via three different types of Socket: `unix`, `tcp`, and `fd`.
106 106
 
107 107
 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
905 905
 plugins available to you.
906 906
 
907 907
 Once a plugin is installed, requests made to the `daemon` through the command
908
-line or Docker's remote API are allowed or denied by the plugin.  If you have
908
+line or Docker's Engine API are allowed or denied by the plugin.  If you have
909 909
 multiple plugins installed, at least one must allow the request for it to
910 910
 complete.
911 911
 
... ...
@@ -1094,11 +1094,11 @@ the `--cgroup-parent` option on the daemon.
1094 1094
 ## Daemon Metrics
1095 1095
 
1096 1096
 The `--metrics-addr` option takes a tcp address to serve the metrics API.
1097
-This feature is still experimental, therefore, the daemon must be running in experimental 
1097
+This feature is still experimental, therefore, the daemon must be running in experimental
1098 1098
 mode for this feature to work.
1099 1099
 
1100 1100
 To serve the metrics API on localhost:1337 you would specify `--metrics-addr 127.0.0.1:1337`
1101
-allowing you to make requests on the API at `127.0.0.1:1337/metrics` to receive metrics in the 
1101
+allowing you to make requests on the API at `127.0.0.1:1337/metrics` to receive metrics in the
1102 1102
 [prometheus](https://prometheus.io/docs/instrumenting/exposition_formats/) format.
1103 1103
 
1104 1104
 If you are running a prometheus server you can add this address to your scrape configs
... ...
@@ -1113,7 +1113,7 @@ scrape_configs:
1113 1113
 ```
1114 1114
 
1115 1115
 Please note that this feature is still marked as experimental as metrics and metric
1116
-names could change while this feature is still in experimental.  Please provide 
1116
+names could change while this feature is still in experimental.  Please provide
1117 1117
 feedback on what you would like to see collected in the API.
1118 1118
 
1119 1119
 ## Daemon configuration file
... ...
@@ -303,7 +303,7 @@ func (s *DockerSuite) TestAPIStatsNoStreamConnectedContainers(c *check.C) {
303 303
 
304 304
 	select {
305 305
 	case err := <-ch:
306
-		c.Assert(err, checker.IsNil, check.Commentf("Error in stats remote API: %v", err))
306
+		c.Assert(err, checker.IsNil, check.Commentf("Error in stats Engine API: %v", err))
307 307
 	case <-time.After(15 * time.Second):
308 308
 		c.Fatalf("Stats did not return after timeout")
309 309
 	}
... ...
@@ -87,7 +87,7 @@ following format.
87 87
   Set additional OCI compatible runtime.
88 88
 
89 89
 **--api-cors-header**=""
90
-  Set CORS headers in the remote API. Default is cors disabled. Give urls like
90
+  Set CORS headers in the Engine API. Default is cors disabled. Give urls like
91 91
   "http://foo, http://bar, ...". Give "*" to allow all.
92 92
 
93 93
 **--authorization-plugin**=""
... ...
@@ -664,7 +664,7 @@ specify a name or path. Consult with your Docker administrator to get
664 664
 information about the plugins available to you.
665 665
 
666 666
 Once a plugin is installed, requests made to the `daemon` through the command
667
-line or Docker's remote API are allowed or denied by the plugin.  If you have
667
+line or Docker's Engine API are allowed or denied by the plugin.  If you have
668 668
 multiple plugins installed, at least one must allow the request for it to
669 669
 complete.
670 670
 
... ...
@@ -20,7 +20,7 @@ const maxBodySize = 1048576 // 1MB
20 20
 // Authenticate Request:
21 21
 // Call authZ plugins with current REST request and AuthN response
22 22
 // Request contains full HTTP packet sent to the docker daemon
23
-// https://docs.docker.com/engine/reference/api/docker_remote_api/
23
+// https://docs.docker.com/engine/reference/api/
24 24
 //
25 25
 // Authenticate Response:
26 26
 // Call authZ plugins with full info about current REST request, REST response and AuthN response
... ...
@@ -117,7 +117,7 @@ If releasing a major version (X or Y increased in vX.Y.Z), simply listing notabl
117 117
 ```markdown
118 118
 #### Notable features since <last major version>
119 119
 * New docker command to do something useful
120
-* Remote API change (deprecating old version)
120
+* Engine API change (deprecating old version)
121 121
 * Performance improvements in some usecases
122 122
 * ...
123 123
 ```
... ...
@@ -131,7 +131,7 @@ Each change should be listed under a category heading formatted as `#### CATEGOR
131 131
   * Documentation
132 132
   * Hack
133 133
   * Packaging
134
-  * Remote API
134
+  * Engine API
135 135
   * Runtime
136 136
   * Other (please use this category sparingly)
137 137
 
... ...
@@ -154,7 +154,7 @@ EXAMPLES:
154 154
 
155 155
 + 'docker build -t FOO .' applies the tag FOO to the newly built image
156 156
 
157
-#### Remote API
157
+#### Engine API
158 158
 
159 159
 - Fix a bug in the optional unix socket transport
160 160
 
... ...
@@ -181,7 +181,7 @@ Possible transitions from this state:
181 181
 After merging a pull request, the maintainer should consider applying one or multiple impact labels
182 182
 to ease future classification:
183 183
 
184
- * `impact/api` signifies the patch impacted the remote API
184
+ * `impact/api` signifies the patch impacted the Engine API
185 185
  * `impact/changelog` signifies the change is significant enough to make it in the changelog
186 186
  * `impact/cli` signifies the patch impacted a CLI command
187 187
  * `impact/dockerfile` signifies the patch impacted the Dockerfile syntax