summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAge
* [CI:DOCS] Docs revamp.Scott McCarty2020-05-21
| | | | | | | | | * Rewrote the Home and Introduction pages. * Created a dedicated Search page * Rewrote the Tutorials page to have native links in RTD/Shpinx * Added iframe to Reference page to display API reference docs inline Signed-off-by: Scott McCarty <scott.mccarty@gmail.com>
* Give `auto-update` ability to use per-container authfile specified by label.Ondřej Kraus2020-05-17
| | | | Signed-off-by: Ondřej Kraus <neverberlerfellerer@gmail.com>
* fix bug --format {{json.}} of eventsQi Wang2020-05-14
| | | | | | Allow the `podman events --format` accept {{json.}} and complete small fix podman-events.1.md Signed-off-by: Qi Wang <qiwan@redhat.com>
* auto-update: support authfilesValentin Rothberg2020-05-12
| | | | | | | | | | Support using custom authfiles for auto updates by adding a new `--authfile` flag and passing it down into the backend. Also do some minor fixes in the help text and the man page. Fixes: #6159 Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* Merge pull request #6106 from mheon/fix_manpagesOpenShift Merge Robot2020-05-08
|\ | | | | [CI:DOCS] Update manpages for image volumes and MAC address
| * Update manpages for image volumes and MAC addressMatthew Heon2020-05-06
| | | | | | | | | | | | | | | | | | | | When reviewing the manpages for `podman run` to find options to test, I found a few mistakes. The description of how we handle image volumes is extremely outdated, and we now provide full support for the `--mac-address` option. Update the docs for these flags so they're accurate. Signed-off-by: Matthew Heon <matthew.heon@pm.me>
* | Merge pull request #6133 from e-minguez/only_bridge_man_podman_network_createOpenShift Merge Robot2020-05-08
|\ \ | | | | | | [CI:DOCS] Fixed typo on podman network create man
| * | Fixed typo on podman network create manEduardo Minguez Perez2020-05-08
| | | | | | | | | | | | Signed-off-by: Eduardo Minguez Perez <e.minguez@gmail.com>
* | | Merge pull request #6054 from cevich/swagger_docs_task_corsOpenShift Merge Robot2020-05-08
|\ \ \ | |/ / |/| | CI:DOCS: Document API docs + CORS maintenance
| * | CI:DOCS: Document API docs + CORS maintenanceChris Evich2020-05-06
| | | | | | | | | | | | Signed-off-by: Chris Evich <cevich@redhat.com>
* | | podman: split env variables in env and overridesGiuseppe Scrivano2020-05-07
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There are three different priorities for applying env variables: 1) environment/config file environment variables 2) image's config 3) user overrides (--env) The third kind are known to the client, while the default config and image's config is handled by the backend. Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com> Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | | Merge pull request #5961 from QiWang19/manifest-remove-pushOpenShift Merge Robot2020-05-07
|\ \ \ | | | | | | | | Manifest remove, push
| * | | Manifest remove, pushQi Wang2020-05-06
| | |/ | |/| | | | | | | | | | | | | Implements podman manifest remove and podman manifest push. Signed-off-by: Qi Wang <qiwan@redhat.com>
* / | [CI:DOCS] Add link to Tutorials to docs homepageTomSweeneyRedHat2020-05-06
|/ / | | | | | | | | | | | | | | Just create a quick link to the tutorials on GitHub so they'll show on docs.podman.io. I've not done rst format before, so fingers crossed! Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* / manifest annotateQi Wang2020-05-05
|/ | | | Signed-off-by: Qi Wang <qiwan@redhat.com>
* search --limit compatible with dockerQi Wang2020-05-01
| | | | | | Check --limit range and update --limit manpage explanation. Signed-off-by: Qi Wang <qiwan@redhat.com>
* Merge pull request #5966 from vrothberg/v2-pod-statsOpenShift Merge Robot2020-04-27
|\ | | | | implement pod stats
| * implement pod statsValentin Rothberg2020-04-27
| | | | | | | | | | | | | | Implement pod stats for the local and remote client. Both code paths end up in infra/abi to allow for code share. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* | Merge pull request #5973 from rhatdan/manOpenShift Merge Robot2020-04-27
|\ \ | | | | | | [ci:docs] Cleanup man pages for pull and push
| * | Cleanup man pages for pull and pushDaniel J Walsh2020-04-25
| |/ | | | | | | | | | | | | | | The podman pull man page has a section on source, but does not show this in the top definitions. This PR attempts to cleanup the man page to make it more understandable. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* / Add --os to manifest addQi Wang2020-04-24
|/ | | | | | Add --os to manifest add for overriding the os field. Signed-off-by: Qi Wang <qiwan@redhat.com>
* manifest create,add,inspectQi Wang2020-04-22
| | | | | | Implememts manifest subcommands create, add, inspect. Signed-off-by: Qi Wang <qiwan@redhat.com>
* Merge pull request #5548 from kunalkushwaha/image-pruneOpenShift Merge Robot2020-04-17
|\ | | | | image prune skips images with child images.
| * note for skipping cache image added.Kunal Kushwaha2020-04-15
| | | | | | | | Signed-off-by: Kunal Kushwaha <kunal.kushwaha@gmail.com>
* | Update podman-generate-systemd man pageSujil022020-04-16
| | | | | | | | | | | | | | Update links, content, and adding more examples to show how to run the generated .service files as root and non-root. Fix for #5497 Signed-off-by: Sujil02 <sushah@redhat.com>
* | Merge pull request #5724 from zypA13510/patch-1OpenShift Merge Robot2020-04-08
|\ \ | |/ |/| man page: add note about issue with SELinux
| * man page: add note about issue with SELinuxYuping Zuo2020-04-08
| | | | | | | | Signed-off-by: Yuping Zuo <zypA13510@users.noreply.github.com>
* | Merge pull request #5478 from giuseppe/auto-usernsOpenShift Merge Robot2020-04-06
|\ \ | | | | | | userns: support --userns=auto
| * | userns: support --userns=autoGiuseppe Scrivano2020-04-06
| |/ | | | | | | | | | | | | automatically pick an empty range and create an user namespace for the container. Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
* | refactor infoBrent Baude2020-04-06
| | | | | | | | | | | | the current implementation of info, while typed, is very loosely done so. we need stronger types for our apiv2 implmentation and bindings. Signed-off-by: Brent Baude <bbaude@redhat.com>
* | Merge pull request #5620 from cfelder/play-kube-networkingOpenShift Merge Robot2020-04-06
|\ \ | |/ |/| Add support for specifying CNI networks in podman play kube
| * Add support for specifying CNI networks in podman play kubeChristian Felder2020-03-27
| | | | | | | | | | Fixes: #5609 Signed-off-by: Christian Felder <c.felder@fz-juelich.de>
* | Merge pull request #5649 from jwhonce/wip/varlinkOpenShift Merge Robot2020-03-31
|\ \ | | | | | | V2 Move varlink home
| * | V2 Move varlink homeJhon Honce2020-03-30
| | | | | | | | | | | | | | | | | | | | | | | | * move cmd/podman/varlink/* to pkg/varlink to support podmanV2 refactor * update Makefile * reformatted all impacted code Signed-off-by: Jhon Honce <jhonce@redhat.com>
* | | Switch to using --time as opposed to --timeout to better match Docker.Daniel J Walsh2020-03-31
|/ / | | | | | | | | | | | | We need to consistently use --time rather then --timeout throughout the code. Fix locations where timeout defaults are not set correctly as well. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | Merge pull request #4976 from rpjday/rpjday/podman_versionOpenShift Merge Robot2020-03-28
|\ \ | | | | | | docs: mention that "podman version" prints out Remote API Version
| * | docs: mention that "podman version" prints out Remote API VersionRobert P. J. Day2020-01-26
| | | | | | | | | | | | | | | | | | | | | | | | Since "man podman-version" seems to want to list everything printed about the current version, add a reference to Remote API Version for completeness. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* | | Add support for containers.confDaniel J Walsh2020-03-27
| | | | | | | | | | | | | | | | | | | | | vendor in c/common config pkg for containers.conf Signed-off-by: Qi Wang qiwan@redhat.com Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | | Fix Markdown typo in podman-create.1.mdErik Sjölund2020-03-27
| |/ |/| | | | | Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* | Merge pull request #5495 from openSUSE/image-signOpenShift Merge Robot2020-03-24
|\ \ | | | | | | Add image signing with GPG tutorial
| * | Add image signing with GPG tutorialSascha Grunert2020-03-23
| | | | | | | | | | | | Signed-off-by: Sascha Grunert <sgrunert@suse.com>
* | | Merge pull request #5559 from rhatdan/dockerOpenShift Merge Robot2020-03-23
|\ \ \ | | | | | | | | Fix docker man page links
| * | | Fix docker man page linksDaniel J Walsh2020-03-19
| | | | | | | | | | | | | | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | | | Implemented --iidfile for podman commitSujil022020-03-19
|/ / / | | | | | | | | | | | | | | | | | | Added flag to Write the image ID to the file with podman commit command. Fix to issue #5461 Signed-off-by: Sujil02 <sushah@redhat.com>
* | | auto updatesValentin Rothberg2020-03-17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add support to auto-update containers running in systemd units as generated with `podman generate systemd --new`. `podman auto-update` looks up containers with a specified "io.containers.autoupdate" label (i.e., the auto-update policy). If the label is present and set to "image", Podman reaches out to the corresponding registry to check if the image has been updated. We consider an image to be updated if the digest in the local storage is different than the one of the remote image. If an image must be updated, Podman pulls it down and restarts the container. Note that the restarting sequence relies on systemd. At container-creation time, Podman looks up the "PODMAN_SYSTEMD_UNIT" environment variables and stores it verbatim in the container's label. This variable is now set by all systemd units generated by `podman-generate-systemd` and is set to `%n` (i.e., the name of systemd unit starting the container). This data is then being used in the auto-update sequence to instruct systemd (via DBUS) to restart the unit and hence to restart the container. Note that this implementation of auto-updates relies on systemd and requires a fully-qualified image reference to be used to create the container. This enforcement is necessary to know which image to actually check and pull. If we used an image ID, we would not know which image to check/pull anymore. Fixes: #3575 Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* | | Merge pull request #5439 from ttys3/fixup-systemdgen-with-new-paramOpenShift Merge Robot2020-03-16
|\ \ \ | |/ / |/| | systemd generator: force run container detached if CreateCommand has no detach param
| * | force run container detached if container CreateCommand missing the detach param荒野無燈2020-03-14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | the podman generated systemd service file has `Type=forking` service, so the command after `ExecStart=` should not run in front. if someone created a container and has the detach(`-d`) param missing like this ``` podman create --name ngxdemo -P nginxdemos/hello ``` and generate the file with `--new` param: ``` podman generate systemd --name --new ngxdemo ``` because `podman run xxx` has no `-d` param, so the container is not run in background and nerver exit. and systemd will fail to start the service: ``` sudo systemctl start container-ngxdemo.service Job for container-ngxdemo.service failed because a timeout was exceeded. See "systemctl status container-ngxdemo.service" and "journalctl -xe" for details. ``` Signed-off-by: 荒野無燈 <ttys3@outlook.com>
* | | man page cross-reference fixes: part 2Ed Santiago2020-03-11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The other direction: fix or clean up elements documented in man pages but which did/do not exist in actual podman: * runlabel: add missing "-n" alias for --name And, remove man page entries for nonexistent options: * podman commit: --iidfile * podman container runlabel: --rootfs, --storage * podman create: --cpu-count There are two problems I don't know how to deal with. Both are related to main_local.go:rootCmd.PersistentFlags() : 1) podman-build.1.md documents --cni-config-dir and --runtime options, but these are not actually options under podman build; they are global options. The documentation in this man page differs from that under podman-build. 2) podman ps implements a binary --namespace option, but this option does not (cannot?) appear in --help because there's a global --namespace string option and Cobra somehow gets confused about this. Do we really intend for global options to be parsed on the right-hand side of subcommands? This strikes me as unintuitive and potentially confusing, although the fact that it has taken me this long to discover it suggests that it's not _that_ confusing. Suggestions welcome. I can file issues for 1/2 above, or simply teach my script to special-case ignore them. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | man pages: fix inconsistenciesEd Santiago2020-03-10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I wrote a script to cross-reference podman --help against man pages. It found a bunch of inconsistencies fix them: * options missing from man pages * options misspelled or misformatted in man pages (usually misplaced asterisks or missing dashes, but see --dns-opt) * one spurious comma in the actual source file --help This is a fix in which I iterate over 'podman CMD --help' and check for presence in man pages. The other way around (look for flags in man pages, check podman CMD --help) is probably impossible: there are too many special cases Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | Merge pull request #5402 from vrothberg/syslogOpenShift Merge Robot2020-03-10
|\ \ \ | | | | | | | | docs: clarify bools in `podman --help`
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-09-29 05:26:12 +0000