Browse code

Add docs for plugin push

Signed-off-by: Anusha Ragunathan <anusha@docker.com>

Anusha Ragunathan authored on 2016/11/15 01:38:06
Showing 10 changed files
... ...
@@ -14,8 +14,8 @@ import (
14 14
 
15 15
 func newPushCommand(dockerCli *command.DockerCli) *cobra.Command {
16 16
 	cmd := &cobra.Command{
17
-		Use:   "push PLUGIN",
18
-		Short: "Push a plugin",
17
+		Use:   "push NAME[:TAG]",
18
+		Short: "Push a plugin to a registry",
19 19
 		Args:  cli.ExactArgs(1),
20 20
 		RunE: func(cmd *cobra.Command, args []string) error {
21 21
 			return runPush(dockerCli, args[0])
... ...
@@ -49,10 +49,11 @@ The plugin can subsequently be enabled for local use or pushed to the public reg
49 49
 
50 50
 ## Related information
51 51
 
52
-* [plugin ls](plugin_ls.md)
53
-* [plugin enable](plugin_enable.md)
54 52
 * [plugin disable](plugin_disable.md)
53
+* [plugin enable](plugin_enable.md)
55 54
 * [plugin inspect](plugin_inspect.md)
56 55
 * [plugin install](plugin_install.md)
56
+* [plugin ls](plugin_ls.md)
57
+* [plugin push](plugin_push.md)
57 58
 * [plugin rm](plugin_rm.md)
58 59
 * [plugin set](plugin_set.md)
... ...
@@ -53,10 +53,11 @@ tiborvass/no-remove   latest              A test plugin for Docker   false
53 53
 
54 54
 ## Related information
55 55
 
56
-* [plugin ls](plugin_ls.md)
57 56
 * [plugin create](plugin_create.md)
58 57
 * [plugin enable](plugin_enable.md)
59 58
 * [plugin inspect](plugin_inspect.md)
60 59
 * [plugin install](plugin_install.md)
60
+* [plugin ls](plugin_ls.md)
61
+* [plugin push](plugin_push.md)
61 62
 * [plugin rm](plugin_rm.md)
62 63
 * [plugin set](plugin_set.md)
... ...
@@ -54,9 +54,10 @@ tiborvass/no-remove   latest              A test plugin for Docker   true
54 54
 ## Related information
55 55
 
56 56
 * [plugin create](plugin_create.md)
57
-* [plugin ls](plugin_ls.md)
58 57
 * [plugin disable](plugin_disable.md)
59 58
 * [plugin inspect](plugin_inspect.md)
60 59
 * [plugin install](plugin_install.md)
60
+* [plugin ls](plugin_ls.md)
61
+* [plugin push](plugin_push.md)
61 62
 * [plugin rm](plugin_rm.md)
62 63
 * [plugin set](plugin_set.md)
... ...
@@ -154,9 +154,10 @@ $ docker plugin inspect -f '{{.Id}}' tiborvass/no-remove:latest
154 154
 ## Related information
155 155
 
156 156
 * [plugin create](plugin_create.md)
157
-* [plugin ls](plugin_ls.md)
158 157
 * [plugin enable](plugin_enable.md)
159 158
 * [plugin disable](plugin_disable.md)
160 159
 * [plugin install](plugin_install.md)
160
+* [plugin ls](plugin_ls.md)
161
+* [plugin push](plugin_push.md)
161 162
 * [plugin rm](plugin_rm.md)
162 163
 * [plugin set](plugin_set.md)
... ...
@@ -60,9 +60,10 @@ tiborvass/no-remove   latest              A test plugin for Docker   true
60 60
 ## Related information
61 61
 
62 62
 * [plugin create](plugin_create.md)
63
-* [plugin ls](plugin_ls.md)
64
-* [plugin enable](plugin_enable.md)
65 63
 * [plugin disable](plugin_disable.md)
64
+* [plugin enable](plugin_enable.md)
66 65
 * [plugin inspect](plugin_inspect.md)
66
+* [plugin ls](plugin_ls.md)
67
+* [plugin push](plugin_push.md)
67 68
 * [plugin rm](plugin_rm.md)
68 69
 * [plugin set](plugin_set.md)
... ...
@@ -43,9 +43,10 @@ tiborvass/no-remove   latest              A test plugin for Docker   true
43 43
 ## Related information
44 44
 
45 45
 * [plugin create](plugin_create.md)
46
-* [plugin enable](plugin_enable.md)
47 46
 * [plugin disable](plugin_disable.md)
47
+* [plugin enable](plugin_enable.md)
48 48
 * [plugin inspect](plugin_inspect.md)
49 49
 * [plugin install](plugin_install.md)
50
+* [plugin push](plugin_push.md)
50 51
 * [plugin rm](plugin_rm.md)
51 52
 * [plugin set](plugin_set.md)
52 53
new file mode 100644
... ...
@@ -0,0 +1,50 @@
0
+---
1
+title: "plugin push"
2
+description: "the plugin push command description and usage"
3
+keywords: "plugin, push"
4
+---
5
+
6
+<!-- This file is maintained within the docker/docker Github
7
+     repository at https://github.com/docker/docker/. Make all
8
+     pull requests against that repo. If you see this file in
9
+     another repository, consider it read-only there, as it will
10
+     periodically be overwritten by the definitive file. Pull
11
+     requests which include edits to this file in other repositories
12
+     will be rejected.
13
+-->
14
+
15
+```markdown
16
+Usage:  docker plugin push NAME[:TAG]
17
+
18
+Push a plugin to a registry
19
+
20
+Options:
21
+      --help       Print usage
22
+```
23
+
24
+Use `docker plugin create` to create the plugin. Once the plugin is ready for distribution,
25
+use `docker plugin push` to share your images to the Docker Hub registry or to a self-hosted one.
26
+
27
+Registry credentials are managed by [docker login](login.md).
28
+
29
+The following example shows how to push a sample `user/plugin`.
30
+
31
+```bash
32
+
33
+$ docker plugin ls
34
+NAME                  	TAG                 DESCRIPTION                  ENABLED
35
+user/plugin             latest              A sample plugin for Docker   false
36
+
37
+$ docker plugin push user/plugin
38
+```
39
+
40
+## Related information
41
+
42
+* [plugin create](plugin_create.md)
43
+* [plugin disable](plugin_disable.md)
44
+* [plugin enable](plugin_enable.md)
45
+* [plugin inspect](plugin_inspect.md)
46
+* [plugin install](plugin_install.md)
47
+* [plugin ls](plugin_ls.md)
48
+* [plugin rm](plugin_rm.md)
49
+* [plugin set](plugin_set.md)
... ...
@@ -46,9 +46,10 @@ tiborvass/no-remove
46 46
 ## Related information
47 47
 
48 48
 * [plugin create](plugin_create.md)
49
-* [plugin ls](plugin_ls.md)
50
-* [plugin enable](plugin_enable.md)
51 49
 * [plugin disable](plugin_disable.md)
50
+* [plugin enable](plugin_enable.md)
52 51
 * [plugin inspect](plugin_inspect.md)
53 52
 * [plugin install](plugin_install.md)
53
+* [plugin ls](plugin_ls.md)
54
+* [plugin push](plugin_push.md)
54 55
 * [plugin set](plugin_set.md)
... ...
@@ -90,9 +90,10 @@ $ docker plugin inspect -f '{{.Settings.Args}}' myplugin
90 90
 ## Related information
91 91
 
92 92
 * [plugin create](plugin_create.md)
93
-* [plugin ls](plugin_ls.md)
94
-* [plugin enable](plugin_enable.md)
95 93
 * [plugin disable](plugin_disable.md)
94
+* [plugin enable](plugin_enable.md)
96 95
 * [plugin inspect](plugin_inspect.md)
97 96
 * [plugin install](plugin_install.md)
97
+* [plugin ls](plugin_ls.md)
98
+* [plugin push](plugin_push.md)
98 99
 * [plugin rm](plugin_rm.md)