summaryrefslogtreecommitdiff
path: root/docs/source/Commands.rst
Commit message (Collapse)AuthorAge
* Fix up build the docs siteDaniel J Walsh2021-09-16
| | | | | | [NO TESTS NEEDED] Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* Use secrets and machine rst file properlyDaniel J Walsh2021-06-01
| | | | | | | | | This change makes secrets and machine handling match the handling of other subcommands of Podman. Possible fixes: https://github.com/containers/podman/issues/10513 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* Podman machine CLI and interface stubAshley Cui2021-03-25
| | | | | | | | | | Podman machine will be a mac-only command that manages the VM where containers are run. Currently, only the CLI is written and the interface function for the VM management is stub for future developement The podman machine cli is only built on mac builds. Signed-off-by: Ashley Cui <acui@redhat.com>
* Implement SecretsAshley Cui2021-02-09
| | | | | | | | | | | Implement podman secret create, inspect, ls, rm Implement podman run/create --secret Secrets are blobs of data that are sensitive. Currently, the only secret driver supported is filedriver, which means creating a secret stores it in base64 unencrypted in a file. After creating a secret, a user can use the --secret flag to expose the secret inside the container at /run/secrets/[secretname] This secret will not be commited to an image on a podman commit Signed-off-by: Ashley Cui <acui@redhat.com>
* Initial implementation of renaming containersMatthew Heon2021-01-14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Basic theory: We remove the container, but *only from the DB*. We leave it in c/storage, we leave the lock allocated, we leave it running (if it is). Then we create an identical container with an altered name, and add that back to the database. Theoretically we now have a renamed container. The advantage of this approach is that it doesn't just apply to rename - we can use this to make *any* configuration change to a container that does not alter its container ID. Potential problems are numerous. This process is *THOROUGHLY* non-atomic at present - if you `kill -9` Podman mid-rename things will be in a bad place, for example. Also, we can't rename containers that can't be removed normally - IE, containers with dependencies (pod infra containers, for example). The largest potential improvement will be to move the majority of the work into the DB, with a `RecreateContainer()` method - that will add atomicity, and let us remove the container without worrying about depencies and similar issues. Potential problems: long-running processes that edit the DB and may have an older version of the configuration around. Most notable example is `podman run --rm` - the removal command needed to be manually edited to avoid this one. This begins to get at the heart of me not wanting to do this in the first place... This provides CLI and API implementations for frontend, but no tunnel implementation. It will be added in a future release (just held back for time now - we need this in 3.0 and are running low on time). This is honestly kind of horrifying, but I think it will work. Signed-off-by: Matthew Heon <mheon@redhat.com>
* [CI:DOCS] Touch up Podman description in man page menuTomSweeneyRedHat2020-11-13
| | | | | | | The title for the Podman man page on the commands menu was a little light, adding a few more words to it. Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* Add podman(1) to the list of man pages on docs.podman.ioTomSweeneyRedHat2020-11-10
| | | | | | | | As the title says. Addresses: #7219 Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* Cross-reference *.rst files tooEd Santiago2020-08-11
| | | | | | | | | | | | | | | | | | | There are a bunch of *.rst files in docs/source, linking sometimes to man pages and sometimes to other .rst files. These files each have entries of the following form: :doc:`foo <link-to-foo>` Description of foo ...for all podman sub and sub-subcommands 'foo'. Read all .rst files and make sure that: - all entries in a given file are in alphabetical order - all link-to-foo targets point to existing doc files - every subcommand known by 'podman help' has a corresponding doc entry in a .rst file Signed-off-by: Ed Santiago <santiago@redhat.com>
* Add missing pages for docs.podman.ioDaniel J Walsh2020-08-10
| | | | | | | | Lots of references to man pages missing from docs.podman.io Also fix sort order in man pages and other documents. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* 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>
* [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>
* Enable pre-commit tool lintingSorin Sbarnea2020-01-14
| | | | | | | | | | | | | | This should help use keep the codebase more consistent, and avoid sevel whitespace related issues, or bad file permissions. pre-commit allows us to easily introduce other linters in follow-ups, like bashate. Note: pre-commit tool does *not* install any git-hooks. Making commits will will call the tool unless you deliverately tell it to install the hooks. Signed-off-by: Sorin Sbarnea <ssbarnea@redhat.com>
* Update document formatting and packaging codeJhon Honce2019-10-31
| | | | | | | | | * Refactored code and Makefile to support new docs layout * Removed some old code packaging code * Add Readme.md to document what we're doing Signed-off-by: Jhon Honce <jhonce@redhat.com> Signed-off-by: baude <bbaude@redhat.com>
* Restructure documentation dirbaude2019-10-31
Restructuring the docs dir to make integration with sphinx easier. man pages now exist in docs/source/man and the sphinx make files exists in docs. Signed-off-by: baude <bbaude@redhat.com>