Commit Graph

163 Commits (main)

Author SHA1 Message Date
Erik Sjölund 885dd2addf [CI:DOCS] performance: fix URL and kernel version requirement
Fix broken URL.

Fix kernel version requirement for native overlay rootless support.
Reference: https://www.redhat.com/sysadmin/podman-rootless-overlay

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2024-03-09 16:29:43 +01:00
Jesse Borden 364813da65
Add note for RHEL 8.5
Add note for RHEL 8.5

Signed-off-by: Jesse Borden <40326854+jesseborden@users.noreply.github.com>
2024-03-08 07:02:24 -05:00
Hadir Garcia e8bf9a323a Update podman-for-windows.md
Signed-off-by: Hadir Garcia <22103698+hadirgax@users.noreply.github.com>
2024-03-04 16:12:30 +00:00
Oleksandr Redko 560455cbd6 docs: fix typos
Signed-off-by: Oleksandr Redko <Oleksandr_Redko@epam.com>
2024-01-04 12:10:11 +02:00
Brent Baude 9a963221b5 [CI:DOCS]use nginx in podman tutorial
the podman tutorial refers to an old httpd image based on Fedora 29.  It
is x86_64 only so Apple Silicon Macs and RPI's cannot follow the
tutorial.  Switch to nginx

Fixes: #20916

[NO NEW TESTS NEEDED]

Signed-off-by: Brent Baude <bbaude@redhat.com>
2023-12-07 07:54:28 -06:00
Erik Sjölund 13e548820e [CI:DOCS] performance: document sometimes slow native overlayfs
Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2023-11-28 12:34:08 +01:00
Ed Santiago 8b2667ef69 More rootless-tutorial fixes
Followup to #20722:

- Fix missing "containers" subdirectory
- Indicate what podman uses as defaults for XDG envariables
- whitespace and quoting fixes (I actually ran pandoc this time)

Signed-off-by: Ed Santiago <santiago@redhat.com>
2023-11-20 07:43:12 -07:00
Ed Santiago 9ea390191b rootless_tutorial: modernize
- We can assume that cgroups v2 and rootless overlayfs are the
  default everywhere.

- Remove RHEL7-only instructions

- add clear '$' and '#' prompts to rootless and root commands

- other minor consistency cleanups

Ref: #20669

Signed-off-by: Ed Santiago <santiago@redhat.com>
2023-11-20 06:04:21 -07:00
Paul Holzinger f2bc638944
quadlet: document cgroupv2 requirement
Units created with quadlet need cgroupv2 in order to work.

Fixes #19365

Signed-off-by: Paul Holzinger <pholzing@redhat.com>
2023-10-19 16:39:55 +02:00
Brent Baude 4796802320 [CI:DOCS]Remove use of --latest|-l from tutorial
Remove the use of the "latest" flags because it cannot be used on
windows or mac.

Fixes #17019

[NO NEW TESTS NEEDED]

Signed-off-by: Brent Baude <bbaude@redhat.com>
2023-09-07 17:57:34 -05:00
Sergio Oller 91b8bc7f13 uid/gid mapping flags
Motivation
===========

This feature aims to make --uidmap and --gidmap easier to use, especially in rootless podman setups.

(I will focus here on the --gidmap option, although the same applies for --uidmap.)

In rootless podman, the user namespace mapping happens in two steps, through an intermediate mapping.

See https://docs.podman.io/en/latest/markdown/podman-run.1.html#uidmap-container-uid-from-uid-amount
for further detail, here is a summary:

First the user GID is mapped to 0 (root), and all subordinate GIDs (defined at /etc/subgid, and
usually >100000) are mapped starting at 1.

One way to customize the mapping is through the `--gidmap` option, that maps that intermediate mapping
to the final mapping that will be seen by the container.

As an example, let's say we have as main GID the group 1000, and we also belong to the additional GID 2000,
that we want to make accessible inside the container.

We first ask the sysadmin to subordinate the group to us, by adding "$user:2000:1" to /etc/subgid.

Then we need to use --gidmap to specify that we want to map GID 2000 into some GID inside the container.

And here is the first trouble:

Since the --gidmap option operates on the intermediate mapping, we first need to figure out where has
podman placed our GID 2000 in that intermediate mapping using:

    podman unshare cat /proc/self/gid_map

Then, we may see that GID 2000 was mapped to intermediate GID 5. So our --gidmap option should include:

    --gidmap 20000:5:1

This intermediate mapping may change in the future if further groups are subordinated to us (or we stop
having its subordination), so we are forced to verify the mapping with
`podman unshare cat /proc/self/gid_map` every time, and parse it if we want to script it.

**The first usability improvement** we agreed on #18333 is to be able to use:

    --gidmap 20000:@2000:1

so podman does this lookup in the parent user namespace for us.

But this is only part of the problem. We must specify a **full** gidmap and not only what we want:

    --gidmap 0:0:5 --gidmap 5:6:15000 --gidmap 20000:5:1

This is becoming complicated. We had to break the gidmap at 5, because the intermediate 5 had to
be mapped to another value (20000), and then we had to keep mapping all other subordinate ids... up to
close to the maximum number of subordinate ids that we have (or some reasonable value). This is hard
to explain to someone who does not understand how the mappings work internally.

To simplify this, **the second usability improvement** is to be able to use:

   --gidmap "+20000:@2000:1"

where the plus flag (`+`) states that the given mapping should extend any previous/default mapping,
overriding any previous conflicting assignment.

Podman will set that mapping and fill the rest of mapped gids with all other subordinated gids, leading
to the same (or an equivalent) full gidmap that we were specifying before.

One final usability improvement related to this is the following:

By default, when podman  gets a --gidmap argument but not a --uidmap argument, it copies the mapping.
This is convenient in many scenarios, since usually subordinated uids and gids are assigned in chunks
simultaneously, and the subordinated IDs in /etc/subuid and /etc/subgid for a given user match.

For scenarios with additional subordinated GIDs, this map copying is annoying, since it forces the user
to provide a --uidmap, to prevent the copy from being made. This means, that when the user wants:

    --gidmap 0:0:5 --gidmap 5:6:15000 --gidmap 20000:5:1

The user has to include a uidmap as well:

    --gidmap 0:0:5 --gidmap 5:6:15000 --gidmap 20000:5:1 --uidmap 0:0:65000

making everything even harder to understand without proper context.

For this reason, besides the "+" flag, we introduce the "u" and "g" flags. Those flags applied to a
mapping tell podman that the mapping should only apply to users or groups, and ignored otherwise.

Therefore we can use:

   --gidmap "+g20000:@2000:1"

So the mapping only applies to groups and is ignored for uidmaps. If no "u" nor "g" flag is assigned
podman assumes the mapping applies to both users and groups as before, so we preserve backwards compatibility.

Co-authored-by: Tom Sweeney <tsweeney@redhat.com>
Signed-off-by: Sergio Oller <sergioller@gmail.com>
2023-08-28 20:21:04 +02:00
Will Thompson 68bd81470a
Add missing verb in machinectl example
Without the verb 'shell', the invocation fails with:

    Unknown command verb testuser@

Signed-off-by: Will Thompson <will@willthompson.co.uk>
2023-08-13 11:52:56 +01:00
Erik Sjölund 5ba0559377 [CI:DOCS] socket_activation.md: increase socat timeout
The default socat timeout is 0.5 seconds.
Make the socket-activate-echo example in socket_activation.md
more robust by increasing the socat timeout.

Fixes: https://github.com/containers/podman/issues/19373

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2023-07-26 17:52:33 +02:00
Daniel J Walsh 1f455cf619
Merge pull request #19320 from eriksjolund/remove_unnecessary_please
Remove unnecessary use of the word "please"
2023-07-25 15:20:38 -04:00
Daniel J Walsh 03ea93c21b
Merge pull request #19323 from eriksjolund/fix_language_typos_markdown_layout
Fix language, typos and markdown layout
2023-07-24 10:56:11 -04:00
Erik Sjölund baf30e6120 [CI:DOCS] migrate socket_activation.md to quadlet
Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2023-07-24 15:01:33 +02:00
Erik Sjölund b5ce0ab2de Fix language, typos and markdown layout
[NO NEW TESTS NEEDED]

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2023-07-24 11:18:25 +02:00
Erik Sjölund d4cfc498d7 Remove unnecessary use of the word "please".
Only use the word "please" in these situations:

- reader is asked to do something inconvenient
- reader is asked for permission
- reader is asked for forgiveness

Remove other uses of the word "please" to
make the language more efficient.

[NO NEW TESTS NEEDED]

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2023-07-23 17:31:29 +02:00
Black-Hole1 d15cca0246
[CI:DOCS] fix command incorrect in windows
Signed-off-by: Black-Hole1 <bh@bugs.cc>
2023-06-28 09:23:51 +08:00
Erik Sjölund 685c736185 source code comments and docs: fix typos, language, Markdown layout
- fix a/an before noun
- fix loose -> lose
- fix "the the"
- fix lets -> let's
- fix Markdown layout
- fix a few typos
- remove unnecessary text in troubleshooting.md

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2023-05-22 07:52:16 +02:00
Paul Holzinger e7a3236358
docs: update network tutorial with netavark DHCP support
Add instructions on how to start the netavark dhcp proxy. Also list
version requirements.

Fixes #17635

Signed-off-by: Paul Holzinger <pholzing@redhat.com>
2023-04-14 12:16:26 +02:00
OpenShift Merge Robot f3c5c8fb05
Merge pull request #17994 from stickM4N/patch-1
Update podman-for-windows.md
2023-04-03 10:23:46 -04:00
Julio C. Galindo 5643058c8a
Update podman-for-windows.md
Signed-off-by: Julio C. Galindo <54072664+stickM4N@users.noreply.github.com>
2023-03-30 17:20:12 -04:00
tomsweeneyredhat b7a8e12859 [CI:DOCS] Improve basic tutorial
Finishing up the work started by @biergit in #17021

Updates the tutorial to explain the use of `-l/--latest`
and converts many of the examples to use `<container_id>`
as that works locally and remote while `-l` doesn't always.

Thanks for the start on this @biergit !

[NO NEW TESTS NEEDED]

Signed-off-by: tomsweeneyredhat <tsweeney@redhat.com>
2023-03-28 20:08:47 -04:00
Heniker 6363fb08f2 docs: fix cmd `set DOCKER_HOST` suggestion
Signed-off-by: Heniker <Heniker@mail.ru>
2023-03-13 08:11:45 +03:00
Chris Evich 0d219486f7
[CI:DOCS] Fix docs/version-check always requesting updates
As suggested by @edsantiago, the complex script and direct-link in the
docs are adding little value while increasing the CI maintenance burden.
Simply retire the script and strip the direct (versioned) links from the
docs.

Signed-off-by: Chris Evich <cevich@redhat.com>
2023-03-02 14:18:20 -05:00
Chris Evich 7d17ec07fc
[CI:DOCS] Windows/Mac docs link update
Signed-off-by: Chris Evich <cevich@redhat.com>
2023-02-21 12:04:56 -05:00
OpenShift Merge Robot a9ec6492e8
Merge pull request #17536 from cevich/fix_version_check_cron
[CI:DOCS] Cirrus: Fix version-check to only run on `main` job
2023-02-20 14:45:29 +01:00
lioutall ad866fecb5
Update remote_client.md
ssh user name should be used here

Signed-off-by: lioutall <lioutall@163.com>
2023-02-18 23:54:41 +08:00
Chris Evich 761da776a5
Cirrus: Fix version-check to only run on `main` job
A conditional in `version-check` bypasses the test for PRs.  However,
it appears it was intended to execute during the daily cirrus-cron runs.
However, the cron-job it references (`nightly`) doesn't exist.  This is
causing the test to run for every merge into `main`, and never run for
`main` branch cirrus-cron job.  Fix the name so the test **ONLY**
runs for the `main` branch cron-job.

Also, since the test is currently failing, update the docs as per the
output instructions.

Signed-off-by: Chris Evich <cevich@redhat.com>
2023-02-16 17:33:26 -05:00
Erik Sjölund a5ca732256 Fix typos
Software version used
https://github.com/crate-ci/typos/releases/tag/v1.13.10

The binary was downloaded from
https://github.com/crate-ci/typos/releases/download/v1.13.10/typos-v1.13.10-x86_64-unknown-linux-musl.tar.gz

Command that was run:

typos --write-changes docs cmd cni contrib dependencies docs hack libpod pkg utils

False positives were manually removed.
A few marshaling/existant typos were manually fixed.

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2023-02-11 18:23:24 +01:00
Arthur Sengileyev 74c0909736 Add gvproxy to Windows packages
Updated build scripts and installer build scripts to include gvproxy.exe.
Includes tutorial on setting up a Podman VM with QEMU and gvproxy on Windows.

Signed-off-by: Arthur Sengileyev <arthur.sengileyev@gmail.com>
2023-01-29 22:01:00 +02:00
tomsweeneyredhat 9db657f40c Clean up more language for inclusiveness
We had a number of references, mostly in docs, to the word master that
can now be changed to main.  This PR does that and makes the project a
bit more inclusive.

[NO NEW TESTS NEEDED]

Signed-off-by: tomsweeneyredhat <tsweeney@redhat.com>
2023-01-27 09:40:27 -05:00
Klaus Frank 2b650e37ce
(fix) mount_program is in storage.options.overlay
mount_program is in storage.options.overlay and not storage.options
(see example in storage.conf)

Signed-off-by: Klaus Frank <agowa338@users.noreply.github.com>
2023-01-22 04:13:04 +01:00
Brent Baude f07aa2adde [CI:DOCS] Add CNI deprecation notices to documentation
Where the terms CNI and cni are used in documentation like man pages,
readme's, and tutorials, we have begun to add deprecation notices where
applicable. In cases where netavark cannot do what CNI can, those have
been left alone.

[NO NEW TESTS NEEDED]

Signed-off-by: Brent Baude <bbaude@redhat.com>
2023-01-19 08:09:32 -06:00
Chris Evich bdf1001790
Docs: version-check updates
Signed-off-by: Chris Evich <cevich@redhat.com>
2023-01-16 15:33:05 -05:00
Brent Baude bdc323cbfa [CI:DOCS] Remove experimental mac tutorial
This doc is no longer applicable.

[NO NEW TESTS NEEDED]

Signed-off-by: Brent Baude <bbaude@redhat.com>
2023-01-16 08:26:15 -06:00
Patrick Reader 598b93722d
Fix instructions about setting storage driver on command-line
The OverlayFS storage driver is called `overlay`, not `overlayfs`.

Signed-off-by: Patrick Reader <_@pxeger.com>
2023-01-01 10:56:46 +00:00
Ed Santiago db439dd23e New tool, docs/version-check
Intended to be run from nightly Cirrus cron job.

 1) Queries github for highest-sorting (not necessarily "latest") tag
 2) Checks that the Windows MSI exists, fails if not
 3) Cross-checks markdown files to ensure they have up-to-date links

When run interactively, it will auto-update the .md files
to show and link to the latest version. This makes it easy
for anyone to then submit an update PR.

And, it turns out that MSI is obsolete, the new thing is EXE.
Update the tutorials to reflect that.

Signed-off-by: Ed Santiago <santiago@redhat.com>
2022-11-10 08:54:56 -07:00
Erik Sjölund b5ee4de8cf [CI:DOCS] Add performance tutorial
Reuse part of the description of --network=host from /docs/source/markdown/podman-run.1.md.in

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2022-11-09 18:39:26 +01:00
Johan Van de Wauw 84ed9bd5e3 Fix small typo
Signed-off-by: Johan Van de Wauw <johan@gisky.be>
2022-10-19 07:00:18 +02:00
OpenShift Merge Robot 1e16668ecc
Merge pull request #15173 from carljmosca/main
[CI:DOCS] added docs for installing certificate authority
2022-09-16 16:58:48 +02:00
Daniel J Walsh 2c63b8439b
Fix stutters
Podman adds an Error: to every error message.  So starting an error
message with "error" ends up being reported to the user as

Error: error ...

This patch removes the stutter.

Also ioutil.ReadFile errors report the Path, so wrapping the err message
with the path causes a stutter.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2022-09-10 07:52:00 -04:00
Carl J. Mosca bd0a8c1462 added docs for installing certficate authority
Co-authored-by: Tom Sweeney <tsweeney@redhat.com>
Signed-off-by: Carl J. Mosca <carljmosca@gmail.com>
2022-08-13 09:19:44 -04:00
William Entriken f26a5246e3
Fix updated link to install instructions
Signed-off-by: William Entriken <github.com@phor.net>
2022-08-11 20:34:59 -04:00
unknowndevQwQ f4c53a41cf docs: update the podman logo
for podman/#15222

Signed-off-by: unknowndevQwQ <unknowndevQwQ@pm.me>
2022-08-07 09:11:53 +08:00
OpenShift Merge Robot 0bf6ee61dd
Merge pull request #15087 from eriksjolund/socket_activation.md_clarify_delay
[CI:DOCS] socket_activation.md: Add start/stop sections
2022-07-27 13:10:13 +02:00
Erik Sjölund 7fab449e32 [CI:DOCS] socket_activation.md: Add start/stop sections
* Add section "Starting a socket-activated service".

* Add section "Stopping a socket-activated service".

* Clarify in the diagrams that socket activation
  only happens for the first client connection.

Co-authored-by: Valentin Rothberg <vrothberg@redhat.com>
Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2022-07-27 10:41:10 +02:00
Paul Holzinger cbdda4e56e
docs: remove CNI word where it is not applicable
Most network commands/features work with both netavark and CNI. When
we added added netavark most docs were not vetted and thus still use CNI
network, it should just say network.

Fixes #14990

Signed-off-by: Paul Holzinger <pholzing@redhat.com>
2022-07-22 13:46:28 +02:00
Erik Sjölund c9722c0b16 [CI:DOCS] socket_activation.md: fix typo and layout
Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2022-07-16 06:41:57 +02:00