diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/podman-container-runlabel.1.md | 102 | ||||
-rw-r--r-- | docs/podman-kill.1.md | 6 | ||||
-rw-r--r-- | docs/podman-stop.1.md | 8 | ||||
-rw-r--r-- | docs/tutorials/podman_tutorial.md | 2 |
4 files changed, 113 insertions, 5 deletions
diff --git a/docs/podman-container-runlabel.1.md b/docs/podman-container-runlabel.1.md new file mode 100644 index 000000000..889a5fb03 --- /dev/null +++ b/docs/podman-container-runlabel.1.md @@ -0,0 +1,102 @@ +% PODMAN(1) Podman Man Pages +% Brent Baude +% September 2018 +# NAME +podman-container-runlabel - Execute Image Label Method + +# SYNOPSIS +**podman container runlabel** +[**-h**|**--help**] +[**--display**] +[**-n**][**--name**[=*NAME*]] +[**-p**][[**--pull**]] +[**--rootfs**=*ROOTFS*] +[**--set**=*NAME*=*VALUE*] +[**--storage**] +LABEL IMAGE [ARG...] + +# DESCRIPTION +**podman container runlabel** reads the provided `LABEL` field in the container +IMAGE and executes the provided value for the label as a command. If this field does not +exist, `podman container runlabel` will just exit. + +If the container image has a LABEL INSTALL instruction like the following: + +`LABEL INSTALL /usr/bin/podman run -t -i --rm \${OPT1} --privileged -v /:/host --net=host --ipc=host --pid=host -e HOST=/host -e NAME=\${NAME} -e IMAGE=\${IMAGE} -e CONFDIR=\/etc/${NAME} -e LOGDIR=/var/log/\${NAME} -e DATADIR=/var/lib/\${NAME} \${IMAGE} \${OPT2} /bin/install.sh \${OPT3}` + +`podman container runlabel` will set the following environment variables for use in the command: + +Note: Podman will always ensure that `podman` is the first argument of the command being executed. + +**NAME** +The name specified via the command. NAME will be replaced with IMAGE if it is not specified. + +**IMAGE** +Image name specified via the command. + +**SUDO_UID** +The `SUDO_UID` environment variable. This is useful with the podman +`-u` option for user space tools. If the environment variable is +not available, the value of `/proc/self/loginuid` is used. + +**SUDO_GID** +The `SUDO_GID` environment variable. This is useful with the podman +`-u` option for user space tools. If the environment variable is +not available, the default GID of the value for `SUDO_UID` is used. +If this value is not available, the value of `/proc/self/loginuid` +is used. + +Any additional arguments will be appended to the command. + +# OPTIONS: +**--authfile** + +Path of the authentication file. Default is ${XDG_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`. +If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`. + +**--display** + +Display the label's value of the image having populated its environment variables. +The runlabel command will not execute if --display is specified. + +**--cert-dir** *path* + +Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry. +Default certificates directory is _/etc/containers/certs.d_. + +**--creds** + +The [username[:password]] to use to authenticate with the registry if required. +If one or both values are not supplied, a command line prompt will appear and the +value can be entered. The password is entered without echo. + +**-h** **--help** +Print usage statement + +**-n** **--name**="" + Use this name for creating content for the container. NAME will default to the IMAGENAME if it is not specified. + +**p** **--pull** + Pull the image if it cannot be found in local storage. + +**--quiet, -q** + +Suppress output information when pulling images + +**--signature-policy="PATHNAME"** + +Pathname of a signature policy file to use. It is not recommended that this +option be used, as the default behavior of using the system-wide default policy +(frequently */etc/containers/policy.json*) is most often preferred + +**--tls-verify** + +Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true, +then tls verification will be used, If set to false then tls verification will not be used. If not specified +tls verification will be used unless the target registry is listed as an insecure registry in registries.conf + +## SEE ALSO +podman(1) + +# HISTORY +September 2018, Originally compiled by Brent Baude (bbaude at redhat dot com) diff --git a/docs/podman-kill.1.md b/docs/podman-kill.1.md index 79449fc57..14066d151 100644 --- a/docs/podman-kill.1.md +++ b/docs/podman-kill.1.md @@ -10,6 +10,10 @@ podman\-kill - Kills one or more containers with a signal The main process inside each container specified will be sent SIGKILL, or any signal specified with option --signal. ## OPTIONS +**--all, -a** + +Signal all running containers. This does not include paused containers. + **--latest, -l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman @@ -30,6 +34,8 @@ podman kill --signal TERM 860a4b23 podman kill --latest +podman kill --signal KILL -a + ## SEE ALSO podman(1), podman-stop(1) diff --git a/docs/podman-stop.1.md b/docs/podman-stop.1.md index 98f74f269..813f0ef9e 100644 --- a/docs/podman-stop.1.md +++ b/docs/podman-stop.1.md @@ -15,10 +15,6 @@ container and also via command line when creating the container. ## OPTIONS -**--timeout, --time, t** - -Timeout to wait before forcibly stopping the container - **--all, -a** Stop all running containers. This does not include paused containers. @@ -28,6 +24,10 @@ Stop all running containers. This does not include paused containers. Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. +**--timeout, --time, t** + +Timeout to wait before forcibly stopping the container + ## EXAMPLE podman stop mywebserver diff --git a/docs/tutorials/podman_tutorial.md b/docs/tutorials/podman_tutorial.md index 9a6cf3e9d..a866b8eed 100644 --- a/docs/tutorials/podman_tutorial.md +++ b/docs/tutorials/podman_tutorial.md @@ -85,7 +85,7 @@ $ sudo cp bin/* /usr/libexec/cni ```console $ git clone https://github.com/opencontainers/runc.git $GOPATH/src/github.com/opencontainers/runc $ cd $GOPATH/src/github.com/opencontainers/runc -$ make static BUILDTAGS="seccomp selinux" +$ make BUILDTAGS="seccomp" $ sudo cp runc /usr/bin/runc ``` |