summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAge
* docs: replace '~' with $HOME in markdown as '~' isn't rendered properlyRobert P. J. Day2020-01-28
| | | | | | | | | Apparently, a tilde is currently rendered as a single space, making a mess of command examples that use it, so use $HOME instead. https://github.com/mattermost/mattermost-server/issues/8228 Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* Merge pull request #4999 from rpjday/docs/network_rstOpenShift Merge Robot2020-01-28
|\ | | | | docs: fix incomplete heading underlining in network.rst
| * docs: fix incomplete heading underlining in network.rstRobert P. J. Day2020-01-28
| | | | | | | | | | | | Lack of proper underlining generates processing diagnostic. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* | Merge pull request #4995 from rpjday/docs/podman_stopOpenShift Merge Robot2020-01-28
|\ \ | | | | | | docs: add missing hyphen for '-t' option, command '$' prompts
| * | docs: add missing hyphen for '-t' option, command '$' promptsRobert P. J. Day2020-01-28
| |/ | | | | | | Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* | Merge pull request #4974 from rhatdan/manOpenShift Merge Robot2020-01-28
|\ \ | |/ |/| Cleanup man pages exit code descriptions
| * Cleanup man pages exit code descriptionsDaniel J Walsh2020-01-26
| | | | | | | | | | | | | | The conversion of markdown to man pages is causing "_" to cover entire lines. This PR cleans this up and fixes some of the english. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | Merge pull request #4982 from rpjday/rpjday/exists_sudoOpenShift Merge Robot2020-01-27
|\ \ | | | | | | docs: remove reference to "sudo" in "podman exists" examples
| * | docs: remove reference to "sudo" in "podman exists" examplesRobert P. J. Day2020-01-26
| | | | | | | | | | | | | | | | | | | | | In both of "podman {container,image} exists" man pages, there are superfluous uses of "sudo" in examples -- get rid of them. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* | | docs: add boolean values and defaults to "man podman-history" optionsRobert P. J. Day2020-01-26
| | | | | | | | | | | | Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* | | Merge pull request #4979 from rpjday/rpjday/system_pruneOpenShift Merge Robot2020-01-26
|\ \ \ | | | | | | | | docs: fix system-prune markdown; reword for clarity
| * | | docs: fix system-prune markdown; reword for clarityRobert P. J. Day2020-01-26
| |/ / | | | | | | | | | | | | | | | | | | In addition to tweaking markdown, reword the explanation of the "--volumes" option for clarity. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* / / docs: clean up "man podman-rm", "man podman-rmi"Robert P. J. Day2020-01-26
|/ / | | | | | | | | | | | | Standardize markdown for options and commands, and add leading dollar signs to emphasize commands being run. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* | Merge pull request #4933 from rpjday/docs/markdown/inspectOpenShift Merge Robot2020-01-26
|\ \ | |/ |/| markdown: reword 'podman-inspect' to properly explain '--size'
| * markdown: reword 'podman-inspect' to properly explain '--size'Robert P. J. Day2020-01-22
| | | | | | | | | | | | | | Reword the man page to clarify that the '--size' option displays the container size in addition to the normal output. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* | Merge pull request #4926 from TomSweeneyRedHat/dev/tsweeney/fixsystemdfOpenShift Merge Robot2020-01-25
|\ \ | | | | | | Fix example format in system df man
| * | Fix example format in system df manTomSweeneyRedHat2020-01-22
| | | | | | | | | | | | | | | | | | | | | Fix the formatting of the examples in the podman system df man page. Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* | | seccomp policy: expect profile in config labelValentin Rothberg2020-01-23
|/ / | | | | | | | | | | | | | | Move the seccomp profile from a manifest annotation to a config label. This way, we can support it for Docker images as well and provide an easy way to add that data via Dockerfiles. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* | Merge pull request #4929 from rpjday/docs/migrateOpenShift Merge Robot2020-01-22
|\ \ | | | | | | markdown: remove erroneous spaces after '**'
| * | markdown: fix formatting/content typos in migrate man pageRobert P. J. Day2020-01-22
| |/ | | | | | | | | | | | | 1) remove erroneous spaces after leading '**' 2) remove duplicate SYNOPSIS section Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* | Merge pull request #4934 from rpjday/docs/markdown/execOpenShift Merge Robot2020-01-22
|\ \ | | | | | | markdown: fix formatting of commands at bottom of podman-exec
| * | markdown: fix formatting of commands at bottom of podman-execRobert P. J. Day2020-01-22
| | | | | | | | | | | | | | | | | | Current (lack of) formatting crunches first two lines together. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* | | Merge pull request #4861 from giuseppe/add-cgroups-disabled-conmonOpenShift Merge Robot2020-01-22
|\ \ \ | |/ / |/| | oci_conmon: do not create a cgroup under systemd
| * | podman: add new option --cgroups=no-conmonGiuseppe Scrivano2020-01-16
| | | | | | | | | | | | | | | | | | | | | | | | it allows to disable cgroups creation only for the conmon process. A new cgroup is created for the container payload. Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
* | | markdown: remove extraneous backquote from "podman rmi"Robert P. J. Day2020-01-22
| |/ |/| | | | | | | | | Extraneous backquote messes up rendering of "man podman-rmi". Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
* | Add service endpointbaude2020-01-21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | add service endpoint for the new API. Also supports the varlink implementation. Signed-off-by: baude <bbaude@redhat.com> Refactor to allow developer more control of API server * Add api.NewServerWithSettings() to create an API server with custom settings * Add api.ListenUnix() to create a UDS net.Listener and setup UDS Signed-off-by: Jhon Honce <jhonce@redhat.com> Signed-off-by: baude <bbaude@redhat.com> More service completion Add podman service command that allows users to run either a RESTful or varlink protocol API service. Addition of docs and RESTful listening. Signed-off-by: baude <bbaude@redhat.com> Signed-off-by: Brent Baude <bbaude@redhat.com>
* | [CI:DOCS] Add logo and dev statementBrent Baude2020-01-20
| | | | | | | | | | | | Add statement to the info section stating this is experimental only for now. Also add the podman logo to the right-hand navigation. Signed-off-by: Brent Baude <bbaude@redhat.com>
* | [CI:DOCS]static files end up in _static on rtdbaude2020-01-17
| | | | | | | | Signed-off-by: baude <bbaude@redhat.com>
* | [CI:DOCS] Correct link syntaxbaude2020-01-17
| | | | | | | | Signed-off-by: baude <bbaude@redhat.com>
* | [CI:DOCS]Connect API docs and RTDbaude2020-01-17
| | | | | | | | Signed-off-by: baude <bbaude@redhat.com>
* | Update `tag` documentation regarding 'alias' usageSascha Grunert2020-01-17
|/ | | | | | | | The word `alias` is not very common when speaking about image names and tags. So we just refer to image name as the overall identifier of an image. Signed-off-by: Sascha Grunert <sgrunert@suse.com>
* Remove c.String(net)Daniel J Walsh2020-01-16
| | | | | | | We have a lot of cludgy code trying to make --net and --network equivalent. This will allow --net to still exists but will eliminate the help and confusion. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* Merge pull request #4807 from ssbarnea/fix/pre-commitOpenShift Merge Robot2020-01-15
|\ | | | | Enable pre-commit linting
| * 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>
* | Merge pull request #4806 from vrothberg/seccompOpenShift Merge Robot2020-01-15
|\ \ | | | | | | policy for seccomp-profile selection
| * | policy for seccomp-profile selectionValentin Rothberg2020-01-09
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Implement a policy for selecting a seccomp profile. In addition to the default behaviour (default profile unless --security-opt seccomp is set) add a second policy doing a lookup in the image annotation. If the image has the "io.containers.seccomp.profile" set its value will be interpreted as a seccomp profile. The policy can be selected via the new --seccomp-policy CLI flag. Once the containers.conf support is merged into libpod, we can add an option there as well. Note that this feature is marked as experimental and may change in the future. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* | | make lint: include docs/Valentin Rothberg2020-01-14
| |/ |/| | | | | Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* | Merge pull request #4845 from baude/pruneforceOpenShift Merge Robot2020-01-13
|\ \ | | | | | | clarify cont
| * | clarify container prune --forcebaude2020-01-13
| | | | | | | | | | | | | | | | | | | | | | | | the --force parameter should only be used for the CLI and should only dictate whether to prompt the user for confirmation. Fixes: #4844 Signed-off-by: baude <bbaude@redhat.com>
* | | Merge pull request #4817 from rhatdan/codespellOpenShift Merge Robot2020-01-13
|\ \ \ | | | | | | | | Add codespell to validate spelling mistakes in code.
| * | | Add codespell to validate spelling mistakes in code.Daniel J Walsh2020-01-11
| |/ / | | | | | | | | | | | | | | | Fix all errors found by codespell Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | | Merge pull request #4694 from openSUSE/history-names-in-inspectOpenShift Merge Robot2020-01-13
|\ \ \ | | | | | | | | Add history names to image inspect data
| * | | Add history names to image inspect dataSascha Grunert2019-12-13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | During writing the tests I found it would be probably useful to have the tag history part of the inspect data. Signed-off-by: Sascha Grunert <sgrunert@suse.com>
* | | | Merge pull request #4841 from markstos/issue-4840-improve-privileged-docsOpenShift Merge Robot2020-01-13
|\ \ \ \ | | | | | | | | | | docs: --privileged docs completeness, consistency
| * | | | docs: --privileged docs completeness, consistencyMark Stosberg2020-01-12
| | |/ / | |/| | | | | | | | | | | | | | | | | | As discussed in https://github.com/containers/libpod/issues/4840 Signed-off-by: Mark Stosberg <mark@rideamigos.com>
* | | | Merge pull request #4823 from vrothberg/gen-systemdOpenShift Merge Robot2020-01-12
|\ \ \ \ | |/ / / |/| | | podman-generate-systemd --new
| * | | podman-generate-systemd --newValentin Rothberg2020-01-09
| | |/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add a --new flag to podman-generate-systemd to create a new container via podman-run instead of starting an existing container. Creating a new container presents the challenge to find a reverse mapping from a container to the CLI flags it can be created with. We are doing this via `(Container).Config.CreateCommand` field, which includes a copy of the process' command from procFS at creating time. This field may not be useful when the container was not created via the Podman CLI (e.g., via a Python script). Hence, we do not guarantee the correctness of the generated files. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* / | log: support --log-opt tag=Giuseppe Scrivano2020-01-10
|/ / | | | | | | | | | | | | | | | | | | support a custom tag to add to each log for the container. It is currently supported only by the journald backend. Closes: https://github.com/containers/libpod/issues/3653 Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
* | Add `untag` sub-commandSascha Grunert2020-01-08
| | | | | | | | | | | | | | | | Podman now supports untagging images via the `untag` sub-command for the root and `image` commands. Testing and documentation has been added as well. Signed-off-by: Sascha Grunert <sgrunert@suse.com>
* | Merge pull request #4781 from haircommander/seccomp-profile-rootOpenShift Merge Robot2020-01-07
|\ \ | | | | | | play kube: make seccomp handling better conform to k8s