1PODMAN(1)                       September 2018                       PODMAN(1)
2
3
4

NAME

6       podman-container-runlabel - Execute Image Label Method
7
8
9

SYNOPSIS

11       podman container runlabel [-h|--help] [--display] [-n][--name[=NAME]]
12       [--rootfs=ROOTFS] [--set=NAME=VALUE] [--storage] [--replace] LABEL
13       IMAGE [ARG...]
14
15
16

DESCRIPTION

18       podman container runlabel reads the provided LABEL field in the
19       container IMAGE and executes the provided value for the label as a
20       command. If this field does not exist, podman container runlabel will
21       just exit.
22
23
24       If the container image has a LABEL INSTALL instruction like the
25       following:
26
27
28       LABEL INSTALL /usr/bin/podman run -t -i --rm \${OPT1} --privileged -v
29       /:/host --net=host --ipc=host --pid=host -e HOST=/host -e NAME=\${NAME}
30       -e IMAGE=\${IMAGE} -e CONFDIR=\/etc/${NAME} -e LOGDIR=/var/log/\${NAME}
31       -e DATADIR=/var/lib/\${NAME} \${IMAGE} \${OPT2} /bin/install.sh
32       \${OPT3}
33
34
35       podman container runlabel will set the following environment variables
36       for use in the command:
37
38
39       If the container image does not have the desired label, an error
40       message will be displayed along with a non-zero return code.  If the
41       image is not found in local storage, Podman will attempt to pull it
42       first.
43
44
45       Note: Podman will always ensure that podman is the first argument of
46       the command being executed.
47
48
49       LABEL The label name specified via the command.
50
51
52       IMAGE Image name specified via the command.
53
54
55       SUDO_UID The SUDO_UID environment variable.  This is useful with the
56       podman -u option for user space tools.  If the environment variable is
57       not available, the value of /proc/self/loginuid is used.
58
59
60       SUDO_GID The SUDO_GID environment variable.  This is useful with the
61       podman -u option for user space tools.  If the environment variable is
62       not available, the default GID of the value for SUDO_UID is used.  If
63       this value is not available, the value of /proc/self/loginuid is used.
64
65
66       Any additional arguments will be appended to the command.
67
68
69

OPTIONS:

71       --authfile
72
73
74       Path of the authentication file. Default is
75       ${XDG_RUNTIME_DIR}/containers/auth.json, which is set using podman
76       login.  If the authorization state is not found there,
77       $HOME/.docker/config.json is checked, which is set using docker login.
78       (Not available for remote commands)
79
80
81       Note: You can also override the default path of the authentication file
82       by setting the REGISTRY_AUTH_FILE environment variable. export
83       REGISTRY_AUTH_FILE=path
84
85
86       --display
87
88
89       Display the label's value of the image having populated its environment
90       variables.  The runlabel command will not execute if --display is
91       specified.
92
93
94       --cert-dir path
95
96
97       Use certificates at path (*.crt, *.cert, *.key) to connect to the
98       registry.  Default certificates directory is /etc/containers/certs.d.
99       (Not available for remote commands)
100
101
102       --creds
103
104
105       The [username[:password]] to use to authenticate with the registry if
106       required.  If one or both values are not supplied, a command line
107       prompt will appear and the value can be entered.  The password is
108       entered without echo.
109
110
111       --help -h Print usage statement
112
113
114       --name -n=""
115
116
117       Use this name for creating content for the container. NAME will default
118       to the IMAGENAME if it is not specified.
119
120
121       --quiet, -q
122
123
124       Suppress output information when pulling images
125
126
127       --replace
128
129
130       If a container exists of the default or given name, as needed it will
131       be stopped, deleted and a new container will be created from this
132       image.
133
134
135       --tls-verify
136
137
138       Require HTTPS and verify certificates when contacting registries
139       (default: true). If explicitly set to true, then TLS verification will
140       be used. If set to false, then TLS verification will not be used. If
141       not specified, TLS verification will be used unless the target registry
142       is listed as an insecure registry in registries.conf (Not available for
143       remote commands)
144
145

Examples

147       Execute the run label of an image called foobar.
148
149
150              $ sudo podman container runlabel run foobar
151
152
153
154       Execute the install label of an image called foobar with additional
155       arguments.
156
157
158              $ sudo podman container runlabel install foobar apples oranges
159
160
161
162       Display the command that would be executed by runlabel.
163
164
165              $ sudo podman container runlabel --display run foobar
166
167
168

SEE ALSO

170       podman(1)
171
172
173

HISTORY

175       September 2018, Originally compiled by Brent Baude (bbaude at redhat
176       dot com)
177
178
179
180Brent Baude                     Podman Man Pages                     PODMAN(1)