Skip to content

Commit

Permalink
docs: auto generate pouch cli/api docs via code
Browse files Browse the repository at this point in the history
Signed-off-by: pouchrobot <pouch-dev@list.alibaba-inc.com>
  • Loading branch information
pouchrobot authored and allencloud committed May 16, 2019
1 parent 5c253f9 commit 7235f82
Show file tree
Hide file tree
Showing 7 changed files with 177 additions and 38 deletions.
124 changes: 87 additions & 37 deletions docs/api/HTTP_API.md

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions docs/commandline/pouch.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ pouch is a client side tool pouch to interact with daemon side process pouchd. F

### SEE ALSO

* [pouch build](pouch_build.md) - Build an image from a Dockerfile
* [pouch checkpoint](pouch_checkpoint.md) - Manage checkpoint commands
* [pouch commit](pouch_commit.md) - Commit an image from a container
* [pouch create](pouch_create.md) - Create a new container with specified image
Expand All @@ -39,6 +40,7 @@ pouch is a client side tool pouch to interact with daemon side process pouchd. F
* [pouch pause](pouch_pause.md) - Pause one or more running containers
* [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
* [pouch remount-lxcfs](pouch_remount-lxcfs.md) - remount lxcfs bind in containers
* [pouch rename](pouch_rename.md) - Rename a container with newName
* [pouch restart](pouch_restart.md) - restart one or more containers
Expand Down
37 changes: 37 additions & 0 deletions docs/commandline/pouch_build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## pouch build

Build an image from a Dockerfile

### Synopsis

Build an image from a Dockerfile

```
pouch build [OPTION] PATH
```

### Options

```
--addr string buildkitd address (default "unix:///run/buildkit/buildkitd.sock")
--build-arg stringArray Set build-time variables
-h, --help help for build
-t, --tag stringArray Name and optionally a tag in the 'name:tag' format
--target string Set the target build stage to build
```

### 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

2 changes: 2 additions & 0 deletions docs/commandline/pouch_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ e1d541722d68dc5d133cca9e7bd8fd9338603e1763096c8e853522b60d11f7b9
--initscript string Initial script executed in container
--intel-rdt-l3-cbm string Limit container resource for Intel RDT/CAT which introduced in Linux 4.10 kernel
-i, --interactive open STDIN even if not attached
--ip string Set IPv4 address of container endpoint
--ip6 string Set IPv6 address of container endpoint
--ipc string IPC namespace to use
--kernel-memory string Kernel memory limit (in bytes)
-l, --label stringArray Set labels for a container
Expand Down
3 changes: 2 additions & 1 deletion docs/commandline/pouch_load.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ load a set of images from a tar archive or STDIN

### Synopsis

load a set of images by tar stream
load a set of images by tar stream.
for docker image format, no need to set the image name because pouch will parse image name from tar stream.

```
pouch load [OPTIONS] [IMAGE_NAME]
Expand Down
45 changes: 45 additions & 0 deletions docs/commandline/pouch_push.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
## pouch push

Push an image to registry

### Synopsis

Push a local image to remote registry.

```
pouch push IMAGE[:TAG]
```

### Examples

```
$ pouch push docker.io/testing/busybox:1.25
docker.io/testing/busybox:1.25: resolved |++++++++++++++++++++++++++++++++++++++|
manifest-sha256:29f5d56d12684887bdfa50dcd29fc31eea4aaf4ad3bec43daf19026a7ce69912: done
layer-sha256:56bec22e355981d8ba0878c6c2f23b21f422f30ab0aba188b54f1ffeff59c190: done
config-sha256:e02e811dd08fd49e7f6032625495118e63f597eb150403d02e3238af1df240ba: done
elapsed: 0.0 s total: 0.0 B (0.0 B/s)
```

### Options

```
-h, --help help for push
```

### 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

2 changes: 2 additions & 0 deletions docs/commandline/pouch_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ crw-rw-rw- 1 root root 1, 3 Jan 8 09:40 /dev/testnull
--initscript string Initial script executed in container
--intel-rdt-l3-cbm string Limit container resource for Intel RDT/CAT which introduced in Linux 4.10 kernel
-i, --interactive Attach container's STDIN
--ip string Set IPv4 address of container endpoint
--ip6 string Set IPv6 address of container endpoint
--ipc string IPC namespace to use
--kernel-memory string Kernel memory limit (in bytes)
-l, --label stringArray Set labels for a container
Expand Down

0 comments on commit 7235f82

Please sign in to comment.