summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAge
* Docs: consistency between man / --helpEd Santiago2020-06-24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | New functionality in hack/man-page-checker: start cross- referencing the man page 'Synopsis' line against the output of 'podman foo --help'. This is part 1, flag/option consistency. Part 2 (arg consistency) is too big and will have to wait for later. flag/option consistency means: if 'podman foo --help' includes the string '[flags]' in the Usage message, make sure the man page includes '[*options*]' in its Synopsis line, and vice-versa. This found several inconsistencies, which I've fixed. While doing this I realized that Cobra automatically includes a 'Flags:' subsection in its --help output for all subcommands that have defined flags. This is great - it lets us cross-check against the usage synopsis, and make sure that '[flags]' is present or absent as needed, without fear of human screwups. If a flag-less subcommand ever gets extended with flags, but the developer forgets to add '[flags]' and remove DisableFlagsInUseLine, we now have a test that will catch that. (This, too, caught two instances which I fixed). I don't actually know if the new man-page-checker functionality will work in CI: I vaguely recall that it might run before 'make podman' does; and also vaguely recall that some steps were taken to remedy that. Signed-off-by: Ed Santiago <santiago@redhat.com>
* podman untag: error if tag doesn't existValentin Rothberg2020-06-24
| | | | | | | | | | | Throw an error if a specified tag does not exist. Also make sure that the user input is normalized as we already do for `podman tag`. To prevent regressions, add a set of end-to-end and systemd tests. Last but not least, update the docs and add bash completions. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* Fix typo in manpage for `podman auto update`.Peter Oliver2020-06-23
| | | | Signed-off-by: Peter Oliver <git@mavit.org.uk>
* V2 podman system connectionJhon Honce2020-06-23
| | | | | | | | | * Implement command * Refactor podman-remote to pull from containers.conf by default * podman-remote defaults to --remote being true * Write podman-system-connection.1.md Signed-off-by: Jhon Honce <jhonce@redhat.com>
* Merge pull request #6625 from QiWang19/fdOpenShift Merge Robot2020-06-23
|\ | | | | Add --preservefds to podman run
| * Add --preservefds to podman runQi Wang2020-06-19
| | | | | | | | | | | | Add --preservefds to podman run. close https://github.com/containers/libpod/issues/6458 Signed-off-by: Qi Wang <qiwan@redhat.com>
* | "pod" was being truncated to "po" in the names of the generated systemd unit ↵Gavin Campbell2020-06-21
| | | | | | | | | | | | | | | | files. s/po/pod Signed-off-by: Gavin Campbell <gavin@gavincampbell.dev>
* | correct the absolute path of `rm` executableYuan-Hao Chen2020-06-19
|/ | | | Signed-off-by: Yuan-Hao Chen <yhchen0906@gmail.com>
* Fix remote docsAshley Cui2020-06-18
| | | | | | | | Fix renaming bug in remote-docs.sh Remove mentions of 'remote' in windows and mac dos Remove podman-remote.conf.5 Signed-off-by: Ashley Cui <acui@redhat.com>
* Merge pull request #6560 from mheon/fix_exec_logdriverOpenShift Merge Robot2020-06-17
|\ | | | | Do not share container log driver for exec
| * Do not share container log driver for execMatthew Heon2020-06-17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | When the container uses journald logging, we don't want to automatically use the same driver for its exec sessions. If we do we will pollute the journal (particularly in the case of healthchecks) with large amounts of undesired logs. Instead, force exec sessions logs to file for now; we can add a log-driver flag later (we'll probably want to add a `podman logs` command that reads exec session logs at the same time). As part of this, add support for the new 'none' logs driver in Conmon. It will be the default log driver for exec sessions, and can be optionally selected for containers. Great thanks to Joe Gooch (mrwizard@dok.org) for adding support to Conmon for a null log driver, and wiring it in here. Fixes #6555 Signed-off-by: Matthew Heon <matthew.heon@pm.me>
* | Add support for the unless-stopped restart policyMatthew Heon2020-06-17
|/ | | | | | | | | | | | | | | | | | We initially believed that implementing this required support for restarting containers after reboot, but this is not the case. The unless-stopped restart policy acts identically to the always restart policy except in cases related to reboot (which we do not support yet), but it does not require that support for us to implement it. Changes themselves are quite simple, we need a new restart policy constant, we need to remove existing checks that block creation of containers when unless-stopped was used, and we need to update the manpages. Fixes #6508 Signed-off-by: Matthew Heon <matthew.heon@pm.me>
* Add deprecated message to varlink commandJhon Honce2020-06-15
| | | | | | | * Remove varlink references from the man pages * Fix signature for extractTarFile() Signed-off-by: Jhon Honce <jhonce@redhat.com>
* pod create --replaceValentin Rothberg2020-06-15
| | | | | | | | | | | | | | | Add a `--replace` flag to the `pod create` command. If another pod with the same name already exists, it will be replaced and removed. Adding this flag is motivated by #5485 to make running Podman in systemd units (or any other scripts/automation) more robust. In case of a crash, a pod may not be removed by a sytemd unit anymore. The `--replace` flag allows for supporting crashes. Note that the `--replace` flag does not require the `--name` flag to be set, so it can be set unconditionally in `podman generate systemd`. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* {create,run} --replaceValentin Rothberg2020-06-15
| | | | | | | | | | | | | Add a `--replace` flag to the `container {create,run}` commands. If another container with the same name already exists, it will be replaced and removed. Adding this flag is motivated by #5485 to make running Podman in systemd units (or any other scripts/automation) more robust. In case of a crash, a container may not be removed by a sytemd unit anymore. The `--replace` flag allows for supporting crashes. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* Merge pull request #6551 from QiWang19/doc-check-authOpenShift Merge Robot2020-06-11
|\ | | | | update document login see config.json as valid
| * update document login see config.json as validQi Wang2020-06-11
| | | | | | | | | | | | Update the document, pointing out podman credentials from $HOME/.docker/config.json can be used by Podman. Signed-off-by: Qi Wang <qiwan@redhat.com>
* | docs: create/run fix --pod-id-file descriptionValentin Rothberg2020-06-11
| | | | | | | | Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* | generate systemd: create pod templateValentin Rothberg2020-06-11
| | | | | | | | | | | | | | | | | | | | Create a new template for generating a pod unit file. Eventually, this allows for treating and extending pod and container generation seprately. The `--new` flag now also works on pods. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* | pod create: add `--infra-conmon-pidfile`Valentin Rothberg2020-06-11
| | | | | | | | | | | | | | | | | | | | | | Add an `--infra-conmon-pidfile` flag to `podman-pod-create` to write the infra container's conmon process ID to a specified path. Several container sub-commands already support `--conmon-pidfile` which is especially helpful to allow for systemd to access and track the conmon processes. This allows for easily tracking the conmon process of a pod's infra container. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* | container-{create,run}: add `--pod-id-file`Valentin Rothberg2020-06-11
| | | | | | | | | | | | | | | | Allow containers to join an existing pod via the `--pod-id-file` which is already supported by a number of `podman-pod` subcommands. Also add tests to make sure it's working and to prevent future regressions. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* | podman-pod{rm,start,stop}: support --pod-id-fileValentin Rothberg2020-06-11
|/ | | | | | | | | | Support the `--pod-id-file` flag in the rm, start and stop pod commands. This completes the already support flag in pod-create and is another prerequisite for generating generic systemd unit files for pods. Also add completions, docs and tests. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* podman-events: clarify streaming behaviourValentin Rothberg2020-06-10
| | | | | | | | | Unless `--since` or `--until` is specified, `podman events` will stream new events. Clarify this behavior in the `--help` message and man page to avoid confusion. Fixes: #6536 Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* Improve swagger+CORS metadata docsChris Evich2020-06-09
| | | | Signed-off-by: Chris Evich <cevich@redhat.com>
* add socket information to podman infoBrent Baude2020-06-03
| | | | | | | this is step 1 to self-discovery of remote ssh connections. we add a remotesocket struct to info to detect what the socket path might be. Co-authored-by: Jhon Honce <jhonce@redhat.com> Signed-off-by: Brent Baude <bbaude@redhat.com>
* V2 Add support for ssh authentication methodsJhon Honce2020-06-03
| | | | | | | | | | | | | | | | | * podman --remote ssh://<user>:<password>@<host>:<port><path> * podman --remote ssh://<user>:<password>@<host>:<port><path> \ --identity <path> --passphrase <phrase> * ssh-add <key> podman --remote ssh://<user>@<host><path> * Fix `podman help` to run even if podman missing components * Prompt for passphrase on stdin IFF key is protected and passphrase not given via any other configuration * cobra flags do not support optional value flags therefore refactored --remote to be a boolean and --url will now contain the URI to Podman service Signed-off-by: Jhon Honce <jhonce@redhat.com>
* Merge pull request #6438 from rhatdan/manOpenShift Merge Robot2020-06-01
|\ | | | | [CI:DOCS] Update man pages for --ip with CNI networks
| * Update man pages for --ip with CNI networksMatthew Heon2020-05-31
| | | | | | | | | | | | | | | | | | Originally, we did not allow this, and the manpage reflects that. We added support with 1.7.0, but did not update the manpage. Fix the manpages so they are once again accurate. Signed-off-by: Matthew Heon <mheon@redhat.com> Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | [CI:DOCS] update httpd location in tutorialTomSweeneyRedHat2020-05-30
|/ | | | | | | | | | | Update the reference to the httpd in the Podman tutorial. This just bumps it to F29 for now to get things working, I'd prefer to get something set up in quay.io to make it more resistant to Fedora version changes. Fixes: #6439 Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* Merge pull request #6380 from mheon/fix_mount_readonlyOpenShift Merge Robot2020-05-29
|\ | | | | Add support for `readonly` option to --mount
| * Add support for `readonly` option to --mountMatthew Heon2020-05-26
| | | | | | | | | | | | | | | | | | This is just an alias to the `ro` option, but it's already in the manpages (and Docker) so we might as well add support for it. Fixes #6379 Signed-off-by: Matthew Heon <matthew.heon@pm.me>
* | Merge pull request #6372 from boaz0/gh_6283OpenShift Merge Robot2020-05-27
|\ \ | | | | | | Add --format to pod inspect
| * | Add --format to pod inspectBoaz Shuster2020-05-27
| |/ | | | | | | Signed-off-by: Boaz Shuster <boaz.shuster.github@gmail.com>
* | docs: fix typoDamiano Donati2020-05-26
| | | | | | | | | | | | | | - Similar is misspelled - a `to` is missing after Similar Signed-off-by: Damiano Donati <damiano.donati@gmail.com>
* | [CI:DOCS] Tweak casing in rootless docTomSweeneyRedHat2020-05-26
|/ | | | | | | I just noticed a few 'podman' references that should be 'Podman' in the rootless doc. This fixes it. Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* Merge pull request #6321 from Luap99/podman-generate-systemd-unit-prefixOpenShift Merge Robot2020-05-25
|\ | | | | Allow to change the generated systemd unit name prefix
| * Added new flags to 'podman generate systemd' to change the unit name prefixLuap992020-05-22
| | | | | | | | | | | | | | | | | | | | | | | | | | --container-prefix <string> - default 'container' Systemd unit name prefix for containers --pod-prefix <string> - default 'pod' Systemd unit name prefix for pods --separator <string> - default '-' Systemd unit name seperator between name/id and prefix Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
* | Merge pull request #6309 from cortopy/nonroot_vol_docsOpenShift Merge Robot2020-05-24
|\ \ | | | | | | add section on rootless volumes in the docs
| * | add section on rootless volumesJuan Jimenez-Anca2020-05-23
| | | | | | | | | | | | Signed-off-by: Juan Jimenez-Anca <cortopy@users.noreply.github.com>
* | | [CI:DOCS] Fix readthedocs linkTomSweeneyRedHat2020-05-22
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Touch up the link to the docs on readthedocs. Using the fully specified link like this will cause a CORS issue in many browsers. Plus we're working on a Spanish variant of the site, so we probably should point to the English variant. Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* | | Attempt to turn on additional build testsDaniel J Walsh2020-05-22
| | | | | | | | | | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | | Merge pull request #6306 from fatherlinux/masterOpenShift Merge Robot2020-05-22
|\ \ \ | | | | | | | | [CI:DOCS] Docs revamp.
| * | | [CI:DOCS] Docs revamp.Scott McCarty2020-05-21
| |/ / | | | | | | | | | | | | | | | | | | | | | | | | * Rewrote the Home and Introduction pages. * Created a dedicated Search page * Rewrote the Tutorials page to have native links in RTD/Shpinx * Added iframe to Reference page to display API reference docs inline Signed-off-by: Scott McCarty <scott.mccarty@gmail.com>
* | | podman version --format ... was not workingDaniel J Walsh2020-05-21
| | | | | | | | | | | | | | | | | | This patch fixes the podman --version --format command. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | | Display human build date in podman infoDaniel J Walsh2020-05-21
| | | | | | | | | | | | | | | | | | | | | Currently we are displaying the Seconds since EPOCH this will change to displaying date, similar to `podman version` Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | | Merge pull request #6320 from rhatdan/skipOpenShift Merge Robot2020-05-21
|\ \ \ | | | | | | | | Start testing with cross compilation
| * | | Start testing with cross compilationDaniel J Walsh2020-05-21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Add missing man page links for podman-image-search and podman-image-diff Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | | | Merge pull request #6310 from mheon/update_api_tutorialOpenShift Merge Robot2020-05-21
|\ \ \ \ | |/ / / |/| | | Update Derivative API tutorial to reflect the HTTP API
| * | | Update Derivative API tutorial to reflect the HTTP APIMatthew Heon2020-05-20
| |/ / | | | | | | | | | | | | | | | | | | | | | Once the HTTP API becomes stable, I think we want to drive people towards using it, as opposed to directly calling our CLI (when possible). Signed-off-by: Matthew Heon <matthew.heon@pm.me>
* | | Merge pull request #6270 from mheon/detached_execOpenShift Merge Robot2020-05-21
|\ \ \ | |_|/ |/| | Implement detached exec
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-07 23:46:03 +0000