diff --git a/CONTRIBUTORS b/CONTRIBUTORS index 27b83316c..6bfb8975d 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -9,6 +9,7 @@ Allen Sun Allen Sun Allen Sun allen.wang +baijia btlcmr0702 bvwells Ce Gao @@ -126,6 +127,7 @@ zhuangqh zhubingbing <1392607554@qq.com> zhubingbing zhubingbing +ziren.wzr ZJ_Lavender Zou Rui <21751189@zju.edu.cn> ZouRui89 <32304680+ZouRui89@users.noreply.github.com> diff --git a/docs/commandline/pouch_events.md b/docs/commandline/pouch_events.md index 132570ba7..1f0552e02 100644 --- a/docs/commandline/pouch_events.md +++ b/docs/commandline/pouch_events.md @@ -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] diff --git a/docs/commandline/pouch_images.md b/docs/commandline/pouch_images.md index afea3e66c..d165b785f 100644 --- a/docs/commandline/pouch_images.md +++ b/docs/commandline/pouch_images.md @@ -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] diff --git a/docs/commandline/pouch_info.md b/docs/commandline/pouch_info.md index 3886c3450..062d2889b 100644 --- a/docs/commandline/pouch_info.md +++ b/docs/commandline/pouch_info.md @@ -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] diff --git a/docs/commandline/pouch_network_create.md b/docs/commandline/pouch_network_create.md index d53b80bf8..55ce47772 100644 --- a/docs/commandline/pouch_network_create.md +++ b/docs/commandline/pouch_network_create.md @@ -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 diff --git a/docs/commandline/pouch_pause.md b/docs/commandline/pouch_pause.md index c8c20a625..d63c75cc0 100644 --- a/docs/commandline/pouch_pause.md +++ b/docs/commandline/pouch_pause.md @@ -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...] diff --git a/docs/commandline/pouch_rmi.md b/docs/commandline/pouch_rmi.md index b30e31b80..b4e2af050 100644 --- a/docs/commandline/pouch_rmi.md +++ b/docs/commandline/pouch_rmi.md @@ -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...] diff --git a/docs/commandline/pouch_start.md b/docs/commandline/pouch_start.md index 6ffab328f..44e9b4e52 100644 --- a/docs/commandline/pouch_start.md +++ b/docs/commandline/pouch_start.md @@ -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...] diff --git a/docs/commandline/pouch_stop.md b/docs/commandline/pouch_stop.md index 8ab00fd85..565e323aa 100644 --- a/docs/commandline/pouch_stop.md +++ b/docs/commandline/pouch_stop.md @@ -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...] diff --git a/docs/commandline/pouch_top.md b/docs/commandline/pouch_top.md index 9b8fb720f..63b0a43d1 100644 --- a/docs/commandline/pouch_top.md +++ b/docs/commandline/pouch_top.md @@ -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] diff --git a/docs/commandline/pouch_unpause.md b/docs/commandline/pouch_unpause.md index 63c21bda5..21834f0de 100644 --- a/docs/commandline/pouch_unpause.md +++ b/docs/commandline/pouch_unpause.md @@ -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...] diff --git a/docs/commandline/pouch_updatedaemon.md b/docs/commandline/pouch_updatedaemon.md index 243c08962..08fd10efc 100644 --- a/docs/commandline/pouch_updatedaemon.md +++ b/docs/commandline/pouch_updatedaemon.md @@ -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] diff --git a/docs/commandline/pouch_upgrade.md b/docs/commandline/pouch_upgrade.md index 176eec36c..beb376295 100644 --- a/docs/commandline/pouch_upgrade.md +++ b/docs/commandline/pouch_upgrade.md @@ -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...] @@ -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