summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAge
* Merge pull request #9754 from mheon/add_depOpenShift Merge Robot2021-04-06
|\ | | | | Add --requires flag to podman run/create
| * Add --requires flag to podman run/createMatthew Heon2021-04-06
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Podman has, for a long time, had an internal concept of dependency management, used mainly to ensure that pod infra containers are started before any other container in the pod. We also have the ability to recursively start these dependencies, which we use to ensure that `podman start` on a container in a pod will not fail because the infra container is stopped. We have not, however, exposed these via the command line until now. Add a `--requires` flag to `podman run` and `podman create` to allow users to manually specify dependency containers. These containers must be running before the container will start. Also, make recursive starting with `podman start` default so we can start these containers and their dependencies easily. Fixes #9250 Signed-off-by: Matthew Heon <matthew.heon@pm.me>
* | Merge pull request #9909 from w4tsn/docs/add-containers-storage-transportOpenShift Merge Robot2021-04-05
|\ \ | | | | | | [CI:DOCS] Add transport and destination info to manifest doc
| * | Add transport and destination info to manifest docAlexander Wellbrock2021-04-03
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Initially I was missing transport information on podman manifest add. Especially the `containers-storage` transport which references the local image store. Had a use case where this came in quite handy and it is not stated anywhere else in the docs. Suppose it does not make sense for podman pull & push. I've only added containers-storage and docker transports for manifest add since I know those work. Maybe others work too. I then also added the destination section to manifest push as it is done in podman push & pull. I've added all transports here, but I don't know if all are supported. Please review. Signed-off-by: Alexander Wellbrock <a.wellbrock@mailbox.org>
* | | Allow users to override default storage opts with --storage-optDaniel J Walsh2021-04-05
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | We define in the man page that this overrides the default storage options, but the code was appending to the existing options. This PR also makes a change to allow users to specify --storage-opt="". This will turn off all storage options. https://github.com/containers/podman/issues/9852 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | | podman-run.1.md, podman-create.1.md : Adjust Markdown layout for --usernsErik Sjölund2021-04-03
| | | | | | | | | | | | | | | | | | | | | * Adjust Markdown layout for --userns. * Make the --userns sections identical for podman-run.1.md and podman-create.1.md Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* | | Fix typos --uidmapping and --gidmappingErik Sjölund2021-04-03
| | | | | | | | | | | | | | | | | | | | | * Fix typos --uidmapping and --gidmapping in podman-run.1.md * Add the corresponding sentence in podman-create.1.md Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* | | Add ssh connection to root userAshley Cui2021-04-01
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | When initing a VM, create two add connections - one to user, one to root. podman machine remove removes both connections as well. [NO TESTS NEEDED] Signed-off-by: Ashley Cui <acui@redhat.com>
* | | Remove --execute from podman machine sshbaude2021-03-31
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The --execute flag ended up serving no purpose. It was removed and documentation was updated. Fixed a panic when no VM name was provided. [NO TESTS NEEDED] Signed-off-by: baude <bbaude@redhat.com>
* | | Merge pull request #9901 from w4tsn/docs/fix-podman-image-unmount-linkOpenShift Merge Robot2021-03-31
|\ \ \ | | | | | | | | [CI:DOCS] Fix unmount doc reference in image.rst
| * | | Fix unmount doc reference in image.rstAlexander Wellbrock2021-03-31
| |/ / | | | | | | | | | | | | | | | | | | This pointed to the container-unmount doc page. It now points to the expected podman-image-unmount doc page. Signed-off-by: Alexander Wellbrock <a.wellbrock@mailbox.org>
* | | Merge pull request #9888 from baude/machineignOpenShift Merge Robot2021-03-31
|\ \ \ | |/ / |/| | podman machine init --ignition-path
| * | podman machine init --ignition-pathbaude2021-03-30
| |/ | | | | | | | | | | | | | | | | | | | | | | allow for the user to provide an alternate ignition-file rather than the auto-generated one. updated docs to describe ramifications of providing an alterate ignition file. [NO TESTS NEEDED] Signed-off-by: baude <bbaude@redhat.com>
* | [CI:DOCS] Add local html build info to docs/README.mdTomSweeneyRedHat2021-03-30
| | | | | | | | | | | | | | | | Rename Readme.md to README.md in the docs directory. Add the local build process per @Luap99 in #9856 for the man pages to preview any changes that are made. Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* | Merge pull request #9885 from ashley-cui/machinelsOpenShift Merge Robot2021-03-30
|\ \ | | | | | | Add podman machine ls
| * | Add podman machine listAshley Cui2021-03-30
| |/ | | | | | | | | | | | | | | | | | | podman machine list lists all virtual machines & indicates the default VM connection, if it exists. it also can take a --format flag arg as a go template. [NO TESTS NEEDED] Signed-off-by: Ashley Cui <acui@redhat.com>
* / Document --volume from podman-remote run/create clientDaniel J Walsh2021-03-30
|/ | | | | | | | | | | [NO TESTS NEEDED] This PR is mainly documentation and some code cleanup. Also cleanup and consolidate handling of other hanlding of podman-remote hidden options. Fixes: https://github.com/containers/podman/issues/9874 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* Merge pull request #9307 from Luap99/powershell-completionOpenShift Merge Robot2021-03-29
|\ | | | | Add powershell completions
| * Add powershell completionsPaul Holzinger2021-03-29
| | | | | | | | | | | | | | | | | | Add support for generating powershell completion files. This is especially useful for people using the podman remote client on windows. [NO TESTS NEEDED] Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
* | Merge pull request #9856 from Luap99/fix-longflagOpenShift Merge Robot2021-03-29
|\ \ | |/ |/| [CI:DOCS] Fix long option format on docs.podman.io
| * Fix long option format on docs.podman.ioPaul Holzinger2021-03-29
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Escape the two dashes, otherwise they are combined into one long dash. I tested that this change is safe and still renders correctly on github and with the man pages. This commit also contains a small change to make it build locally. Assuming you have the dependencies installed you can do: ``` cd docs make html ``` Preview the html files in docs/build/html with `python -m http.server 8000 --directory build/html`. Fixes containers/podman.io#373 Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
* | man pages: correct seccomp-policy labelValentin Rothberg2021-03-29
|/ | | | | | | | | The implementation uses `io.containers.seccomp.profile` while the docs mentioned `io.podman`. Correct the two references in the docs to reflect the implementation. Fixes: #9853 Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* Podman machine enhancementsbaude2021-03-27
| | | | | | | | | | | | | | | | | | | Podman machine remove is now called `rm`. Podman machine create now supports resizing the image to the value of --disk-size as provided. The default is to 10G. Added systemd unit file on guest via ignition that sends a Ready message to the host over a virtio-socket so that we know when the VM is booted and ready for use. Podman machine commands no longer require a VM name as an argument. A default VM name is defined and if no VM name is provided as a arg, the default will be used. [NO TESTS NEEDED] Signed-off-by: baude <bbaude@redhat.com>
* Merge pull request #9726 from tunacado/add_runroot_mount_require_to_systemd_genOpenShift Merge Robot2021-03-26
|\ | | | | Add RequiresMountsFor= to systemd generate
| * Add RequiresMountsFor= to systemd generateRobb Manes2021-03-26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | It is rare but possible that storage locations for the graphroot and the runroot are not mounted at boot time, and therefore might race when doing container operations. An example we've seen in the wild is that a slow tmpfs mount for the runroot would suddenly mount over /run, causing the container to lose all currently-running data, requiring a system refresh to get it back. This patch adds RequiresMountsFor= to the systemd.unit header to ensure the paths for both the graphroot and runroot are mounted prior to starting any generated unit files. Signed-off-by: Robb Manes <rmanes@redhat.com>
* | Rename podman machine create to init and clean upAshley Cui2021-03-25
| | | | | | | | | | | | | | | | | | | | Rename podman machine create to init because we're initing a VM, not really creating it Wire up CPUs flag Suppress QEMU GUI from popping up when not in debug mode [NO TESTS NEEDED] Signed-off-by: Ashley Cui <acui@redhat.com>
* | Improvements for machinebaude2021-03-25
| | | | | | | | | | | | clean up ci failures and add appropriate arch,os exclusion tags Signed-off-by: baude <bbaude@redhat.com>
* | Add --execute flag to podman machine sshAshley Cui2021-03-25
| | | | | | | | | | | | --execute, -e allows to execute a command through ssh Signed-off-by: Ashley Cui <acui@redhat.com>
* | introduce podman machinebaude2021-03-25
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | podman machine allows podman to create, manage, and interact with a vm running some form of linux (default is fcos). podman is then configured to be able to interact with the vm automatically. while this is usable on linux, the real push is to get this working on both current apple architectures in macos. Ashley Cui contributed to this PR and was a great help. [NO TESTS NEEDED] Signed-off-by: baude <bbaude@redhat.com>
* | Podman machine CLI and interface stubAshley Cui2021-03-25
| | | | | | | | | | | | | | | | | | | | Podman machine will be a mac-only command that manages the VM where containers are run. Currently, only the CLI is written and the interface function for the VM management is stub for future developement The podman machine cli is only built on mac builds. Signed-off-by: Ashley Cui <acui@redhat.com>
* | Merge pull request #9749 from jwillikers/generate-kube-persistent-volume-claimOpenShift Merge Robot2021-03-23
|\ \ | | | | | | Generate Kubernetes PersistentVolumeClaims from named volumes
| * | Generate Kubernetes PersistentVolumeClaims from named volumesJordan Williams2021-03-19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fixes #5788 This commit adds support for named volumes in podman-generate-kube. Named volumes are output in the YAML as PersistentVolumeClaims. To avoid naming conflicts, the volume name is suffixed with "-pvc". This commit adds a corresponding suffix for host path mounts. Host path volumes are suffixed with "-host". Signed-off-by: Jordan Williams <jordan@jwillikers.com>
* | | [CI:DOCS] Add note to mappings for user/group userns in buildTomSweeneyRedHat2021-03-22
|/ / | | | | | | | | | | | | | | | | Add a note to the `--userns-uid-map` and `--userns-gid-map` options in the `podman build` man page. Addresses: https://bugzilla.redhat.com/show_bug.cgi?id=1930509 Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* / Docs: removing secrets is safe for in-use secretsAshley Cui2021-03-16
|/ | | | | | | | Add docs explaining that it is safe to remove a secret that is in use by a container: secrets are copied and mounted into the container at creation Signed-off-by: Ashley Cui <acui@redhat.com>
* Document CONTAINERS_CONF/CONTAINERS_STORAGE_CONF Env variablesDaniel J Walsh2021-03-10
| | | | | | | Also Switch to using CONTAINERS_REGISTRIES_CONF for registries.conf overrides. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* Docs: Add docs to access APIs inside containerxcffl2021-03-10
| | | | Signed-off-by: xcffl <2216902+xcffl@users.noreply.github.com>
* podman cp: ignore EPERMs in rootless modeValentin Rothberg2021-03-09
| | | | | | | | | | | | Ignore permission errors when copying from a rootless container. TTY devices inside rootless containers are owned by the host's root user which is "nobody" inside the container's user namespace rendering us unable to even read them. Enable the integration test which was temporarily disabled for rootless users. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* podman-remote build does not support volumesDaniel J Walsh2021-03-08
| | | | | | | | Remove --volume option from podman-remote since it is not supported, also add information to podman-build man page indicating options not supported over remote connections. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* Handle podman build --dns-searchDaniel J Walsh2021-03-07
| | | | | | Fixes: https://github.com/containers/podman/issues/9574 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* [ci skip] Bad formatting fix in build documentationJakub Guzik2021-03-06
| | | | Signed-off-by: Jakub Guzik <jakubmguzik@gmail.com>
* Merge pull request #9568 from wjt/podman-system-service-timeout-docsOpenShift Merge Robot2021-03-04
|\ | | | | [ci:docs] podman-system-service.1.md: fix timeout example
| * podman-system-service.1.md: fix timeout exampleWill Thompson2021-03-02
| | | | | | | | | | | | | | | | | | | | | | | | | | The rest of this document claims that the argument is called '--time', not '--timeout', and that the value is expressed in seconds. As currently written, the example (which ostensibly runs the API service for 5 seconds) uses the '--timeout' spelling (which actually does work, as an undocumented alias) and passes a value of '5000', which is more than an hour. Fix both. [NO TESTS NEEDED] as this is a simple documentation change. Signed-off-by: Will Thompson <wjt@endlessos.org>
* | Merge pull request #9536 from jmguzik/enable-cgroupsv2-sec-optsOpenShift Merge Robot2021-03-03
|\ \ | |/ |/| Enable cgroupsv2 rw mount via security-opt unmask
| * Add /sys/fs/cgroup as readonly path in docsJakub Guzik2021-03-03
| | | | | | | | Signed-off-by: Jakub Guzik <jakubmguzik@gmail.com>
* | podman-image-sign.1.md: typo fixSteve Phillips2021-02-27
|/ | | | | | identify -> identity Signed-off-by: Steve Phillips <steve@tryingtobeawesome.com>
* podman-system-connection.1.md: fix copy/paste errorKier Davis2021-02-24
| | | | Signed-off-by: Kier Davis <me@kierdavis.com>
* Add U volume flag to chown source volumesEduardo Vega2021-02-22
| | | | Signed-off-by: Eduardo Vega <edvegavalerio@gmail.com>
* Merge pull request #9445 from jmguzik/no-header-info-for-systemd-generationOpenShift Merge Robot2021-02-22
|\ | | | | No header info for systemd generation
| * --no-header flag implementation for generate systemdJakub Guzik2021-02-22
| | | | | | | | Signed-off-by: Jakub Guzik <jakubmguzik@gmail.com>
* | Merge pull request #9420 from rhatdan/kubeOpenShift Merge Robot2021-02-22
|\ \ | | | | | | [NO TESTS NEEDED] Allow podman play kube to read yaml file from stdin