aboutsummaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAge
* Man pages: refactor common options: --timeEd Santiago2022-10-05
| | | | | | | | | | Only in container/pod stop/rm/restart man pages; the others (volume-rm, network-rm, system-service) are too different to refactor. Mostly an easy one, no manual reconciliation needed apart from the pod-vs-container difference. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Merge pull request #16055 from edsantiago/docs_dedup_podOpenShift Merge Robot2022-10-05
|\ | | | | [CI:DOCS] Man pages: refactor common options: --pod
| * Man pages: refactor common options: --podEd Santiago2022-10-05
| | | | | | | | | | | | | | | | | | | | Only between podman-create and -run; the other meanings of --pod are too different. This almost didn't feel worth refactoring, except the podman-run version fixed a word and added a possibly important note about infra containers. I went with the podman-run version. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | Merge pull request #16029 from andrei-n-cosma/kube-default-networkOpenShift Merge Robot2022-10-05
|\ \ | |/ |/| Add pods created by play kube to a default network
| * Add pods created by kube play to a default networkAndrei Natanael Cosma2022-10-04
| | | | | | | | | | | | | | | | | | | | In order to allow pods to reach other pods (as in Kubernetes) they all need to be added to the same network. A network is created (if it doesn't exist) and pods created by play-kube are added to that network. When network options are passed to kube command the pods are not attached to the default kube network. Signed-off-by: Andrei Natanael Cosma <andrei@intersect.ro>
* | Man pages: refactor common options: --featuresEd Santiago2022-10-04
|/ | | | | | Easy one: text was already identical between both files. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Man pages: refactor common options: --variantEd Santiago2022-10-03
| | | | | | | | | | Two different texts, split into two .md files. Nontrivial, but still easy to review because the text is unchanged. I was unable to reconcile either version with podman-build, so that file remains with a separate version. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Man pages: refactor common options: --compression-formatEd Santiago2022-10-02
| | | | | | Easy one: text was already identical across both files. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Merge pull request #15999 from edsantiago/docs_dedup_sign-passphrase-fileOpenShift Merge Robot2022-09-30
|\ | | | | [CI:DOCS] Man pages: Refactor common options: --sign-passphrase-file
| * Man pages: Refactor common options: --sign-passphrase-fileEd Santiago2022-09-29
| | | | | | | | | | | | | | Trivial one: no human intervention needed, the man page text was already identical between both files. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | Merge pull request #15998 from Luap99/play-kube-hostnetOpenShift Merge Robot2022-09-29
|\ \ | |/ |/| podman kube play allow --network host
| * Man pages: refactor common options: --networkEd Santiago2022-09-29
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Tricky one. In particular: podman-kube-play did not enumerate the "host" option; here I take the liberty of using it in the common network.md, so it will appear in podman-kube-play.1. If that is wrong, please tell me ASAP: I will need to un-refactor podman-kube-play. Other decisions: * move the "invalid if" text to the bottom, because it can't be shared between pod and container man pages. * ditto for "together with --pod" * kube-play said "Change the network mode of"; all the others said ">SET< the network mode >FOR< ...". I chose the latter, so that's what kube-play will have also. Again, if that's wrong, please lmk. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | Man pages: refactor common options: --log-optEd Santiago2022-09-29
|/ | | | | | | | | | | | | | Simple in reality, but hard to review due to lots of little diffs: - "Logging driver specific options" was only in podman-run; I added it to create and kube-play. - whitespace changes, the 'e.g.'s got consistent 4-space indentation - the "same keys" and "supported only" sentences, I moved up to be closer to **tag** and without intervening whitespace, because they were unclear as they were: I believe the intent is to apply those sentences only to **tag**, not to the **--log-opt** option itself. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Add SELinux information about boolean for using random devicesDaniel J Walsh2022-09-26
| | | | | | Fixes: https://github.com/containers/podman/issues/15930 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* Man pages: refactor common options: --env-fileEd Santiago2022-09-26
| | | | | | | | | | Another easy one. Option is only present in these three man pages. I took the liberty of changing the "See note" text, making it the same as --env. I also took the liberty of hyphenating "line-delimited" because that's the correct thing to do. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Man pages: refactor common options: --envEd Santiago2022-09-26
| | | | | | | | | | | | | Only among podman create, exec, run. The same option in podman build, generate-systemd, and secret-create is too different. Should be a trivial one to review, the only difference is a period at the end of one sentence. And, of course, the "See Environment note" applies only to podman-create and run, not exec, so it can't be deduplicated. Signed-off-by: Ed Santiago <santiago@redhat.com>
* Merge pull request #15936 from edsantiago/docs_dedup_sigproxyOpenShift Merge Robot2022-09-26
|\ | | | | [CI:DOCS] Man pages: Refactor common options: --sig-proxy
| * Man pages: Refactor common options: --sig-proxyEd Santiago2022-09-26
| | | | | | | | | | | | | | | | | | | | | | Unusually, I discarded the podman-run version and went with the one common to attach and start. (The defaults are left out of the common file, because 'start' is different by necessity). Please review extra-carefully to make sure the new wording applies to podman-run, in particular the "non-TTY mode" words. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | man page xref: verify page titleEd Santiago2022-09-26
|/ | | | | | | | Issue #15923 should have never happened: the problem should've been autodetected. Make it so henceforth (and fix another existing discrepancy) Signed-off-by: Ed Santiago <santiago@redhat.com>
* [CI:DOCS] man pages: fix incorrect titleErik Sjölund2022-09-24
| | | | | | Fixes: https://github.com/containers/podman/issues/15923 Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* Merge pull request #15900 from rhatdan/VENDOROpenShift Merge Robot2022-09-23
|\ | | | | Update vendor of containers(image, common, buildah, storage)
| * Fixup Buildah mergeEd Santiago2022-09-23
| | | | | | | | | | | | | | | | | | | | | | | | | | Changes since 2022-09-09: - man page: add --skip-unused-stages (buildah 4249) - man page: bring in new Note for --cache-ttl (4248) - system tests: de-stutter (4205) - (internal): in skip() applier: escape asterisk, otherwise the "bud with --dns* flags" sed expression never applies. Signed-off-by: Ed Santiago <santiago@redhat.com> Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | Merge pull request #15873 from ashley-cui/prettysecretsOpenShift Merge Robot2022-09-23
|\ \ | |/ |/| Add --pretty to podman secret inspect
| * Add --pretty to podman secret inspectAshley Cui2022-09-22
| | | | | | | | | | | | Pretty-print podman secret inspect output in a human-readable format Signed-off-by: Ashley Cui <acui@redhat.com>
* | Add support for 'image' volume driverMatthew Heon2022-09-22
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | We added the concept of image volumes in 2.2.0, to support inspecting an image from within a container. However, this is a strictly read-only mount, with no modification allowed. By contrast, the new `image` volume driver creates a c/storage container as its underlying storage, so we have a read/write layer. This, in and of itself, is not especially interesting, but what it will enable in the future is. If we add a new command to allow these image volumes to be committed, we can now distribute volumes - and changes to them - via a standard OCI image registry (which is rather new and quite exciting). Future work in this area: - Add support for `podman volume push` (commit volume changes and push resulting image to OCI registry). - Add support for `podman volume pull` (currently, we require that the image a volume is created from be already pulled; it would be simpler if we had a dedicated command that did the pull and made a volume from it) - Add support for scratch images (make an empty image on demand to use as the base of the volume) - Add UOR support to `podman volume push` and `podman volume pull` to enable both with non-image volume drivers Signed-off-by: Matthew Heon <matthew.heon@pm.me>
* Merge pull request #15837 from rhatdan/formatOpenShift Merge Robot2022-09-21
|\ | | | | Improve generate systemd format
| * Improve generate systemd formatDaniel J Walsh2022-09-21
| | | | | | | | | | | | | | | | Fixes: https://github.com/containers/podman/issues/14897 Followup to #13814 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | Merge pull request #15842 from ashley-cui/seclabelsOpenShift Merge Robot2022-09-21
|\ \ | |/ |/| Add labels to secrets
| * Add labels to secretsAshley Cui2022-09-20
| | | | | | | | | | | | | | Add --label/-l label flag to secret create, and show labels when inspecting secrets. Also allow labeling secrets via libpod/compat API. Signed-off-by: Ashley Cui <acui@redhat.com>
* | Merge pull request #15859 from edsantiago/docs_format_eventsOpenShift Merge Robot2022-09-19
|\ \ | | | | | | [CI:DOCS] man pages: document some --format options
| * | man pages: document some --format optionsEd Santiago2022-09-19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Baby steps toward merging #14046: document Go format options for podman events. This is deliberately imperfect. I am not the right person to document these. I am simply the person who is getting a skeleton framework in place. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | Merge pull request #15072 from rhatdan/contextOpenShift Merge Robot2022-09-19
|\ \ \ | |/ / |/| | Add support for podman context as alias to podman system connection
| * | Add support for podman context as alias to podman system connectionDaniel J Walsh2022-09-15
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Alias podman --context -> podman --connection podman context use -> podman system connection default podman context rm -> podman system connection rm podman context create -> podman system connection add podman context ls ->podman system connection ls podman context inspect ->podman system connection ls --json (For specified connections) Podman context is a hidden command, but can be used for existing scripts that assume Docker under the covers. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | | Merge pull request #15823 from rhatdan/dns-optOpenShift Merge Robot2022-09-16
|\ \ \ | | | | | | | | Default to --dns-option to match Docker and Buildah
| * | | Default to --dns-option to match Docker and BuildahDaniel J Walsh2022-09-16
| | | | | | | | | | | | | | | | | | | | | | | | [NO NEW TESTS NEEDED] Existing tests cover this. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | | | Merge pull request #15173 from carljmosca/mainOpenShift Merge Robot2022-09-16
|\ \ \ \ | | | | | | | | | | [CI:DOCS] added docs for installing certificate authority
| * | | | added docs for installing certficate authorityCarl J. Mosca2022-08-13
| | | | | | | | | | | | | | | | | | | | | | | | | Co-authored-by: Tom Sweeney <tsweeney@redhat.com> Signed-off-by: Carl J. Mosca <carljmosca@gmail.com>
* | | | | Merge pull request #15755 from edsantiago/docs_for_formatsOpenShift Merge Robot2022-09-16
|\ \ \ \ \ | |_|/ / / |/| | | | [CI:DOCS] man pages: document some --format options
| * | | | [CI:DOCS] man pages: document some --format optionsEd Santiago2022-09-15
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Baby steps toward merging #14046: document a few of the Go format command-line options. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | | | Merge pull request #15817 from edsantiago/docs_dedup_dnsOpenShift Merge Robot2022-09-16
|\ \ \ \ \ | | | | | | | | | | | | [CI:DOCS] Man pages: Refactor common options: --dns
| * | | | | Man pages: Refactor common options: --dnsEd Santiago2022-09-15
| |/ / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Only between podman-build, create, and run. podman-pod-create is too different. As usual I went with the podman-run version. This means keeping the word "flag" (which should be "option"), for ease of review. I will fix in my in-progress cleanup PR. For podman-build, I removed "during the build" and changed it to a note for that man page only. Signed-off-by: Ed Santiago <santiago@redhat.com>
* / / / / Fix broken titles on readthedocsEd Santiago2022-09-15
|/ / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Followup to #15621, which (correctly) removed parentheses from md files. Turns out, a hidden part of our readthedocs process depended on those parentheses. Update that step so it handles the new, correct, <space><section-number> format. Also update local-testing documentation in README, and clean it up a little. Fixes: #15822 Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | | Man pages: refactor common options: 2 stats optsEd Santiago2022-09-15
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | --no-reset and --no-stream, in podman-stats and pod-stats. Very minor tweak to --no-stream to account for pods. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | | Man pages: refactor common options: --shm-sizeEd Santiago2022-09-14
| |/ / |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Mostly went with the podman-run version. For ease of review, I kept the "you" word -- I will fix that in my in-progress cleanup PR. This affects lots of files, each of which had slightly different wording, but this actually isn't as bad as it looks. The diffs were minor, and I'm pretty sure the new refactored text applies equally well to all the man pages. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | Man pages: refactor common options: --userEd Santiago2022-09-14
| | | | | | | | | | | | | | | | | | In podman-create, exec, and run. Went with the podman-run version. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | Man pages: refactor common options: --preserve-fds, -itEd Santiago2022-09-14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Three simple options shared among podman-create, exec, run. I mostly went with the podman-run versions. For --tty, this means that create and exec get the long stdout/stderr note. (The example, though, remains only in podman-run). For -i, mostly boldspace changes. For --preserve-fds, podman-exec now has the "not with remote" note (which it didn't until now) Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | Merge pull request #15795 from edsantiago/docs_dedup_ip6OpenShift Merge Robot2022-09-14
|\ \ \ | | | | | | | | [CI:DOCS] Man pages: refactor common options: --ip6
| * | | Man pages: refactor common options: --ip6Ed Santiago2022-09-14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Similar to yesterday's --ip. No changes to content, all I did was variableize the instances of 'container'/'pod'. Did not touch podman-network-connect file, but if someone wants to look at that one and tell me whether all this long text is applicable to it (or not), I'd appreciate it. Signed-off-by: Ed Santiago <santiago@redhat.com>
* | | | improve slirp4netns allow_host_loopback docsPaul Holzinger2022-09-14
|/ / / | | | | | | | | | | | | | | | | | | | | | | | | The default ip is 10.0.2.2 but is always the second ip from the slirp4netns subnet, which can be changed via the cidr option. Fixes https://bugzilla.redhat.com/show_bug.cgi?id=2090166 Signed-off-by: Paul Holzinger <pholzing@redhat.com>
* | | Man pages: refactor common options: --tls-verifyEd Santiago2022-09-13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Ugh. This had about five different variations among twelve files. I went with the version from podman-create, kube play, login, pull, push, run. The others: - manifest-add and create did not include the "true, false, missing" text. Now they do. (If this text is N/A to these two, please yell). Also, these two were written with "talking" instead of "contacting" the registry. - podman-build had "does not work with remote", but this does not seem to be true, so I removed it. None of the other files had that. - the wording in podman-search is just weird, with "if needed" and "is listed" and unclear "insecure registries". I just nuked it all. If that wording was deliberate, for some reason that applies only to podman-search, please yell. - podman-container-runlabel has one diff that I like, actually spelling out containers-registries.conf(5), but incorporating that would make this even harder to review. I will add that to my in-progress doc-cleanup PR. Review recommendation: run hack/markdown-preprocess-review but just quit out of it immediately (on both popups). Ignore it completely. Then cd /tmp/markdown-preprocess-review.diffs/tls-verify and run $ clear;for i in podman-*;do echo;echo $i;wdiff -t $i zzz-chosen.md;done This will show the major diffs between each version and the chosen one. Assumes you have wdiff installed. If you have another colorize-actual- individual-word-diffs tool installed, use that. I like cdif[1]. [1] https://github.com/kaz-utashiro/sdif-tools Signed-off-by: Ed Santiago <santiago@redhat.com>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-12 05:01:08 +0000