summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAge
* Improve documentation of (podman image save --format)Miloslav Trmač2021-12-06
| | | | | | | | - Don't pointlessly repeat the names - Improve documentation of the formats - Use a table, per MANPAGE_SYNTAX.md Signed-off-by: Miloslav Trmač <mitr@redhat.com>
* List /etc/containers/certs.d as default for --cert-pathDaniel J Walsh2021-12-06
| | | | | | Helps Document https://github.com/containers/podman/issues/10116 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* Add note about volume with unprivileged containerUrvashi Mohnani2021-12-06
| | | | | | | | | | | | | Add a note to the generated kube yaml if we detect a volume is being mounted. The note lets the user know what needs to be done to avoid permission denied error when trying to access the volume for an unprivileged container. Add the same note to the man pages. NO NEW TESTS NEEDED Signed-off-by: Urvashi Mohnani <umohnani@redhat.com>
* systemd: replace multi-user with default.targetValentin Rothberg2021-12-01
| | | | | | | | | | | | Replace multi-user.target with default.target across the code base. It seems like the multi-user one is not available for (rootless) users on F35 anymore is causing issues in all kinds of ways, for instance, enabling the podman.service or generated systemd units. Backport of commit 9a10e2124bb11027fc71db4c495c116277b8b7e3. Fixes: #12438 Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* Support env variables based on ConfigMaps sent in payloadJakub Dzon2021-11-30
| | | | | | Fixes #12363 Signed-off-by: Jakub Dzon <jdzon@redhat.com>
* Fix Zsh completion command documentationYahav Itzhak2021-11-12
| | | | Signed-off-by: yahavi <yahavi@jfrog.com>
* Add some information about disabling SELinux when using system volumesDaniel J Walsh2021-11-12
| | | | | | | | | | | A comment was made on internal mailing list about confusion on SELinux labeling of volumes. This PR makes it a little more clear about when you should or should not relabel. We need a similar comment in podman pod create, but it does not support --security-opt processing yet. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* Add information on how podman machine is updatedAshley Cui2021-11-12
| | | | | | | Update documentation on how the default podman machine distribution, FCOS, is updated. Signed-off-by: Ashley Cui <acui@redhat.com>
* Fix pause usage exampleGiacomo Sanchietti2021-11-12
| | | | | | The page contains a wrong 'stop' command example. Signed-off-by: Giacomo Sanchietti <giacomo.sanchietti@nethesis.it>
* Pod Rm Infra Improvementscdoern2021-11-12
| | | | | | | | Made changes so that if the pod contains all exited containers and only infra is running, remove the pod. resolves #11713 Signed-off-by: cdoern <cdoern@redhat.com>
* Generate Kube should not print default structsDaniel J Walsh2021-11-12
| | | | | | | | | | | | | | | | | | | | If podman uses Workdir="/" or the workdir specified in the image, it should not add it to the yaml. If Podman find environment variables in the image, they should not get added to the yaml. If the container or pod do not have changes to SELinux we should not print seLinuxOpt{} If the container or pod do not change any dns options the yaml should not have a dnsOption={} If the container is not privileged it should not have privileged=false in the yaml. Fixes: https://github.com/containers/podman/issues/11995 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* fuse-overlay probably means fuse-overlayfs.Junichi Uekawa2021-11-12
| | | | | | fuse-overlayfs is usually the package name. Signed-off-by: Junichi Uekawa <dancer@debian.org>
* Replace 'an user' => 'a user'Stefan Weil2021-11-12
| | | | Signed-off-by: Stefan Weil <sw@weilnetz.de>
* [CI:DOCS] Include manifest example usageChris Evich2021-10-19
| | | | | | Fixes #8872 Signed-off-by: Chris Evich <cevich@redhat.com>
* Change podman.1 man page to show corret log-level defaultDaniel J Walsh2021-10-19
| | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* Allow a value of -1 to set unlimited pids limitUrvashi Mohnani2021-10-19
| | | | | | | | | Users can set --pids-limit to -1 now to set unlimited pids limit for a container - this matches the convention. [NO TESTS NEEDED] Signed-off-by: Urvashi Mohnani <umohnani@redhat.com>
* Update docs for --platform in podman-build.1Nalin Dahyabhai2021-09-29
| | | | | | | | Update the descriptions of the --arch, --os, --variant, and --platform options, since the last of those hasn't been a no-op for some time, and it was recently extended to accept multiple values. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
* Merge pull request #11705 from mheon/340OpenShift Merge Robot2021-09-22
|\ | | | | Release 3.4.0-rc2 (inc. backports)
| * Use a new markdown converter for sphinxPaul Holzinger2021-09-22
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Recommonmark has many issues and is deprecated. The recommended alternative is MyST-Parser. [1] The myst parser looks great, it also correctly parses tables and adds the correct links. To test locallay run: ``` cd docs rm -rf build/ \# install build deps sudo dnf install python3-sphinx && pip install myst-parser make html python -m http.server 8000 --directory build/html \# Now check in your browser if it looks good to you ``` [1] https://github.com/readthedocs/recommonmark/issues/221 Signed-off-by: Paul Holzinger <pholzing@redhat.com>
| * [CI:DOCS] Add network alias note in man pagesTomSweeneyRedHat2021-09-22
| | | | | | | | | | | | | | Adds a note about the limitation of network aliases to the man pages This should satisfy https://issues.redhat.com/browse/RUN-1189 Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
| * Remove references to kube being developmentBrent Baude2021-09-22
| | | | | | | | | | | | | | | | | | | | At this point and even though we are always improving the play and generate kube functions, I would say it no longers needs to be denoted as under development. [NO TESTS NEEDED] Signed-off-by: Brent Baude <bbaude@redhat.com>
| * Add podman image/container inspect man pagesDaniel J Walsh2021-09-22
| | | | | | | | | | | | | | | | [NO TESTS NEEDED] since this is really a docs change. Concludes: https://github.com/containers/podman/pull/11620 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
| * [CI:DOCS] Add link to skopeo delete in podman rmiUrvashi Mohnani2021-09-22
| | | | | | | | | | | | | | Add a note pointing to skopeo delete for when users want to delete an image in a remote registry. Signed-off-by: Urvashi Mohnani <umohnani@redhat.com>
| * [CI:DOCS] markdown cleanupEd Santiago2021-09-22
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * podman-inspect: make references be live links, not a static list. Also, remove container- and image-inspect, because those are NOPs. * podman-pull: add a missing right-paren * podman-search, podman: remove unwanted indentation from some file descriptions. Markdown indentation renders as one very very long line, requiring the user to use a horizontal scroll bar to read the text. I searched using grep '^ ' and eyeball-looking for text that doesn't look like one-line code examples, and see no more, but eyeball checks are fragile. One bug remains: MyST renders mailto: links uglily. I can find no way to fix this other than patching the source code. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | Fix machine imageAshley Cui2021-09-22
|/ | | | | | | Make sure setting machine image to `testing` pulls down the testing stream, and not the next stream Signed-off-by: Ashley Cui <acui@redhat.com>
* Fix podman-build manpages by using version from mainMatthew Heon2021-09-16
| | | | Signed-off-by: Matthew Heon <mheon@redhat.com>
* Show variant and codename of the distributionAnders F Björklund2021-09-16
| | | | | | | | | | | | Along with the name (id) and the version(_id) But only show the information if is available Examples: Fedora CoreOS, Ubuntu Focal [NO TESTS NEEDED] Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>
* Fix example in podman machine init man pagePaul Holzinger2021-09-16
| | | | | | Fixes #11582 Signed-off-by: Paul Holzinger <pholzing@redhat.com>
* Remove pod create options `--cpus` and `--cpuset-cpus`Matthew Heon2021-09-16
| | | | | | | These are not presently functional - we need a rewrite of how the pod cgroup is handled first. Signed-off-by: Matthew Heon <mheon@redhat.com>
* [CI:DOCS] Remove short 'a' option from all-tagsTomSweeneyRedHat2021-09-13
| | | | | | | | | The short option 'a' for the --all-tags option in the pull page is not valid, remove it. Addresses: #11536 Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* Merge pull request #11513 from Luap99/unshareOpenShift Merge Robot2021-09-11
|\ | | | | podman unshare keep exit code
| * podman unshare keep exit codePaul Holzinger2021-09-10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | In case the command inside the podman unshare env failed podman unshare always exits with 125 and prints `Error: exit status 125`. This is a bad user experience and makes it difficult to use in scripts which could expect certain exit codes. This commit makes sure podman unshare uses the same exit code as the command and does not print the useless `exit status X` message. Also to match podman run/exec it should return 126 for EPERM and 127 for ENOENT. Signed-off-by: Paul Holzinger <pholzing@redhat.com>
* | Merge pull request #11323 from umohnani8/initOpenShift Merge Robot2021-09-10
|\ \ | | | | | | Add init containers to generate and play kube
| * | Add init containers to generate and play kubeUrvashi Mohnani2021-09-10
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | Kubernetes has a concept of init containers that run and exit before the regular containers in a pod are started. We added init containers to podman pods as well. This patch adds support for generating init containers in the kube yaml when a pod we are converting had init containers. When playing a kube yaml, it detects an init container and creates such a container in podman accordingly. Note, only init containers created with the init type set to "always" will be generated as the "once" option deletes the init container after it has run and exited. Play kube will always creates init containers with the "always" init container type. Signed-off-by: Urvashi Mohnani <umohnani@redhat.com>
* / Fix missing args in name in exampleShion Tanaka2021-09-10
|/ | | | Signed-off-by: Shion Tanaka <shtanaka@redhat.com>
* Merge pull request #11492 from rhatdan/manOpenShift Merge Robot2021-09-09
|\ | | | | [CI:DOCS] Fix spacing on --userns options in docs
| * Fix spacing on --userns options in docsDaniel J Walsh2021-09-08
| | | | | | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | Add logDriver to podman infoDaniel J Walsh2021-09-08
|/ | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* Merge pull request #11468 from Luap99/play-kube-slirpOpenShift Merge Robot2021-09-08
|\ | | | | fix play kube --network options
| * fix play kube --network optionsPaul Holzinger2021-09-08
| | | | | | | | | | | | | | | | | | | | | | | | Commit 092902b45555 introduced advanced network options for podman play kube. However this never worked because it unconditionally set the network mode to bridge after it parsed the network option. Added a test to ensure the correct mode is set. Truly fixes #10807 Signed-off-by: Paul Holzinger <pholzing@redhat.com>
* | Merge pull request #11427 from flouthoc/kube-pod-logsOpenShift Merge Robot2021-09-07
|\ \ | |/ |/| kube: Add support for `podman pod logs`.
| * kube: Add support for podman pod logsAditya Rajan2021-09-05
| | | | | | | | | | | | | | | | | | | | | | Following PR adds support for `kubectl` like `pod logs` to podman. Usage `podman pod logs <podIDorName` gives a stream of logs for all the containers within the pod with **containername** as a field. Just like **`kubectl`** also supports `podman pod logs -c ctrIDorName podIDorName` to limit the log stream to any of the specificied container which belongs to pod. Signed-off-by: Aditya Rajan <arajan@redhat.com>
* | Merge pull request #11402 from Luap99/macvlan-docOpenShift Merge Robot2021-09-07
|\ \ | | | | | | network create: add warning for deprecated macvlan flag
| * | network create: add warning for deprecated macvlan flagPaul Holzinger2021-09-07
| |/ | | | | | | | | | | | | | | | | | | | | | | The macvlan driver is not deprecated, only the --macvlan flag is. Remove the flag from the man page since it is deprecated and add a warning to podman network create if it is used. [NO TESTS NEEDED] Fixes #11400 Signed-off-by: Paul Holzinger <pholzing@redhat.com>
* / Example says there is not IP then in the next command suggests to use itFabien Benetou2021-09-05
|/ | | | Signed-off-by: Utopiah <fabien-services@benetou.fr>
* Merge pull request #11368 from giuseppe/fix-man-formatDaniel J Walsh2021-09-01
|\ | | | | [CI:DOCS] fix indentation for userns modes
| * docs: fix indentation for userns modesGiuseppe Scrivano2021-08-31
| | | | | | | | | | | | Closes: https://github.com/containers/podman/issues/11364 Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
* | generate systemd: clarify limitations of `--new`Valentin Rothberg2021-09-01
| | | | | | | | | | | | | | | | | | | | | | | | | | `generate systemd --new` is looking at the "create command" of the container/pod which is simply the os.Args at creation time. It does not work on containers or pods created via the REST API since the create command is not set. `--new` does work on such containers and pods since there is no reliable way to reverse-map their configs to command-line arguments of podman. Fixes: #11370 Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* | [CI:DOCS] podman cp: highlight globbing and multi-file copyValentin Rothberg2021-08-31
|/ | | | | | | | | | | | `podman cp` does not allow for globbing or filtering copied data in any form. `docker cp` does not either, so Podman remains compatible. Due to a number of requests, highlight how users can effectively achieve that by means of chaining with tools such as xargs(1) or find(1), or by making use of `podman mount`. Closes: #11346 Closes: #11194 Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* InfraContainer Reworkcdoern2021-08-26
| | | | | | | | | | InfraContainer should go through the same creation process as regular containers. This change was from the cmd level down, involving new container CLI opts and specgen creating functions. What now happens is that both container and pod cli options are populated in cmd and used to create a podSpecgen and a containerSpecgen. The process then goes as follows FillOutSpecGen (infra) -> MapSpec (podOpts -> infraOpts) -> PodCreate -> MakePod -> createPodOptions -> NewPod -> CompleteSpec (infra) -> MakeContainer -> NewContainer -> newContainer -> AddInfra (to pod state) Signed-off-by: cdoern <cdoern@redhat.com>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-12-27 09:51:12 +0000