summaryrefslogtreecommitdiff
path: root/docs/source/markdown
Commit message (Collapse)AuthorAge
* Align the podman pod ps --filter behavior with podman psPaul Holzinger2020-11-18
| | | | | | | | | Filters with the same key work inclusive with the only exception being `label` which is exclusive. Filters with different keys always work exclusive. Also update the documentation with the new behavior. Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
* Merge pull request #8363 from AlbanBedel/play-kube-create-onlyOpenShift Merge Robot2020-11-17
|\ | | | | Add an option to control if play kube should start the pod
| * Add an option to control if play kube should start the podAlban Bedel2020-11-17
| | | | | | | | | | | | | | | | | | | | Having play kube start the pod is not always appropriate, one might for example like to have the pod running as a set of systemd services. Add a `start` option to the command line and API to control if the pod should be started or not; it defaults to true for backward compatibility. Signed-off-by: Alban Bedel <albeu@free.fr>
* | [CI:DOCS] fix an apostrophe nit in man pageTomSweeneyRedHat2020-11-17
|/ | | | | | | A quick follow up to #8367 to add a missing apostrophe in three man pages. Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* Explain the relation between --pod and --networkPaul Holzinger2020-11-17
| | | | Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
* Merge pull request #8345 from afbjorklund/volume-filterOpenShift Merge Robot2020-11-15
|\ | | | | Add support for volume ls --filter label=key=value
| * Add support for volume ls --filter label=key=valueAnders F Björklund2020-11-14
| | | | | | | | | | | | | | | | | | | | | | | | Supposed to be able to search for labels with a given value. Previously it meant searching for label key and label value: --filter label=key --filter label=value Add some documentation and integration tests for it as well. Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>
* | [CI:DOCS] Touch up Podman description in man page menuTomSweeneyRedHat2020-11-13
|/ | | | | | | The title for the Podman man page on the commands menu was a little light, adding a few more words to it. Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* Merge pull request #7964 from vrothberg/shortnamesOpenShift Merge Robot2020-11-13
|\ | | | | short-name aliasing
| * short-name aliasingValentin Rothberg2020-11-13
| | | | | | | | | | | | Add support for short-name aliasing. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* | Merge pull request #6442 from Luap99/podman-autocompleteOpenShift Merge Robot2020-11-13
|\ \ | | | | | | Shell completion
| * | Install the new shell completion logicPaul Holzinger2020-11-12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add a new make target (completion) to generate the shell completion scripts. This will generate the scripts for bash, zsh and fish for both podman and podman-remote with `podman completion`. The scripts are put into the completions directory and can be installed system wide with `sudo make install.completions`. This commit replaces the current handwritten scripts for bash and zsh. The `validate.completion` target has been adjusted to make sure nobody edits these scripts directly. Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
| * | Add shell completion with cobraPaul Holzinger2020-11-12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Allow automatic generation for shell completion scripts with the internal cobra functions (requires v1.0.0+). This should replace the handwritten completion scripts and even adds support for fish. With this approach it is less likley that completions and code are out of sync. We can now create the scripts with - podman completion bash - podman completion zsh - podman completion fish To test the completion run: source <(podman completion bash) The same works for podman-remote and podman --remote and it will complete your remote containers/images with the correct endpoints values from --url/--connection. The completion logic is written in go and provided by the cobra library. The completion functions lives in `cmd/podman/completion/completion.go`. The unit test at cmd/podman/shell_completion_test.go checks if each command and flag has an autocompletion function set. This prevents that commands and flags have no shell completion set. This commit does not replace the current autocompletion scripts. Closes #6440 Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
* | | Merge pull request #8326 from Luap99/fix-build-namespaceOpenShift Merge Robot2020-11-13
|\ \ \ | |_|/ |/| | Fix namespace flag parsing for podman build
| * | Add podman build --net alias for --networkPaul Holzinger2020-11-12
| | | | | | | | | | | | | | | | | | Fixes #8332 Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
* | | Change podman build --pull=true to PullIfMissingTomSweeneyRedHat2020-11-12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | One last tweak to the man page for 'build --pull' and after further testing against Docker, one slight change to the pull policy. First I changed `--pull=false` from PullNever to PullIfMissing. This matches Docker and will pull the image if it's not present rather than erroring. We've the `--pull-never` option if someone wants the pull to not do an actual pull and to error if the image isn't local. Then for the man page, I'd a much bigger change, in the initial PR, I've backed most of that out and just added a tweak. Hopefully this puts this portion of the pull work behind us for a while. Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* | | Merge pull request #8316 from rhatdan/codespellOpenShift Merge Robot2020-11-12
|\ \ \ | |/ / |/| | Fix issues found with codespell
| * | Fix issues found with codespellDaniel J Walsh2020-11-12
| |/ | | | | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* / Maintain consistent order of short and long flag names in docsPaul Holzinger2020-11-12
|/ | | | | | | | Make the order of short and long flag names in the documentation consistent. Also adjust the man page validaten script to only allow the `**--long**, **-s**` syntax. Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
* [CI:DOCS] Restore man page cross-checkerEd Santiago2020-11-11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Somewhere in the CIv2 migration we lost the man page vs --help cross-checker. Add it back, by adding it into the man-page-check Makefile target; this is part of 'make validate', which is run in CI even on CI:DOCS PRs. As happens when CI doesn't run, things broke. Man pages got out of sync with --help. This PR: 1) Fixes hack/xref-helpmsgs-manpages to deal with the new "Options" (instead of "Flags") form of podman help. #8034 did part of that, but one of my review comments was accidentally left out. 2) Fixes hack/xref-helpmsgs-manpages to deal with the new option syntax in man pages, post- #8292, in which each option is preceded by four hashes so as to make them HTML <h4> elements with named anchors. 3) Fixes man pages that #8292 accidentally missed. 4) Adds man page entries for two flags that got added to podman but not documented (pod create --network-alias, play kube --log-driver) Fixes: #8296 Signed-off-by: Ed Santiago <santiago@redhat.com>
* Merge pull request #8292 from Luap99/doc-anchorsOpenShift Merge Robot2020-11-10
|\ | | | | [CI:DOCS] Add anchors for flag names on docs.podman.io
| * Add anchors for flag names on docs.podman.ioPaul Holzinger2020-11-10
| | | | | | | | | | | | | | | | | | | | Change the docs markdown so that flag names will be h4 headers. Sphinx will automatically add anchors to headers. Add css to make sure the flag names are not to big compared to the text. The man pages also still renders fine but it looks a bit different. Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
* | Merge pull request #8251 from baude/networkaliasesOpenShift Merge Robot2020-11-10
|\ \ | |/ |/| network aliases for container creation
| * network aliases for container creationbaude2020-11-09
| | | | | | | | | | | | | | | | podman can now support adding network aliases when running containers (--network-alias). It requires an updated dnsname plugin as well as an updated ocicni to work properly. Signed-off-by: baude <bbaude@redhat.com>
* | Merge pull request #8278 from rhatdan/man1OpenShift Merge Robot2020-11-10
|\ \ | | | | | | [CI:DOCS] Add example of fuse-overlay to podman system reset
| * | Add example of fuse-overlay to podman system resetDaniel J Walsh2020-11-10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | A fairly common mistake users are hitting is running rootless podman without installing fuse-overlay. Then they want to reset storage. Sometimes they modify storage.conf first and `podman system reset` fails. This PR attempts to explain how to convert properly. Fixes: https://github.com/containers/podman/issues/7446 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | | enable ipv6 network configuration optionsAntonio Ojea2020-11-10
|/ / | | | | | | | | | | | | | | | | | | | | | | | | enable the ipv6 flag in podman network to be able to create dual-stack networks for containers. This is required to be compatible with docker, where --ipv6 really means dual stack. podman, unlike docker, support IPv6 only containers since 07e3f1bba9674c0cb93a0fa260930bfebbf75728. Signed-off-by: Antonio Ojea <aojea@redhat.com>
* / Update podman build man page to match buildah bud man pageDaniel J Walsh2020-11-09
|/ | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* podman-pull.1.md: add example for pulling an image by hashKier Davis2020-11-09
| | | | Signed-off-by: Kier Davis <me@kierdavis.com>
* podman-import.1.md: fix paragraph formattingKier Davis2020-11-09
| | | | Signed-off-by: Kier Davis <me@kierdavis.com>
* podman-import.1.md: fix shell syntaxKier Davis2020-11-09
| | | | Signed-off-by: Kier Davis <me@kierdavis.com>
* Merge pull request #8249 from marcnuri-forks/fix/doc-typoOpenShift Merge Robot2020-11-05
|\ | | | | [CI:DOCS] fix: podman-system-service doc time is seconds
| * fix: podman-system-service doc time is secondsMarc Nuri2020-11-05
| | | | | | | | Signed-off-by: Marc Nuri <marc@marcnuri.com>
* | Add support for mounting external containersDaniel J Walsh2020-11-04
|/ | | | | | | | | Continue progress on use of external containers. This PR adds the ability to mount, umount and list the storage containers whether they are in libpod or not. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* Merge pull request #8219 from rhafer/rootless-mountsOpenShift Merge Robot2020-11-03
|\ | | | | docs: Mention mounts.conf location for non-root users
| * docs: Mention mounts.conf location for non-root usersRalf Haferkamp2020-11-02
| | | | | | | | Signed-off-by: Ralf Haferkamp <rhafer@suse.com>
* | Merge pull request #8166 from rhatdan/unbindableOpenShift Merge Robot2020-11-02
|\ \ | |/ |/| Allow users to mount with unbindable flag
| * Add better support for unbindable volume mountsDaniel J Walsh2020-11-02
| | | | | | | | | | | | | | | | Allow users to specify unbindable on volume command line Switch internal mounts to rprivate to help prevent leaks. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | Match build pull functionality with Docker'sTomSweeneyRedHat2020-10-31
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is a continuation of #8189 and #8085. When doing a `docker build` command, if the `--pull` command is not specified or set to `false` the pullOption used is `PullifMissing`. This causes the build to pull the image only if it is not present in local storage. It also will raise an error if the image is not found in the registry (or the registry is down), even if the image is present in local storage. If the `--pull` command IS specified or specified with an argument of `true`, the build will always pull the image from the registries. This uses the pullOption `PullAlways`. It also will raise an error if the image is not found in the registry, even if the image is present in local storage. These changes now brings the pull functionality for `podman build` into line with `docker build`. However, I consider this to be a breaking change. Previously if you did `podman build --pull`, `podman build` or `podman build --pull = true`, then the image would be pulled from the registry if there was not an image in local storage or if the image in the registry was newer than the one in local storage. An error would *NOT* be raised if there was not an image in the registry or the registry was down as long as there was a copy in the local storage. An error would be raised if the image could not be retrieved from both the registry and local storage. This is the PullOption `PullIfNewer`. I believe this also differs from what Buildah does at this time but I'm too beat to chase that down at the moment. Personally I'd like to use the `PullIfNewer` for at least `--pull` and `--pull=true` so that you don't get an error if the registry has a network hiccup and the image is already stored locally. But this differs from Docker. I'd like to post scrum about this at our next stand up to make sure we're all on the same page about the ramifications of this change. Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* Remove search limit since pagination supportQi Wang2020-10-30
| | | | | | Remove the search limit check since the c/image v5.6.0 supports pagination and can give result over 100 entries. Signed-off-by: Qi Wang <qiwan@redhat.com>
* new "image" mount typeValentin Rothberg2020-10-29
| | | | | | | | | | | | | | Add a new "image" mount type to `--mount`. The source of the mount is the name or ID of an image. The destination is the path inside the container. Image mounts further support an optional `rw,readwrite` parameter which if set to "true" will yield the mount writable inside the container. Note that no changes are propagated to the image mount on the host (which in any case is read only). Mounts are overlay mounts. To support read-only overlay mounts, vendor a non-release version of Buildah. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* Merge pull request #8102 from ashley-cui/inspectOpenShift Merge Robot2020-10-27
|\ | | | | Add pod, volume, network to inspect package
| * Add pod, volume, network to inspect packageAshley Cui2020-10-27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | podman inspect only had the capabilities to inspect containers and images. if a user wanted to inspect a pod, volume, or network, they would have to use `podman network inspect`, `podman pod inspect` etc. Docker's cli allowed users to inspect both volumes and networks using regular inspect, so this commit gives the user the functionality If the inspect type is not specified using --type, the order of inspection is: containers images volumes networks pods meaning if container that has the same name as an image, podman inspect would return the container inspect. To avoid duplicate code, podman network inspect and podman volume inspect now use the inspect package as well. Podman pod inspect does not because podman pod inspect returns a single json object while podman inspect can return multiple) Signed-off-by: Ashley Cui <acui@redhat.com>
* | Merge pull request #8133 from xordspar0/cpu-limit-detailsOpenShift Merge Robot2020-10-27
|\ \ | | | | | | [CI:DOCS] Add more details about how CPU limits work
| * | Add more details about how CPU limits workJordan Christiansen2020-10-27
| |/ | | | | | | Signed-off-by: Jordan Christiansen <xordspar0@gmail.com>
* / Document how to enable CPU limit delegationJordan Christiansen2020-10-27
|/ | | | Signed-off-by: Jordan Christiansen <xordspar0@gmail.com>
* filter events by labelsbaude2020-10-23
| | | | | | adding the ability to filter evens by the container labels. this requires that container labels be added to the events data being recorded and subsequently read. Signed-off-by: baude <bbaude@redhat.com>
* podman create doesn't support creating detached containersDaniel J Walsh2020-10-21
| | | | | | | | | | | | Detached containers and detach keys are only created with the podman run, i exec, and start commands. We do not store the detach key sequence or the detach flags in the database, nor does Docker. The current code was ignoreing these fields but documenting that they can be used. Fix podman create man page and --help output to no longer indicate that --detach and --detach-keys works. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* Merge pull request #8034 from rhatdan/optionsOpenShift Merge Robot2020-10-21
|\ | | | | Switch help messages from using [flags] to [options]
| * Switch use of Flags to OptionsDaniel J Walsh2020-10-21
| | | | | | | | | | | | | | | | Want to have man pages match commands, since we have lots of printed man pages with using Options, we will change the command line to use Options in --help. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-14 03:42:22 +0000