summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAge
* alphabetize the varlink methods, types, and errors in the docsbaude2018-05-10
| | | | | | | | | | | | We have decided to alphabetize things in the API documentation to help users find things easier. It also solves an issue where when being made, the API.md doc would remake itself in a different order resulting in massive diffs in the pull requests but no new content. Signed-off-by: baude <bbaude@redhat.com> Closes: #739 Approved by: baude
* Generate varlink API documentation automaticallybaude2018-05-08
| | | | | | | | | | Using varlink's idl parser, we generate API documentation for the podman API relying on the .varlink file as the source. Signed-off-by: baude <bbaude@redhat.com> Closes: #734 Approved by: baude
* Begin wiring in USERNS Support into podmanDaniel J Walsh2018-05-04
| | | | | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #690 Approved by: mheon
* Make podman commit to localhost rather then docker.ioDaniel J Walsh2018-05-03
| | | | | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #715 Approved by: mheon
* remove options from create/run that we cannot supportbaude2018-05-02
| | | | | | | Signed-off-by: baude <bbaude@redhat.com> Closes: #711 Approved by: rhatdan
* Add iidfile parame to build and commit man pagesTomSweeneyRedHat2018-04-30
| | | | | | | Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com> Closes: #693 Approved by: mheon
* Make ':' a restricted character for file namesumohnani82018-04-30
| | | | | | | | | | | file names for podman load, save, export, and import cannot contain ":" in them. It is a reserved character for parsing filenames. Signed-off-by: umohnani8 <umohnani@redhat.com> Closes: #694 Approved by: rhatdan
* Add isolation note to build man pageTomSweeneyRedHat2018-04-26
| | | | | | | Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com> Closes: #677 Approved by: rhatdan
* Modify man pages so they compile correctly in mandbDaniel J Walsh2018-04-26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This fixes an issue where if you did man -k podman-run podman-run (1) - (unknown subject) Now you will see man -k podman-run podman-run (1) - Run a command in a new container More importantly man -k containers | grep podman podman (1) - Simple management tool for containers and images podman-kill (1) - Kills one or more containers with a signal podman-pause (1) - Pause one or more containers podman-ps (1) - Prints out information about containers podman-rm (1) - Remove one or more containers podman-start (1) - Start one or more containers podman-stats (1) - Display a live stream of 1 or more containers' resource usage statistics podman-stop (1) - Stop one or more containers podman-unpause (1) - Unpause one or more containers podman-wait (1) - Waits on one or more containers to stop and prints exit code Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #676 Approved by: mheon
* Merge pull request #641 from nathwill/man-libpodDaniel J Walsh2018-04-23
|\ | | | | add libpod.conf man page (closes #537)
| * add libpod.conf man pageNathan Williams2018-04-21
| | | | | | | | Signed-off-by: Nathan Williams <nath.e.will@gmail.com>
* | Initial varlink implementationbaude2018-04-23
|/ | | | | | | Signed-off-by: baude <bbaude@redhat.com> Closes: #627 Approved by: mheon
* Allow podman start to attach to a running containerbaude2018-04-18
| | | | | | | | | | If a container is already running, and a user asks to start it -a (attach), we should honor this and attach to the container. Signed-off-by: baude <bbaude@redhat.com> Closes: #634 Approved by: baude
* regression: tls verify should be set on registries.conf if insecurebaude2018-04-18
| | | | | | | | | | | In the case where podman needs to pull an image, if that registry that the image resides on is known to be insesure (as defined in /etc/containers/registries.conf), tls-verify should be altered on the fly. Signed-off-by: baude <bbaude@redhat.com> Closes: #626 Approved by: mheon
* Modify diff and inspect docsumohnani82018-04-17
| | | | | | | | | | | | Format the examples in podman-diff.md better. The description for --type in the inspect docs was slightly different from that in the inline help. Also stated what values to use in the Go template for the --format flag. Signed-off-by: umohnani8 <umohnani@redhat.com> Closes: #620 Approved by: mheon
* Use buildah commit for podman commitbaude2018-04-10
| | | | | | | | Resolves: #586 and #520 Signed-off-by: baude <bbaude@redhat.com> Closes: #592 Approved by: mheon
* Add conmon-pidfile flag to bash completions/manpagesMatthew Heon2018-04-03
| | | | | | | Signed-off-by: Matthew Heon <matthew.heon@gmail.com> Closes: #584 Approved by: rhatdan
* Add files section to podman man pageDaniel J Walsh2018-03-26
| | | | | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #536 Approved by: TomSweeneyRedHat
* Small manpage rewordMatthew Heon2018-03-23
| | | | | | | Signed-off-by: Matthew Heon <matthew.heon@gmail.com> Closes: #533 Approved by: baude
* Document .containerenv in manpages. Move it to /run.Matthew Heon2018-03-23
| | | | | | | Signed-off-by: Matthew Heon <matthew.heon@gmail.com> Closes: #533 Approved by: baude
* Merge pull request #447 from mheon/sig_proxyDaniel J Walsh2018-03-16
|\ | | | | Add signal proxying to podman run and attach
| * Add signal proxying to podman run, start, and attachMatthew Heon2018-03-15
| | | | | | | | | | | | | | Also removes sig-proxy from 'podman create', where is does not make sense. Signed-off-by: Matthew Heon <matthew.heon@gmail.com>
* | Add restart to main podman manpageMatthew Heon2018-03-16
| | | | | | | | | | | | | | Signed-off-by: Matthew Heon <mheon@redhat.com> Closes: #503 Approved by: rhatdan
* | Make manpage more clearMatthew Heon2018-03-16
| | | | | | | | | | | | | | Signed-off-by: Matthew Heon <matthew.heon@gmail.com> Closes: #503 Approved by: rhatdan
* | Add 'podman restart' commandMatthew Heon2018-03-16
|/ | | | | | | Signed-off-by: Matthew Heon <matthew.heon@gmail.com> Closes: #503 Approved by: rhatdan
* We should not allow a user to mount a container with a different labelDaniel J Walsh2018-03-15
| | | | | | | | | We need to get the label from the container and mount with it. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #502 Approved by: mheon
* Remove references to container restart on create/run commandDaniel J Walsh2018-03-14
| | | | | | | | | | podman does not support autorestart. Should use systemd if you want containers to restart Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #487 Approved by: edsantiago
* Merge pull request #471 from TomSweeneyRedHat/dev/tsweeney/podmanmanMatthew Heon2018-03-12
|\ | | | | Update commands section to a table and add missing commands
| * Update commands section to a table and add missing commandsTomSweeneyRedHat2018-03-10
| | | | | | | | Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* | Remove crio.conf references from manpagesMatthew Heon2018-03-12
|/ | | | | | | | | Also changes a few docker-login references to podman-login. Signed-off-by: Matthew Heon <mheon@redhat.com> Closes: #473 Approved by: rhatdan
* podman import, load, and commit are too verbosebaude2018-03-07
| | | | | | | | | | | | | | | The progress should not be show for import, load, and commit. It makes machine parsing of the output much more difficult. Also, each command should output an image ID or name for the user. Added a --verbose flag for users that still want to see progress. Resolves issue #450 Signed-off-by: baude <bbaude@redhat.com> Closes: #456 Approved by: rhatdan
* Add buildah bud options from common.goTomSweeneyRedHat2018-03-06
| | | | | | | Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com> Closes: #453 Approved by: rhatdan
* docs: podman-top: fix nonworking exampleEd Santiago2018-03-06
| | | | | | | | | | | | | | | | | | (minor) One example in the podman-top man page results in an error when actually invoked: unable to find PID field in ps output. try a different set of ps arguments Cause: commit 6cb1c31d (PR #400) has to check PIDs in order to filter those in the container. Solution: add 'pid' to the list of requested output fields in the sample command. Signed-off-by: Ed Santiago <santiago@redhat.com> Closes: #457 Approved by: rhatdan
* docs/podman-info.1.md update man pagebaude2018-03-01
| | | | | | | | | | update man page with example outputs. tidy up the man page where applicable. Signed-off-by: baude <bbaude@redhat.com> Closes: #429 Approved by: rhatdan
* (minor) correct misspellings in man pagesEd Santiago2018-02-27
| | | | | | | Signed-off-by: Ed Santiago <santiago@redhat.com> Closes: #410 Approved by: baude
* Tagging an image alias by shortnamebaude2018-02-26
| | | | | | | | | | | | | | | | | | When trying to tag an alias (tag) of an image using only the shortname and no tag, we were unable to find the image in storage. This corrects that issue and adds an integration test to protect against regression. I also updated the man page per the filed issue. While writing the integration test, I discovered that inspect could also not find a tagged image without its :tag. Resolves Issue #385 Resolves Issue #384 Signed-off-by: baude <bbaude@redhat.com> Closes: #398 Approved by: mheon
* Implement --image-volumes for create and runumohnani82018-02-22
| | | | | | | | | | | | | | --image-volumes tells podman what to do with the image volumes in the image config There are 3 options: bind, tmpfs, and ignore bind puts the volume contents in /var/lib/containers/storage/container-id/volumes/vol-dir and bind mounts it into the container at /vol-dir tmpfs mounts /vol-dir as a tmps into the container ignore doesn't mount the image volumes onto the container Signed-off-by: umohnani8 <umohnani@redhat.com> Closes: #377 Approved by: rhatdan
* Inspect output should be in array formbaude2018-02-21
| | | | | | | | | | | | | | | | | | | | | | | | Inspect should be able to inspect one or more containers depending on the user input. Therefore, inspect output should be in array format so the consumer could potentially iterate it. This PR allows users to specify one more or containers|images|or a mix for inspection. The output, as stated, is therefore in array form. This holds true even for a singular image. In the case that the user enters an invalid container|image "name", we handle that gracefully. Podman will output json for the valid names until it reaches the invalid one. For example: In this case, podman will out the json for alpine and then print an error about 123 being invalid. It will not continute onto busybox. This behavior imatates docker. This addresses issue #360 Signed-off-by: baude <bbaude@redhat.com> Closes: #371 Approved by: baude
* Add --time alias to manpagesMatthew Heon2018-02-21
| | | | | | | Signed-off-by: Matthew Heon <matthew.heon@gmail.com> Closes: #375 Approved by: rhatdan
* language: correct 'vice versa' in docsEd Santiago2018-02-19
| | | | Signed-off-by: Ed Santiago <santiago@redhat.com>
* Touch up tutorial location and install reqsTomSweeneyRedHat2018-02-15
| | | | | | | Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com> Closes: #337 Approved by: rhatdan
* Return imageid from podman pullbaude2018-02-15
| | | | | | | | | | | | When using podman to pull an image, print the image id after the image is pulled. Resolves issue #329 Signed-off-by: baude <bbaude@redhat.com> Closes: #342 Approved by: rhatdan
* Change json to match docker inspectDaniel J Walsh2018-02-11
| | | | | | | | | | Changing these fields caused the output of podman inspect to more closely match docker inspect. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #306 Approved by: mheon
* podman logs: fix tailingbaude2018-02-09
| | | | | | | | | | | Fix issues with tailing of container logs as described in issue #16. Also add in the ability to use a duration or known time stamp formats for the --since flag. Signed-off-by: baude <bbaude@redhat.com> Closes: #317 Approved by: mheon
* docs/tutorials/podman_tutorial.mdbaude2018-02-07
| | | | | | | Update now that more of the podman commands are working correctly, esp top and friends. Signed-off-by: baude <bbaude@redhat.com>
* Merge pull request #289 from TomSweeneyRedHat/dev/tsweeney/usernameDaniel J Walsh2018-02-07
|\ | | | | Change un/pwd handling to match Buildah's
| * Change un/pwd handling to match Buildah'sTomSweeneyRedHat2018-02-06
| | | | | | | | Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* | Merge pull request #303 from umohnani8/certsDaniel J Walsh2018-02-07
|\ \ | | | | | | Change default certs dir to /etc/containers/certs.d
| * | Change default certs dir to /etc/containers/certs.dumohnani82018-02-06
| | | | | | | | | | | | | | | | | | Updated man pages to reflect the change Signed-off-by: umohnani8 <umohnani@redhat.com>
* | | Change sudo examples to use $ instead of $Daniel J Walsh2018-02-07
|/ / | | | | | | | | | | | | sudo is not required when running as root, and # indicates that you are already root. $ indicates you are not root. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-15 18:20:19 +0000