Skip to content

Commit

Permalink
Update main admindocs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Mar 12, 2024
1 parent c663d3b commit 7580d9a
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 19 deletions.
11 changes: 5 additions & 6 deletions public/docs/admin/main/_sources/installation.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,13 @@ Full functionality of {Project} requires that the kernel supports:
- **Unprivileged user namespaces** - (minimum kernel >=3.8, >=4.18
or 3.10.0-1127 on RHEL7 recommended)
Required to run containers without root or setuid privilege.
The recommended versions are required for unprivileged SIF file
mounts.
The recommended versions are required for unprivileged FUSE mounts.

- **OverlayFS mounts** - (minimum kernel >=3.18, >=5.11 recommended)
Required for full flexibility in bind mounts to containers in suid
mode, and to support persistent overlays for writable containers
in suid mode. Kernel 5.11 enables support for persistent overlay
unprivileged, but otherwise fuse-overlayfs will be used for that.
Used for creating missing bind mount paths and for writable overlays.
Kernel 5.11 enables support for overlays unprivileged, but whenever
the kernel OverlayFS driver doesn't work, fuse-overlayfs will be used
instead.

Instructions to install without or with setuid privileges are below.
Please make sure you are familiar with the discussion on
Expand Down
8 changes: 5 additions & 3 deletions public/docs/admin/main/_sources/user_namespace.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,11 @@ required, with >=4.18 being recommended due to support for unprivileged
mounting of FUSE filesystems (needed for example for mounting SIF files).
The equivalent recommendation on RHEL7 is >=3.10.0-1127 from release
7.8, where unprivileged mounting of FUSE filesystems was backported.
To use unprivileged overlayFS for persistent overlays, kernel >=5.11 is
recommended, but if that's not available then {Project} will use
fuse-overlayfs instead. That feature has not been backported to RHEL7.
To use unprivileged overlayFS for creating missing bind mount paths and
for writable overlays, kernel >=5.11 is recommended.
That feature has not been backported to RHEL7.
Whenever the kernel overlayFS doesn't work then {Project} will use
fuse-overlayfs instead.

Additionally, some Linux distributions require that unprivileged user
namespace creation is enabled using a ``sysctl`` or kernel command line
Expand Down
11 changes: 5 additions & 6 deletions public/docs/admin/main/installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -162,13 +162,12 @@ <h3>System Requirements<a class="headerlink" href="#system-requirements" title="
<li><p><strong>Unprivileged user namespaces</strong> - (minimum kernel &gt;=3.8, &gt;=4.18
or 3.10.0-1127 on RHEL7 recommended)
Required to run containers without root or setuid privilege.
The recommended versions are required for unprivileged SIF file
mounts.</p></li>
The recommended versions are required for unprivileged FUSE mounts.</p></li>
<li><p><strong>OverlayFS mounts</strong> - (minimum kernel &gt;=3.18, &gt;=5.11 recommended)
Required for full flexibility in bind mounts to containers in suid
mode, and to support persistent overlays for writable containers
in suid mode. Kernel 5.11 enables support for persistent overlay
unprivileged, but otherwise fuse-overlayfs will be used for that.</p></li>
Used for creating missing bind mount paths and for writable overlays.
Kernel 5.11 enables support for overlays unprivileged, but whenever
the kernel OverlayFS driver doesn’t work, fuse-overlayfs will be used
instead.</p></li>
</ul>
<p>Instructions to install without or with setuid privileges are below.
Please make sure you are familiar with the discussion on
Expand Down
2 changes: 1 addition & 1 deletion public/docs/admin/main/searchindex.js

Large diffs are not rendered by default.

8 changes: 5 additions & 3 deletions public/docs/admin/main/user_namespace.html
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,11 @@
mounting of FUSE filesystems (needed for example for mounting SIF files).
The equivalent recommendation on RHEL7 is &gt;=3.10.0-1127 from release
7.8, where unprivileged mounting of FUSE filesystems was backported.
To use unprivileged overlayFS for persistent overlays, kernel &gt;=5.11 is
recommended, but if that’s not available then Apptainer will use
fuse-overlayfs instead. That feature has not been backported to RHEL7.</p>
To use unprivileged overlayFS for creating missing bind mount paths and
for writable overlays, kernel &gt;=5.11 is recommended.
That feature has not been backported to RHEL7.
Whenever the kernel overlayFS doesn’t work then Apptainer will use
fuse-overlayfs instead.</p>
<p>Additionally, some Linux distributions require that unprivileged user
namespace creation is enabled using a <code class="docutils literal notranslate"><span class="pre">sysctl</span></code> or kernel command line
parameter. Please consult your distribution documentation or vendor to
Expand Down

0 comments on commit 7580d9a

Please sign in to comment.