summaryrefslogtreecommitdiff
path: root/docs/reference/commandline/plugin_create.md
diff options
context:
space:
mode:
authorMisty Stanley-Jones <misty@apache.org>2017-04-03 16:54:34 -0700
committerGitHub <noreply@github.com>2017-04-03 16:54:34 -0700
commit473c5701cb66403b0535a5c01845cb0f27fbeb47 (patch)
tree9a40326ad4b426655abca7377dc30da003847d4d /docs/reference/commandline/plugin_create.md
parentce07fb6b0f1b8765b92022e45f96bd4349812e06 (diff)
parent71e6babfa2598669218177b5b429e873b7f35e8f (diff)
downloaddocker-1.13.x.tar.gz
Merge pull request #32332 from mstanleyjones/1.13.x1.13.x
Cherry-pick command-line ref improvements
Diffstat (limited to 'docs/reference/commandline/plugin_create.md')
-rw-r--r--docs/reference/commandline/plugin_create.md15
1 files changed, 10 insertions, 5 deletions
diff --git a/docs/reference/commandline/plugin_create.md b/docs/reference/commandline/plugin_create.md
index 9d4e99e56a..6f1754326b 100644
--- a/docs/reference/commandline/plugin_create.md
+++ b/docs/reference/commandline/plugin_create.md
@@ -21,33 +21,38 @@ Usage: docker plugin create [OPTIONS] PLUGIN PLUGIN-DATA-DIR
Create a plugin from a rootfs and configuration. Plugin data directory must contain config.json and rootfs directory.
Options:
- --compress Compress the context using gzip
+ --compress Compress the context using gzip
--help Print usage
```
+## Description
+
Creates a plugin. Before creating the plugin, prepare the plugin's root filesystem as well as
[the config.json](../../extend/config.md)
+## Examples
The following example shows how to create a sample `plugin`.
```bash
-
$ ls -ls /home/pluginDir
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
$ docker plugin create plugin /home/pluginDir
+
plugin
-NAME TAG DESCRIPTION ENABLED
-plugin latest A sample plugin for Docker true
+$ docker plugin ls
+
+ID NAME TAG DESCRIPTION ENABLED
+672d8144ec02 plugin latest A sample plugin for Docker false
```
The plugin can subsequently be enabled for local use or pushed to the public registry.
-## Related information
+## Related commands
* [plugin disable](plugin_disable.md)
* [plugin enable](plugin_enable.md)