aboutsummaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAge
* docs: resolve typo in create,run manpagesEwout van Mansom2022-07-28
| | | | | | * Replace typo 'personaity' with 'personality' in several man pages Signed-off-by: Ewout van Mansom <ewout@vanmansom.name>
* Merge pull request #15087 from eriksjolund/socket_activation.md_clarify_delayOpenShift Merge Robot2022-07-27
|\ | | | | [CI:DOCS] socket_activation.md: Add start/stop sections
| * [CI:DOCS] socket_activation.md: Add start/stop sectionsErik Sjölund2022-07-27
| | | | | | | | | | | | | | | | | | | | | | | | * Add section "Starting a socket-activated service". * Add section "Stopping a socket-activated service". * Clarify in the diagrams that socket activation only happens for the first client connection. Co-authored-by: Valentin Rothberg <vrothberg@redhat.com> Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* | Merge pull request #15043 from eriksjolund/fix_sdnotify_option_docsOpenShift Merge Robot2022-07-26
|\ \ | | | | | | [CI:DOCS] podman-generate-systemd.1.md: document --sdnotify
| * | [CI:DOCS] podman-generate-systemd.1.md: document --sdnotifyErik Sjölund2022-07-26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Document why the default value for --sdnotify is overridden. Some was included text from https://github.com/containers/podman/issues/15029#issuecomment-1192244755 * Document that --sdnotify=ignore is overridden. Fixes #15029 Co-authored-by: Valentin Rothberg <vrothberg@redhat.com> Co-authored-by: Tom Sweeney <tsweeney@redhat.com> Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* | | pod create --share none should not create infraCharlie Doern2022-07-25
|/ / | | | | | | | | | | | | | | | | | | | | for podman pod create, when we are not sharing any namespaces there is no point for the infra container. This is especially true since resources have also been decoupled from the container recently. handle this on the cmd level so that we can still create infra if set explicitly resolves #15048 Signed-off-by: Charlie Doern <cdoern@redhat.com>
* | Merge pull request #15039 from Luap99/cni-docOpenShift Merge Robot2022-07-22
|\ \ | |/ |/| [CI:DOCS] docs: remove CNI word where it is not applicable
| * docs: remove CNI word where it is not applicablePaul Holzinger2022-07-22
| | | | | | | | | | | | | | | | | | | | 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>
* | Merge pull request #14967 from sstosh/pause-optionOpenShift Merge Robot2022-07-22
|\ \ | | | | | | Add pause/unpause --latest, --cidfile, --filter
| * | Add pause/unpause --latest, --cidfile, --filterToshiki Sonoda2022-07-20
| | | | | | | | | | | | | | | | | | | | | | | | --latest : pause/unpause the latest container. --filter : pause/unpause the filtered container. --cidfile : Read container ID from the specified file and pause/unpause the container. Signed-off-by: Toshiki Sonoda <sonoda.toshiki@fujitsu.com>
* | | Merge pull request #14957 from edsantiago/dont_remake_remoteOpenShift Merge Robot2022-07-22
|\ \ \ | |_|/ |/| | Makefile: use order-only prereq for podman-remote
| * | Makefile: use order-only prereq for podman-remoteEd Santiago2022-07-19
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | podman-remote has a dependency on $(SRCBINDIR), because on Mac and Windows that's a special dir that may not exist. But depending on a directory means depending on its mtime, which changes every time a file in it is updated, which means running 'make' twice in a row will rebuild podman-remote for no good reason. Solution: GNU Make has the concept of "order-only" prerequisites, precisely for this situation. Use it. Since it's an obscure feature, document it. UPDATE: This exposed some nasty duplication wrt podman-remote rules. Clean those up, and add comments to some confusing sections. Fixes: #14756 (Also, drive-by edit to remove a stray misdocumented non-option) Signed-off-by: Ed Santiago <santiago@redhat.com>
* | resource limits for podsCharlie Doern2022-07-21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | added the following flags and handling for podman pod create --memory-swap --cpuset-mems --device-read-bps --device-write-bps --blkio-weight --blkio-weight-device --cpu-shares given the new backend for systemd in c/common, all of these can now be exposed to pod create. most of the heavy lifting (nearly all) is done within c/common. However, some rewiring needed to be done here as well! Signed-off-by: Charlie Doern <cdoern@redhat.com>
* | Merge pull request #14958 from cdoern/networkOpenShift Merge Robot2022-07-20
|\ \ | | | | | | [CI:DOCS] document isolate option for network create
| * | document isolate option for network createCharlie Doern2022-07-18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | [CI:DOCS] document the podman network create -o=isolate which allows networks to cut themselves off from external connections. resolves #5805 Signed-off-by: Charlie Doern <cdoern@redhat.com>
* | | Update init ctr default for play kubeUrvashi Mohnani2022-07-20
| |/ |/| | | | | | | | | | | | | | | Update the init container type default to once instead of always to match k8s behavior. Add a new annotation that can be used to change the init ctr type in the kube yaml. Signed-off-by: Urvashi Mohnani <umohnani@redhat.com>
* | [CI:DOCS] Fix typo in manifest manpageToshiki Sonoda2022-07-19
|/ | | | | | rme -> rm Signed-off-by: Toshiki Sonoda <sonoda.toshiki@fujitsu.com>
* [CI:DOCS] socket_activation.md: fix typo and layoutErik Sjölund2022-07-16
| | | | Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* [CI:DOCS] Tutorials.rst: add socket activationErik Sjölund2022-07-15
| | | | Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* Merge pull request #14932 from jakecorrenti/pull-all-tags-shorthandopenshift-ci[bot]2022-07-15
|\ | | | | Podman pull --all-tags shorthand option
| * Podman pull --all-tags shorthand optionJake Correnti2022-07-14
| | | | | | | | | | | | | | I added the shorthand option for `podman pull --all-tags`. Like Docker, Podman can now do `podman pull -a`. Signed-off-by: Jake Correnti <jcorrenti13@gmail.com>
* | Merge pull request #14909 from eriksjolund/add_socket_activation_tutorialopenshift-ci[bot]2022-07-15
|\ \ | | | | | | [CI:DOCS] Add socket_activation.md
| * | [CI:DOCS] Update docs/tutorials/socket_activation.mdErik Sjölund2022-07-14
| | | | | | | | | | | | | | | Co-authored-by: Valentin Rothberg <vrothberg@redhat.com> Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
| * | [CI:DOCS] Add socket activation tutorialErik Sjölund2022-07-14
| | | | | | | | | | | | | | | | | | Closes #14908 Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* | | Podman stop --filter flagKarthik Elango2022-07-14
| | | | | | | | | | | | | | | | | | | | | Filter flag is added for podman stop and podman --remote stop. Filtering logic is implemented in getContainersAndInputByContext(). Start filtering can be manipulated to use this logic as well to limit redundancy. Signed-off-by: Karthik Elango <kelango@redhat.com>
* | | man page checker: enforce stricter options formatEd Santiago2022-07-14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | Merge pull request #14923 from rhatdan/eventsopenshift-ci[bot]2022-07-14
|\ \ \ | |_|/ |/| | Add podman events -f to be alias for --filter
| * | Add podman events -f to be alias for --filterDaniel J Walsh2022-07-13
| | | | | | | | | | | | | | | | | | Needed for Docker compatibility. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | | Merge pull request #14772 from nicrowe00/12475openshift-ci[bot]2022-07-13
|\ \ \ | | | | | | | | Add "podman kube play" cmd
| * | | Add "podman kube play" cmdNiall Crowe2022-07-13
| |/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The "podman kube play" command is designed to be a replacement for the "podman play kube" command. It performs the same function as "play kube" while also still working with the same flags and options. The "podman play kube" command is still functional as an alias of "kube play". Closes #12475 Signed-off-by: Niall Crowe <nicrowe@redhat.com> Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
* | | Merge pull request #14915 from eriksjolund/rename_c_to_cpu_sharesopenshift-ci[bot]2022-07-13
|\ \ \ | |/ / |/| | [CI:DOCS] man pages: replace -c with --cpu-shares
| * | [CI:DOCS] man pages: replace -c with --cpu-sharesErik Sjölund2022-07-13
| | | | | | | | | | | | Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
| * | [CI:DOCS] podman-create.md: replace -c with --cpu-sharesErik Sjölund2022-07-12
| |/ | | | | | | Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* | Merge pull request #14916 from rhatdan/dockeropenshift-ci[bot]2022-07-13
|\ \ | | | | | | Docker uses "-c" to mean "--cpu-shares" in create and run
| * | Docker uses "-c" to mean "--cpu-shares" in create and runDaniel J Walsh2022-07-12
| | | | | | | | | | | | | | | | | | | | | Add support for -c as an alias for --cpu-shares to be compatible with Docker. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | | Merge pull request #14905 from eriksjolund/remove_rootless_considerationsopenshift-ci[bot]2022-07-12
|\ \ \ | |/ / |/| | [CI:DOCS] rootless_tutorial: Remove incorrect advice regarding volume…
| * | [CI:DOCS] rootless_tutorial: Remove incorrect advice regarding volumes and ↵Erik Sjölund2022-07-12
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | mount points * Remove the instruction "The mount point must exist in the container" as it is incorrect which is shown by this example ``` $ mkdir dir1 $ podman run --rm -v ./dir1:/dir1:Z docker.io/library/fedora:36 touch /dir1/file $ ls dir1 file $ podman run --rm docker.io/library/fedora:36 ls -l /dir1 ls: cannot access '/dir1': No such file or directory $ podman --version podman version 4.1.1 $ ``` * Rewrite the advice "You should always give the full path to the volume you'd like to mount" so that it also mentions relative paths starting with a dot. Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* / [CI:DOCS] man pages: remove non-existent option builtin-volumeErik Sjölund2022-07-12
|/ | | | | | Closes #14906 Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* [CI:DOCS] Improve language. Fix spelling and typos.Erik Sjölund2022-07-11
| | | | | | | | | * 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>
* [CI:DOCS] podman-info.1.md: Update examplesErik Sjölund2022-07-11
| | | | | | | | | | | * Add example "Extracting the list of container registries with a Go template". (The example was already present but in a much shorter form) * Add example "Extracting the list of container registries from JSON with jq". * Add shell completion instructions 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>
* Merge pull request #14803 from bugfood/volumesopenshift-ci[bot]2022-07-07
|\ | | | | make 9p security model configurable; document
| * podman machine: make 9p security model configurable; adjust docsCorey Hickey2022-07-06
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This addresses: Symlinks don't work on podman machine on macOS Monterey when using volumes feature #13784 This change does NOT exactly fix the bug, but it does allow the user to work around it via 'podman init' option, e.g.: podman machine init -v "$HOME/git:$HOME/git:ro:security_model=none" If the default security model were to be changed to 'none', then that would fix the bug, at the possible cost of breaking any use cases that depend on 'mapped-xattr'. The documentation of the purpose and behavior of the different security models seems to be rather light: https://wiki.qemu.org/Documentation/9psetup#Starting_the_Guest_directly From testing, it appears that the mapped-xattr security model intends to manage symlinks such that the guest can see the symlinks but the host only sees regular files (with extended attributes). As far as I can tell, this behavior only makes sense when the guest is the only thing that ever needs to create and read symlinks. Otherwise, symlinks created on the host are unusable on the guest, and vice versa. As per the original commit: 8e7eeaa4dd14621bda15e396fcd7b9187bc500c5 [NO NEW TESTS NEEDED] Also document existing ro and rw options. Also remove misleading statement about /mnt. By my observation, this line is incorrect. If the intended meaning is different, then I don't understand. The default volume is mounted read/write and is not within /mnt. [core@localhost ~]$ mount | grep 9p vol0 on /Users/chickey type 9p (rw,relatime,sync,dirsync,access=client,trans=virtio) Signed-off-by: Corey Hickey <chickey@tagged.com>
* | Merge pull request #14762 from ashley-cui/machinfoopenshift-ci[bot]2022-07-07
|\ \ | | | | | | Podman machine info
| * | Podman machine infoAshley Cui2022-07-05
| |/ | | | | | | | | | | | | Add podman machine info command, which displays infor about the machine host as well as version info. Signed-off-by: Ashley Cui <acui@redhat.com>
* | Merge pull request #14842 from umohnani8/play-kubeopenshift-ci[bot]2022-07-07
|\ \ | | | | | | Update play kube docs
| * | Update play kube docsUrvashi Mohnani2022-07-06
| | | | | | | | | | | | | | | | | | | | | Update play kube docs with supported fields for configMap and deployment kinds. Signed-off-by: Urvashi Mohnani <umohnani@redhat.com>
* | | podman pod create --uts supportcdoern2022-07-05
|/ / | | | | | | | | | | | | | | | | | | | | | | add support for the --uts flag in pod create, allowing users to avoid issues with default values in containers.conf. uts follows the same format as other namespace flags: --uts=private (default), --uts=host, --uts=ns:PATH resolves #13714 Signed-off-by: Charlie Doern <cdoern@redhat.com>
* | Merge pull request #14807 from eriksjolund/fix_read_only_spellingopenshift-ci[bot]2022-07-04
|\ \ | | | | | | [CI:DOCS] Fix spelling "read only" -> "read-only"
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-12-26 07:29:39 +0000