docs: auto generate pouch cli/api docs via code

Signed-off-by: pouchrobot <pouch-dev@list.alibaba-inc.com>
AliyunContainerService · Jun 11, 2019 · 9b3b371 · 9b3b371
1 parent 772c9bf
commit 9b3b371
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 0 deletions.
diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -1,6 +1,7 @@
 # This file lists all contributors having contributed to this project.
 # For how it is generated, see command "git log --format='%aN <%aE>' | sort -uf".
 
+630445639 <630445639@qq.com>
 Ace Tang <Ace-Tang@users.noreply.github.com>
 Ace-Tang <aceapril@126.com>
 AlertBear <alertbear@163.com>
@@ -121,6 +122,7 @@ yanli <liyan@harmonycloud.cn>
 Yao Zengzeng <yaozengzeng@zju.edu.cn>
 YaoZengzeng <yaozengzeng@zju.edu.cn>
 Yaxiong Zhao <justicezyx@gmail.com>
+yeya24 <yb532204897@gmail.com>
 Yuan Sun <yile.sy@alibaba-inc.com>
 yuannauy123 <13673717303@163.com>
 yuchuan <yuchuan.jyc@gmail.com>

diff --git a/docs/commandline/pouch.md b/docs/commandline/pouch.md
@@ -39,6 +39,7 @@ pouch is a client side tool pouch to interact with daemon side process pouchd. F
 * [pouch logs](pouch_logs.md)	 - Print a container's logs
 * [pouch network](pouch_network.md)	 - Manage pouch networks
 * [pouch pause](pouch_pause.md)	 - Pause one or more running containers
+* [pouch port](pouch_port.md)	 - List port mappings or a specific mapping for the container
 * [pouch ps](pouch_ps.md)	 - List containers
 * [pouch pull](pouch_pull.md)	 - Pull an image from registry
 * [pouch push](pouch_push.md)	 - Push an image to registry

diff --git a/docs/commandline/pouch_port.md b/docs/commandline/pouch_port.md
@@ -0,0 +1,48 @@
+## pouch port
+
+List port mappings or a specific mapping for the container
+
+### Synopsis
+
+Return port binding information on Pouch container
+
+```
+pouch port CONTAINER [PRIVATE_PORT[/PROTO]]
+```
+
+### Examples
+
+```
+$ pouch run -d -p 6379:6379 -p 6380:6380/udp  redis:latest
+179eba2c29fb27a000bcda75cb2be271d1833ab140d1133799d0d4d865abc44e
+$ pouch port 179
+6379/tcp -> 0.0.0.0:6379
+6380/udp -> 0.0.0.0:6380
+$ pouch port 179 6379
+0.0.0.0:6379
+$ pouch port 179 6380/udp
+0.0.0.0:6380
+
+```
+
+### Options
+
+```
+  -h, --help   help for port
+```
+
+### Options inherited from parent commands
+
+```
+  -D, --debug              Switch client log level to DEBUG mode
+  -H, --host string        Specify connecting address of Pouch CLI (default "unix:///var/run/pouchd.sock")
+      --tlscacert string   Specify CA file of TLS
+      --tlscert string     Specify cert file of TLS
+      --tlskey string      Specify key file of TLS
+      --tlsverify          Use TLS and verify remote
+```
+
+### SEE ALSO
+
+* [pouch](pouch.md)	 - An efficient container engine
+