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

     1  % runc-run "8"
     2  
     3  # NAME
     4  **runc-run** - create and start a container
     5  
     6  # SYNOPSIS
     7  **runc run** [_option_ ...] _container-id_
     8  
     9  # DESCRIPTION
    10  The **run** command creates an instance of a container from a bundle, and
    11  starts it.  You can think of **run** as a shortcut for **create** followed by
    12  **start**.
    13  
    14  # OPTIONS
    15  **--bundle**|**-b** _path_
    16  : Path to the root of the bundle directory. Default is current directory.
    17  
    18  **--console-socket** _path_
    19  : Path to an **AF_UNIX**  socket which will receive a file descriptor
    20  referencing the master end of the console's pseudoterminal.  See
    21  [docs/terminals](https://github.com/opencontainers/runc/blob/master/docs/terminals.md).
    22  
    23  **--detach**|**-d**
    24  : Detach from the container's process.
    25  
    26  **--pid-file** _path_
    27  : Specify the file to write the initial container process' PID to.
    28  
    29  **--no-subreaper**
    30  : Disable the use of the subreaper used to reap reparented processes.
    31  
    32  **--no-pivot**
    33  : Do not use pivot root to jail process inside rootfs. This should not be used
    34  except in exceptional circumstances, and may be unsafe from the security
    35  standpoint.
    36  
    37  **--no-new-keyring**
    38  : Do not create a new session keyring for the container. This will cause the
    39  container to inherit the calling processes session key.
    40  
    41  **--preserve-fds** _N_
    42  : Pass _N_ additional file descriptors to the container (**stdio** +
    43  **$LISTEN_FDS** + _N_ in total). Default is **0**.
    44  
    45  **--keep**
    46  : Keep container's state directory and cgroup. This can be helpful if a user
    47  wants to check the state (e.g. of cgroup controllers) after the container has
    48  exited. If this option is used, a manual **runc delete** is needed afterwards
    49  to clean an exited container's artefacts.
    50  
    51  # SEE ALSO
    52  
    53  **runc**(8).