From 7f6a7ed8d1a803ab6b2bc2e3b1fc68799374bdc6 Mon Sep 17 00:00:00 2001 From: Tibor Vass Date: Tue, 12 Jan 2016 19:38:18 -0500 Subject: [PATCH] Rename authz to authorization for greater clarity Signed-off-by: Tibor Vass --- contrib/completion/bash/docker | 4 ++-- contrib/completion/zsh/_docker | 2 +- docs/extend/authorization.md | 13 ++++++++----- docs/reference/commandline/daemon.md | 6 +++--- man/docker-daemon.8.md | 8 ++++---- 5 files changed, 18 insertions(+), 15 deletions(-) diff --git a/contrib/completion/bash/docker b/contrib/completion/bash/docker index c119b5eb93..53c58a9cf7 100644 --- a/contrib/completion/bash/docker +++ b/contrib/completion/bash/docker @@ -685,7 +685,7 @@ _docker_daemon() { local options_with_args=" $global_options_with_args --api-cors-header - --authz-plugin + --authorization-plugin --bip --bridge -b --cgroup-parent @@ -717,7 +717,7 @@ _docker_daemon() { " case "$prev" in - --authz-plugin) + --authorization-plugin) __docker_complete_plugins Authorization return ;; diff --git a/contrib/completion/zsh/_docker b/contrib/completion/zsh/_docker index fff050c2df..df344a069f 100644 --- a/contrib/completion/zsh/_docker +++ b/contrib/completion/zsh/_docker @@ -590,7 +590,7 @@ __docker_subcommand() { _arguments $(__docker_arguments) \ $opts_help \ "($help)--api-cors-header=[Set CORS headers in the remote API]:CORS headers: " \ - "($help)*--authz-plugin=[Set authorization plugins to load]" \ + "($help)*--authorization-plugin=[Set authorization plugins to load]" \ "($help -b --bridge)"{-b=,--bridge=}"[Attach containers to a network bridge]:bridge:_net_interfaces" \ "($help)--bip=[Specify network bridge IP]" \ "($help)--cgroup-parent=[Set parent cgroup for all containers]:cgroup: " \ diff --git a/docs/extend/authorization.md b/docs/extend/authorization.md index 80fa6c94b1..48790833cf 100644 --- a/docs/extend/authorization.md +++ b/docs/extend/authorization.md @@ -12,7 +12,7 @@ weight = -1 # Create an authorization plugin -Docker’s out-of-the-box authorization model is all or nothing. Any user with +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 require greater access control, you can create authorization plugins and add @@ -45,6 +45,9 @@ Authorization plugins must follow the rules described in [Docker Plugin API](plu Each plugin must reside within directories described under the [Plugin discovery](plugin_api.md#plugin-discovery) section. +**Note**: the abbreviations `AuthZ` and `AuthN` mean authorization and authentication +respectively. + ## Basic architecture You are responsible for registering your plugin as part of the Docker daemon @@ -93,14 +96,14 @@ support the Docker client interactions detailed in this section. ### Setting up Docker daemon Enable the authorization plugin with a dedicated command line flag in the -`--authz-plugin=PLUGIN_ID` format. The flag supplies a `PLUGIN_ID` value. -This value can be the plugin’s socket or a path to a specification file. +`--authorization-plugin=PLUGIN_ID` format. The flag supplies a `PLUGIN_ID` +value. This value can be the plugin’s socket or a path to a specification file. ```bash -$ docker daemon --authz-plugin=plugin1 --authz-plugin=plugin2,... +$ docker daemon --authorization-plugin=plugin1 --authorization-plugin=plugin2,... ``` -Docker's authorization subsystem supports multiple `--authz-plugin` parameters. +Docker's authorization subsystem supports multiple `--authorization-plugin` parameters. ### Calling authorized command (allow) diff --git a/docs/reference/commandline/daemon.md b/docs/reference/commandline/daemon.md index 8bc30a8eca..11bc223dc8 100644 --- a/docs/reference/commandline/daemon.md +++ b/docs/reference/commandline/daemon.md @@ -17,7 +17,7 @@ weight = -1 Options: --api-cors-header="" Set CORS headers in the remote API - --authz-plugin=[] Set authorization plugins to load + --authorization-plugin=[] Set authorization plugins to load -b, --bridge="" Attach containers to a network bridge --bip="" Specify network bridge IP --cgroup-parent= Set parent cgroup for all containers @@ -613,10 +613,10 @@ The currently supported cluster store options are: Docker's access authorization can be extended by authorization plugins that your organization can purchase or build themselves. You can install one or more authorization plugins when you start the Docker `daemon` using the -`--authz-plugin=PLUGIN_ID` option. +`--authorization-plugin=PLUGIN_ID` option. ```bash -docker daemon --authz-plugin=plugin1 --authz-plugin=plugin2,... +docker daemon --authorization-plugin=plugin1 --authorization-plugin=plugin2,... ``` The `PLUGIN_ID` value is either the plugin's name or a path to its specification diff --git a/man/docker-daemon.8.md b/man/docker-daemon.8.md index 8e4a3acc0b..233a6c8433 100644 --- a/man/docker-daemon.8.md +++ b/man/docker-daemon.8.md @@ -7,7 +7,7 @@ docker-daemon - Enable daemon mode # SYNOPSIS **docker daemon** [**--api-cors-header**=[=*API-CORS-HEADER*]] -[**--authz-plugin**[=*[]*]] +[**--authorization-plugin**[=*[]*]] [**-b**|**--bridge**[=*BRIDGE*]] [**--bip**[=*BIP*]] [**--cgroup-parent**[=*[]*]] @@ -73,7 +73,7 @@ format. **--api-cors-header**="" Set CORS headers in the remote API. Default is cors disabled. Give urls like "http://foo, http://bar, ...". Give "*" to allow all. -**--authz-plugin**="" +**--authorization-plugin**="" Set authorization plugins to load **-b**, **--bridge**="" @@ -473,10 +473,10 @@ Key/Value store. Docker's access authorization can be extended by authorization plugins that your organization can purchase or build themselves. You can install one or more authorization plugins when you start the Docker `daemon` using the -`--authz-plugin=PLUGIN_ID` option. +`--authorization-plugin=PLUGIN_ID` option. ```bash -docker daemon --authz-plugin=plugin1 --authz-plugin=plugin2,... +docker daemon --authorization-plugin=plugin1 --authorization-plugin=plugin2,... ``` The `PLUGIN_ID` value is either the plugin's name or a path to its specification