Add man page and fix typo for update command

Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
This commit is contained in:
Qiang Huang 2016-05-09 19:04:25 +08:00
parent d49ece5a83
commit e75465b1a3
2 changed files with 46 additions and 2 deletions

44
man/runc-update.8.md Normal file
View File

@ -0,0 +1,44 @@
# NAME
runc update - update container resource constraints
# SYNOPSIS
runc update [command options] <container-id>
# DESCRIPTION
The data can be read from a file or the standard input, the
accepted format is as follow (unchanged values can be omitted):
{
"memory": {
"limit": 0,
"reservation": 0,
"swap": 0,
"kernel": 0
},
"cpu": {
"shares": 0,
"quota": 0,
"period": 0,
"cpus": "",
"mems": ""
},
"blockIO": {
"blkioWeight": 0
},
}
Note: if data is to be read from a file or the standard input, all
other options are ignored.
# OPTIONS
--resources, -r path to the file containing the resources to update or '-' to read from the standard input.
--blkio-weight "0" Specifies per cgroup weight, range is from 10 to 1000.
--cpu-period CPU period to be used for hardcapping (in usecs). 0 to use system default.
--cpu-quota CPU hardcap limit (in usecs). Allowed cpu time in a given period.
--cpu-share CPU shares (relative weight vs. other containers)
--cpuset-cpus CPU(s) to use
--cpuset-mems Memory node(s) to use
--kernel-memory Kernel memory limit (in bytes) for tcp buffer
--memory Memory limit (in bytes)
--memory-reservation Memory reservation or soft_limit (in bytes)
--memory-swap Total memory usage (memory + swap); set `-1` to enable unlimited swap

View File

@ -18,7 +18,7 @@ func u16Ptr(i uint16) *uint16 { return &i }
var updateCommand = cli.Command{ var updateCommand = cli.Command{
Name: "update", Name: "update",
Usage: "update container resource constraints", Usage: "update container resource constraints",
ArgsUsage: `<container-id> <ps options>`, ArgsUsage: `<container-id>`,
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.StringFlag{ cli.StringFlag{
Name: "resources, r", Name: "resources, r",
@ -46,7 +46,7 @@ The accepted format is as follow (unchanged values can be omitted):
}, },
} }
Note: if data is to be read from a file or the standard output all Note: if data is to be read from a file or the standard input, all
other options are ignored. other options are ignored.
`, `,
}, },