Adjust man pages for create start split
Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
This commit is contained in:
parent
0636bdd45b
commit
c669b8d156
|
@ -0,0 +1,26 @@
|
||||||
|
# NAME
|
||||||
|
runc create - create a container
|
||||||
|
|
||||||
|
# SYNOPSIS
|
||||||
|
runc create [command options] <container-id>
|
||||||
|
|
||||||
|
Where "<container-id>" is your name for the instance of the container that you
|
||||||
|
are starting. The name you provide for the container instance must be unique on
|
||||||
|
your host.
|
||||||
|
|
||||||
|
# DESCRIPTION
|
||||||
|
The create command creates an instance of a container for a bundle. The bundle
|
||||||
|
is a directory with a specification file named "config.json" and a root
|
||||||
|
filesystem.
|
||||||
|
|
||||||
|
The specification file includes an args parameter. The args parameter is used
|
||||||
|
to specify command(s) that get run when the container is started. To change the
|
||||||
|
command(s) that get executed on start, edit the args parameter of the spec. See
|
||||||
|
"runc spec --help" for more explanation.
|
||||||
|
|
||||||
|
# OPTIONS
|
||||||
|
--bundle value, -b value path to the root of the bundle directory, defaults to the current directory
|
||||||
|
--console value specify the pty slave path for use with the container
|
||||||
|
--pid-file value specify the file to write the process id to
|
||||||
|
--no-pivot do not use pivot root to jail process inside rootfs. This should be used whenever the rootfs is on top of a ramdisk
|
||||||
|
--no-new-keyring do not create a new session keyring for the container. This will cause the container to inherit the calling processes session key
|
|
@ -0,0 +1,28 @@
|
||||||
|
# NAME
|
||||||
|
runc run - create and run a container
|
||||||
|
|
||||||
|
# SYNOPSIS
|
||||||
|
runc run [command options] <container-id>
|
||||||
|
|
||||||
|
Where "<container-id>" is your name for the instance of the container that you
|
||||||
|
are starting. The name you provide for the container instance must be unique on
|
||||||
|
your host.
|
||||||
|
|
||||||
|
# DESCRIPTION
|
||||||
|
The run command creates an instance of a container for a bundle. The bundle
|
||||||
|
is a directory with a specification file named "config.json" and a root
|
||||||
|
filesystem.
|
||||||
|
|
||||||
|
The specification file includes an args parameter. The args parameter is used
|
||||||
|
to specify command(s) that get run when the container is started. To change the
|
||||||
|
command(s) that get executed on start, edit the args parameter of the spec. See
|
||||||
|
"runc spec --help" for more explanation.
|
||||||
|
|
||||||
|
# OPTIONS
|
||||||
|
--bundle value, -b value path to the root of the bundle directory, defaults to the current directory
|
||||||
|
--console value specify the pty slave path for use with the container
|
||||||
|
--detach, -d detach from the container's process
|
||||||
|
--pid-file value specify the file to write the process id to
|
||||||
|
--no-subreaper disable the use of the subreaper used to reap reparented processes
|
||||||
|
--no-pivot do not use pivot root to jail process inside rootfs. This should be used whenever the rootfs is on top of a ramdisk
|
||||||
|
--no-new-keyring do not create a new session keyring for the container. This will cause the container to inherit the calling processes session key
|
|
@ -1,27 +1,12 @@
|
||||||
# NAME
|
# NAME
|
||||||
runc start - create and run a container
|
runc start - start signals a created container to execute the user defined process
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
runc start [command options] <container-id>
|
runc start <container-id>
|
||||||
|
|
||||||
Where "<container-id>" is your name for the instance of the container that you
|
Where "<container-id>" is your name for the instance of the container that you
|
||||||
are starting. The name you provide for the container instance must be unique on
|
are starting. The name you provide for the container instance must be unique on
|
||||||
your host.
|
your host.
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTIONa
|
||||||
The start command creates an instance of a container for a bundle. The bundle
|
The start command signals the container to start the user's defined process.
|
||||||
is a directory with a specification file named "config.json" and a root
|
|
||||||
filesystem.
|
|
||||||
|
|
||||||
The specification file includes an args parameter. The args parameter is used
|
|
||||||
to specify command(s) that get run when the container is started. To change the
|
|
||||||
command(s) that get executed on start, edit the args parameter of the spec. See
|
|
||||||
"runc spec --help" for more explanation.
|
|
||||||
|
|
||||||
# OPTIONS
|
|
||||||
--bundle value, -b value path to the root of the bundle directory, defaults to the current directory
|
|
||||||
--console value specify the pty slave path for use with the container
|
|
||||||
--detach, -d detach from the container's process
|
|
||||||
--pid-file value specify the file to write the process id to
|
|
||||||
--no-subreaper disable the use of the subreaper used to reap reparented processes
|
|
||||||
--no-pivot do not use pivot root to jail process inside rootfs. This should be used whenever the rootfs is on top of a ramdisk
|
|
||||||
|
|
|
@ -39,8 +39,9 @@ value for "bundle" is the current directory.
|
||||||
ps displays the processes running inside a container
|
ps displays the processes running inside a container
|
||||||
restore restore a container from a previous checkpoint
|
restore restore a container from a previous checkpoint
|
||||||
resume resumes all processes that have been previously paused
|
resume resumes all processes that have been previously paused
|
||||||
|
run create and run a container
|
||||||
spec create a new specification file
|
spec create a new specification file
|
||||||
start create and run a container
|
start executes the user defined process in a created container
|
||||||
state output the state of a container
|
state output the state of a container
|
||||||
update update container resource constraints
|
update update container resource constraints
|
||||||
help, h Shows a list of commands or help for one command
|
help, h Shows a list of commands or help for one command
|
||||||
|
|
4
start.go
4
start.go
|
@ -9,13 +9,13 @@ import (
|
||||||
|
|
||||||
var startCommand = cli.Command{
|
var startCommand = cli.Command{
|
||||||
Name: "start",
|
Name: "start",
|
||||||
Usage: "start signals a created container to execute the user defined process",
|
Usage: "executes the user defined process in a created container",
|
||||||
ArgsUsage: `<container-id>
|
ArgsUsage: `<container-id>
|
||||||
|
|
||||||
Where "<container-id>" is your name for the instance of the container that you
|
Where "<container-id>" is your name for the instance of the container that you
|
||||||
are starting. The name you provide for the container instance must be unique on
|
are starting. The name you provide for the container instance must be unique on
|
||||||
your host.`,
|
your host.`,
|
||||||
Description: `The start command signals the container to start the user's defined process.`,
|
Description: `The start command executes the user defined process in a created container.`,
|
||||||
Action: func(context *cli.Context) error {
|
Action: func(context *cli.Context) error {
|
||||||
container, err := getContainer(context)
|
container, err := getContainer(context)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|
Loading…
Reference in New Issue