mirror of
https://github.com/containers/podman.git
synced 2025-05-17 06:59:07 +08:00
Update links and markup in man pages
- Fix links to other man-pages in podman-build.1.md.in - Fix markup and add link to oci-hooks manpage in podman.1.md Signed-off-by: Paul Lettich <paul.lettich@netknights.it>
This commit is contained in:
Paul Lettich
@ -699,15 +699,15 @@ mechanism:
|
||||
Exclude all doc files except Help.doc from the image.
|
||||
|
||||
This functionality is compatible with the handling of .containerignore files
|
||||
described here:
|
||||
described here: **[containerignore(5)](https://github.com/containers/common/blob/main/docs/containerignore.5.md)**
|
||||
|
||||
https://github.com/containers/common/blob/main/docs/containerignore.5.md
|
||||
|
||||
**registries.conf** (`/etc/containers/registries.conf`)
|
||||
### registries.conf (`/etc/containers/registries.conf`)
|
||||
|
||||
registries.conf is the configuration file which specifies which container
|
||||
registries is consulted when completing image names which do not include
|
||||
a registry or domain portion.
|
||||
See **[containers-registries.conf(5)](https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md)**
|
||||
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
||||
@ -213,12 +213,12 @@ URL value resolution precedence:
|
||||
Remote connections use local containers.conf for default.
|
||||
|
||||
Some example URL values in valid formats:
|
||||
- unix:///run/podman/podman.sock
|
||||
- unix:///run/user/$UID/podman/podman.sock
|
||||
- ssh://notroot@localhost:22/run/user/$UID/podman/podman.sock
|
||||
- ssh://root@localhost:22/run/podman/podman.sock
|
||||
- tcp://localhost:34451
|
||||
- tcp://127.0.0.1:34451
|
||||
- `unix:///run/podman/podman.sock`
|
||||
- `unix:///run/user/$UID/podman/podman.sock`
|
||||
- `ssh://notroot@localhost:22/run/user/$UID/podman/podman.sock`
|
||||
- `ssh://root@localhost:22/run/podman/podman.sock`
|
||||
- `tcp://localhost:34451`
|
||||
- `tcp://127.0.0.1:34451`
|
||||
|
||||
#### **--version**, **-v**
|
||||
|
||||
@ -435,7 +435,7 @@ When Podman runs in rootless mode, the file `$HOME/.config/containers/storage.co
|
||||
If the **CONTAINERS_STORAGE_CONF** environment variable is set, then its value is used for the storage.conf file rather than the default.
|
||||
|
||||
## Rootless mode
|
||||
Podman can also be used as non-root user. When podman runs in rootless mode, a user namespace is automatically created for the user, defined in /etc/subuid and /etc/subgid.
|
||||
Podman can also be used as non-root user. When podman runs in rootless mode, a user namespace is automatically created for the user, defined in `/etc/subuid` and `/etc/subgid`.
|
||||
|
||||
Containers created by a non-root user are not visible to other users and are not seen or managed by Podman running as root.
|
||||
|
||||
@ -455,7 +455,7 @@ See the `subuid(5)` and `subgid(5)` man pages for more information.
|
||||
|
||||
|
||||
|
||||
Note: whitespace in any row of /etc/subuid or /etc/subgid, including trailing blanks, may result in no entry failures.
|
||||
Note: whitespace in any row of `/etc/subuid` or `/etc/subgid`, including trailing blanks, may result in no entry failures.
|
||||
|
||||
Images are pulled under `XDG_DATA_HOME` when specified, otherwise in the home directory of the user under `.local/share/containers/storage`.
|
||||
|
||||
@ -463,16 +463,16 @@ Currently slirp4netns or pasta is required to be installed to create a network
|
||||
device, otherwise rootless containers need to run in the network namespace of
|
||||
the host.
|
||||
|
||||
In certain environments like HPC (High Performance Computing), users cannot take advantage of the additional UIDs and GIDs from the /etc/subuid and /etc/subgid systems. However, in this environment, rootless Podman can operate with a single UID. To make this work, set the `ignore_chown_errors` option in the `containers-storage.conf(5)` file. This option tells Podman when pulling an image to ignore chown errors when attempting to change a file in a container image to match the non-root UID in the image. This means all files get saved as the user's UID. Note this can cause issues when running the container.
|
||||
In certain environments like HPC (High Performance Computing), users cannot take advantage of the additional UIDs and GIDs from the `/etc/subuid` and `/etc/subgid` systems. However, in this environment, rootless Podman can operate with a single UID. To make this work, set the `ignore_chown_errors` option in the `containers-storage.conf(5)` file. This option tells Podman when pulling an image to ignore chown errors when attempting to change a file in a container image to match the non-root UID in the image. This means all files get saved as the user's UID. Note this can cause issues when running the container.
|
||||
|
||||
### **NOTE:** Unsupported file systems in rootless mode
|
||||
|
||||
The Overlay file system (OverlayFS) is not supported with kernels prior to 5.12.9 in rootless mode. The fuse-overlayfs package is a tool that provides the functionality of OverlayFS in user namespace that allows mounting file systems in rootless environments. It is recommended to install the fuse-overlayfs package. In rootless mode, Podman automatically uses the fuse-overlayfs program as the mount_program if installed, as long as the $HOME/.config/containers/storage.conf file was not previously created. If storage.conf exists in the homedir, add `mount_program = "/usr/bin/fuse-overlayfs"` under `[storage.options.overlay]` to enable this feature.
|
||||
The Overlay file system (OverlayFS) is not supported with kernels prior to 5.12.9 in rootless mode. The fuse-overlayfs package is a tool that provides the functionality of OverlayFS in user namespace that allows mounting file systems in rootless environments. It is recommended to install the fuse-overlayfs package. In rootless mode, Podman automatically uses the fuse-overlayfs program as the mount_program if installed, as long as the `$HOME/.config/containers/storage.conf` file was not previously created. If storage.conf exists in the homedir, add `mount_program = "/usr/bin/fuse-overlayfs"` under `[storage.options.overlay]` to enable this feature.
|
||||
|
||||
The Network File System (NFS) and other distributed file systems (for example: Lustre, Spectrum Scale, the General Parallel File System (GPFS)) are not supported when running in rootless mode as these file systems do not understand user namespace. However, rootless Podman can make use of an NFS Homedir by modifying the `$HOME/.config/containers/storage.conf` to have the `graphroot` option point to a directory stored on local (Non NFS) storage.
|
||||
|
||||
## SEE ALSO
|
||||
**[containers-mounts.conf(5)](https://github.com/containers/common/blob/main/docs/containers-mounts.conf.5.md)**, **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)**, **[containers-registries.conf(5)](https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md)**, **[containers-storage.conf(5)](https://github.com/containers/storage/blob/main/docs/containers-storage.conf.5.md)**, **[buildah(1)](https://github.com/containers/buildah/blob/main/docs/buildah.1.md)**, **oci-hooks(5)**, **[containers-policy.json(5)](https://github.com/containers/image/blob/main/docs/containers-policy.json.5.md)**, **[crun(1)](https://github.com/containers/crun/blob/main/crun.1.md)**, **[runc(8)](https://github.com/opencontainers/runc/blob/main/man/runc.8.md)**, **[subuid(5)](https://www.unix.com/man-page/linux/5/subuid)**, **[subgid(5)](https://www.unix.com/man-page/linux/5/subgid)**, **[slirp4netns(1)](https://github.com/rootless-containers/slirp4netns/blob/master/slirp4netns.1.md)**, **[pasta(1)](https://passt.top/builds/latest/web/passt.1.html)**, **[conmon(8)](https://github.com/containers/conmon/blob/main/docs/conmon.8.md)**
|
||||
**[containers-mounts.conf(5)](https://github.com/containers/common/blob/main/docs/containers-mounts.conf.5.md)**, **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)**, **[containers-registries.conf(5)](https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md)**, **[containers-storage.conf(5)](https://github.com/containers/storage/blob/main/docs/containers-storage.conf.5.md)**, **[buildah(1)](https://github.com/containers/buildah/blob/main/docs/buildah.1.md)**, **[oci-hooks(5)](https://github.com/containers/common/blob/main/pkg/hooks/docs/oci-hooks.5.md)**, **[containers-policy.json(5)](https://github.com/containers/image/blob/main/docs/containers-policy.json.5.md)**, **[crun(1)](https://github.com/containers/crun/blob/main/crun.1.md)**, **[runc(8)](https://github.com/opencontainers/runc/blob/main/man/runc.8.md)**, **[subuid(5)](https://www.unix.com/man-page/linux/5/subuid)**, **[subgid(5)](https://www.unix.com/man-page/linux/5/subgid)**, **[slirp4netns(1)](https://github.com/rootless-containers/slirp4netns/blob/master/slirp4netns.1.md)**, **[pasta(1)](https://passt.top/builds/latest/web/passt.1.html)**, **[conmon(8)](https://github.com/containers/conmon/blob/main/docs/conmon.8.md)**
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
|
||||
Reference in New Issue
Block a user