1NAME()                                                                  NAME()
2
3
4
5       runc - Open Container Initiative runtime
6
7
8

SYNOPSIS

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

DESCRIPTION

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

COMMANDS

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

GLOBAL OPTIONS

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