github.com/opencontainers/runc@v1.2.0-rc.1.0.20240520010911-492dc558cdd6/man/runc.8.md (about)

     1  % runc "8"
     2  
     3  # NAME
     4  **runc** - Open Container Initiative runtime
     5  
     6  # SYNOPSIS
     7  
     8  **runc** [_global-option_ ...] _command_ [_command-option_ ...] [_argument_ ...]
     9  
    10  # DESCRIPTION
    11  runc is a command line client for running applications packaged according to
    12  the Open Container Initiative (OCI) format and is a compliant implementation of the
    13  Open Container Initiative specification.
    14  
    15  runc integrates well with existing process supervisors to provide a production
    16  container runtime environment for applications. It can be used with your
    17  existing process monitoring tools and the container will be spawned as a
    18  direct child of the process supervisor.
    19  
    20  Containers are configured using bundles. A bundle for a container is a directory
    21  that includes a specification file named _config.json_ and a root filesystem.
    22  The root filesystem contains the contents of the container.
    23  
    24  To run a new instance of a container:
    25  
    26  	# runc run [ -b bundle ] container-id
    27  
    28  Where _container-id_ is your name for the instance of the container that you
    29  are starting. The name you provide for the container instance must be unique on
    30  your host.
    31  
    32  Providing the bundle directory using **-b** is optional. The default
    33  value for _bundle_ is the current directory.
    34  
    35  # COMMANDS
    36  **checkpoint**
    37  : Checkpoint a running container. See **runc-checkpoint**(8).
    38  
    39  **create**
    40  : Create a container. See **runc-create**(8).
    41  
    42  **delete**
    43  : Delete any resources held by the container; often used with detached
    44  containers. See **runc-delete**(8).
    45  
    46  **events**
    47  : Display container events, such as OOM notifications, CPU, memory, I/O and
    48  network statistics. See **runc-events**(8).
    49  
    50  **exec**
    51  : Execute a new process inside the container. See **runc-exec**(8).
    52  
    53  **kill**
    54  : Send a specified signal to the container's init process. See
    55  **runc-kill**(8).
    56  
    57  **list**
    58  : List containers started by runc with the given **--root**. See
    59  **runc-list**(8).
    60  
    61  **pause**
    62  : Suspend all processes inside the container. See **runc-pause**(8).
    63  
    64  **ps**
    65  : Show processes running inside the container. See **runc-ps**(8).
    66  
    67  **restore**
    68  : Restore a container from a previous checkpoint. See **runc-restore**(8).
    69  
    70  **resume**
    71  : Resume all processes that have been previously paused. See **runc-resume**(8).
    72  
    73  **run**
    74  : Create and start a container. See **runc-run**(8).
    75  
    76  **spec**
    77  : Create a new specification file (_config.json_). See **runc-spec**(8).
    78  
    79  **start**
    80  : Start a container previously created by **runc create**. See **runc-start**(8).
    81  
    82  **state**
    83  : Show the container state. See **runc-state**(8).
    84  
    85  **update**
    86  : Update container resource constraints. See **runc-update**(8).
    87  
    88  **help**, **h**
    89  : Show a list of commands or help for a particular command.
    90  
    91  # GLOBAL OPTIONS
    92  
    93  These options can be used with any command, and must precede the **command**.
    94  
    95  **--debug**
    96  : Enable debug logging.
    97  
    98  **--log** _path_
    99  : Set the log destination to _path_. The default is to log to stderr.
   100  
   101  **--log-format** **text**|**json**
   102  : Set the log format (default is **text**).
   103  
   104  **--root** _path_
   105  : Set the root directory to store containers' state. The _path_ should be
   106  located on tmpfs. Default is */run/runc*, or *$XDG_RUNTIME_DIR/runc* for
   107  rootless containers.
   108  
   109  **--systemd-cgroup**
   110  : Enable systemd cgroup support. If this is set, the container spec
   111  (_config.json_) is expected to have **cgroupsPath** value in the
   112  *slice:prefix:name* form (e.g. **system.slice:runc:434234**).
   113  
   114  **--rootless** **true**|**false**|**auto**
   115  : Enable or disable rootless mode. Default is **auto**, meaning to auto-detect
   116  whether rootless should be enabled.
   117  
   118  **--help**|**-h**
   119  : Show help.
   120  
   121  **--version**|**-v**
   122  : Show version.
   123  
   124  # SEE ALSO
   125  
   126  **runc-checkpoint**(8),
   127  **runc-create**(8),
   128  **runc-delete**(8),
   129  **runc-events**(8),
   130  **runc-exec**(8),
   131  **runc-kill**(8),
   132  **runc-list**(8),
   133  **runc-pause**(8),
   134  **runc-ps**(8),
   135  **runc-restore**(8),
   136  **runc-resume**(8),
   137  **runc-run**(8),
   138  **runc-spec**(8),
   139  **runc-start**(8),
   140  **runc-state**(8),
   141  **runc-update**(8).