mirror of https://github.com/docker/cli.git
Rename Remote API to Engine API
Implementation of https://github.com/docker/docker/issues/28319 Signed-off-by: Ben Firshman <ben@firshman.co.uk>
This commit is contained in:
parent
e0ce0361ba
commit
2cfcc8a8fa
|
@ -43,7 +43,7 @@ function __fish_print_docker_repositories --description 'Print a list of docker
|
|||
end
|
||||
|
||||
# common options
|
||||
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"
|
||||
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"
|
||||
complete -c docker -f -n '__fish_docker_no_subcommand' -s b -l bridge -d 'Attach containers to a pre-existing network bridge'
|
||||
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"
|
||||
complete -c docker -f -n '__fish_docker_no_subcommand' -s D -l debug -d 'Enable debug mode'
|
||||
|
|
|
@ -2200,7 +2200,7 @@ __docker_subcommand() {
|
|||
_arguments $(__docker_arguments) \
|
||||
$opts_help \
|
||||
"($help)*--add-runtime=[Register an additional OCI compatible runtime]:runtime:__docker_complete_runtimes" \
|
||||
"($help)--api-cors-header=[CORS headers in the remote API]:CORS headers: " \
|
||||
"($help)--api-cors-header=[CORS headers in the Engine API]:CORS headers: " \
|
||||
"($help)*--authorization-plugin=[Authorization plugins to load]" \
|
||||
"($help -b --bridge)"{-b=,--bridge=}"[Attach containers to a network bridge]:bridge:_net_interfaces" \
|
||||
"($help)--bip=[Network bridge IP]:IP address: " \
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -87,7 +87,7 @@ following format.
|
|||
Set additional OCI compatible runtime.
|
||||
|
||||
**--api-cors-header**=""
|
||||
Set CORS headers in the remote API. Default is cors disabled. Give urls like
|
||||
Set CORS headers in the Engine API. Default is cors disabled. Give urls like
|
||||
"http://foo, http://bar, ...". Give "*" to allow all.
|
||||
|
||||
**--authorization-plugin**=""
|
||||
|
@ -664,7 +664,7 @@ specify a name or 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.
|
||||
|
||||
|
|
Loading…
Reference in New Issue