aboutsummaryrefslogtreecommitdiff
path: root/docs/source
Commit message (Collapse)AuthorAge
* Man pages: refactor common options: --subXidnameEd Santiago2022-08-30
| | | | | | | | | | Whew! This one started off identical everywhere, but the version in podman-run got fixed in #1380, then again in #5192, with no corresponding fixes to any of the other man pages. I went with the podman-run version, with a small change in wording. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Man pages: refactor common options: --http-proxyEd Santiago2022-08-29
| | | | | | | Only between podman-create and -run. (podman-build is too different). I went with the podman-run version. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Man pages: refactor common options: --dns-*Ed Santiago2022-08-29
| | | | | | | | | | | --dns-opt and --dns-search, but only in podman-create and -run. Went with the -run version in both cases; --dns-opt remained unchanged, but in --dns-search I changed 'and' to 'with'. Did not consolidate podman-build or podman-pod-create: too different. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Merge pull request #15507 from patrycja-guzik/docs-examplesOpenShift Merge Robot2022-08-27
|\ | | | | [CI:DOCS] Fix example sections to follow the same format
| * Fix example sections to follow the same formatpatrycja-guzik2022-08-27
| | | | | | | | Signed-off-by: patrycja-guzik <patrycja.k.guzik@gmail.com>
* | Fix template name inconsistency Stefano Figura2022-08-26
| | | | | | Signed-off-by: Stefano Figura <stefano@figura.im>
* | Merge pull request #15482 from edsantiago/docs_dedup_systemdOpenShift Merge Robot2022-08-26
|\ \ | |/ |/| Man pages: refactor common options: --systemd
| * Man pages: refactor common options: --systemdEd Santiago2022-08-25
| | | | | | | | | | | | | | I went with the podman-run version, which better conforms to style conventions. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | Merge pull request #15466 from mtrmac/image-trust-sigstoreDaniel J Walsh2022-08-25
|\ \ | |/ |/| podman image trust overhaul, incl. sigstore
| * Add support for sigstoreSigned in (podman image trust set)Miloslav Trmač2022-08-25
| | | | | | | | | | | | | | | | NOTE: This does not edit the use-sigstore-attachments value in registries.d, similarly to how (podman image trust set) didn't set the lookaside paths for simple signing. Signed-off-by: Miloslav Trmač <mitr@redhat.com>
* | Man pages: refactor common options: log-related optionsEd Santiago2022-08-24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | podman-logs and podman-pod-logs. Most of these were already identical, needing no review. Exceptions: --follow : needed some container/pod tweaking. This is the only one that really needs careful review. --names : I went with the longer version Note that podman-events has --since and --until options too, but those are too different to be combined here. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | Man pages: refactor common options: --pidEd Santiago2022-08-24
|/ | | | | | | I chose the one from podman-run, but reordered ns/private to put them in alphabetical order. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Merge pull request #15453 from edsantiago/docs_dedup_ipcOpenShift Merge Robot2022-08-24
|\ | | | | [CI:DOCS] Man pages: refactor common options: --ipc
| * Man pages: refactor common options: --ipcEd Santiago2022-08-24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is not an easy one to review, sorry. I went with the version from podman-create. The differences against podman-run are subtle: apostrophes, whitespace, and the arg description in the '####' line. Suggestion for review: run hack/markdown-preprocess-review, then after you finish with that, cd /tmp/markdown<TAB>/ipc and use your favorite two-file diff tool to compare podman-run* against zzz*. I did not even try to combine the podman-build one; that one is too different. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | Merge pull request #15439 from rhatdan/serviceOpenShift Merge Robot2022-08-24
|\ \ | | | | | | Fix documentation of use of tcp connections
| * | Fix documentation of use of tcp connectionsDaniel J Walsh2022-08-23
| | | | | | | | | | | | | | | | | | Fixes: https://github.com/containers/podman/issues/15430 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | | Merge pull request #15443 from flouthoc/env-merge-supportOpenShift Merge Robot2022-08-24
|\ \ \ | |_|/ |/| | run,create: add support for `--env-merge` for preprocessing default environment variables
| * | run,create: add support for --env-merge for preprocessing varsAditya R2022-08-24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Allow end users to preprocess default environment variables before injecting them into container using `--env-merge` Usage ``` podman run -it --rm --env-merge some=${some}-edit --env-merge some2=${some2}-edit2 myimage sh ``` Closes: https://github.com/containers/podman/issues/15288 Signed-off-by: Aditya R <arajan@redhat.com>
* | | Man pages: refactor common options: --gidmapEd Santiago2022-08-24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Two versions: one for container-related commands, one for pods. The container one is easy: all versions matched, so I made no changes. The pod one is hard to review. I went with the pod-clone version because the pod-create one looks suspicious: it talks in terms of containers, not pods. It's possible that I've got it wrong, and that these two cannot be combined, so please review very carefully. I strongly recommend using hack/markdown-preprocess-review for this one. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | Man pages: Refactor common options: --workdirEd Santiago2022-08-24
| | | | | | | | | | | | | | | | | | | | | | | | I chose the version from podman-run because it is the most up-to-date, and most correct wrt current syntax guidelines. Differences are in arg description, language, and asterisks. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | Man pages: refactor common options: --ignoreEd Santiago2022-08-23
|/ / | | | | | | | | | | Should be an easy one to review. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | Merge pull request #15438 from edsantiago/docs_dedup_devicecgroupruleOpenShift Merge Robot2022-08-23
|\ \ | | | | | | [CI:DOCS] Man pages: refactor common options: --device-cgroup-rule
| * | Man pages: refactor common options: --device-cgroup-ruleEd Santiago2022-08-23
| |/ | | | | | | | | | | | | I chose the version from podman-create. (This is unusual. podman-run tends to have the better-maintained, more up-to-date version.) Signed-off-by: Ed Santiago <santiago@redhat.com>
* | Merge pull request #15429 from graywolf-at-work/document-transportOpenShift Merge Robot2022-08-23
|\ \ | |/ |/| Document restrictions on transport in FROM
| * Document restrictions on transport in FROMTomas Volf2022-08-23
| | | | | | | | | | | | | | | | When using remote podman client, not all transports work as expected. So document this limitation. Fixes: containers/podman#15141 Signed-off-by: Tomas Volf <tomas.volf@showmax.com>
* | Man pages: refactor common options: --disable-content-trustEd Santiago2022-08-23
| | | | | | | | | | | | | | | | | | | | | | | | A NOP option. I chose the container word, of course, and the word 'option' instead of 'flag'. I also hyphenated where needed. I'm choosing to eliminate the "not on remote" text, because I don't think it's true: podman-remote happily accepts that flag on all those commands, including build. (It's marked as hidden on build, but still accepted). Signed-off-by: Ed Santiago <santiago@redhat.com>
* | Merge pull request #15417 from edsantiago/docs_dedup_fix_sloppinessOpenShift Merge Robot2022-08-23
|\ \ | | | | | | [CI:DOCS] Man pages: fix sloppiness
| * | Man pages: fix sloppinessEd Santiago2022-08-22
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I've been doing the man-page cleanup distractedly, while fighting other fires, and submitted some crap: * #15339: I used single angle brackets, not double * #15407: I only refactored --cert-dir from some man pages, not all Easy to review with hack/markdown-preprocess-review, because all the removed texts are identical. The only diff is that container-certs.d is now a link. Sorry about that. I'm going to spend more time being careful. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | Merge pull request #15426 from nicrowe00/14955OpenShift Merge Robot2022-08-23
|\ \ \ | | | | | | | | podman kube play/down --read from URL
| * | | podman kube play/down --read from URLNiall Crowe2022-08-23
| | |/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | `podman kube play` can create pods and containers from YAML read from a URL poiniting to a YAML file. For example: `podman kube play https://example.com/demo.yml`. `podman kube down` can also teardown pods and containers created from that YAML file by also reading YAML from a URL, provided the YAML file the URL points to has not been changed or altered since it was used to create pods and containers Closes #14955 Signed-off-by: Niall Crowe <nicrowe@redhat.com>
* | | Man pages: refactor common options: --cpusEd Santiago2022-08-23
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Only on podman create and run: the --cpus option on container-clone and pod-clone can probably be combined, but maybe later. pod-create has unique wording that can't be combined. This is a freebie to review: the text in both files was already identical, and I made no changes to it. hack/markdown-preprocess-review will agree, and show you no diffs, because there are none worth seeing. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | Merge pull request #15384 from sstosh/options-cgroupsv1-rootlessOpenShift Merge Robot2022-08-23
|\ \ \ | | | | | | | | Warning messages are printed and ignored if we use an unsupported option on cgroups V1 rootless systems
| * | | Warning messages are printed and ignored if we use an unsupported optionToshiki Sonoda2022-08-23
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | When an unsupported limit on cgroups V1 rootless systems is requested, podman prints an warning message and ignores the option/flag. ``` Target options/flags: --cpu-period, --cpu-quota, --cpu-rt-period, --cpu-rt-runtime, --cpus, --cpu-shares, --cpuset-cpus, --cpuset-mems, --memory, --memory-reservation, --memory-swap, --memory-swappiness, --blkio-weight, --device-read-bps, --device-write-bps, --device-read-iops, --device-write-iops, --blkio-weight-device ``` Related to https://github.com/containers/podman/discussions/10152 Signed-off-by: Toshiki Sonoda <sonoda.toshiki@fujitsu.com>
* | | | Merge pull request #15420 from sstosh/fix-troubleOpenShift Merge Robot2022-08-23
|\ \ \ \ | |_|/ / |/| | | [CI:DOCS] Update Troubleshooting.md
| * | | [CI:DOCS] Update Troubleshooting.mdToshiki Sonoda2022-08-23
| |/ / | | | | | | | | | | | | | | | | | | - Fix the item number - Fix the links Signed-off-by: Toshiki Sonoda <sonoda.toshiki@fujitsu.com>
* | | Man pages: refactor common options: --pod-id-fileEd Santiago2022-08-22
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Much like --cidfile (#15414), --pod-id-file has two meanings. One is used in pod-related commands, one in container ones. Both meanings read the file, so the read/write split used in --cidfile is not applicable here. podman-pod-create keeps its --pod-id-file option because that one cannot be refactored: that's the only command (now) that writes a pod-id file. Reviewable using hack/markdown-preprocess-review but I did take some liberties with the #### args because they were wrong. And, since I had to much with the description text anyway (resulting in diffs), I also took the liberty of cleaning up a double space. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | Merge pull request #15414 from edsantiago/docs_dedup_cidfileOpenShift Merge Robot2022-08-22
|\ \ \ | |/ / |/| | Man pages: refactor common options: --cidfile
| * | Man pages: refactor common options: --cidfileEd Santiago2022-08-22
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There are two meanings: one writes a cidfile, the other reads. Split into two .md files. This can be reviewed with hack/markdown-preprocess-review . The main differences you'll see are all in cidfile.read: 1) I use the <<subcommand>> feature. This works nicely for kill, pause/unpause, and stop. It works less nicely for rm, because the man page will show "...and rm the container" (a human might prefer to see "REMOVE the container"). Given the benefit of this cleanup, I think this is a fine tradeoff. 2) I choose to include the "multiple times" text even on man pages where it wasn't present before. I tested to make sure it works. 3) The #### line I choose is IMHO the best one. Minor differences: * I believe the "remove the container" text in podman-kill and podman-stop is a copy/paste error. This PR fixes it. * The only differences between the cidfile.write texts is the #### line (my version is best) and a final period. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | Merge pull request #15392 from ashley-cui/quietOpenShift Merge Robot2022-08-22
|\ \ | |/ |/| Add quiet/q flag to podman secret ls
| * Add quiet/q flag to podman secret lsAshley Cui2022-08-22
| | | | | | | | | | | | | | Add quiet/q flag to podman secret ls, which will print only the secret ID. Signed-off-by: Ashley Cui <acui@redhat.com>
* | Merge pull request #15412 from edsantiago/docs_dedup_credsOpenShift Merge Robot2022-08-22
|\ \ | | | | | | Man pages: refactor common options: --creds
| * | Man pages: refactor common options: --credsEd Santiago2022-08-22
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Refactor the --creds option. I went with the one in podman-pull The main difference between all of them is the '####' line, differences in the param descriptions. podman-pull had the clearest one. This is another one that hack/markdown-preprocess-review is good for reviewing. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | Merge pull request #15363 from rhatdan/secretOpenShift Merge Robot2022-08-22
|\ \ \ | | | | | | | | podman secret create -d alias --driver, inspect -f alias --format: Docker compatibity
| * | | Add podman secret inspect -f alias for --format: Docker compatibilityDaniel J Walsh2022-08-17
| | | | | | | | | | | | | | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
| * | | Add podman secret create -d as alias for --driver for Docker compatibilityDaniel J Walsh2022-08-17
| | | | | | | | | | | | | | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | | | Merge pull request #15403 from sstosh/cgroups-cpusetOpenShift Merge Robot2022-08-22
|\ \ \ \ | | | | | | | | | | [CI:DOCS] Update how to enable resource limit delegation
| * | | | [CI:DOCS] Update how to enable resource limit delegationToshiki Sonoda2022-08-22
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add a information about `cpu-shares` option and `CPUSET` limits. Signed-off-by: Toshiki Sonoda <sonoda.toshiki@fujitsu.com>
* | | | | Merge pull request #15409 from vrothberg/fix-15300OpenShift Merge Robot2022-08-22
|\ \ \ \ \ | |_|_|/ / |/| | | | [CI:DOCS] elaborate on image lookups of foreign platforms
| * | | | [CI:DOCS] elaborate on image lookups of foreign platformsValentin Rothberg2022-08-22
| | |_|/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | After pulling/creating an image of a foreign platform, Podman will happily use it when looking it up in the local storage and will not pull down the image matching the host platform. As discussed in #12682, the reasoning for it is Docker compatibility and the fact that user already rely on the behavior. While Podman is now emitting a warning when an image is in use not matching the local platform, the documentation was lacking that information. Fixes: #15300 Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
* / | | Man pages: refactor common options: cert-dirEd Santiago2022-08-22
|/ / / | | | | | | | | | | | | | | | | | | ...and, tweak markdown-process-review so it can detect and remove identical files, making review easier. Signed-off-by: Ed Santiago <santiago@redhat.com>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-12-29 19:26:56 +0000