summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAge
* 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>
* | | Merge pull request #15342 from edsantiago/docs_dedup_authfileOpenShift Merge Robot2022-08-22
|\ \ \ | |/ / |/| | Man pages: refactor common options: authfile
| * | Man pages: refactor common options: authfileEd Santiago2022-08-16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Refactor the --authfile option. My suggestion for review: 1) run hack/markdown-preprocess-review and immediately Ctrl-Q to quit out of diffuse, which is completely unusable for this many files; then 2) cd /tmp/markdown-preprocess-review.diffs/authfile - this is the directory created by the review script 3) rm podman-image-sign* podman-log* podman-search.1.md.in - because they're essentially identical to podman-create 4) rm podman-manifest-* podman-push.* - because they're 100% identical to podman-kube-play 5) rm podman-kube-play* - because it's apart-from-whitespace identical to podman-build (use "wdiff" to confirm) 6) rm podman-auto-update* - because that's the one I chose (hence == zzz-chosen.md) (You should obviously run your own diff/cmp before rm, to confirm my assertions about which files are identical). After all that, you have a manageable number of files which you can scan, read, diff against zzz-chosen.md, even run diffuse. This option is IMHO the poster child for why we need this kind of man page refactoring. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | Merge pull request #15305 from dilyanpalauzov/reword_exit_policyDaniel J Walsh2022-08-18
|\ \ \ | | | | | | | | Reword --exit-policy option
| * | | Reword --exit-policy optionДилян Палаузов2022-08-14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Insisting on “DCO” imposes formalities, that serve self-purpose. One cannot assume that the submitter has time or will to read texts about symbolism in software contributions. If the system wants to see the text nrEAUIEUAIe eanuitdnuae EAIUEAUIAIE »ℓ§444.3.72b)°»°ℓ§euaieauuae in each commit, people will write this, or any other text, that the system wants to see. All such text, which presence is mandated by the system, has the same value. Signed-off-by: Дилян Палаузов <git-dpa@aegee.org>
* | | | Merge pull request #15364 from rhatdan/statsOpenShift Merge Robot2022-08-17
|\ \ \ \ | | | | | | | | | | Add podman stats --no-trunc option
| * | | | Add podman stats --no-trunc optionDaniel J Walsh2022-08-17
| | |_|/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | This is for compatibility with Docker. Partial fix for https://github.com/containers/podman/issues/14917 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* / | | Add podman manifest create -a. Alias for --amend:Docker compatibilityDaniel J Walsh2022-08-17
|/ / / | | | | | | | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | | Merge pull request #14999 from sstosh/restart-optionOpenShift Merge Robot2022-08-17
|\ \ \ | | | | | | | | Add restart --cidfile, --filter
| * | | Add restart --cidfile, --filterToshiki Sonoda2022-08-12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | --cidfile : Read container ID from the specified file and restart the container. --filter : restart the filtered container. Signed-off-by: Toshiki Sonoda <sonoda.toshiki@fujitsu.com>
* | | | podman manifest create: accept --amend and --insecure flagsNalin Dahyabhai2022-08-16
| |_|/ |/| | | | | | | | | | | | | | | | | | | | Accept a --amend flag in `podman manifest create`, and treat `--insecure` as we would `--tls-verify=false` in `podman manifest`'s "add", "create", and "push" subcommands. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
* | | Merge pull request #15339 from edsantiago/docs_dedup_annotationOpenShift Merge Robot2022-08-16
|\ \ \ | | | | | | | | Man pages: refactor common options: --annotation
| * | | Man pages: refactor common options: --annotationEd Santiago2022-08-16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Refactor the --annotation option, but only between podman create, kube play, and run. This does not include: * podman build: - usage is in terms of images, not containers/pods * manifest add, manifest annotate: - usage is in terms of images, not containers/pods - also, wording is slightly different Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | | Merge pull request #15270 from nicrowe00/kubegenerateOpenShift Merge Robot2022-08-16
|\ \ \ \ | |/ / / |/| | | Add "podman kube generate" command
| * | | Add "podman kube generate" commandNiall Crowe2022-08-11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | "podman kube generate" creates Kubernetes YAML from Podman containers, pods or volumes. Users will still be able to use "podman generate kube" as an alias of "kube generate". Signed-off-by: Niall Crowe <nicrowe@redhat.com>
* | | | Merge pull request #15331 from edsantiago/docs_dedup_piecemealOpenShift Merge Robot2022-08-16
|\ \ \ \ | | | | | | | | | | Man pages: refactor common options: arch
| * | | | Man pages: refactor common options: archEd Santiago2022-08-15
| | |_|/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Smaller, more reviewable chunks. This is just one option, --arch. Future PRs may, if the reviewing is easy, include multiple options. This one includes fixes to the preprocessor script, though: * big oops, I was not handling '<<something pod|something>>' where 'pod' appears other than the beginning of the string. * I was also not handling 'container<<| or pod>>', where one side was empty. * Behavior change: <<subcommand>>, on podman-pod-foo, becomes just 'foo' (not 'pod foo'). This will be useful in a future PR where we refactor --pod-id-file. Signed-off-by: Ed Santiago <santiago@redhat.com>
* / | | podman images and friends can take one image as argumentDaniel J Walsh2022-08-15
|/ / / | | | | | | | | | | | | | | | Fixes: https://github.com/containers/podman/issues/15309 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | | Add default value for $RMDoug Rabson2022-08-13
| | | | | | | | | | | | | | | | | | | | | | | | For some reason GNU make doesn't define this on FreeBSD. [NO NEW TESTS NEEDED] Signed-off-by: Doug Rabson <dfr@rabson.org>
* | | Fix updated link to install instructionsWilliam Entriken2022-08-11
| |/ |/| | | | | Signed-off-by: William Entriken <github.com@phor.net>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-12 20:01:08 +0000