Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: auto generate pouch cli/api docs via code #1217

Merged
merged 1 commit into from
Apr 26, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CONTRIBUTORS
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ allen.wang <allen.wq@alipay.com>
bvwells <b.v.wells@gmail.com>
Ce Gao <ce.gao@outlook.com>
chenzhimin <1141685075@qq.com>
Chuanyun Li <lcy041536@gmail.com>
Cindy <176425810@qq.com>
CodeJuan <CodeJuan@users.noreply.github.com>
codejuan <xh@decbug.com>
Expand Down
1 change: 1 addition & 0 deletions docs/commandline/pouch_network.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ pouch network [command]
### SEE ALSO

* [pouch](pouch.md) - An efficient container engine
* [pouch network connect](pouch_network_connect.md) - Connect a container to a network
* [pouch network create](pouch_network_create.md) - Create a pouch network
* [pouch network disconnect](pouch_network_disconnect.md) - Disconnect a container from a network
* [pouch network inspect](pouch_network_inspect.md) - Inspect one or more pouch networks
Expand Down
44 changes: 44 additions & 0 deletions docs/commandline/pouch_network_connect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
## pouch network connect

Connect a container to a network

### Synopsis

Connect a container to a network in pouchd. It must specify network's name and container's name.

```
pouch network connect [OPTIONS] NETWORK CONTAINER
```

### Examples

```
$ pouch network connect net1 container1
container container1 is connected to network net1
```

### Options

```
--alias strings Add network-scoped alias for the container
-h, --help help for connect
--ip string IP Address
--ip6 string IPv6 Address
--link strings Add link to another container
--link-local-ip strings Add a link-local address for the container
```

### Options inherited from parent commands

```
-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 network](pouch_network.md) - Manage pouch networks

1 change: 0 additions & 1 deletion docs/commandline/pouch_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ $ cat /sys/fs/cgroup/memory/8649804cb63ff9713a2734d99728b9d6d5d1e4d2fbafb2b4dbdf
--cpuset-mems string MEMs in cpuset
-e, --env strings Set environment variables for container
-h, --help help for update
--image string Image of container
-l, --label strings Set label for container
-m, --memory string Container memory limit
--memory-swap string Container swap limit
Expand Down