Additional documentation for warewulf.conf:warewulf.secure

Closes #615

Signed-off-by: Jonathon Anderson <janderson@ciq.co>
This commit is contained in:
Jonathon Anderson
2023-04-20 13:35:11 -06:00
parent 28c8b335c1
commit 951e10755a
2 changed files with 13 additions and 10 deletions

View File

@@ -69,14 +69,15 @@ Default: 9983
\fBsecure\fP
When true, this limits the Warewulf server to only respond to runtime
overlay requests originating from a privileged report port. This makes
it so that only the root user on a compute node can request the
runtime overlay. While generally there is nothing super "secure" in
these overlays, this adds the necessary protection that the users can
not obtain this information.
overlay requests originating from a privileged port. This prevents
non-root users from requesting the runtime overlay, which may contain
sensitive information.
When true, wwclient uses TCP port 987.
Changing this option requires rebuilding node overlays and rebooting
compute nodes, to configure them to use a privileged port.
Default: true
.IP

View File

@@ -86,11 +86,13 @@ explained as follows:
* ``warewulf:secure``: When ``true``, this limits the Warewulf server
to only respond to runtime overlay requests originating from a
privileged report port. This makes it so that only the ``root`` user
on a compute node can request the runtime overlay. While generally
there is nothing super "secure" in these overlays, this adds the
necessary protection that the user's can not obtain this
information.
privileged port. This prevents non-root users from requesting the
runtime overlay, which may contain sensitive information.
When ``true``, ``wwclient`` uses TCP port 987.
Changing this option requires rebuilding node overlays and rebooting
compute nodes, to configure them to use a privileged port.
* ``warewulf:update interval``: This defines the frequency (in
seconds) with which the Warewulf client on the compute node fetches