summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAge
* man pages: sort flags, and keep them that wayEd Santiago2022-03-23
| | | | | | | | | | | | | | Command flags (OPTIONS) in man pages have to date been in haphazard order. Sometimes that order is sensible, e.g., most-important options first, but more often they're just in arbitrary places. This makes life hard for users. Here, I update the man-page-check Makefile script so it checks and enforces alphabetical order in OPTIONS sections. Then -- the hard part -- update all existing man pages to conform to this requirement. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Merge pull request #13588 from flouthoc/import-os-archOpenShift Merge Robot2022-03-23
|\ | | | | import: allow users to set `--os`, `--arch` and `--variant` of image imports
| * import: allow users to set os, arch and variant of importsAditya R2022-03-23
| | | | | | | | | | | | | | | | | | | | Allows users to set `--os` , `--arch` and `--variant` of the image created from the custom import. Following is useful when user is already aware of the values which are correct for their generated rootfs Signed-off-by: Aditya R <arajan@redhat.com>
* | docs: Fix links to Containerfile and containerignoreJohn Kristensen2022-03-23
| | | | | | | | | | | | | | | | | | The documentation files for `Containerfile` and `containerignore` have been moved from the `buildah` repository to the `common` repository. ref: https://github.com/containers/buildah/commit/488e8654ea Signed-off-by: John Kristensen <john@jerrykan.com>
* | podman unshare: document that command cannot be used with remotePaul Holzinger2022-03-22
|/ | | | | | Fixes #13596 Signed-off-by: Paul Holzinger <pholzing@redhat.com>
* Merge pull request #13541 from vrothberg/rmi-ignoreOpenShift Merge Robot2022-03-21
|\ | | | | podman rmi --ignore
| * podman rmi --ignoreValentin Rothberg2022-03-19
| | | | | | | | | | | | | | | | | | | | | | Add an `--ignore` flag to `podman image rm` to instruct ignoring image if a specified image does not exist and to not throw an error. Other commands (e.g., `podman container rm`) already support this flag. Such an `--ignore` flag can come in handy in clean-up scripcts such as the teardown phases in the Podman tests. Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
* | Fix documentation typoKuldar Kaasik2022-03-21
| | | | | | | | Signed-off-by: Kuldar Kaasik <kaasikkuldar@gmail.com>
* | Fix type-o and cleanup doc punctuationJason T. Greene2022-03-18
|/ | | | Signed-off-by: Jason T. Greene <jason.greene@redhat.com>
* [CI:DOCS]: Mention netavark limitations for macvlan/ipvlan driversClayton Craft2022-03-15
| | | | | | | The example is also improved to add the --subnet option, this option is required with netavark, else you get: Error: macvlan driver needs at least one subnet specified, DHCP is not supported with netavark Signed-off-by: Clayton Craft <clayton@craftyguy.net>
* Merge pull request #13498 from flouthoc/podman-vendor-buildahOpenShift Merge Robot2022-03-15
|\ | | | | vendor: update `c/buildah`, `c/image` and `c/storage`
| * docs: podman-build add --no-hostsAditya R2022-03-14
| | | | | | | | | | | | | | Add newly added `--no-hosts` to build docs and document its conflicting nature with `--add-host` Signed-off-by: Aditya R <arajan@redhat.com>
* | Add support for --chrootdirsLStandman2022-03-14
|/ | | | Signed-off-by: LStandman <65296484+LStandman@users.noreply.github.com>
* Merge pull request #13445 from rhatdan/annotationOpenShift Merge Robot2022-03-10
|\ | | | | Add podman play kube --annotation
| * Add podman play kube --annotationDaniel J Walsh2022-03-09
| | | | | | | | | | | | | | | | | | | | Allow users to add annotions in the podman play kube command. This PR Also fixes the fact that annotations in the pod spec were not being passed down to containers. Fixes: https://github.com/containers/podman/issues/12968 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | Merge pull request #13440 from eriksjolund/remove_web_tab_numberOpenShift Merge Robot2022-03-10
|\ \ | |/ |/| [CI:DOCS] Remove "(1)" from web tab text
| * [CI:DOCS] Remove "(1)" from web tab textErik Sjölund2022-03-06
| | | | | | | | | | | | | | | | | | | | | | | | * Remove the ending text "(1)" to avoid it from being displayed in the web tab title for a command man page on the web. Often such a text indicates that a web page got an update. For instance GitHub issues shows the number of new comments that have been written after the user's last visit. Fixes #13438 Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* | Merge pull request #12913 from rhatdan/kubeOpenShift Merge Robot2022-03-09
|\ \ | | | | | | Add --context-dir option to podman play kube
| * | Add --context-dir option to podman play kubeDaniel J Walsh2022-03-01
| |/ | | | | | | | | | | | | | | | | | | This option was requested so that users could specify alternate locations to find context directories for each image build. It requites the --build option to be set. Partion Fix: https://github.com/containers/podman/issues/12485 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* / machine rm -f stops and removes machineBrent Baude2022-03-08
|/ | | | | | | | | | | | If you want to remove a running machine, you can now pass the --force/-f to podman machine rm and the machine will be stopped and removed without confirmations. Fixes: #13448 [NO NEW TESTS NEEDED] Signed-off-by: Brent Baude <bbaude@redhat.com>
* Merge pull request #13362 from keonchennl/pod-logs-add-flagOpenShift Merge Robot2022-03-01
|\ | | | | Add the names flag for pod logs
| * Add the names flag for pod logsXueyuan Chen2022-03-01
| | | | | | | | | | | | Fixes containers#13261 Signed-off-by: Xueyuan Chen <X.Chen-47@student.tudelft.nl>
* | Add podman volume mount supportDaniel J Walsh2022-02-28
|/ | | | | | Fixes: https://github.com/containers/podman/issues/12768 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* Merge pull request #13325 from xordspar0/configmap-error-msgOpenShift Merge Robot2022-02-24
|\ | | | | Improve the error message for usused configMaps
| * Improve the error message for usused configMapsJordan Christiansen2022-02-24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | If you run `podman play kube` on a yaml file that only contains configMaps, podman will fail with the error: Error: YAML document does not contain any supported kube kind This is not strictly true; configMaps are a supported kube kind. The problem is that configMaps aren't a standalone entity. They have to be used in a container somewhere, otherwise they don't do anything. This change adds a new message in the case when there only configMaps resources. It would be helpful if podman reported which configMaps are unused on every invocation of kube play. However, even if that feedback were added, this new error messages still helpfully explains the reason that podman is not creating any resources. [NO NEW TESTS NEEDED] Signed-off-by: Jordan Christiansen <xordspar0@gmail.com>
* | docs: generate-systemd: pod requires an infra containerValentin Rothberg2022-02-24
| | | | | | | | | | | | | | | | | | | | | | Generating unit files for a pod requires the pod to be created with an infra container (see `--infra=true`). An infra container runs across the entire lifespan of a pod and is hence required for systemd to manage the life cycle of the pod's main unit. This issue came up on the mailing list. Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
* | Merge pull request #13314 from flouthoc/container-commit-squashOpenShift Merge Robot2022-02-23
|\ \ | |/ |/| container-commit: support `--squash` to squash layers into one if users want.
| * container-commit: support --squash to squash layers into oneAditya R2022-02-23
| | | | | | | | | | | | | | | | | | | | | | Allow users to commit containers into a single layer. Usage ```bash podman container commit --squash <name> ``` Signed-off-by: Aditya R <arajan@redhat.com>
* | Cleanup display of trust with transportsDaniel J Walsh2022-02-22
| | | | | | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | Merge pull request #13059 from cdoern/cloneOpenShift Merge Robot2022-02-22
|\ \ | | | | | | Implement Podman Container Clone
| * | Implement Podman Container Clonecdoern2022-02-20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | podman container clone takes the id of an existing continer and creates a specgen from the given container's config recreating all proper namespaces and overriding spec options like resource limits and the container name if given in the cli options this command utilizes the common function DefineCreateFlags meaning that we can funnel as many create options as we want into clone over time allowing the user to clone with as much or as little of the original config as they want. container clone takes a second argument which is a new name and a third argument which is an image name to use instead of the original container's the current supported flags are: --destroy (remove the original container) --name (new ctr name) --cpus (sets cpu period and quota) --cpuset-cpus --cpu-period --cpu-rt-period --cpu-rt-runtime --cpu-shares --cpuset-mems --memory --run resolves #10875 Signed-off-by: cdoern <cdoern@redhat.com> Signed-off-by: cdoern <cbdoer23@g.holycross.edu> Signed-off-by: cdoern <cdoern@redhat.com>
* | | Merge pull request #13280 from baude/updatetutorialsOpenShift Merge Robot2022-02-22
|\ \ \ | |_|/ |/| | [CI:DOCS]Update networking tutorial for netavark
| * | [CI:DOCS]Update networking tutorial for netavarkBrent Baude2022-02-21
| |/ | | | | | | | | | | | | | | | | With netavark being the default networking implementation for Podman v4, the tutorial needed some updating. [NO NEW TESTS] Signed-off-by: Brent Baude <bbaude@redhat.com>
* | Merge pull request #13286 from flouthoc/kube-build-false-defaultOpenShift Merge Robot2022-02-21
|\ \ | | | | | | kube: honor `--build=false` if specified.
| * | kube: honor --build=false and make --build=true by defaultAditya R2022-02-21
| |/ | | | | | | | | | | | | | | `podman play kube` tries to build images even if `--build` is set to false so lets honor that and make `--build` , `true` by default so it matches the original behviour. Signed-off-by: Aditya R <arajan@redhat.com>
* / Option --url and --connection should imply --remote.Romain Geissler2022-02-19
|/ | | | | | Closes #13242 Signed-off-by: Romain Geissler <romain.geissler@amadeus.com>
* Merge pull request #13075 from n1hility/mac-forward-helperOpenShift Merge Robot2022-02-16
|\ | | | | Mac API forwarding using a privileged docker socket claim helper
| * Introduce podman machine init --root=t|f and podman machine set --root=t|fJason T. Greene2022-02-16
| | | | | | | | | | | | Switch default to rootless for mac and windows Signed-off-by: Jason T. Greene <jason.greene@redhat.com>
* | Unify ls --filter docs for networks and podsPatrycja Guzik2022-02-15
|/ | | | | | Signed-off-by: Patrycja Guzik <patrycja.k.guzik@gmail.com> #13078 follow-up
* podman network: add documentation for netavarkPaul Holzinger2022-02-15
| | | | | | | Add some docs about the different network backends. Also remove the CNI word from network since we refer to either a netavark or CNI config. Signed-off-by: Paul Holzinger <pholzing@redhat.com>
* Show API doc for several versionsPaul Holzinger2022-02-09
| | | | | | | | | | | Right now it is not possible to look at the API version for a specific version. docs.podman.io always show the latest version from the main branch. This is not want many users want so they now have the ability to select a different version. Fixes #12796 Signed-off-by: Paul Holzinger <pholzing@redhat.com>
* Merge pull request #12930 from cdoern/podCgroupOpenShift Merge Robot2022-02-04
|\ | | | | Podman pod create --share-parent vs --share=cgroup
| * Podman pod create --share-parent vs --share=cgroupcdoern2022-02-03
| | | | | | | | | | | | | | | | | | | | | | | | | | | | separated cgroupNS sharing from setting the pod as the cgroup parent, made a new flag --share-parent which sets the pod as the cgroup parent for all containers entering the pod remove cgroup from the default kernel namespaces since we want the same default behavior as before which is just the cgroup parent. resolves #12765 Signed-off-by: cdoern <cdoern@redhat.com> Signed-off-by: cdoern <cbdoer23@g.holycross.edu> Signed-off-by: cdoern <cdoern@redhat.com>
* | Merge pull request #13125 from nalind/url-docsOpenShift Merge Robot2022-02-03
|\ \ | | | | | | [CI:DOCS] Document `schema` values in the `--url` flag
| * | Document `schema` values in the `--url` flagNalin Dahyabhai2022-02-02
| | | | | | | | | | | | | | | | | | | | | | | | | | | Document the recognized `schema` types that can be used in a value passed to the `--url` command line flag. [CI:DOCS] Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
* | | system prune: remove all networksPaul Holzinger2022-02-03
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | podman system prune should also remove all networks. When we want to users to migrate to the new network stack we recommend to run podman system reset. However this did not remove networks and if there were still networks around we would continue to use cni since this was considered an old system. There is one exception for the default network. It should not be removed since this could cause other issues when it no longer exists. The network backend detection logic ignores the default network so this is fine. Signed-off-by: Paul Holzinger <pholzing@redhat.com>
* | Merge pull request #13104 from giuseppe/fix-podman-stats-commentOpenShift Merge Robot2022-02-02
|\ \ | | | | | | [CI:DOCS] docs: clarify rootless net stats
| * | docs: clarify rootless net statsGiuseppe Scrivano2022-02-01
| | | | | | | | | | | | | | | | | | | | | | | | follow-up for https://github.com/containers/podman/pull/13101 [CI:DOCS] Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
* | | Merge pull request #13066 from rhatdan/manOpenShift Merge Robot2022-02-01
|\ \ \ | |/ / |/| | Clarify remote client means Mac and Windows
| * | Clarify remote client means Mac and WindowsDaniel J Walsh2022-01-28
| | | | | | | | | | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>