aboutsummaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAge
* Man pages: refactor common options: --rootfsEd Santiago2022-09-12
| | | | | | | | | | podman-create and -run only. The SELinux text was added to podman-run (but not -create) in #3631, and reformatted in #5192. I assume here that it also applies to podman-create. Per feedback from Dan, added :s0 to SELinux context Signed-off-by: Ed Santiago <santiago@redhat.com>
* Merge pull request #15717 from Luap99/eventsOpenShift Merge Robot2022-09-12
|\ | | | | fix several podman events issues
| * Improve --tmpdir and --events-backend docsPaul Holzinger2022-09-12
| | | | | | | | | | | | List the default paths to the event log file and the tmpdir option. Signed-off-by: Paul Holzinger <pholzing@redhat.com>
* | Merge pull request #15751 from edsantiago/docs_dedup_volumes_fromOpenShift Merge Robot2022-09-12
|\ \ | |/ |/| [CI:DOCS] Man pages: refactor common options: --volumes-from
| * Man pages: refactor common options: --volumes-fromEd Santiago2022-09-12
| | | | | | | | | | | | | | | | | | | | Removed a spurious right-bracket; went with upper-case for options; removed 'you's; added some <<container|pod>>s. Hard to review because none of the existing man pages had it quite right. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | Merge pull request #15511 from rhatdan/codespellOpenShift Merge Robot2022-09-12
|\ \ | | | | | | Fix stutters
| * | Fix stuttersDaniel J Walsh2022-09-10
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | Podman adds an Error: to every error message. So starting an error message with "error" ends up being reported to the user as Error: error ... This patch removes the stutter. Also ioutil.ReadFile errors report the Path, so wrapping the err message with the path causes a stutter. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* / [CI:DOCS] --volume: consistent wordingValentin Rothberg2022-09-12
|/ | | | | | | Make sure that the wording of mounting something _from_ the source _into_ the destination is consistent. Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
* Man pages: refactor common options: --volumeEd Santiago2022-09-09
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This one is a nightmare, because --volume has been edited in four different files throughout the years (five if you count podman-build, which I am not including in this PR). Those edits have not always been done in sync. The list of options was reordered 2022-06-28 by Giuseppe in #14734, but only in podman-create and -run (not in podman-pod-*). No explanation of why, but I'll assume he knew what he was doing, and have accepted that for the reference copy. There was also a big edit in #8519. The "Propagation property...bind mounted" sentence first appeared in pod-clone, in #14299 by cdoern, with no obvious source of where it came from. I choose to include it in the reference copy. The "**copy**" option seems to work in pod-create, so I'm including it in the reference copy. Someone please yell loudly if this is not the case. The "disables SELinux separation for containers used in the build", no idea, changed that to just "for the container/pod" The "advanced users / overlay / upperdir / workdir" paragraph makes zero sense to me, but hey, I assume it applies to all the commands, so I put it in the reference copy. Finally, there's still a mishmash of backticks, asterisks, underscores, and even quotation marks. Someone is gonna have to perform major cleanup on this one day, but at least it'll be in only one place. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Merge pull request #15687 from vrothberg/RUN-1639OpenShift Merge Robot2022-09-09
|\ | | | | health check: add on-failure actions
| * health check: add on-failure actionsValentin Rothberg2022-09-09
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | For systems that have extreme robustness requirements (edge devices, particularly those in difficult to access environments), it is important that applications continue running in all circumstances. When the application fails, Podman must restart it automatically to provide this robustness. Otherwise, these devices may require customer IT to physically gain access to restart, which can be prohibitively difficult. Add a new `--on-failure` flag that supports four actions: - **none**: Take no action. - **kill**: Kill the container. - **restart**: Restart the container. Do not combine the `restart` action with the `--restart` flag. When running inside of a systemd unit, consider using the `kill` or `stop` action instead to make use of systemd's restart policy. - **stop**: Stop the container. To remain backwards compatible, **none** is the default action. Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
* | Fixes for vendoring BuildahEd Santiago2022-09-09
|/ | | | | | | | | | | | | | | | | | | | | This commit was automatically cherry-picked by buildah-vendor-treadmill v0.3 from the buildah vendor treadmill PR, #13808 Changes since 2022-08-16: - buildah 4139: minor line-number changes to the diff file because helpers.bash got edited - buildah 4190: skip the new test if remote - buildah 4195: add --retry / --retry-delay - changes to deal with vendoring gomega, units - changes to the podman login error message in system test Signed-off-by: Paul Holzinger <pholzing@redhat.com>
* Man pages: refactor common options: --userns (pod)Ed Santiago2022-09-07
| | | | | | | | Another easy one. Difference is that pod-create was fixed in #14532 (s/ignore/not allowed/) but pod-clone was not. I went with the fixed version. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Man pages: refactor common options: --privilegedEd Santiago2022-09-07
| | | | | | An easy one. Went with the version from podman-run. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Merge pull request #15653 from edsantiago/docs_dedup_sysctlOpenShift Merge Robot2022-09-07
|\ | | | | [CI:DOCS] Man pages: refactor common options: --sysctl
| * Man pages: refactor common options: --sysctlEd Santiago2022-09-06
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | As promised, harder and harder to review. Please take your time with this one. For IPC, I went with the list form. For net, I used the single- sentence form instead of a one-element list. The container/pod diffs are clumsy, sorry. Maybe it's time to start thinking of a more flexible conditional mechanism, but I'd really like to avoid that so I hope this is acceptable. In the first sentence I went with 'namespaced' (final 'd') in all instances. I also got rid of the 'new' in 'new pod' in pod-clone. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | Merge pull request #15634 from bbalp/update-system-reset-warning-messageOpenShift Merge Robot2022-09-07
|\ \ | | | | | | Update system reset warning message regarding deletion of volumes
| * | Update the displayed warning in documentation regarding the system resetBarnabé BALP2022-09-06
| | | | | | | | | | | | | | | | | | [NO NEW TESTS NEEDED] Signed-off-by: Barnabé BALP <contact@barnabebalp.fr>
* | | Merge pull request #15547 from vrothberg/RUN-1606OpenShift Merge Robot2022-09-06
|\ \ \ | | | | | | | | Support auto updates for Kubernetes workloads
| * | | kube play: support auto updates and rollbacksValentin Rothberg2022-09-06
| |/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add auto-update support to `podman kube play`. Auto-update policies can be configured for: * the entire pod via the `io.containers.autoupdate` annotation * a specific container via the `io.containers.autoupdate/$name` annotation To make use of rollbacks, the `io.containers.sdnotify` policy should be set to `container` such that the workload running _inside_ the container can send the READY message via the NOTIFY_SOCKET once ready. For further details on auto updates and rollbacks, please refer to the specific article [1]. Since auto updates and rollbacks bases on Podman's systemd integration, the k8s YAML must be executed in the `podman-kube@` systemd template. For further details on how to run k8s YAML in systemd via Podman, please refer to the specific article [2]. An examplary k8s YAML may look as follows: ```YAML apiVersion: v1 kind: Pod metadata: annotations: io.containers.autoupdate: "local" io.containers.autoupdate/b: "registry" labels: app: test name: test_pod spec: containers: - command: - top image: alpine name: a - command: - top image: alpine name: b ``` [1] https://www.redhat.com/sysadmin/podman-auto-updates-rollbacks [2] https://www.redhat.com/sysadmin/kubernetes-workloads-podman-systemd Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
* | | Merge pull request #15621 from ventifus/fix-manpage-headerOpenShift Merge Robot2022-09-06
|\ \ \ | |_|/ |/| | [CI:DOCS] Fix manpage header formatting
| * | Fix manpage headersAndrew Denton2022-09-06
| | | | | | | | | | | | Signed-off-by: Andrew Denton <adenton@redhat.com>
* | | Man pages: refactor common options: --deviceEd Santiago2022-09-06
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The refactors are starting to get harder to review - sorry. Here the differences are pretty small, mostly changes to the "it is a combination" wording and some asteriskization. The more significant diffs are that there are some Notes that are pod- or container- or build-specific; I needed to move those from the middle to the end, then keep them in the source files themselves. I don't think this affects readability of the resulting man pages, but your opinion may differ. Last important thing: I included the /dev/fuse text in the common option, which means it will now show up in podman-build (it was not previously there). If this text is not applicable to podman-build, please LMK ASAP so I can just move it back to individual source files. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | Merge pull request #15584 from sstosh/generate-systemd-envOpenShift Merge Robot2022-09-06
|\ \ \ | | | | | | | | Add generate systemd -e/--env option
| * | | Add generate systemd -e/--env optionToshiki Sonoda2022-09-06
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | -e/--env option sets environment variables to the systemd unit files. Fixes: #15523 Signed-off-by: Toshiki Sonoda <sonoda.toshiki@fujitsu.com>
* | | | Man pages: refactor common options: --memory*Ed Santiago2022-09-05
| |_|/ |/| | | | | | | | | | | | | | | | | | | | | | | (memory-star, i.e., several memory options) that didn't get included in #15276. Most of them are shoo-ins; the two in container-clone and pod-clone deserve special attention because of the "If unspecified" wording. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | Fix list of default capabilitiesDaniel J Walsh2022-09-05
| | | | | | | | | | | | | | | | | | Fixes: https://github.com/containers/podman/issues/15626 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | | Man pages: refactor common options: --labelEd Santiago2022-09-03
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Went with the podman-run version, where the "example" is in the option template as per our guidelines. I could not include the network- or volume-create man pages, nor podman build. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | Merge pull request #15606 from edsantiago/docs_dedup_digestfileOpenShift Merge Robot2022-09-03
|\ \ \ | |_|/ |/| | [CI:DOCS] Man pages: refactor common options: --digestfile
| * | Man pages: refactor common options: --digestfileEd Santiago2022-09-01
| |/ | | | | | | | | | | | | Only used in two pages. I took the liberty of adding the "N/A on remote" text to manifest-push. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | Merge pull request #15604 from edsantiago/docs_dedup_deviceXYOpenShift Merge Robot2022-09-02
|\ \ | |/ |/| [CI:DOCS] Man pages: refactor common options: --device-X-Y
| * Man pages: refactor common options: --device-X-YEd Santiago2022-09-01
| | | | | | | | | | | | | | Followup from #15276: add the FAQ-26 link, and fix one broken replacement. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | Merge pull request #15601 from edsantiago/docs_dedup_nameOpenShift Merge Robot2022-09-01
|\ \ | |/ |/| [CI:DOCS] Man pages: refactor common options: --name
| * Man pages: refactor common options: --nameEd Santiago2022-09-01
| | | | | | | | | | | | | | | | | | | | Only for podman-create and -run, unfortunately: all the others are too different, and can't easily be combined. I went with the podman-run version because it was most recently updated in #5192. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | implement podman updateCharlie Doern2022-09-01
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | podman update allows users to change the cgroup configuration of an existing container using the already defined resource limits flags from podman create/run. The supported flags in crun are: this command is also now supported in the libpod api via the /libpod/containers/<CID>/update endpoint where the resource limits are passed inthe request body and follow the OCI resource spec format –memory –cpus –cpuset-cpus –cpuset-mems –memory-swap –memory-reservation –cpu-shares –cpu-quota –cpu-period –blkio-weight –cpu-rt-period –cpu-rt-runtime -device-read-bps -device-write-bps -device-read-iops -device-write-iops -memory-swappiness -blkio-weight-device resolves #15067 Signed-off-by: Charlie Doern <cdoern@redhat.com>
* Merge pull request #15473 from umohnani8/empty-dirOpenShift Merge Robot2022-08-31
|\ | | | | Add emptyDir volume support to kube play
| * Add emptyDir volume support to kube playUrvashi Mohnani2022-08-30
| | | | | | | | | | | | | | | | | | | | | | When a kube yaml has a volume set as empty dir, podman will create an anonymous volume with the empty dir name and attach it to the containers running in the pod. When the pod is removed, the empy dir volume created is also removed. Add tests and docs for this as well. Signed-off-by: Urvashi Mohnani <umohnani@redhat.com>
* | Merge pull request #15562 from edsantiago/docs_dedup_signalOpenShift Merge Robot2022-08-31
|\ \ | | | | | | [CI:DOCS] Man pages: refactor common options: --signal
| * | Man pages: refactor common options: --signalEd Santiago2022-08-31
| | | | | | | | | | | | | | | | | | | | | | | | | | | Would've been an easy one, except I decided to fix the text to conform to our guidelines. I haven't been doing this, but in this case it's only two man pages and the text is short enough to make for easy review. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | Merge pull request #15411 from arixmkii/override_default_usernameOpenShift Merge Robot2022-08-31
|\ \ \ | | | | | | | | Allow to override default username via command line
| * | | Allow to override default username via command lineArthur Sengileyev2022-08-30
| | | | | | | | | | | | | | | | Signed-off-by: Arthur Sengileyev <arthur.sengileyev@gmail.com>
* | | | Merge pull request #15389 from giuseppe/userns-map-userOpenShift Merge Robot2022-08-31
|\ \ \ \ | |_|/ / |/| | | podman: add uid and gid options to keep-id
| * | | docs: move userns options to separate fileGiuseppe Scrivano2022-08-30
| | | | | | | | | | | | | | | | Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
| * | | podman: add uid and gid options to keep-idGiuseppe Scrivano2022-08-30
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | add two new options to the keep-id user namespace option: - uid: allow to override the UID used inside the container. - gid: allow to override the GID used inside the container. For example, the following command will map the rootless user (that has UID=0 inside the rootless user namespace) to the UID=11 inside the container user namespace: $ podman run --userns=keep-id:uid=11 --rm -ti fedora cat /proc/self/uid_map 0 1 11 11 0 1 12 12 65525 Closes: https://github.com/containers/podman/issues/15294 Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
* | | | Man pages: refactor common options: --restartEd Santiago2022-08-30
| |_|/ |/| | | | | | | | | | | | | | | | | Only applicable to podman-create and -run. I went with the -run version because it is cleaner and more recently updated. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | Man pages: refactor common options: --subXidnameEd Santiago2022-08-30
|/ / | | | | | | | | | | | | | | | | | | Whew! This one started off identical everywhere, but the version in podman-run got fixed in #1380, then again in #5192, with no corresponding fixes to any of the other man pages. I went with the podman-run version, with a small change in wording. Signed-off-by: Ed Santiago <santiago@redhat.com>
* / Man pages: refactor common options: --http-proxyEd Santiago2022-08-29
|/ | | | | | | Only between podman-create and -run. (podman-build is too different). I went with the podman-run version. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Man pages: refactor common options: --dns-*Ed Santiago2022-08-29
| | | | | | | | | | | --dns-opt and --dns-search, but only in podman-create and -run. Went with the -run version in both cases; --dns-opt remained unchanged, but in --dns-search I changed 'and' to 'with'. Did not consolidate podman-build or podman-pod-create: too different. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Merge pull request #15507 from patrycja-guzik/docs-examplesOpenShift Merge Robot2022-08-27
|\ | | | | [CI:DOCS] Fix example sections to follow the same format
| * Fix example sections to follow the same formatpatrycja-guzik2022-08-27
| | | | | | | | Signed-off-by: patrycja-guzik <patrycja.k.guzik@gmail.com>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-12-29 17:25:42 +0000