1podman-remote(1) General Commands Manual podman-remote(1)
2
6 podman-remote - A remote CLI for Podman: A Simple management tool for
7 pods, containers and images.
8
11 podman-remote [options] command
12
15 Podman (Pod Manager) is a fully featured container engine that is a
16 simple daemonless tool. Podman provides a Docker-CLI comparable com‐
17 mand line that eases the transition from other container engines and
18 allows the management of pods, containers and images. Simply put:
19 alias docker=podman. Most Podman commands can be run as a regular
20 user, without requiring additional privileges.
21 Podman uses Buildah(1) internally to create container images. Both
24 tools share image (not container) storage, hence each can use or manip‐
25 ulate images (but not containers) created by the other.
26 Podman-remote provides a local client interacting with a Podman backend
29 node through a RESTful API tunneled through a ssh connection. In this
30 context, a Podman node is a Linux system with Podman installed on it
31 and the API service activated. Credentials for this session can be
32 passed in using flags, environment variables, or in containers.conf.
33 The containers.conf file is placed under $HOME/.config/containers/con‐
36 tainers.conf on Linux and Mac and %APPDATA%\containers\containers.conf
37 on Windows.
38 podman [GLOBAL OPTIONS]
41
44 --connection=name, -c
45 Remote connection name
46 Overrides environment variable CONTAINER_CONNECTION if set.
49 --help, -h
52 Print usage statement
53 --identity=path
56 Path to ssh identity file. If the identity file has been encrypted,
57 Podman prompts the user for the passphrase. If no identity file is
58 provided and no user is given, Podman defaults to the user running the
59 podman command. Podman prompts for the login password on the remote
60 server.
61 Identity value resolution precedence:
64 - command line value
65 - environment variable CONTAINER_SSHKEY, if CONTAINER_HOST is found
66 - containers.conf
67 --log-level=level
70 Log messages above specified level: debug, info, warn, error (default),
71 fatal or panic
72 --url=value
75 URL to access Podman service (default from containers.conf, rootless
76 "unix://run/user/$UID/podman/podman.sock" or as root "unix://run/pod‐
77 man/podman.sock).
78 • CONTAINER_HOST is of the format <schema>://[<user[:<pass‐
81 word>]@]<host>[:<port>][<path>]
82 • CONTAINER_PROXY is of the format
84 <socks5|socks5h>://[<user[:<password>]@]<host>[:<port>]
85 Details:
89 - schema is one of:
90 * ssh (default): a local unix(7) socket on the named host and port,
91 reachable via SSH
92 * tcp: an unencrypted, unauthenticated TCP connection to the named
93 host and port, can work with proxy if CONTAINER_PROXY is set
94 * unix: a local unix(7) socket at the specified path, or the default
95 for the user
96 - user defaults to either root or the current running user (ssh only)
97 - password has no default (ssh only)
98 - host must be provided and is either the IP or name of the machine
99 hosting the Podman service (ssh and tcp)
100 - port defaults to 22 (ssh and tcp)
101 - path defaults to either /run/podman/podman.sock, or
102 /run/user/$UID/podman/podman.sock if running rootless (unix), or must
103 be explicitly specified (ssh)
104 - CONTAINER_PROXY: use proxy (socks5 or socks5h) to access Podman ser‐
105 vice (tcp only)
106 URL value resolution precedence:
109 - command line value
110 - environment variable CONTAINER_HOST
111 - engine.service_destinations table in containers.conf, excluding the
112 /usr/share/containers directory
113 - unix://run/podman/podman.sock
114 Remote connections use local containers.conf for default.
117 Some example URL values in valid formats:
120 - unix://run/podman/podman.sock
121 - unix://run/user/$UID/podman/podman.sock
122 - ssh://notroot@localhost:22/run/user/$UID/podman/podman.sock
123 - ssh://root@localhost:22/run/podman/podman.sock
124 - tcp://localhost:34451
125 - tcp://127.0.0.1:34451
126 --version
129 Print the version
130
133 Podman can set up environment variables from env of [engine] table in
134 containers.conf. These variables can be overridden by passing environ‐
135 ment variables before the podman commands.
136 CONTAINERS_CONF
139 Set default locations of containers.conf file
140 CONTAINER_CONNECTION
143 Set default --connection value to access Podman service.
144 CONTAINER_HOST
147 Set default --url value to access Podman service.
148 CONTAINER_SSHKEY
151 Set default --identity path to ssh key file value used to access Podman
152 service.
153
156 The exit code from podman gives information about why the container
157 failed to run or why it exited. When podman commands exit with a non-
158 zero code, the exit codes follow the chroot standard, see below:
159 125 The error is with podman itself
162 $ podman run --foo busybox; echo $?
165 Error: unknown flag: --foo
166 125
167 126 Executing a contained command and the command cannot be invoked
171 $ podman run busybox /etc; echo $?
174 Error: container_linux.go:346: starting container process caused "exec: \"/etc\": permission denied": OCI runtime error
175 126
176 127 Executing a contained command and the command cannot be found
180 $ podman run busybox foo; echo $?
181 Error: container_linux.go:346: starting container process caused
182 "exec: \"foo\": executable file not found in $PATH": OCI runtime error
183 127
184 Exit code contained command exit code
187 $ podman run busybox /bin/sh -c 'exit 3'; echo $?
190 3
191
195 ┌──────────────────────┬────────────────────────────────┐
196 │Command │ Description │
197 ├──────────────────────┼────────────────────────────────┤
198 │podman-attach(1) │ Attach to a running container. │
199 ├──────────────────────┼────────────────────────────────┤
200 │podman-build(1) │ Build a container image using │
201 │ │ a Dockerfile. │
202 ├──────────────────────┼────────────────────────────────┤
203 │podman-commit(1) │ Create new image based on the │
204 │ │ changed container. │
205 ├──────────────────────┼────────────────────────────────┤
206 │podman-container(1) │ Manage containers. │
207 ├──────────────────────┼────────────────────────────────┤
208 │podman-cp(1) │ Copy files/folders between a │
209 │ │ container and the local │
210 │ │ filesystem. │
211 ├──────────────────────┼────────────────────────────────┤
212 │podman-create(1) │ Create a new container. │
213 ├──────────────────────┼────────────────────────────────┤
214 │podman-diff(1) │ Inspect changes on a container │
215 │ │ or image's filesystem. │
216 ├──────────────────────┼────────────────────────────────┤
217 │podman-events(1) │ Monitor Podman events │
218 ├──────────────────────┼────────────────────────────────┤
219 │podman-export(1) │ Export a container's filesys‐ │
220 │ │ tem contents as a tar archive. │
221 ├──────────────────────┼────────────────────────────────┤
222 │podman-generate(1) │ Generate structured data based │
223 │ │ on containers and pods. │
224 ├──────────────────────┼────────────────────────────────┤
225 │podman-healthcheck(1) │ Manage healthchecks for con‐ │
226 │ │ tainers │
227 ├──────────────────────┼────────────────────────────────┤
228 │podman-history(1) │ Show the history of an image. │
229 ├──────────────────────┼────────────────────────────────┤
230 │podman-image(1) │ Manage images. │
231 ├──────────────────────┼────────────────────────────────┤
232 │podman-images(1) │ List images in local storage. │
233 ├──────────────────────┼────────────────────────────────┤
234 │podman-import(1) │ Import a tarball and save it │
235 │ │ as a filesystem image. │
236 ├──────────────────────┼────────────────────────────────┤
237 │podman-info(1) │ Display Podman related system │
238 │ │ information. │
239 ├──────────────────────┼────────────────────────────────┤
240 │podman-init(1) │ Initialize a container │
241 ├──────────────────────┼────────────────────────────────┤
242 │podman-inspect(1) │ Display a container or image's │
243 │ │ configuration. │
244 ├──────────────────────┼────────────────────────────────┤
245 │podman-kill(1) │ Kill the main process in one │
246 │ │ or more containers. │
247 ├──────────────────────┼────────────────────────────────┤
248 │podman-load(1) │ Load an image from a container │
249 │ │ image archive into container │
250 │ │ storage. │
251 ├──────────────────────┼────────────────────────────────┤
252 │podman-logs(1) │ Display the logs of a con‐ │
253 │ │ tainer. │
254 ├──────────────────────┼────────────────────────────────┤
255 │podman-pause(1) │ Pause one or more containers. │
256 ├──────────────────────┼────────────────────────────────┤
257 │podman-pod(1) │ Management tool for groups of │
258 │ │ containers, called pods. │
259 ├──────────────────────┼────────────────────────────────┤
260 │podman-port(1) │ List port mappings for a con‐ │
261 │ │ tainer. │
262 ├──────────────────────┼────────────────────────────────┤
263 │podman-ps(1) │ Print out information about │
264 │ │ containers. │
265 ├──────────────────────┼────────────────────────────────┤
266 │podman-pull(1) │ Pull an image from a registry. │
267 ├──────────────────────┼────────────────────────────────┤
268 │podman-push(1) │ Push an image from local stor‐ │
269 │ │ age to elsewhere. │
270 ├──────────────────────┼────────────────────────────────┤
271 │podman-restart(1) │ Restart one or more contain‐ │
272 │ │ ers. │
273 ├──────────────────────┼────────────────────────────────┤
274 │podman-rm(1) │ Remove one or more containers. │
275 ├──────────────────────┼────────────────────────────────┤
276 │podman-rmi(1) │ Remove one or more locally │
277 │ │ stored images. │
278 ├──────────────────────┼────────────────────────────────┤
279 │podman-run(1) │ Run a command in a new con‐ │
280 │ │ tainer. │
281 ├──────────────────────┼────────────────────────────────┤
282 │podman-save(1) │ Save an image to a container │
283 │ │ archive. │
284 ├──────────────────────┼────────────────────────────────┤
285 │podman-start(1) │ Start one or more containers. │
286 ├──────────────────────┼────────────────────────────────┤
287 │podman-stop(1) │ Stop one or more running con‐ │
288 │ │ tainers. │
289 ├──────────────────────┼────────────────────────────────┤
290 │podman-system(1) │ Manage podman. │
291 ├──────────────────────┼────────────────────────────────┤
292 │podman-tag(1) │ Add an additional name to a │
293 │ │ local image. │
294 ├──────────────────────┼────────────────────────────────┤
295 │podman-top(1) │ Display the running processes │
296 │ │ of a container. │
297 ├──────────────────────┼────────────────────────────────┤
298 │podman-unpause(1) │ Unpause one or more contain‐ │
299 │ │ ers. │
300 ├──────────────────────┼────────────────────────────────┤
301 │podman-version(1) │ Display the Podman version in‐ │
302 │ │ formation. │
303 ├──────────────────────┼────────────────────────────────┤
304 │podman-volume(1) │ Manage Volumes. │
305 └──────────────────────┴────────────────────────────────┘
306
308 containers.conf ($HOME/.config/containers/containers.conf)
309 Podman has builtin defaults for command line options. These defaults
312 can be overridden using the containers.conf configuration files.
313 Users can modify defaults by creating the $HOME/.config/containers/con‐
316 tainers.conf file. Podman merges its builtin defaults with the speci‐
317 fied fields from this file, if it exists. Fields specified in the users
318 file override the built-in defaults.
319 Podman uses builtin defaults if no containers.conf file is found.
322
325 podman(1), podman-system-service(1), containers.conf(5)
326 podman-remote(1)