From 6353f993d9c5e05ae5cc1c235de7d23cae7c5bd7 Mon Sep 17 00:00:00 2001 From: yuexiao-wang Date: Fri, 28 Apr 2017 05:24:49 +0800 Subject: [PATCH] fix some typos for plugin Signed-off-by: yuexiao-wang --- docs/reference/commandline/index.md | 2 +- docs/reference/commandline/plugin_create.md | 1 + docs/reference/commandline/plugin_disable.md | 2 +- docs/reference/commandline/plugin_inspect.md | 1 - docs/reference/commandline/plugin_ls.md | 2 -- docs/reference/commandline/plugin_push.md | 1 + docs/reference/commandline/plugin_rm.md | 2 ++ docs/reference/commandline/plugin_set.md | 5 +++++ docs/reference/commandline/plugin_upgrade.md | 12 ++++++++++++ 9 files changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/reference/commandline/index.md b/docs/reference/commandline/index.md index 3c978cc2b0..c000082fab 100644 --- a/docs/reference/commandline/index.md +++ b/docs/reference/commandline/index.md @@ -175,7 +175,7 @@ read the [`dockerd`](dockerd.md) reference page. |:--------|:-------------------------------------------------------------------| | [plugin create](plugin_create.md) | Create a plugin from a rootfs and configuration | | [plugin disable](plugin_disable.md) | Disable a plugin | -| [plugin enbale](plugin_enable.md) | Enable a plugin | +| [plugin enable](plugin_enable.md) | Enable a plugin | | [plugin inspect](plugin_inspect.md) | Display detailed information on a plugin | | [plugin install](plugin_install.md) | Install a plugin | | [plugin ls](plugin_ls.md) | List plugins | diff --git a/docs/reference/commandline/plugin_create.md b/docs/reference/commandline/plugin_create.md index 6f1754326b..5f16ac3e43 100644 --- a/docs/reference/commandline/plugin_create.md +++ b/docs/reference/commandline/plugin_create.md @@ -37,6 +37,7 @@ The following example shows how to create a sample `plugin`. ```bash $ ls -ls /home/pluginDir +total 4 4 -rw-r--r-- 1 root root 431 Nov 7 01:40 config.json 0 drwxr-xr-x 19 root root 420 Nov 7 01:40 rootfs diff --git a/docs/reference/commandline/plugin_disable.md b/docs/reference/commandline/plugin_disable.md index 2ff81887f7..fa1327b0c7 100644 --- a/docs/reference/commandline/plugin_disable.md +++ b/docs/reference/commandline/plugin_disable.md @@ -29,7 +29,7 @@ Options: Disables a plugin. The plugin must be installed before it can be disabled, see [`docker plugin install`](plugin_install.md). Without the `-f` option, -a plugin that has references (eg, volumes, networks) cannot be disabled. +a plugin that has references (e.g., volumes, networks) cannot be disabled. ## Examples diff --git a/docs/reference/commandline/plugin_inspect.md b/docs/reference/commandline/plugin_inspect.md index c0e6573cb8..e1a6403343 100644 --- a/docs/reference/commandline/plugin_inspect.md +++ b/docs/reference/commandline/plugin_inspect.md @@ -153,7 +153,6 @@ $ docker plugin inspect -f '{{.Id}}' tiborvass/sample-volume-plugin:latest 8c74c978c434745c3ade82f1bc0acf38d04990eaf494fa507c16d9f1daa99c21 ``` - ## Related commands * [plugin create](plugin_create.md) diff --git a/docs/reference/commandline/plugin_ls.md b/docs/reference/commandline/plugin_ls.md index e5793dc21d..7808c79f6d 100644 --- a/docs/reference/commandline/plugin_ls.md +++ b/docs/reference/commandline/plugin_ls.md @@ -77,7 +77,6 @@ $ docker plugin ls --filter enabled=true NAME TAG DESCRIPTION ENABLED ``` - ### Formatting The formatting options (`--format`) pretty-prints plugins output @@ -106,7 +105,6 @@ $ docker plugin ls --format "{{.ID}}: {{.Name}}" 4be01827a72e: tiborvass/no-remove ``` - ## Related commands * [plugin create](plugin_create.md) diff --git a/docs/reference/commandline/plugin_push.md b/docs/reference/commandline/plugin_push.md index f27a49894b..f444ed4d4d 100644 --- a/docs/reference/commandline/plugin_push.md +++ b/docs/reference/commandline/plugin_push.md @@ -40,6 +40,7 @@ $ docker plugin ls ID NAME TAG DESCRIPTION ENABLED 69553ca1d456 user/plugin latest A sample plugin for Docker false + $ docker plugin push user/plugin ``` diff --git a/docs/reference/commandline/plugin_rm.md b/docs/reference/commandline/plugin_rm.md index c820c869fd..d599ed8fc1 100644 --- a/docs/reference/commandline/plugin_rm.md +++ b/docs/reference/commandline/plugin_rm.md @@ -42,9 +42,11 @@ plugin: ```bash $ docker plugin disable tiborvass/sample-volume-plugin + tiborvass/sample-volume-plugin $ docker plugin rm tiborvass/sample-volume-plugin:latest + tiborvass/sample-volume-plugin ``` diff --git a/docs/reference/commandline/plugin_set.md b/docs/reference/commandline/plugin_set.md index 5092b0b0cd..ea7d92e735 100644 --- a/docs/reference/commandline/plugin_set.md +++ b/docs/reference/commandline/plugin_set.md @@ -130,11 +130,13 @@ the `myplugin` plugin. ```bash $ docker plugin inspect -f '{{with $device := index .Settings.Devices 0}}{{$device.Path}}{{end}}' myplugin + /dev/foo $ docker plugins set myplugin mydevice.path=/dev/bar $ docker plugin inspect -f '{{with $device := index .Settings.Devices 0}}{{$device.Path}}{{end}}' myplugin + /dev/bar ``` @@ -147,11 +149,13 @@ The following example change the value of the args on the `myplugin` plugin. ```bash $ docker plugin inspect -f '{{.Settings.Args}}' myplugin + ["foo", "bar"] $ docker plugins set myplugin myargs="foo bar baz" $ docker plugin inspect -f '{{.Settings.Args}}' myplugin + ["foo", "bar", "baz"] ``` @@ -165,3 +169,4 @@ $ docker plugin inspect -f '{{.Settings.Args}}' myplugin * [plugin ls](plugin_ls.md) * [plugin push](plugin_push.md) * [plugin rm](plugin_rm.md) +* [plugin upgrade](plugin_upgrade.md) diff --git a/docs/reference/commandline/plugin_upgrade.md b/docs/reference/commandline/plugin_upgrade.md index 38191fff73..8c79ebdabf 100644 --- a/docs/reference/commandline/plugin_upgrade.md +++ b/docs/reference/commandline/plugin_upgrade.md @@ -50,28 +50,40 @@ Do you grant the above permissions? [y/N] y vieux/sshfs:next $ docker volume create -d vieux/sshfs:next -o sshcmd=root@1.2.3.4:/tmp/shared -o password=XXX sshvolume + sshvolume + $ docker run -it -v sshvolume:/data alpine sh -c "touch /data/hello" + $ docker plugin disable -f vieux/sshfs:next + viex/sshfs:next # Here docker volume ls doesn't show 'sshfsvolume', since the plugin is disabled $ docker volume ls + DRIVER VOLUME NAME $ docker plugin upgrade vieux/sshfs:next vieux/sshfs:next + Plugin "vieux/sshfs:next" is requesting the following privileges: - network: [host] - device: [/dev/fuse] - capabilities: [CAP_SYS_ADMIN] Do you grant the above permissions? [y/N] y Upgrade plugin vieux/sshfs:next to vieux/sshfs:next + $ docker plugin enable vieux/sshfs:next + viex/sshfs:next + $ docker volume ls + DRIVER VOLUME NAME viuex/sshfs:next sshvolume + $ docker run -it -v sshvolume:/data alpine sh -c "ls /data" + hello ```