1runc(8)                     System Manager's Manual                    runc(8)
2
3
4

NAME

6       runc - Open Container Initiative runtime
7
8
9

SYNOPSIS

11       runc [global options] command [command options] [arguments...]
12
13
14

DESCRIPTION

16       runc is a command line client for running applications packaged accord‐
17       ing to the Open Container Initiative (OCI) format and  is  a  compliant
18       implementation of the Open Container Initiative specification.
19
20
21       runc  integrates  well  with  existing process supervisors to provide a
22       production container runtime environment for applications.  It  can  be
23       used with your existing process monitoring tools and the container will
24       be spawned as a direct child of the process supervisor.
25
26
27       Containers are configured using bundles. A bundle for a container is  a
28       directory  that includes a specification file named "config.json" and a
29       root filesystem.  The root filesystem contains the contents of the con‐
30       tainer.
31
32
33       To start a new instance of a container:
34
35
36              # runc start [ -b bundle ] <container-id>
37
38
39
40       Where  "<container-id>"  is your name for the instance of the container
41       that you are starting. The name you provide for the container  instance
42       must  be unique on your host. Providing the bundle directory using "-b"
43       is optional. The default value for "bundle" is the current directory.
44
45
46

COMMANDS

48              checkpoint   checkpoint a running container
49              create       create a container
50              delete       delete any resources held by the container often used with detached containers
51              events       display container events such as OOM notifications, cpu, memory, IO and network stats
52              exec         execute new process inside the container
53              init         initialize the namespaces and launch the process (do not call it outside of runc)
54              kill         kill sends the specified signal (default: SIGTERM) to the container's init process
55              list         lists containers started by runc with the given root
56              pause        pause suspends all processes inside the container
57              ps           displays the processes running inside a container
58              restore      restore a container from a previous checkpoint
59              resume       resumes all processes that have been previously paused
60              run          create and run a container
61              spec         create a new specification file
62              start        executes the user defined process in a created container
63              state        output the state of a container
64              update       update container resource constraints
65              help, h      Shows a list of commands or help for one command
66
67
68
69

GLOBAL OPTIONS

71              --debug              enable debug output for logging
72              --log value          set the log file path where internal debug information is written (default: "/dev/null")
73              --log-format value   set the format used by logs ('text' (default), or 'json') (default: "text")
74              --root value         root directory for storage of container state (this should be located in tmpfs) (default: "/run/runc" or $XDG_RUNTIME_DIR/runc for rootless containers)
75              --criu value         path to the criu binary used for checkpoint and restore (default: "criu")
76              --systemd-cgroup     enable systemd cgroup support, expects cgroupsPath to be of form "slice:prefix:name" for e.g. "system.slice:runc:434234"
77              --rootless value    enable rootless mode ('true', 'false', or 'auto') (default: "auto")
78              --help, -h           show help
79              --version, -v        print the version
80
81
82
83
84                                                                       runc(8)
Impressum