Skip to content
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
2 changes: 2 additions & 0 deletions CONTRIBUTORS
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Allen Sun <[email protected]>
Allen Sun <[email protected]>
Allen Sun <[email protected]>
allen.wang <[email protected]>
baijia <[email protected]>
btlcmr0702 <[email protected]>
bvwells <[email protected]>
Ce Gao <[email protected]>
Expand Down Expand Up @@ -126,6 +127,7 @@ zhuangqh <[email protected]>
zhubingbing <[email protected]>
zhubingbing <[email protected]>
zhubingbing <[email protected]>
ziren.wzr <[email protected]>
ZJ_Lavender <[email protected]>
Zou Rui <[email protected]>
ZouRui89 <[email protected]>
Expand Down
2 changes: 1 addition & 1 deletion docs/commandline/pouch_events.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Get real time events from the daemon

### Synopsis

events cli tool is used to subscribe pouchd events.We support filter parameter to filter some events that we care about or not.
events cli tool is used to subscribe pouchd events. We support filter parameter to filter some events that we care about or not.

```
pouch events [OPTIONS]
Expand Down
2 changes: 1 addition & 1 deletion docs/commandline/pouch_images.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ List all images

### Synopsis

List all images in Pouchd.This is useful when you wish to have a look at images and Pouchd will show all local images with their NAME and SIZE.All local images will be shown in a table format you can use.
List all images in Pouchd. This is useful when you wish to have a look at images and Pouchd will show all local images with their NAME and SIZE. All local images will be shown in a table format you can use.

```
pouch images [OPTIONS]
Expand Down
2 changes: 1 addition & 1 deletion docs/commandline/pouch_info.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Display system-wide information

### Synopsis

Display the information of pouch, including Containers, Images, Storage Driver, Execution Driver, Logging Driver, Kernel Version,Operating System, CPUs, Total Memory, Name, ID.
Display the information of pouch, including Containers, Images, Storage Driver, Execution Driver, Logging Driver, Kernel Version, Operating System, CPUs, Total Memory, Name, ID.

```
pouch info [OPTIONS]
Expand Down
1 change: 1 addition & 0 deletions docs/commandline/pouch_network_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ pouchnet: e1d541722d68dc5d133cca9e7bd8fd9338603e1763096c8e853522b60d11f7b9
-h, --help help for create
--ip-range string the range of network's ip
--ipam-driver string the ipam driver of network (default "default")
--ipam-opt strings the ipam driver options of network
-l, --label strings create network with labels
-n, --name string the name of network
-o, --option strings create network with options
Expand Down
2 changes: 1 addition & 1 deletion docs/commandline/pouch_pause.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Pause one or more running containers

### Synopsis

Pause one or more running containers in Pouchd. when pausing, the container will pause its running but hold all the relevant resource.This is useful when you wish to pause a container for a while and to restore the running status later.The container you paused will pause without being terminated.
Pause one or more running containers in Pouchd. when pausing, the container will pause its running but hold all the relevant resource. This is useful when you wish to pause a container for a while and to restore the running status later. The container you paused will pause without being terminated.

```
pouch pause CONTAINER [CONTAINER...]
Expand Down
2 changes: 1 addition & 1 deletion docs/commandline/pouch_rmi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Remove one or more images by reference

### Synopsis

Remove one or more images by reference.When the image is being used by a container, you must specify -f to delete it.But it is strongly discouraged, because the container will be in abnormal status.
Remove one or more images by reference.When the image is being used by a container, you must specify -f to delete it. But it is strongly discouraged, because the container will be in abnormal status.

```
pouch rmi [OPTIONS] IMAGE [IMAGE...]
Expand Down
2 changes: 1 addition & 1 deletion docs/commandline/pouch_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Start one or more created or stopped containers

### Synopsis

Start one or more created container objects in Pouchd. When starting, the relevant resource preserved during creating period comes into use.This is useful when you wish to start a container which has been created in advance.The container you started will be running if no error occurs.
Start one or more created container objects in Pouchd. When starting, the relevant resource preserved during creating period comes into use. This is useful when you wish to start a container which has been created in advance.The container you started will be running if no error occurs.

```
pouch start [OPTIONS] CONTAINER [CONTAINER...]
Expand Down
2 changes: 1 addition & 1 deletion docs/commandline/pouch_stop.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Stop one or more running containers

### Synopsis

Stop one or more running containers in Pouchd. Waiting the given number of seconds before forcefully killing the container.This is useful when you wish to stop a container. And Pouchd will stop this running container and release the resource. The container that you stopped will be terminated.
Stop one or more running containers in Pouchd. Waiting the given number of seconds before forcefully killing the container. This is useful when you wish to stop a container. And Pouchd will stop this running container and release the resource. The container that you stopped will be terminated.

```
pouch stop [OPTIONS] CONTAINER [CONTAINER...]
Expand Down
2 changes: 1 addition & 1 deletion docs/commandline/pouch_top.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Display the running processes of a container

### Synopsis

top command is to display the running processes of a container.You can add options just like using Linux ps command.
top command is to display the running processes of a container. You can add options just like using Linux ps command.

```
pouch top CONTAINER [ps OPTIONS]
Expand Down
2 changes: 1 addition & 1 deletion docs/commandline/pouch_unpause.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Unpause one or more paused container

### Synopsis

Unpause one or more paused containers in Pouchd. when unpausing, the paused container will resumes the process execution within the container.The container you unpaused will be running again if no error occurs.
Unpause one or more paused containers in Pouchd. when unpausing, the paused container will resumes the process execution within the container. The container you unpaused will be running again if no error occurs.

```
pouch unpause CONTAINER [CONTAINER...]
Expand Down
2 changes: 1 addition & 1 deletion docs/commandline/pouch_updatedaemon.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Update the configurations of pouchd

### Synopsis

Update daemon's configurations, if daemon is stoped, it will just update config file. Online update just including: image proxy, label, offline update including: manager white list, debug level, execute root directory, bridge name, bridge IP, fixed CIDR, defaut gateway, iptables, ipforwark, userland proxyIf pouchd is alive, you can only use --offline=true to update config file
Update daemon's configurations, if daemon is stoped, it will just update config file. Online update just including: image proxy, label, offline update including: manager white list, debug level, execute root directory, bridge name, bridge IP, fixed CIDR, defaut gateway, iptables, ipforwark, userland proxy. If pouchd is alive, you can only use --offline=true to update config file

```
pouch updatedaemon [OPTIONS]
Expand Down
4 changes: 2 additions & 2 deletions docs/commandline/pouch_upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Upgrade a container with new image and args

### Synopsis

upgrade is a feature to replace a container's image.You can specify the new Entrypoint and Cmd for the new container. When you want to updatea container's image, but inherit the network and volumes of the old container, then you shouldthink about the upgrade feature.
upgrade is a feature to replace a container's image. You can specify the new Entrypoint and Cmd for the new container. When you want to update a container's image, but inherit the network and volumes of the old container, then you should think about the upgrade feature.

```
pouch upgrade [OPTIONS] CONTAINER [COMMAND] [ARG...]
Expand All @@ -16,7 +16,7 @@ pouch upgrade [OPTIONS] CONTAINER [COMMAND] [ARG...]
$ pouch run -d -m 20m --name test registry.hub.docker.com/library/busybox:latest
4c58d27f58d38776dda31c01c897bbf554c802a9b80ae4dc20be1337f8a969f2
$ pouch upgrade --image registry.hub.docker.com/library/hello-world:latest test
test1
test
```

### Options
Expand Down