bump runc@b263a43430ac6996a4302b891688544225197294
Signed-off-by: Antonio Murdaca <runcom@redhat.com>
This commit is contained in:
parent
73a0881dbb
commit
c258a2d8f0
386 changed files with 9394 additions and 39467 deletions
11
vendor/github.com/opencontainers/runc/man/runc-checkpoint.8.md
generated
vendored
11
vendor/github.com/opencontainers/runc/man/runc-checkpoint.8.md
generated
vendored
|
@ -1,7 +1,7 @@
|
|||
# NAME
|
||||
runc checkpoint - checkpoint a running container
|
||||
|
||||
# USAGE
|
||||
# SYNOPSIS
|
||||
runc checkpoint [command options] <container-id>
|
||||
|
||||
Where "<container-id>" is the name for the instance of the container to be
|
||||
|
@ -11,12 +11,13 @@ checkpointed.
|
|||
The checkpoint command saves the state of the container instance.
|
||||
|
||||
# OPTIONS
|
||||
--image-path path for saving criu image files
|
||||
--work-path path for saving work files and logs
|
||||
--image-path value path for saving criu image files
|
||||
--work-path value path for saving work files and logs
|
||||
--leave-running leave the process running after checkpointing
|
||||
--tcp-established allow open tcp connections
|
||||
--ext-unix-sk allow external unix sockets
|
||||
--shell-job allow shell jobs
|
||||
--page-server ADDRESS:PORT of the page server
|
||||
--page-server value ADDRESS:PORT of the page server
|
||||
--file-locks handle file locks, for safety
|
||||
--manage-cgroups-mode cgroups mode: 'soft' (default), 'full' and 'strict'.
|
||||
--manage-cgroups-mode value cgroups mode: 'soft' (default), 'full' and 'strict'
|
||||
--empty-ns value create a namespace, but don't restore its properies
|
||||
|
|
26
vendor/github.com/opencontainers/runc/man/runc-create.8.md
generated
vendored
Normal file
26
vendor/github.com/opencontainers/runc/man/runc-create.8.md
generated
vendored
Normal file
|
@ -0,0 +1,26 @@
|
|||
# NAME
|
||||
runc create - create a container
|
||||
|
||||
# SYNOPSIS
|
||||
runc create [command options] <container-id>
|
||||
|
||||
Where "<container-id>" is your name for the instance of the container that you
|
||||
are starting. The name you provide for the container instance must be unique on
|
||||
your host.
|
||||
|
||||
# DESCRIPTION
|
||||
The create command creates an instance of a container for a bundle. The bundle
|
||||
is a directory with a specification file named "config.json" and a root
|
||||
filesystem.
|
||||
|
||||
The specification file includes an args parameter. The args parameter is used
|
||||
to specify command(s) that get run when the container is started. To change the
|
||||
command(s) that get executed on start, edit the args parameter of the spec. See
|
||||
"runc spec --help" for more explanation.
|
||||
|
||||
# OPTIONS
|
||||
--bundle value, -b value path to the root of the bundle directory, defaults to the current directory
|
||||
--console value specify the pty slave path for use with the container
|
||||
--pid-file value specify the file to write the process id to
|
||||
--no-pivot do not use pivot root to jail process inside rootfs. This should be used whenever the rootfs is on top of a ramdisk
|
||||
--no-new-keyring do not create a new session keyring for the container. This will cause the container to inherit the calling processes session key
|
9
vendor/github.com/opencontainers/runc/man/runc-delete.8.md
generated
vendored
9
vendor/github.com/opencontainers/runc/man/runc-delete.8.md
generated
vendored
|
@ -1,14 +1,17 @@
|
|||
# NAME
|
||||
runc delete - delete any resources held by the container often used with detached containers
|
||||
runc delete - delete any resources held by one or more containers often used with detached containers
|
||||
|
||||
# SYNOPSIS
|
||||
runc delete <container-id>
|
||||
runc delete [command options] <container-id> [container-id...]
|
||||
|
||||
Where "<container-id>" is the name for the instance of the container.
|
||||
|
||||
# OPTIONS
|
||||
--force, -f Forcibly deletes the container if it is still running (uses SIGKILL)
|
||||
|
||||
# EXAMPLE
|
||||
For example, if the container id is "ubuntu01" and runc list currently shows the
|
||||
status of "ubuntu01" as "destroyed" the following will delete resources held for
|
||||
status of "ubuntu01" as "stopped" the following will delete resources held for
|
||||
"ubuntu01" removing "ubuntu01" from the runc list of containers:
|
||||
|
||||
# runc delete ubuntu01
|
||||
|
|
5
vendor/github.com/opencontainers/runc/man/runc-events.8.md
generated
vendored
5
vendor/github.com/opencontainers/runc/man/runc-events.8.md
generated
vendored
|
@ -1,5 +1,5 @@
|
|||
# NAME
|
||||
runc events - display container events such as OOM notifications, cpu, memory, IO and network stats
|
||||
runc events - display container events such as OOM notifications, cpu, memory, and IO usage statistics
|
||||
|
||||
# SYNOPSIS
|
||||
runc events [command options] <container-id>
|
||||
|
@ -11,6 +11,5 @@ Where "<container-id>" is the name for the instance of the container.
|
|||
information is displayed once every 5 seconds.
|
||||
|
||||
# OPTIONS
|
||||
--interval "5s" set the stats collection interval
|
||||
--interval value set the stats collection interval (default: 5s)
|
||||
--stats display the container's stats then exit
|
||||
|
||||
|
|
27
vendor/github.com/opencontainers/runc/man/runc-exec.8.md
generated
vendored
27
vendor/github.com/opencontainers/runc/man/runc-exec.8.md
generated
vendored
|
@ -2,7 +2,7 @@
|
|||
runc exec - execute new process inside the container
|
||||
|
||||
# SYNOPSIS
|
||||
runc exec [command options] <container-id> <container command>
|
||||
runc exec [command options] <container-id> -- <container command> [args...]
|
||||
|
||||
Where "<container-id>" is the name for the instance of the container and
|
||||
"<container command>" is the command to be executed in the container.
|
||||
|
@ -14,15 +14,16 @@ following will output a list of processes running in the container:
|
|||
# runc exec <container-id> ps
|
||||
|
||||
# OPTIONS
|
||||
--console specify the pty slave path for use with the container
|
||||
--cwd current working directory in the container
|
||||
--env, -e [--env option --env option] set environment variables
|
||||
--tty, -t allocate a pseudo-TTY
|
||||
--user, -u UID (format: <uid>[:<gid>])
|
||||
--process, -p path to the process.json
|
||||
--detach, -d detach from the container's process
|
||||
--pid-file specify the file to write the process id to
|
||||
--process-label set the asm process label for the process commonly used with selinux
|
||||
--apparmor set the apparmor profile for the process
|
||||
--no-new-privs set the no new privileges value for the process
|
||||
--cap, -c [--cap option --cap option] add a capability to the bounding set for the process
|
||||
--console value specify the pty slave path for use with the container
|
||||
--cwd value current working directory in the container
|
||||
--env value, -e value set environment variables
|
||||
--tty, -t allocate a pseudo-TTY
|
||||
--user value, -u value UID (format: <uid>[:<gid>])
|
||||
--process value, -p value path to the process.json
|
||||
--detach, -d detach from the container's process
|
||||
--pid-file value specify the file to write the process id to
|
||||
--process-label value set the asm process label for the process commonly used with selinux
|
||||
--apparmor value set the apparmor profile for the process
|
||||
--no-new-privs set the no new privileges value for the process
|
||||
--cap value, -c value add a capability to the bounding set for the process
|
||||
--no-subreaper disable the use of the subreaper used to reap reparented processes
|
||||
|
|
5
vendor/github.com/opencontainers/runc/man/runc-kill.8.md
generated
vendored
5
vendor/github.com/opencontainers/runc/man/runc-kill.8.md
generated
vendored
|
@ -2,11 +2,14 @@
|
|||
runc kill - kill sends the specified signal (default: SIGTERM) to the container's init process
|
||||
|
||||
# SYNOPSIS
|
||||
runc kill <container-id> <signal>
|
||||
runc kill [command options] <container-id> <signal>
|
||||
|
||||
Where "<container-id>" is the name for the instance of the container and
|
||||
"<signal>" is the signal to be sent to the init process.
|
||||
|
||||
# OPTIONS
|
||||
--all, -a send the specified signal to all processes inside the container
|
||||
|
||||
# EXAMPLE
|
||||
|
||||
For example, if the container id is "ubuntu01" the following will send a "KILL"
|
||||
|
|
17
vendor/github.com/opencontainers/runc/man/runc-list.8.md
generated
vendored
17
vendor/github.com/opencontainers/runc/man/runc-list.8.md
generated
vendored
|
@ -2,13 +2,18 @@
|
|||
runc list - lists containers started by runc with the given root
|
||||
|
||||
# SYNOPSIS
|
||||
runc list [command options] [arguments...]
|
||||
runc list [command options]
|
||||
|
||||
# DESCRIPTION
|
||||
The default format is table. The following will output the list of containers
|
||||
in json format:
|
||||
# EXAMPLE
|
||||
Where the given root is specified via the global option "--root"
|
||||
(default: "/run/runc").
|
||||
|
||||
# runc list -f json
|
||||
To list containers created via the default "--root":
|
||||
# runc list
|
||||
|
||||
To list containers created using a non-default value for "--root":
|
||||
# runc --root value list
|
||||
|
||||
# OPTIONS
|
||||
--format, -f select one of: table or json.
|
||||
--format value, -f value select one of: table or json (default: "table")
|
||||
--quiet, -q display only container IDs
|
||||
|
|
2
vendor/github.com/opencontainers/runc/man/runc-pause.8.md
generated
vendored
2
vendor/github.com/opencontainers/runc/man/runc-pause.8.md
generated
vendored
|
@ -2,7 +2,7 @@
|
|||
runc pause - pause suspends all processes inside the container
|
||||
|
||||
# SYNOPSIS
|
||||
runc pause <container-id>
|
||||
runc pause <container-id> [container-id...]
|
||||
|
||||
Where "<container-id>" is the name for the instance of the container to be
|
||||
paused.
|
||||
|
|
13
vendor/github.com/opencontainers/runc/man/runc-ps.8.md
generated
vendored
Normal file
13
vendor/github.com/opencontainers/runc/man/runc-ps.8.md
generated
vendored
Normal file
|
@ -0,0 +1,13 @@
|
|||
# NAME
|
||||
runc ps - ps displays the processes running inside a container
|
||||
|
||||
# SYNOPSIS
|
||||
runc ps [command options] <container-id> [-- ps options]
|
||||
|
||||
# OPTIONS
|
||||
--format value, -f value select one of: table(default) or json
|
||||
|
||||
The default format is table. The following will output the processes of a container
|
||||
in json format:
|
||||
|
||||
# runc ps -f json
|
12
vendor/github.com/opencontainers/runc/man/runc-restore.8.md
generated
vendored
12
vendor/github.com/opencontainers/runc/man/runc-restore.8.md
generated
vendored
|
@ -12,13 +12,15 @@ restored.
|
|||
using the runc checkpoint command.
|
||||
|
||||
# OPTIONS
|
||||
--image-path path to criu image files for restoring
|
||||
--work-path path for saving work files and logs
|
||||
--image-path value path to criu image files for restoring
|
||||
--work-path value path for saving work files and logs
|
||||
--tcp-established allow open tcp connections
|
||||
--ext-unix-sk allow external unix sockets
|
||||
--shell-job allow shell jobs
|
||||
--file-locks handle file locks, for safety
|
||||
--manage-cgroups-mode cgroups mode: 'soft' (default), 'full' and 'strict'.
|
||||
--bundle, -b path to the root of the bundle directory
|
||||
--manage-cgroups-mode value cgroups mode: 'soft' (default), 'full' and 'strict'
|
||||
--bundle value, -b value path to the root of the bundle directory
|
||||
--detach, -d detach from the container's process
|
||||
--pid-file specify the file to write the process id to
|
||||
--pid-file value specify the file to write the process id to
|
||||
--no-subreaper disable the use of the subreaper used to reap reparented processes
|
||||
--no-pivot do not use pivot root to jail process inside rootfs. This should be used whenever the rootfs is on top of a ramdisk
|
||||
|
|
2
vendor/github.com/opencontainers/runc/man/runc-resume.8.md
generated
vendored
2
vendor/github.com/opencontainers/runc/man/runc-resume.8.md
generated
vendored
|
@ -2,7 +2,7 @@
|
|||
runc resume - resumes all processes that have been previously paused
|
||||
|
||||
# SYNOPSIS
|
||||
runc resume <container-id>
|
||||
runc resume <container-id> [container-id...]
|
||||
|
||||
Where "<container-id>" is the name for the instance of the container to be
|
||||
resumed.
|
||||
|
|
28
vendor/github.com/opencontainers/runc/man/runc-run.8.md
generated
vendored
Normal file
28
vendor/github.com/opencontainers/runc/man/runc-run.8.md
generated
vendored
Normal file
|
@ -0,0 +1,28 @@
|
|||
# NAME
|
||||
runc run - create and run a container
|
||||
|
||||
# SYNOPSIS
|
||||
runc run [command options] <container-id>
|
||||
|
||||
Where "<container-id>" is your name for the instance of the container that you
|
||||
are starting. The name you provide for the container instance must be unique on
|
||||
your host.
|
||||
|
||||
# DESCRIPTION
|
||||
The run command creates an instance of a container for a bundle. The bundle
|
||||
is a directory with a specification file named "config.json" and a root
|
||||
filesystem.
|
||||
|
||||
The specification file includes an args parameter. The args parameter is used
|
||||
to specify command(s) that get run when the container is started. To change the
|
||||
command(s) that get executed on start, edit the args parameter of the spec. See
|
||||
"runc spec --help" for more explanation.
|
||||
|
||||
# OPTIONS
|
||||
--bundle value, -b value path to the root of the bundle directory, defaults to the current directory
|
||||
--console value specify the pty slave path for use with the container
|
||||
--detach, -d detach from the container's process
|
||||
--pid-file value specify the file to write the process id to
|
||||
--no-subreaper disable the use of the subreaper used to reap reparented processes
|
||||
--no-pivot do not use pivot root to jail process inside rootfs. This should be used whenever the rootfs is on top of a ramdisk
|
||||
--no-new-keyring do not create a new session keyring for the container. This will cause the container to inherit the calling processes session key
|
9
vendor/github.com/opencontainers/runc/man/runc-spec.8.md
generated
vendored
9
vendor/github.com/opencontainers/runc/man/runc-spec.8.md
generated
vendored
|
@ -14,7 +14,7 @@ parameter that is initially set to call the "sh" command when the container is
|
|||
started. Calling "sh" may work for an ubuntu container or busybox, but will not
|
||||
work for containers that do not include the "sh" program.
|
||||
|
||||
EXAMPLE:
|
||||
# EXAMPLE
|
||||
To run docker's hello-world container one needs to set the args parameter
|
||||
in the spec to call hello. This can be done using the sed command or a text
|
||||
editor. The following commands create a bundle for hello-world, change the
|
||||
|
@ -35,10 +35,15 @@ In the start command above, "container1" is the name for the instance of the
|
|||
container that you are starting. The name you provide for the container instance
|
||||
must be unique on your host.
|
||||
|
||||
An alternative for generating a customized spec config is to use "oci-runtime-tool", the
|
||||
sub-command "oci-runtime-tool generate" has lots of options that can be used to do any
|
||||
customizations as you want, see [runtime-tools](https://github.com/opencontainers/runtime-tools)
|
||||
to get more information.
|
||||
|
||||
When starting a container through runc, runc needs root privilege. If not
|
||||
already running as root, you can use sudo to give runc root privilege. For
|
||||
example: "sudo runc start container1" will give runc root privilege to start the
|
||||
container on your host.
|
||||
|
||||
# OPTIONS
|
||||
--bundle, -b path to the root of the bundle directory
|
||||
--bundle value, -b value path to the root of the bundle directory
|
||||
|
|
21
vendor/github.com/opencontainers/runc/man/runc-start.8.md
generated
vendored
21
vendor/github.com/opencontainers/runc/man/runc-start.8.md
generated
vendored
|
@ -1,25 +1,12 @@
|
|||
# NAME
|
||||
runc start - create and run a container
|
||||
runc start - start signals a created container to execute the user defined process
|
||||
|
||||
# SYNOPSIS
|
||||
runc start [command options] <container-id>
|
||||
runc start <container-id> [container-id...]
|
||||
|
||||
Where "<container-id>" is your name for the instance of the container that you
|
||||
are starting. The name you provide for the container instance must be unique on
|
||||
your host.
|
||||
|
||||
# DESCRIPTION
|
||||
The start command creates an instance of a container for a bundle. The bundle
|
||||
is a directory with a specification file named "config.json" and a root
|
||||
filesystem.
|
||||
|
||||
The specification file includes an args parameter. The args parameter is used
|
||||
to specify command(s) that get run when the container is started. To change the
|
||||
command(s) that get executed on start, edit the args parameter of the spec. See
|
||||
"runc spec --help" for more explanation.
|
||||
|
||||
# OPTIONS
|
||||
--bundle, -b path to the root of the bundle directory, defaults to the current directory
|
||||
--console specify the pty slave path for use with the container
|
||||
--detach, -d detach from the container's process
|
||||
--pid-file specify the file to write the process id to
|
||||
# DESCRIPTIONa
|
||||
The start command signals the container to start the user's defined process.
|
||||
|
|
50
vendor/github.com/opencontainers/runc/man/runc-update.8.md
generated
vendored
Normal file
50
vendor/github.com/opencontainers/runc/man/runc-update.8.md
generated
vendored
Normal file
|
@ -0,0 +1,50 @@
|
|||
# NAME
|
||||
runc update - update container resource constraints
|
||||
|
||||
# SYNOPSIS
|
||||
runc update [command options] <container-id>
|
||||
|
||||
# DESCRIPTION
|
||||
The data can be read from a file or the standard input, the
|
||||
accepted format is as follow (unchanged values can be omitted):
|
||||
|
||||
{
|
||||
"memory": {
|
||||
"limit": 0,
|
||||
"reservation": 0,
|
||||
"swap": 0,
|
||||
"kernel": 0,
|
||||
"kernelTCP": 0
|
||||
},
|
||||
"cpu": {
|
||||
"shares": 0,
|
||||
"quota": 0,
|
||||
"period": 0,
|
||||
"realtimeRuntime": 0,
|
||||
"realtimePeriod": 0,
|
||||
"cpus": "",
|
||||
"mems": ""
|
||||
},
|
||||
"blockIO": {
|
||||
"blkioWeight": 0
|
||||
}
|
||||
}
|
||||
|
||||
Note: if data is to be read from a file or the standard input, all
|
||||
other options are ignored.
|
||||
|
||||
# OPTIONS
|
||||
--resources value, -r value path to the file containing the resources to update or '-' to read from the standard input
|
||||
--blkio-weight value Specifies per cgroup weight, range is from 10 to 1000 (default: 0)
|
||||
--cpu-period value CPU CFS period to be used for hardcapping (in usecs). 0 to use system default
|
||||
--cpu-quota value CPU CFS hardcap limit (in usecs). Allowed cpu time in a given period
|
||||
--cpu-rt-period value CPU realtime period to be used for hardcapping (in usecs). 0 to use system default
|
||||
--cpu-rt-runtime value CPU realtime hardcap limit (in usecs). Allowed cpu time in a given period
|
||||
--cpu-share value CPU shares (relative weight vs. other containers)
|
||||
--cpuset-cpus value CPU(s) to use
|
||||
--cpuset-mems value Memory node(s) to use
|
||||
--kernel-memory value Kernel memory limit (in bytes)
|
||||
--kernel-memory-tcp value Kernel memory limit (in bytes) for tcp buffer
|
||||
--memory value Memory limit (in bytes)
|
||||
--memory-reservation value Memory reservation or soft_limit (in bytes)
|
||||
--memory-swap value Total memory usage (memory + swap); set '-1' to enable unlimited swap
|
24
vendor/github.com/opencontainers/runc/man/runc.8.md
generated
vendored
24
vendor/github.com/opencontainers/runc/man/runc.8.md
generated
vendored
|
@ -6,7 +6,7 @@
|
|||
|
||||
# DESCRIPTION
|
||||
runc is a command line client for running applications packaged according to
|
||||
the Open Container Format (OCF) and is a compliant implementation of the
|
||||
the Open Container Initiative (OCI) format and is a compliant implementation of the
|
||||
Open Container Initiative specification.
|
||||
|
||||
runc integrates well with existing process supervisors to provide a production
|
||||
|
@ -32,22 +32,26 @@ value for "bundle" is the current directory.
|
|||
delete delete any resources held by the container often used with detached containers
|
||||
events display container events such as OOM notifications, cpu, memory, IO and network stats
|
||||
exec execute new process inside the container
|
||||
init initialize the namespaces and launch the process (do not call it outside of runc)
|
||||
kill kill sends the specified signal (default: SIGTERM) to the container's init process
|
||||
list lists containers started by runc with the given root
|
||||
pause pause suspends all processes inside the container
|
||||
ps displays the processes running inside a container
|
||||
restore restore a container from a previous checkpoint
|
||||
resume resumes all processes that have been previously paused
|
||||
run create and run a container
|
||||
spec create a new specification file
|
||||
start create and run a container
|
||||
start executes the user defined process in a created container
|
||||
state output the state of a container
|
||||
update update container resource constraints
|
||||
help, h Shows a list of commands or help for one command
|
||||
|
||||
# GLOBAL OPTIONS
|
||||
--debug enable debug output for logging
|
||||
--log set the log file path where internal debug information is written
|
||||
--log-format "text" set the format used by logs ('text' (default), or 'json')
|
||||
--root "/run/opencontainer/containers" root directory for storage of container state (this should be located in tmpfs)
|
||||
--criu "criu" path to the criu binary used for checkpoint and restore
|
||||
--systemd-cgroup enable systemd cgroup support, expects cgroupsPath to be of form "slice:prefix:name" for e.g. "system.slice:runc:434234"
|
||||
--help, -h show help
|
||||
--version, -v print the version
|
||||
--debug enable debug output for logging
|
||||
--log value set the log file path where internal debug information is written (default: "/dev/null")
|
||||
--log-format value set the format used by logs ('text' (default), or 'json') (default: "text")
|
||||
--root value root directory for storage of container state (this should be located in tmpfs) (default: "/run/runc")
|
||||
--criu value path to the criu binary used for checkpoint and restore (default: "criu")
|
||||
--systemd-cgroup enable systemd cgroup support, expects cgroupsPath to be of form "slice:prefix:name" for e.g. "system.slice:runc:434234"
|
||||
--help, -h show help
|
||||
--version, -v print the version
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue