summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-run.1.md
Commit message (Collapse)AuthorAge
* docs: remove CNI word where it is not applicablePaul Holzinger2022-07-26
| | | | | | | | | | Most network commands/features work with both netavark and CNI. When we added added netavark most docs were not vetted and thus still use CNI network, it should just say network. Fixes #14990 Signed-off-by: Paul Holzinger <pholzing@redhat.com>
* man page checker: enforce stricter options formatEd Santiago2022-07-26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Followup to #14906, in which a nonexistent option was found in a man page. The xref script was designed to catch that, but I was too lax in my parsing: the option was documented using wrong syntax, and the script didn't catch it. Solution: do not allow *any* unrecognized cruft in the option description lines. And fix all improperly-written entries to conform to the rule: **--option**=*value(s)* Two asterisks around option, which must have two dashes. One asterisk around value(s). This is going to cause headaches for some people adding new options, but I don't think I can fix that: there are many factors that make an unparseable line. Adding 'hint' code would make the script even more complex than it is. I have to assume that our contributors are smart enough to look at surrounding context and figure out the right way to specify options. Signed-off-by: Ed Santiago <santiago@redhat.com> <MH: Fixed cherry-pick conflicts> Signed-off-by: Matthew Heon <matthew.heon@pm.me>
* [CI:DOCS] man pages: replace -c with --cpu-sharesErik Sjölund2022-07-26
| | | | Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* Docker uses "-c" to mean "--cpu-shares" in create and runDaniel J Walsh2022-07-26
| | | | | | | Add support for -c as an alias for --cpu-shares to be compatible with Docker. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* [CI:DOCS] Improve language. Fix spelling and typos.Erik Sjölund2022-07-26
| | | | | | | | | * Correct spelling and typos. * Improve language. Co-authored-by: Ed Santiago <santiago@redhat.com> Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* [CI:DOCS] Rewrite the --gidmap option docsErik Sjölund2022-07-11
| | | | | | | | * Reference --uidmap in --gidmap docs for additional information * Remove --gidmap example "groupname -> 100000 / 30000 -> 0" Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* improve pull-policy documentationValentin Rothberg2022-07-08
| | | | | | | | | | | | Make sure that the docs for pull policies is consistent with Buildah and reflects the implementation. Further improve the help messages and auto completions. [NO NEW TESTS NEEDED] Fixes: #14846 Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
* Fix spelling "read only" -> "read-only"Erik Sjölund2022-07-02
| | | | Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* volume: new options [no]copyGiuseppe Scrivano2022-06-27
| | | | | | | | | | | add two new options to the volume create command: copy and nocopy. When nocopy is specified, the files from the container image are not copied up to the volume. Closes: https://github.com/containers/podman/issues/14722 Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
* Fix spelling "setup" -> "set up" and similarErik Sjölund2022-06-22
| | | | | | | | | | * Replace "setup", "lookup", "cleanup", "backup" with "set up", "look up", "clean up", "back up" when used as verbs. Replace also variations of those. * Improve language in a few places. Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* [CI:DOCS] Rewrite --env docsErik Sjölund2022-06-19
| | | | | | | | | | * Add docs about trailing * functionality in podman-exec.1.md * Rewrite --env description in podman-create.1.md and podman-run.1.md * Rewrite the --env examples in podman-create.1.md and podman-run.1.md Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* Merge pull request #14405 from rhatdan/docsOpenShift Merge Robot2022-06-09
|\ | | | | [CI:DOCS] Mount propagation works with named volumes
| * Mount propagation works with named volumesDaniel J Walsh2022-05-28
| | | | | | | | | | | | Fixes: https://github.com/containers/podman/issues/13939 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | --userns=keep-id,nomap are not allowed in rootful modeDaniel J Walsh2022-06-08
| | | | | | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | changed megabyte to mebibyteKarthik Elango2022-06-02
| | | | | | | | | | | | | | | | In podman run --help, the message said megabyte, gigabyte, etc. In reality podman takes mebibytes, gibibytes, etc. [CI:DOCS] Signed-off-by: Karthik Elango <kelango@redhat.com>
* | Document protocol usage for --publishDaniel Rudolf2022-06-02
|/ | | | | | This also unifies the documentation of `--publish` for `podman create`, `podman run`, and `podman pod create`. Signed-off-by: Daniel Rudolf <github.com@daniel-rudolf.de>
* fix --init with /dev bind mountValentin Rothberg2022-05-23
| | | | | | | | | | The init binary until now has been bind-mounted to /dev/init which breaks when bind-mounting to /dev. Instead mount the init to /run/podman-init. The reasoning for using /run is that it is already used for other runtime data such as secrets. Fixes: #14251 Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
* Docs rootfull -> rootfulAshley Cui2022-04-25
| | | | | | | | Some docs say roofull. Change to rootful. [NO NEW TESTS NEEDED] Signed-off-by: Ashley Cui <acui@redhat.com>
* Merge pull request #13918 from Luap99/hostsOpenShift Merge Robot2022-04-22
|\ | | | | use etchosts package from c/common
| * Improve /etc/hosts documentationPaul Holzinger2022-04-22
| | | | | | | | | | | | | | | | Update the documentation for /etc/hosts options --add-host and --no-hosts. Also make sure that all references use the same text for consistency. Signed-off-by: Paul Holzinger <pholzing@redhat.com>
* | Add support for --userns=nomapDaniel J Walsh2022-04-21
|/ | | | | | | | | | | From a security point of view, it would be nice to be able to map a rootless usernamespace that does not use your own UID within the container. This would add protection against a hostile process escapping the container and reading content in your homedir. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* slirp4netns: actually make ipv6 defaultPaul Holzinger2022-04-20
| | | | | | | | | | | | | | | | | We already have ipv6 enabled as default via the containers.conf setting. However the documentation did not reflect this. Also if no options were set in contianers.conf it would have ipv6 disabled. We can now remove the extra option from containers.conf. Also fix another outdated option description for host.containers.internal and add that the options can also be set in contianers.conf. [NO NEW TESTS NEEDED] Fixes #13914 Signed-off-by: Paul Holzinger <pholzing@redhat.com>
* Merge pull request #13583 from rhatdan/ipcOpenShift Merge Robot2022-04-16
|\ | | | | Add support for ipc namespace modes "none, private, sharable"
| * Add support for ipc namespace modes "none, private, sharable"Daniel J Walsh2022-04-12
| | | | | | | | | | | | Fixes: #13265 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | run, create: add --passwd-entryGiuseppe Scrivano2022-04-14
|/ | | | | | | | | It allows to customize the entry that is written to the `/etc/passwd` file when --passwd is used. Closes: https://github.com/containers/podman/issues/13185 Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
* [CI:DOCS] Rewrite rootless --userns=auto docsErik Sjölund2022-04-12
| | | | | | | | | | * Remove the statement that rootless --userns=auto does not work. * Mention that --userns=keep-id consumes all subuids and subgids. Co-authored-by: Tom Sweeney <tsweeney@redhat.com> Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* [CI:DOCS] docs: drop note about upcoming RHEL 7.7Giuseppe Scrivano2022-03-25
| | | | | | it was released more than two years ago. Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
* Merge pull request #13622 from rhatdan/systemd1OpenShift Merge Robot2022-03-24
|\ | | | | When running systemd in a container set container_uuid
| * When running systemd in a container set container_uuidDaniel J Walsh2022-03-23
| | | | | | | | | | | | | | | | | | systemd expects the container_uuid environment variable be set when it is running in a container. Fixes: https://github.com/containers/podman/issues/13187 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | man pages: sort flags, and keep them that wayEd Santiago2022-03-23
|/ | | | | | | | | | | | | | Command flags (OPTIONS) in man pages have to date been in haphazard order. Sometimes that order is sensible, e.g., most-important options first, but more often they're just in arbitrary places. This makes life hard for users. Here, I update the man-page-check Makefile script so it checks and enforces alphabetical order in OPTIONS sections. Then -- the hard part -- update all existing man pages to conform to this requirement. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Add support for --chrootdirsLStandman2022-03-14
| | | | Signed-off-by: LStandman <65296484+LStandman@users.noreply.github.com>
* Merge pull request #13066 from rhatdan/manOpenShift Merge Robot2022-02-01
|\ | | | | Clarify remote client means Mac and Windows
| * Clarify remote client means Mac and WindowsDaniel J Walsh2022-01-28
| | | | | | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | Add notes to "--oom-kill-disable" not supported on cgroups V2Tsubasa Watanabe2022-01-31
|/ | | | | | | Clarify "--oom-kill-disable" is not supported on cgroups V2 in documentation. Signed-off-by: Tsubasa Watanabe <w.tsubasa@fujitsu.com>
* volume: add support for non-volatile upperdir,workdir for overlay volumesAditya Rajan2022-01-28
| | | | | | | | | | | | | | | | | | | | Often users want their overlayed volumes to be `non-volatile` in nature that means that same `upper` dir can be re-used by one or more containers but overall of nature of volumes still have to be `overlay` so work done is still on a overlay not on the actual volume. Following PR adds support for more advanced options i.e custom `workdir` and `upperdir` for overlayed volumes. So that users can re-use `workdir` and `upperdir` across new containers as well. Usage ```console $ podman run -it -v myvol:/data:O,upperdir=/path/persistant/upper,workdir=/path/persistant/work alpine sh ``` Signed-off-by: Aditya R <arajan@redhat.com>
* [CI:DOCS] Fix typos and improve languageErik Sjölund2022-01-24
| | | | Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* [CI:DOCS] fix typo subpordinateErik Sjölund2022-01-22
| | | | Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* [CI:DOCS] fix default branch linksErik Sjölund2022-01-15
| | | | | | | | | | * Replace https://github.com/containers/podman/blob/master with https://github.com/containers/podman/blob/main to match the new default branch "main". Previously the default branch was "master". The substitutions were made in the documentation but not the code. Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* [CI:DOCS] Fix typo in --envErik Sjölund2022-01-15
| | | | Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* Prohibit --uid/gid map and --pod for container create/runcdoern2022-01-13
| | | | | | | | | add a check in namespaceOptions() that ensures the user is not setting a new uid/gid map if entering or creating a pod that has an infra container resolves #12669 Signed-off-by: cdoern <cdoern@redhat.com>
* add --ip6 flag to podman create/runPaul Holzinger2022-01-03
| | | | | | | | | | | | Add the --ipv6 flag to podman create/run and pod create. We support the --network name:ip6=<ip> syntax now but for docker compat we should also support the --ip6 flag. Note that there is no validation if the ip is actually a v6 or v4 address because the backend does not care either. Fixes #7511 Signed-off-by: Paul Holzinger <pholzing@redhat.com>
* Merge pull request #12627 from rhatdan/passwdOpenShift Merge Robot2021-12-23
|\ | | | | Allow users to add host user accounts to /etc/passwd
| * Allow users to add host user accounts to /etc/passwdDaniel J Walsh2021-12-23
| | | | | | | | | | | | | | | | | | | | | | Some containers require certain user account(s) to exist within the container when they are run. This option will allow callers to add a bunch of passwd entries from the host to the container even if the entries are not in the local /etc/passwd file on the host. Fixes: https://bugzilla.redhat.com/show_bug.cgi?id=1935831 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | Merge pull request #12679 from vrothberg/fix-12671OpenShift Merge Robot2021-12-23
|\ \ | |/ |/| clarify `io.podman.annotations.seccomp`
| * [CI:DOCS] clarify `io.podman.annotations.seccomp`Valentin Rothberg2021-12-23
| | | | | | | | | | | | | | | | | | Clarify the semantics of the `io.podman.annotations.seccomp` annotation which is set when a container has been created with a custom seccomp profile. Fixes: #12671 Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* | [CI:DOCS] docs: document rootless userns mappingsGiuseppe Scrivano2021-12-23
|/ | | | | | | | | document how the host IDs are mapped inside the rootless user namespace. Closes: https://github.com/containers/podman/issues/12676 Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
* Podman run --passwdcdoern2021-12-21
| | | | | | | | | added support for a new flag --passwd which, when false prohibits podman from creating entries in /etc/passwd and /etc/groups allowing users to modify those files in the container entrypoint resolves #11805 Signed-off-by: cdoern <cdoern@redhat.com>
* support advanced network configuration via cliPaul Holzinger2021-12-14
| | | | | | | | | | | | | | | | | | | | | | | | | | Rework the --network parse logic to support multiple networks with specific network configuration settings. --network can now be set multiple times. For bridge network mode the following options have been added: - **alias=name**: Add network-scoped alias for the container. - **ip=IPv4**: Specify a static ipv4 address for this container. - **ip=IPv6**: Specify a static ipv6 address for this container. - **mac=MAC**: Specify a static mac address address for this container. - **interface_name**: Specify a name for the created network interface inside the container. So now you can set --network bridge:ip=10.88.0.10,mac=44:33:22:11:00:99 for the default bridge network as well as for network names. This is better than using --ip because we can set the ip per network without any confusion which network the ip address should be assigned to. The --ip, --mac-address and --network-alias options are still supported but --ip or --mac-address can only be set when only one network is set. This limitation already existed previously. The ability to specify a custom network interface name is new Fixes #11534 Signed-off-by: Paul Holzinger <pholzing@redhat.com>
* [CI:DOCS] Update notes on java TZ in man pageUrvashi Mohnani2021-11-22
| | | | Signed-off-by: Urvashi Mohnani <umohnani@redhat.com>
* [CI:DOCS] Add java TZ note to run manpageTomSweeneyRedHat2021-11-19
| | | | | | | | | Add a note to show how to workaround the `--tz` option being ignored in the run command. Related to: https://bugzilla.redhat.com/show_bug.cgi?id=1984251 Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-10-23 12:23:25 +0000