1podman-container-runlabel(1)()                  podman-container-runlabel(1)()
2
3
4

NAME

6       podman-container-runlabel  -  Executes a command as described by a con‐
7       tainer image label
8
9

SYNOPSIS

11       podman container runlabel [options] label image [arg...]
12
13

DESCRIPTION

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

OPTIONS:

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

Examples

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

SEE ALSO

175       podman(1)
176
177

HISTORY

179       September  2018,  Originally  compiled by Brent Baude (bbaude at redhat
180       dot com)
181
182
183
184                                                podman-container-runlabel(1)()