Add man pages in markdown format
Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
This commit is contained in:
Mrunal Patel
parent
7b6c4c418d
commit
dffb1d232b
|
|
@ -0,0 +1,22 @@
|
|||
# NAME
|
||||
runc checkpoint - checkpoint a running container
|
||||
|
||||
# USAGE
|
||||
runc checkpoint [command options] <container-id>
|
||||
|
||||
Where "<container-id>" is the name for the instance of the container to be
|
||||
checkpointed.
|
||||
|
||||
# DESCRIPTION
|
||||
The checkpoint command saves the state of the container instance.
|
||||
|
||||
# OPTIONS
|
||||
--image-path path for saving criu image files
|
||||
--work-path path for saving work files and logs
|
||||
--leave-running leave the process running after checkpointing
|
||||
--tcp-established allow open tcp connections
|
||||
--ext-unix-sk allow external unix sockets
|
||||
--shell-job allow shell jobs
|
||||
--page-server ADDRESS:PORT of the page server
|
||||
--file-locks handle file locks, for safety
|
||||
--manage-cgroups-mode cgroups mode: 'soft' (default), 'full' and 'strict'.
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# NAME
|
||||
runc delete - delete any resources held by the container often used with detached containers
|
||||
|
||||
# SYNOPSIS
|
||||
runc delete <container-id>
|
||||
|
||||
Where "<container-id>" is the name for the instance of the container.
|
||||
|
||||
# EXAMPLE
|
||||
For example, if the container id is "ubuntu01" and runc list currently shows the
|
||||
status of "ubuntu01" as "destroyed" the following will delete resources held for
|
||||
"ubuntu01" removing "ubuntu01" from the runc list of containers:
|
||||
|
||||
# runc delete ubuntu01
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
# NAME
|
||||
runc events - display container events such as OOM notifications, cpu, memory, IO and network stats
|
||||
|
||||
# SYNOPSIS
|
||||
runc events [command options] <container-id>
|
||||
|
||||
Where "<container-id>" is the name for the instance of the container.
|
||||
|
||||
# DESCRIPTION
|
||||
The events command displays information about the container. By default the
|
||||
information is displayed once every 5 seconds.
|
||||
|
||||
# OPTIONS
|
||||
--interval "5s" set the stats collection interval
|
||||
--stats display the container's stats then exit
|
||||
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
# NAME
|
||||
runc exec - execute new process inside the container
|
||||
|
||||
# SYNOPSIS
|
||||
runc exec [command options] <container-id> <container command>
|
||||
|
||||
Where "<container-id>" is the name for the instance of the container and
|
||||
"<container command>" is the command to be executed in the container.
|
||||
|
||||
# EXAMPLE
|
||||
For example, if the container is configured to run the linux ps command the
|
||||
following will output a list of processes running in the container:
|
||||
|
||||
# runc exec <container-id> ps
|
||||
|
||||
# OPTIONS
|
||||
--console specify the pty slave path for use with the container
|
||||
--cwd current working directory in the container
|
||||
--env, -e [--env option --env option] set environment variables
|
||||
--tty, -t allocate a pseudo-TTY
|
||||
--user, -u UID (format: <uid>[:<gid>])
|
||||
--process, -p path to the process.json
|
||||
--detach, -d detach from the container's process
|
||||
--pid-file specify the file to write the process id to
|
||||
--process-label set the asm process label for the process commonly used with selinux
|
||||
--apparmor set the apparmor profile for the process
|
||||
--no-new-privs set the no new privileges value for the process
|
||||
--cap, -c [--cap option --cap option] add a capability to the bounding set for the process
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
# NAME
|
||||
runc kill - kill sends the specified signal (default: SIGTERM) to the container's init process
|
||||
|
||||
# SYNOPSIS
|
||||
runc kill <container-id> <signal>
|
||||
|
||||
Where "<container-id>" is the name for the instance of the container and
|
||||
"<signal>" is the signal to be sent to the init process.
|
||||
|
||||
# EXAMPLE
|
||||
|
||||
For example, if the container id is "ubuntu01" the following will send a "KILL"
|
||||
signal to the init process of the "ubuntu01" container:
|
||||
|
||||
# runc kill ubuntu01 KILL
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# NAME
|
||||
runc list - lists containers started by runc with the given root
|
||||
|
||||
# SYNOPSIS
|
||||
runc list [command options] [arguments...]
|
||||
|
||||
# DESCRIPTION
|
||||
The default format is table. The following will output the list of containers
|
||||
in json format:
|
||||
|
||||
# runc list -f json
|
||||
|
||||
# OPTIONS
|
||||
--format, -f select one of: table or json.
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
# NAME
|
||||
runc pause - pause suspends all processes inside the container
|
||||
|
||||
# SYNOPSIS
|
||||
runc pause <container-id>
|
||||
|
||||
Where "<container-id>" is the name for the instance of the container to be
|
||||
paused.
|
||||
|
||||
# DESCRIPTION
|
||||
The pause command suspends all processes in the instance of the container.
|
||||
Use runc list to identiy instances of containers and their current status.
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# NAME
|
||||
runc restore - restore a container from a previous checkpoint
|
||||
|
||||
# SYNOPSIS
|
||||
runc restore [command options] <container-id>
|
||||
|
||||
Where "<container-id>" is the name for the instance of the container to be
|
||||
restored.
|
||||
|
||||
# DESCRIPTION
|
||||
Restores the saved state of the container instance that was previously saved
|
||||
using the runc checkpoint command.
|
||||
|
||||
# OPTIONS
|
||||
--image-path path to criu image files for restoring
|
||||
--work-path path for saving work files and logs
|
||||
--tcp-established allow open tcp connections
|
||||
--ext-unix-sk allow external unix sockets
|
||||
--shell-job allow shell jobs
|
||||
--file-locks handle file locks, for safety
|
||||
--manage-cgroups-mode cgroups mode: 'soft' (default), 'full' and 'strict'.
|
||||
--bundle, -b path to the root of the bundle directory
|
||||
--detach, -d detach from the container's process
|
||||
--pid-file specify the file to write the process id to
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
# NAME
|
||||
runc resume - resumes all processes that have been previously paused
|
||||
|
||||
# SYNOPSIS
|
||||
runc resume <container-id>
|
||||
|
||||
Where "<container-id>" is the name for the instance of the container to be
|
||||
resumed.
|
||||
|
||||
# DESCRIPTION
|
||||
The resume command resumes all processes in the instance of the container.
|
||||
Use runc list to identiy instances of containers and their current status.
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
# NAME
|
||||
runc spec - create a new specification file
|
||||
|
||||
# SYNOPSIS
|
||||
runc spec [command options] [arguments...]
|
||||
|
||||
# DESCRIPTION
|
||||
The spec command creates the new specification file named "config.json" for the bundle."
|
||||
|
||||
# OPTIONS
|
||||
--bundle, -b path to the root of the bundle directory
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
# NAME
|
||||
runc start - create and run a container
|
||||
|
||||
# SYNOPSIS
|
||||
runc start [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 start command creates an instance of a container for a bundle. The bundle
|
||||
is a directory with a specification file and a root filesystem.
|
||||
|
||||
# OPTIONS
|
||||
--bundle, -b path to the root of the bundle directory, defaults to the current directory
|
||||
--console specify the pty slave path for use with the container
|
||||
--detach, -d detach from the container's process
|
||||
--pid-file specify the file to write the process id to
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
# NAME
|
||||
runc state - output the state of a container
|
||||
|
||||
# SYNOPSIS
|
||||
runc state <container-id>
|
||||
|
||||
Where "<container-id>" is your name for the instance of the container.
|
||||
|
||||
# DESCRIPTION
|
||||
The state command outputs current state information for the
|
||||
instance of a container.
|
||||
|
|
@ -0,0 +1,52 @@
|
|||
# NAME
|
||||
runc - Open Container Initiative runtime
|
||||
|
||||
# SYNOPSIS
|
||||
runc [global options] command [command options] [arguments...]
|
||||
|
||||
# DESCRIPTION
|
||||
runc is a command line client for running applications packaged according to
|
||||
the Open Container Format (OCF) and is a compliant implementation of the
|
||||
Open Container Initiative specification.
|
||||
|
||||
runc integrates well with existing process supervisors to provide a production
|
||||
container runtime environment for applications. It can be used with your
|
||||
existing process monitoring tools and the container will be spawned as a
|
||||
direct child of the process supervisor.
|
||||
|
||||
Containers are configured using bundles. A bundle for a container is a directory
|
||||
that includes a specification file named "config.json" and a root filesystem.
|
||||
The root filesystem contains the contents of the container.
|
||||
|
||||
To start a new instance of a container:
|
||||
|
||||
# runc start [ -b bundle ] <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. Providing the bundle directory using "-b" is optional. The default
|
||||
value for "bundle" is the current directory.
|
||||
|
||||
# COMMANDS
|
||||
checkpoint checkpoint a running container
|
||||
delete delete any resources held by the container often used with detached containers
|
||||
events display container events such as OOM notifications, cpu, memory, IO and network stats
|
||||
exec execute new process inside the container
|
||||
kill kill sends the specified signal (default: SIGTERM) to the container's init process
|
||||
list lists containers started by runc with the given root
|
||||
pause pause suspends all processes inside the container
|
||||
restore restore a container from a previous checkpoint
|
||||
resume resumes all processes that have been previously paused
|
||||
spec create a new specification file
|
||||
start create and run a container
|
||||
state output the state of a container
|
||||
help, h Shows a list of commands or help for one command
|
||||
|
||||
# GLOBAL OPTIONS
|
||||
--debug enable debug output for logging
|
||||
--log set the log file path where internal debug information is written
|
||||
--log-format "text" set the format used by logs ('text' (default), or 'json')
|
||||
--root "/run/opencontainer/containers" root directory for storage of container state (this should be located in tmpfs)
|
||||
--criu "criu" path to the criu binary used for checkpoint and restore
|
||||
--help, -h show help
|
||||
--version, -v print the version
|
||||
Loading…
Reference in New Issue