diff --git a/docs/reference/commandline/plugin_disable.md b/docs/reference/commandline/plugin_disable.md new file mode 100644 index 0000000000..44f78af8c4 --- /dev/null +++ b/docs/reference/commandline/plugin_disable.md @@ -0,0 +1,52 @@ + + +# plugin disable (experimental) + + Usage: docker plugin disable PLUGIN + + Disable a plugin + + --help Print usage + +Disables a plugin. The plugin must be installed before it can be disabled, +see [`docker plugin install`](plugin_install.md). + + +The following example shows that the `no-remove` plugin is currently installed +and active: + +```bash +$ docker plugin ls +NAME TAG ACTIVE +tiborvass/no-remove latest true +``` +To disable the plugin, use the following command: + +```bash +$ docker plugin disable tiborvass/no-remove:latest +``` + +After the plugin is disabled, it appears as "inactive" in the list of plugins: + +```bash +$ docker plugin ls +NAME VERSION ACTIVE +tiborvass/no-remove latest false +``` + +## Related information + +* [plugin ls](plugin_ls.md) +* [plugin enable](plugin_enable.md) +* [plugin inspect](plugin_inspect.md) +* [plugin install](plugin_install.md) +* [plugin rm](plugin_rm.md) diff --git a/docs/reference/commandline/plugin_enable.md b/docs/reference/commandline/plugin_enable.md new file mode 100644 index 0000000000..2bd577fd04 --- /dev/null +++ b/docs/reference/commandline/plugin_enable.md @@ -0,0 +1,52 @@ + + +# plugin enable (experimental) + + Usage: docker plugin enable PLUGIN + + Enable a plugin + + --help Print usage + +Enables a plugin. The plugin must be installed before it can be enabled, +see [`docker plugin install`](plugin_install.md). + + +The following example shows that the `no-remove` plugin is currently installed, +but disabled ("inactive"): + +```bash +$ docker plugin ls +NAME VERSION ACTIVE +tiborvass/no-remove latest false +``` +To enable the plugin, use the following command: + +```bash +$ docker plugin enable tiborvass/no-remove:latest +``` + +After the plugin is enabled, it appears as "active" in the list of plugins: + +```bash +$ docker plugin ls +NAME VERSION ACTIVE +tiborvass/no-remove latest true +``` + +## Related information + +* [plugin ls](plugin_ls.md) +* [plugin disable](plugin_disable.md) +* [plugin inspect](plugin_inspect.md) +* [plugin install](plugin_install.md) +* [plugin rm](plugin_rm.md) diff --git a/docs/reference/commandline/plugin_inspect.md b/docs/reference/commandline/plugin_inspect.md new file mode 100644 index 0000000000..e0282ea294 --- /dev/null +++ b/docs/reference/commandline/plugin_inspect.md @@ -0,0 +1,135 @@ + + +# plugin inspect (experimental) + + Usage: docker plugin inspect PLUGIN + + Return low-level information about a plugin + + --help Print usage + + +Returns information about a plugin. By default, this command renders all results +in a JSON array. + +Example output: + +```bash +$ docker plugin inspect tiborvass/no-remove:latest +``` +```JSON +{ + "Manifest": { + "ManifestVersion": "", + "Description": "A test plugin for Docker", + "Documentation": "https://docs.docker.com/engine/extend/plugins/", + "Entrypoint": [ + "plugin-no-remove", + "/data" + ], + "Interface": { + "Types": [ + "docker.volumedriver/1.0" + ], + "Socket": "plugins.sock" + }, + "Network": { + "Type": "host" + }, + "Capabilities": null, + "Mounts": [ + { + "Name": "", + "Description": "", + "Settable": false, + "Source": "/data", + "Destination": "/data", + "Type": "bind", + "Options": [ + "shared", + "rbind" + ] + }, + { + "Name": "", + "Description": "", + "Settable": false, + "Source": null, + "Destination": "/foobar", + "Type": "tmpfs", + "Options": null + } + ], + "Devices": [ + { + "Name": "device", + "Description": "a host device to mount", + "Settable": false, + "Path": null + } + ], + "Env": [ + { + "Name": "DEBUG", + "Description": "If set, prints debug messages", + "Settable": false, + "Value": null + } + ], + "Args": [ + { + "Name": "arg1", + "Description": "a command line argument", + "Settable": false, + "Value": null + } + ] + }, + "Config": { + "Mounts": [ + { + "Source": "/data", + "Destination": "/data", + "Type": "bind", + "Options": [ + "shared", + "rbind" + ] + }, + { + "Source": null, + "Destination": "/foobar", + "Type": "tmpfs", + "Options": null + } + ], + "Env": [], + "Args": [], + "Devices": null + }, + "Active": true, + "Name": "tiborvass/no-remove", + "Tag": "latest", + "ID": "ac9d36b664921d61813254f7e9946f10e3cadbb676346539f1705fcaf039c01f" +} +``` +(output formatted for readability) + + + +## Related information + +* [plugin ls](plugin_ls.md) +* [plugin enable](plugin_enable.md) +* [plugin disable](plugin_disable.md) +* [plugin install](plugin_install.md) +* [plugin rm](plugin_rm.md) diff --git a/docs/reference/commandline/plugin_install.md b/docs/reference/commandline/plugin_install.md new file mode 100644 index 0000000000..276af5a09f --- /dev/null +++ b/docs/reference/commandline/plugin_install.md @@ -0,0 +1,51 @@ + + +# plugin install (experimental) + + Usage: docker plugin install PLUGIN + + Install a plugin + + --help Print usage + +Installs and enables a plugin. Docker looks first for the plugin on your Docker +host. If the plugin does not exist locally, then the plugin is pulled from +Docker Hub. + + +The following example installs `no-remove` plugin. Install consists of pulling the +plugin from Docker Hub, prompting the user to accept the list of privileges that +the plugin needs and enabling the plugin. + +```bash +$ docker plugin install tiborvass/no-remove +Plugin "tiborvass/no-remove:latest" requested the following privileges: + - Networking: host + - Mounting host path: /data +Do you grant the above permissions? [y/N] y +``` + +After the plugin is installed, it appears in the list of plugins: + +```bash +$ docker plugin ls +NAME VERSION ACTIVE +tiborvass/no-remove latest true +``` + +## Related information + +* [plugin ls](plugin_ls.md) +* [plugin enable](plugin_enable.md) +* [plugin disable](plugin_disable.md) +* [plugin inspect](plugin_inspect.md) +* [plugin rm](plugin_rm.md) diff --git a/docs/reference/commandline/plugin_ls.md b/docs/reference/commandline/plugin_ls.md new file mode 100644 index 0000000000..ea36368ed9 --- /dev/null +++ b/docs/reference/commandline/plugin_ls.md @@ -0,0 +1,40 @@ + + +# plugin ls (experimental) + + Usage: docker plugin ls + + List plugins + + --help Print usage + + Aliases: + ls, list + +Lists all the plugins that are currently installed. You can install plugins +using the [`docker plugin install`](plugin_install.md) command. + +Example output: + +```bash +$ docker plugin ls +NAME VERSION ACTIVE +tiborvass/no-remove latest true +``` + +## Related information + +* [plugin enable](plugin_enable.md) +* [plugin disable](plugin_disable.md) +* [plugin inspect](plugin_inspect.md) +* [plugin install](plugin_install.md) +* [plugin rm](plugin_rm.md) diff --git a/docs/reference/commandline/plugin_rm.md b/docs/reference/commandline/plugin_rm.md new file mode 100644 index 0000000000..a5dcf9e7cc --- /dev/null +++ b/docs/reference/commandline/plugin_rm.md @@ -0,0 +1,41 @@ + + +# plugin rm (experimental) + + Usage: docker plugin rm PLUGIN + + Remove a plugin + + --help Print usage + + Aliases: + rm, remove + +Removes a plugin. You cannot remove a plugin if it is active, you must disable +a plugin using the [`docker plugin disable`](plugin_disable.md) before removing +it. + +The following example disables and removes the `no-remove:latest` plugin; + +```bash +$ docker plugin disable tiborvass/no-remove:latest +$ docker plugin rm tiborvass/no-remove:latest +no-remove:latest +``` + +## Related information + +* [plugin ls](plugin_ls.md) +* [plugin enable](plugin_enable.md) +* [plugin disable](plugin_disable.md) +* [plugin inspect](plugin_inspect.md) +* [plugin install](plugin_install.md)