397 Commits

Author SHA1 Message Date
0bc96b4829 markdown: fix erroneous asterisk markup for options
Fix option markup in a number of man pages so it renders
properly when viewing online.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
2020-01-30 06:44:33 -05:00
d8f2333b29 Merge pull request #4984 from baude/pullarchoverride
expose --arch-override option for pull
2020-01-28 11:39:56 -08:00
8c825cdaae docs: replace '~' with $HOME in markdown as '~' isn't rendered properly
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>
2020-01-28 12:56:55 -05:00
d07c263106 Merge pull request #4999 from rpjday/docs/network_rst
docs: fix incomplete heading underlining in network.rst
2020-01-28 05:08:37 -08:00
3b574dde6c Merge pull request #4995 from rpjday/docs/podman_stop
docs: add missing hyphen for '-t' option, command '$' prompts
2020-01-28 04:44:15 -08:00
2460bacbf9 docs: fix incomplete heading underlining in network.rst
Lack of proper underlining generates processing diagnostic.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
2020-01-28 06:44:07 -05:00
9d30e9f2b6 Merge pull request #4974 from rhatdan/man
Cleanup man pages exit code descriptions
2020-01-28 03:28:18 -08:00
c38e22de23 docs: add missing hyphen for '-t' option, command '$' prompts
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
2020-01-28 05:31:52 -05:00
d42b064c8c expose --arch-override option for pull
We no longer wish to hide the --arch-override from the cli on pulls. we now expose it.  docs updated.  tests already exist.

Fixes: #4849

Signed-off-by: Brent Baude <bbaude@redhat.com>
2020-01-27 10:06:39 -06:00
7794fafdad Merge pull request #4982 from rpjday/rpjday/exists_sudo
docs: remove reference to "sudo" in "podman exists" examples
2020-01-27 04:49:58 -08:00
4aeb25d5f2 docs: add boolean values and defaults to "man podman-history" options
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
2020-01-26 14:13:54 -05:00
c28af15932 Merge pull request #4979 from rpjday/rpjday/system_prune
docs: fix system-prune markdown; reword for clarity
2020-01-26 10:18:27 -08:00
bb66d78b2f docs: remove reference to "sudo" in "podman exists" examples
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>
2020-01-26 12:43:26 -05:00
5871446e8d docs: fix system-prune markdown; reword for clarity
In addition to tweaking markdown, reword the explanation of
the "--volumes" option for clarity.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
2020-01-26 07:46:21 -05:00
3ff2ea329b docs: clean up "man podman-rm", "man podman-rmi"
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>
2020-01-26 07:16:16 -05:00
d7e99b04b9 Merge pull request #4933 from rpjday/docs/markdown/inspect
markdown: reword 'podman-inspect' to properly explain '--size'
2020-01-26 03:00:31 -08:00
2e34d06d0f docs: mention that "podman version" prints out Remote API Version
Since "man podman-version" seems to want to list everything printed
about the current version, add a reference to Remote API Version
for completeness.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
2020-01-26 05:40:41 -05:00
2557cdb4b2 Cleanup man pages exit code descriptions
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>
2020-01-26 08:53:52 +01:00
c21445d73d Merge pull request #4926 from TomSweeneyRedHat/dev/tsweeney/fixsystemdf
Fix example format in system df man
2020-01-25 23:35:33 -08:00
103b5e7807 markdown: fix grammar/formatting, standardize on markdown
While fixing grammar and list formatting issues, standardize on
markdown as follows:

  - commands are marked by '**'
  - files are marked by backquotes
  - list items are marked with leading '-'

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
2020-01-23 06:59:21 -05:00
1531509542 seccomp policy: expect profile in config label
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>
2020-01-23 10:06:43 +01:00
71c38e8f2e Fix example format in system df man
Fix the formatting of the examples in the
podman system df man page.

Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
2020-01-22 16:59:21 -05:00
94b53a2d4a Merge pull request #4929 from rpjday/docs/migrate
markdown: remove erroneous spaces after '**'
2020-01-22 15:40:46 -05:00
c42383f70a Merge pull request #4934 from rpjday/docs/markdown/exec
markdown: fix formatting of commands at bottom of podman-exec
2020-01-22 13:23:40 -05:00
9f146b1b54 Merge pull request #4861 from giuseppe/add-cgroups-disabled-conmon
oci_conmon: do not create a cgroup under systemd
2020-01-22 17:00:48 +01:00
1e82702ff5 markdown: fix formatting of commands at bottom of podman-exec
Current (lack of) formatting crunches first two lines together.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
2020-01-22 10:57:16 -05:00
a78658a11a markdown: reword 'podman-inspect' to properly explain '--size'
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>
2020-01-22 10:02:06 -05:00
fafa67e7b5 markdown: remove extraneous backquote from "podman rmi"
Extraneous backquote messes up rendering of "man podman-rmi".

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
2020-01-22 07:50:48 -05:00
fcf916a620 markdown: fix formatting/content typos in migrate man page
1) remove erroneous spaces after leading '**'
 2) remove duplicate SYNOPSIS section

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
2020-01-22 06:16:12 -05:00
d4c2aaf38a Add service endpoint
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>
2020-01-21 16:35:45 -06:00
f432999023 [CI:DOCS] Add logo and dev statement
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>
2020-01-20 13:59:55 -06:00
47f9a63574 [CI:DOCS]static files end up in _static on rtd
Signed-off-by: baude <bbaude@redhat.com>
2020-01-17 16:13:30 -06:00
9ea2024c55 [CI:DOCS] Correct link syntax
Signed-off-by: baude <bbaude@redhat.com>
2020-01-17 15:50:36 -06:00
cc0f7defdc [CI:DOCS]Connect API docs and RTD
Signed-off-by: baude <bbaude@redhat.com>
2020-01-17 15:12:35 -06:00
38ba9e6922 Update tag documentation regarding 'alias' usage
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>
2020-01-17 08:51:36 +01:00
ba0a6f34e3 podman: add new option --cgroups=no-conmon
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>
2020-01-16 18:56:51 +01:00
45e9a6b12e Remove c.String(net)
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>
2020-01-16 09:23:32 -05:00
e1e405b70d Merge pull request #4807 from ssbarnea/fix/pre-commit
Enable pre-commit linting
2020-01-15 23:51:22 +01:00
0aa9dba3e1 Merge pull request #4806 from vrothberg/seccomp
policy for seccomp-profile selection
2020-01-15 01:16:07 +01:00
e9cd3319cf Enable pre-commit tool linting
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>
2020-01-14 13:42:59 +00:00
6c3d383b50 Merge pull request #4845 from baude/pruneforce
clarify cont
2020-01-13 21:45:13 +01:00
e83a1b87da Merge pull request #4817 from rhatdan/codespell
Add codespell to validate spelling mistakes in code.
2020-01-13 17:59:58 +01:00
649331cb18 clarify container prune --force
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>
2020-01-13 08:56:43 -06:00
9e2e4d7615 Merge pull request #4694 from openSUSE/history-names-in-inspect
Add history names to image inspect data
2020-01-13 08:52:13 +01:00
aa554d7ba2 Merge pull request #4841 from markstos/issue-4840-improve-privileged-docs
docs: --privileged docs completeness, consistency
2020-01-13 08:27:15 +01:00
9c8e2822cb docs: --privileged docs completeness, consistency
As discussed in https://github.com/containers/libpod/issues/4840

Signed-off-by: Mark Stosberg <mark@rideamigos.com>
2020-01-12 23:28:12 -05:00
55dd73cf58 Merge pull request #4823 from vrothberg/gen-systemd
podman-generate-systemd --new
2020-01-12 23:13:45 +01:00
4093b2c011 Add codespell to validate spelling mistakes in code.
Fix all errors found by codespell

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2020-01-11 06:32:19 -05:00
71341a1948 log: support --log-opt tag=
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>
2020-01-10 10:35:19 +01:00
f3f4c54f2a policy for seccomp-profile selection
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>
2020-01-09 17:57:58 +01:00