1. docker
  2. Commit e79873c27c2b3f404db02682bb4f11b5a046602e
Browse code

docker plugin commandline reference

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Sebastiaan van Stijn authored on 2016/06/10 06:57:15
Showing 6 changed files
docs/reference/commandline/plugin_disable.md
History View file @ e79873c
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,52 @@
0 
+<!--[metadata]>
1 
+title = "plugin disable"
2 
+description = "the plugin disable command description and usage"
3 
+keywords = ["plugin, disable"]
4 
+[menu.main]
5 
+parent = "smn_cli"
6 
+advisory = "experimental"
7 
+<![end-metadata]-->
8 
+
9 
+# plugin disable (experimental)
10 
+
11 
+    Usage: docker plugin disable PLUGIN
12 
+
13 
+    Disable a plugin
14 
+
15 
+      --help             Print usage
16 
+
17 
+Disables a plugin. The plugin must be installed before it can be disabled,
18 
+see [`docker plugin install`](plugin_install.md).
19 
+
20 
+
21 
+The following example shows that the `no-remove` plugin is currently installed
22 
+and active:
23 
+
24 
+```bash
25 
+$ docker plugin ls
26 
+NAME        	            TAG			ACTIVE
27 
+tiborvass/no-remove	    latest		true
28 
+```
29 
+To disable the plugin, use the following command:
30 
+
31 
+```bash
32 
+$ docker plugin disable tiborvass/no-remove:latest
33 
+```
34 
+
35 
+After the plugin is disabled, it appears as "inactive" in the list of plugins:
36 
+
37 
+```bash
38 
+$ docker plugin ls
39 
+NAME			VERSION		ACTIVE
40 
+tiborvass/no-remove	latest		false
41 
+```
42 
+
43 
+## Related information
44 
+
45 
+* [plugin ls](plugin_ls.md)
46 
+* [plugin enable](plugin_enable.md)
47 
+* [plugin inspect](plugin_inspect.md)
48 
+* [plugin install](plugin_install.md)
49 
+* [plugin rm](plugin_rm.md)
docs/reference/commandline/plugin_enable.md
History View file @ e79873c
0 50 
new file mode 100644
... ... 
@@ -0,0 +1,52 @@
0 
+<!--[metadata]>
1 
+title = "plugin enable"
2 
+description = "the plugin enable command description and usage"
3 
+keywords = ["plugin, enable"]
4 
+[menu.main]
5 
+parent = "smn_cli"
6 
+advisory = "experimental"
7 
+<![end-metadata]-->
8 
+
9 
+# plugin enable (experimental)
10 
+
11 
+    Usage: docker plugin enable PLUGIN
12 
+
13 
+    Enable a plugin
14 
+
15 
+      --help             Print usage
16 
+
17 
+Enables a plugin. The plugin must be installed before it can be enabled,
18 
+see [`docker plugin install`](plugin_install.md).
19 
+
20 
+
21 
+The following example shows that the `no-remove` plugin is currently installed,
22 
+but disabled ("inactive"):
23 
+
24 
+```bash
25 
+$ docker plugin ls
26 
+NAME                	VERSION             ACTIVE
27 
+tiborvass/no-remove	latest              false
28 
+```
29 
+To enable the plugin, use the following command:
30 
+
31 
+```bash
32 
+$ docker plugin enable tiborvass/no-remove:latest
33 
+```
34 
+
35 
+After the plugin is enabled, it appears as "active" in the list of plugins:
36 
+
37 
+```bash
38 
+$ docker plugin ls
39 
+NAME                	VERSION             ACTIVE
40 
+tiborvass/no-remove	latest              true
41 
+```
42 
+
43 
+## Related information
44 
+
45 
+* [plugin ls](plugin_ls.md)
46 
+* [plugin disable](plugin_disable.md)
47 
+* [plugin inspect](plugin_inspect.md)
48 
+* [plugin install](plugin_install.md)
49 
+* [plugin rm](plugin_rm.md)
docs/reference/commandline/plugin_inspect.md
History View file @ e79873c
0 50 
new file mode 100644
... ... 
@@ -0,0 +1,135 @@
0 
+<!--[metadata]>
1 
+title = "plugin inspect"
2 
+description = "The plugin inspect command description and usage"
3 
+keywords = ["plugin, inspect"]
4 
+[menu.main]
5 
+parent = "smn_cli"
6 
+advisory = "experimental"
7 
+<![end-metadata]-->
8 
+
9 
+# plugin inspect (experimental)
10 
+
11 
+    Usage: docker plugin inspect PLUGIN
12 
+
13 
+    Return low-level information about a plugin
14 
+
15 
+      --help              Print usage
16 
+
17 
+
18 
+Returns information about a plugin. By default, this command renders all results
19 
+in a JSON array.
20 
+
21 
+Example output:
22 
+
23 
+```bash
24 
+$ docker plugin inspect tiborvass/no-remove:latest
25 
+```
26 
+```JSON
27 
+{
28 
+    "Manifest": {
29 
+        "ManifestVersion": "",
30 
+        "Description": "A test plugin for Docker",
31 
+        "Documentation": "https://docs.docker.com/engine/extend/plugins/",
32 
+        "Entrypoint": [
33 
+            "plugin-no-remove",
34 
+            "/data"
35 
+        ],
36 
+        "Interface": {
37 
+            "Types": [
38 
+                "docker.volumedriver/1.0"
39 
+            ],
40 
+            "Socket": "plugins.sock"
41 
+        },
42 
+        "Network": {
43 
+            "Type": "host"
44 
+        },
45 
+        "Capabilities": null,
46 
+        "Mounts": [
47 
+            {
48 
+                "Name": "",
49 
+                "Description": "",
50 
+                "Settable": false,
51 
+                "Source": "/data",
52 
+                "Destination": "/data",
53 
+                "Type": "bind",
54 
+                "Options": [
55 
+                    "shared",
56 
+                    "rbind"
57 
+                ]
58 
+            },
59 
+            {
60 
+                "Name": "",
61 
+                "Description": "",
62 
+                "Settable": false,
63 
+                "Source": null,
64 
+                "Destination": "/foobar",
65 
+                "Type": "tmpfs",
66 
+                "Options": null
67 
+            }
68 
+        ],
69 
+        "Devices": [
70 
+            {
71 
+                "Name": "device",
72 
+                "Description": "a host device to mount",
73 
+                "Settable": false,
74 
+                "Path": null
75 
+            }
76 
+        ],
77 
+        "Env": [
78 
+            {
79 
+                "Name": "DEBUG",
80 
+                "Description": "If set, prints debug messages",
81 
+                "Settable": false,
82 
+                "Value": null
83 
+            }
84 
+        ],
85 
+        "Args": [
86 
+            {
87 
+                "Name": "arg1",
88 
+                "Description": "a command line argument",
89 
+                "Settable": false,
90 
+                "Value": null
91 
+            }
92 
+        ]
93 
+    },
94 
+    "Config": {
95 
+        "Mounts": [
96 
+            {
97 
+                "Source": "/data",
98 
+                "Destination": "/data",
99 
+                "Type": "bind",
100 
+                "Options": [
101 
+                    "shared",
102 
+                    "rbind"
103 
+                ]
104 
+            },
105 
+            {
106 
+                "Source": null,
107 
+                "Destination": "/foobar",
108 
+                "Type": "tmpfs",
109 
+                "Options": null
110 
+            }
111 
+        ],
112 
+        "Env": [],
113 
+        "Args": [],
114 
+        "Devices": null
115 
+    },
116 
+    "Active": true,
117 
+    "Name": "tiborvass/no-remove",
118 
+    "Tag": "latest",
119 
+    "ID": "ac9d36b664921d61813254f7e9946f10e3cadbb676346539f1705fcaf039c01f"
120 
+}
121 
+```
122 
+(output formatted for readability)
123 
+
124 
+
125 
+
126 
+## Related information
127 
+
128 
+* [plugin ls](plugin_ls.md)
129 
+* [plugin enable](plugin_enable.md)
130 
+* [plugin disable](plugin_disable.md)
131 
+* [plugin install](plugin_install.md)
132 
+* [plugin rm](plugin_rm.md)
docs/reference/commandline/plugin_install.md
History View file @ e79873c
0 133 
new file mode 100644
... ... 
@@ -0,0 +1,51 @@
0 
+<!--[metadata]>
1 
+title = "plugin install"
2 
+description = "the plugin install command description and usage"
3 
+keywords = ["plugin, install"]
4 
+[menu.main]
5 
+parent = "smn_cli"
6 
+advisory = "experimental"
7 
+<![end-metadata]-->
8 
+
9 
+# plugin install (experimental)
10 
+
11 
+    Usage: docker plugin install PLUGIN
12 
+
13 
+    Install a plugin
14 
+
15 
+      --help             Print usage
16 
+
17 
+Installs and enables a plugin. Docker looks first for the plugin on your Docker
18 
+host. If the plugin does not exist locally, then the plugin is pulled from
19 
+Docker Hub.
20 
+
21 
+
22 
+The following example installs `no-remove` plugin. Install consists of pulling the
23 
+plugin from Docker Hub, prompting the user to accept the list of privileges that
24 
+the plugin needs and enabling the plugin.
25 
+
26 
+```bash
27 
+$ docker plugin install tiborvass/no-remove
28 
+Plugin "tiborvass/no-remove:latest" requested the following privileges:
29 
+ - Networking: host
30 
+ - Mounting host path: /data
31 
+Do you grant the above permissions? [y/N] y
32 
+```
33 
+
34 
+After the plugin is installed, it appears in the list of plugins:
35 
+
36 
+```bash
37 
+$ docker plugin ls
38 
+NAME                	VERSION             ACTIVE
39 
+tiborvass/no-remove   latest              true
40 
+```
41 
+
42 
+## Related information
43 
+
44 
+* [plugin ls](plugin_ls.md)
45 
+* [plugin enable](plugin_enable.md)
46 
+* [plugin disable](plugin_disable.md)
47 
+* [plugin inspect](plugin_inspect.md)
48 
+* [plugin rm](plugin_rm.md)
docs/reference/commandline/plugin_ls.md
History View file @ e79873c
0 49 
new file mode 100644
... ... 
@@ -0,0 +1,40 @@
0 
+<!--[metadata]>
1 
+title = "plugin ls"
2 
+description = "The plugin ls command description and usage"
3 
+keywords = ["plugin, list"]
4 
+[menu.main]
5 
+parent = "smn_cli"
6 
+advisory = "experimental"
7 
+<![end-metadata]-->
8 
+
9 
+# plugin ls (experimental)
10 
+
11 
+    Usage: docker plugin ls
12 
+
13 
+    List plugins
14 
+
15 
+      --help   Print usage
16 
+
17 
+    Aliases:
18 
+      ls, list
19 
+
20 
+Lists all the plugins that are currently installed. You can install plugins
21 
+using the [`docker plugin install`](plugin_install.md) command.
22 
+
23 
+Example output:
24 
+
25 
+```bash
26 
+$ docker plugin ls
27 
+NAME                	VERSION             ACTIVE
28 
+tiborvass/no-remove	latest              true
29 
+```
30 
+
31 
+## Related information
32 
+
33 
+* [plugin enable](plugin_enable.md)
34 
+* [plugin disable](plugin_disable.md)
35 
+* [plugin inspect](plugin_inspect.md)
36 
+* [plugin install](plugin_install.md)
37 
+* [plugin rm](plugin_rm.md)
docs/reference/commandline/plugin_rm.md
History View file @ e79873c
0 38 
new file mode 100644
... ... 
@@ -0,0 +1,41 @@
0 
+<!--[metadata]>
1 
+title = "plugin rm"
2 
+description = "the plugin rm command description and usage"
3 
+keywords = ["plugin, rm"]
4 
+[menu.main]
5 
+parent = "smn_cli"
6 
+advisory = "experimental"
7 
+<![end-metadata]-->
8 
+
9 
+# plugin rm (experimental)
10 
+
11 
+    Usage: docker plugin rm PLUGIN
12 
+
13 
+    Remove a plugin
14 
+
15 
+      --help             Print usage
16 
+
17 
+    Aliases:
18 
+      rm, remove
19 
+
20 
+Removes a plugin. You cannot remove a plugin if it is active, you must disable
21 
+a plugin using the [`docker plugin disable`](plugin_disable.md) before removing
22 
+it.
23 
+
24 
+The following example disables and removes the `no-remove:latest` plugin;
25 
+
26 
+```bash
27 
+$ docker plugin disable tiborvass/no-remove:latest
28 
+$ docker plugin rm tiborvass/no-remove:latest
29 
+no-remove:latest
30 
+```
31 
+
32 
+## Related information
33 
+
34 
+* [plugin ls](plugin_ls.md)
35 
+* [plugin enable](plugin_enable.md)
36 
+* [plugin disable](plugin_disable.md)
37 
+* [plugin inspect](plugin_inspect.md)
38 
+* [plugin install](plugin_install.md)