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-option ...] command [command-option ...] [argument ...]
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 run a new instance of a container:
34
35
36              # runc run [ -b bundle ] container-id
37
38
39
40       Where  container-id is your name for the instance of the container that
41       you are starting. The name you provide for the container instance  must
42       be unique on your host.
43
44
45       Providing  the bundle directory using -b is optional. The default value
46       for bundle is the current directory.
47
48
49

COMMANDS

51       checkpoint
52              Checkpoint a running container. See runc-checkpoint(8).
53
54
55       create Create a container. See runc-create(8).
56
57
58       delete Delete any resources held by the container; often used with  de‐
59              tached containers. See runc-delete(8).
60
61
62       events Display  container  events, such as OOM notifications, CPU, mem‐
63              ory, I/O and network statistics. See runc-events(8).
64
65
66       exec   Execute a new process inside the container. See runc-exec(8).
67
68
69       kill   Send a specified signal to the  container's  init  process.  See
70              runc-kill(8).
71
72
73       list   List containers started by runc with the given --root. See runc-
74              list(8).
75
76
77       pause  Suspend all processes inside the container. See runc-pause(8).
78
79
80       ps     Show processes running inside the container. See runc-ps(8).
81
82
83       restore
84              Restore a container from a  previous  checkpoint.  See  runc-re‐
85              store(8).
86
87
88       resume Resume all processes that have been previously paused. See runc-
89              resume(8).
90
91
92       run    Create and start a container. See runc-run(8).
93
94
95       spec   Create a new specification file (config.json). See runc-spec(8).
96
97
98       start  Start a container previously created by runc create.  See  runc-
99              start(8).
100
101
102       state  Show the container state. See runc-state(8).
103
104
105       update Update container resource constraints. See runc-update(8).
106
107
108       help, h
109              Show a list of commands or help for a particular command.
110
111
112

GLOBAL OPTIONS

114       These  options  can be used with any command, and must precede the com‐
115       mand.
116
117
118       --debug
119              Enable debug logging.
120
121
122       --log path
123              Set the log destination to  path.  The  default  is  to  log  to
124              stderr.
125
126
127       --log-format text|json
128              Set the log format (default is text).
129
130
131       --root path
132              Set  the  root  directory  to  store containers' state. The path
133              should be located on tmpfs. Default is /run/runc,  or  $XDG_RUN‐
134              TIME_DIR/runc for rootless containers.
135
136
137       --criu path
138              Set  the  path to the criu(8) binary used for checkpoint and re‐
139              store.  Default is criu.
140
141
142       --systemd-cgroup
143              Enable systemd cgroup support. If this  is  set,  the  container
144              spec  (config.json) is expected to have cgroupsPath value in the
145              slice:prefix:name form (e.g. system.slice:runc:434234).
146
147
148       --rootless true|false|auto
149              Enable or disable rootless mode. Default  is  auto,  meaning  to
150              auto-detect whether rootless should be enabled.
151
152
153       --help|-h
154              Show help.
155
156
157       --version|-v
158              Show version.
159
160
161

SEE ALSO

163       runc-checkpoint(8),   runc-create(8),  runc-delete(8),  runc-events(8),
164       runc-exec(8), runc-kill(8),  runc-list(8),  runc-pause(8),  runc-ps(8),
165       runc-restore(8),   runc-resume(8),   runc-run(8),  runc-spec(8),  runc-
166       start(8), runc-state(8), runc-update(8).
167
168
169
170                                                                       runc(8)