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, memory,
63              IO and network stats. See runc-events(8).
64
65
66       exec   Execute a new process inside the container. See runc-exec(8).
67
68
69       init   Initialize the namespaces and launch the container init process.
70              This command is not supposed to be used directly.
71
72
73       kill   Send  a  specified  signal  to the container's init process. See
74              runc-kill(8).
75
76
77       list   List containers started by runc with the given --root. See runc-
78              list(8).
79
80
81       pause  Suspend all processes inside the container. See runc-pause(8).
82
83
84       ps     Show processes running inside the container. See runc-ps(8).
85
86
87       restore
88              Restore  a  container  from  a previous checkpoint. See runc-re‐
89              store(8).
90
91
92       resume Resume all processes that have been previously paused. See runc-
93              resume(8).
94
95
96       run    Create and start a container. See runc-run(8).
97
98
99       spec   Create a new specification file (config.json). See runc-spec(8).
100
101
102       start  Start  a  container previously created by runc create. See runc-
103              start(8).
104
105
106       state  Show the container state. See runc-state(8).
107
108
109       update Update container resource constraints. See runc-update(8).
110
111
112       help, h
113              Show a list of commands or help for a particular command.
114
115
116

GLOBAL OPTIONS

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

SEE ALSO

167       runc-checkpoint(8),  runc-create(8),  runc-delete(8),   runc-events(8),
168       runc-exec(8),  runc-kill(8),  runc-list(8),  runc-pause(8), runc-ps(8),
169       runc-restore(8),  runc-resume(8),  runc-run(8),   runc-spec(8),   runc-
170       start(8), runc-state(8), runc-update(8).
171
172
173
174                                                                       runc(8)
Impressum