github.com/zhuohuang-hust/src-cbuild@v0.0.0-20230105071821-c7aab3e7c840/mergeCode/runc/man/runc.8.md (about)

     1  # NAME
     2     runc - Open Container Initiative runtime
     3  
     4  # SYNOPSIS
     5     runc [global options] command [command options] [arguments...]
     6     
     7  # DESCRIPTION
     8  runc is a command line client for running applications packaged according to
     9  the Open Container Initiative (OCI) format and is a compliant implementation of the
    10  Open Container Initiative specification.
    11  
    12  runc integrates well with existing process supervisors to provide a production
    13  container runtime environment for applications. It can be used with your
    14  existing process monitoring tools and the container will be spawned as a
    15  direct child of the process supervisor.
    16  
    17  Containers are configured using bundles. A bundle for a container is a directory
    18  that includes a specification file named "config.json" and a root filesystem.
    19  The root filesystem contains the contents of the container. 
    20  
    21  To start a new instance of a container:
    22  
    23      # runc start [ -b bundle ] <container-id>
    24  
    25  Where "<container-id>" is your name for the instance of the container that you
    26  are starting. The name you provide for the container instance must be unique on
    27  your host. Providing the bundle directory using "-b" is optional. The default
    28  value for "bundle" is the current directory.
    29  
    30  # COMMANDS
    31     checkpoint   checkpoint a running container
    32     delete       delete any resources held by the container often used with detached containers
    33     events       display container events such as OOM notifications, cpu, memory, IO and network stats
    34     exec         execute new process inside the container
    35     init         initialize the namespaces and launch the process (do not call it outside of runc)
    36     kill         kill sends the specified signal (default: SIGTERM) to the container's init process
    37     list         lists containers started by runc with the given root
    38     pause        pause suspends all processes inside the container
    39     ps           displays the processes running inside a container
    40     restore      restore a container from a previous checkpoint
    41     resume       resumes all processes that have been previously paused
    42     run          create and run a container
    43     spec         create a new specification file
    44     start        executes the user defined process in a created container
    45     state        output the state of a container
    46     update       update container resource constraints
    47     help, h      Shows a list of commands or help for one command
    48     
    49  # GLOBAL OPTIONS
    50     --debug              enable debug output for logging
    51     --log value          set the log file path where internal debug information is written (default: "/dev/null")
    52     --log-format value   set the format used by logs ('text' (default), or 'json') (default: "text")
    53     --root value         root directory for storage of container state (this should be located in tmpfs) (default: "/run/runc")
    54     --criu value         path to the criu binary used for checkpoint and restore (default: "criu")
    55     --systemd-cgroup     enable systemd cgroup support, expects cgroupsPath to be of form "slice:prefix:name" for e.g. "system.slice:runc:434234"
    56     --help, -h           show help
    57     --version, -v        print the version