From: Sebastien Buisson <sbuisson@ddn.com>
Date: Tue, 22 Jan 2019 13:20:27 +0000 (+0100)
Subject: LUDOC-430 nodemap: doc for 'default' nodemap
X-Git-Tag: 2.13.0~27
X-Git-Url: https://git.whamcloud.com/?a=commitdiff_plain;h=b962f19e32154b51d5b636ebadac2f1fe2f0db6b;p=doc%2Fmanual.git

LUDOC-430 nodemap: doc for 'default' nodemap

This patch adds documentation about the 'default' nodemap.
This doc is added under the Mapping UIDs and GIDs with Nodemap
chapter.

Signed-off-by: Sebastien Buisson <sbuisson@ddn.com>
Change-Id: I9ae21cc4ae321f804f950a9a05e48f1df91c9dc0
Reviewed-on: https://review.whamcloud.com/34089
Tested-by: Jenkins
Reviewed-by: James Nunez <jnunez@whamcloud.com>
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
---

diff --git a/LustreNodemap.xml b/LustreNodemap.xml
index 0efd877..313ab95 100644
--- a/LustreNodemap.xml
+++ b/LustreNodemap.xml
@@ -23,6 +23,10 @@
     </listitem>
 
     <listitem>
+      <para><xref linkend="defaultNodemap"/></para>
+    </listitem>
+
+    <listitem>
       <para><xref linkend="verifyingsettings"/></para>
     </listitem>
 
@@ -363,6 +367,45 @@ oss# lctl set_param nodemap.add_nodemap_idmap='<replaceable>SiteName</replaceabl
     ten seconds in normal circumstances.</para>
   </section>
 
+  <section xml:id="defaultNodemap">
+    <title><literal>default</literal> Nodemap</title>
+
+    <para>There is a special nodemap called <literal>default</literal>. As the
+      name suggests, it is created by default and cannot be removed. It is like
+      a fallback nodemap, setting the behaviour for Lustre clients that do not
+      match any other nodemap.</para>
+    <para>Because of its special role, only some parameters can be set on the
+      <literal>default</literal> nodemap:</para>
+    <itemizedlist>
+      <listitem>
+        <para><literal>admin</literal></para>
+      </listitem>
+      <listitem>
+        <para><literal>trusted</literal></para>
+      </listitem>
+      <listitem>
+        <para><literal>squash_uid</literal></para>
+      </listitem>
+      <listitem>
+        <para><literal>squash_gid</literal></para>
+      </listitem>
+      <listitem>
+        <para><literal>fileset</literal></para>
+      </listitem>
+      <listitem>
+        <para><literal>audit_mode</literal></para>
+      </listitem>
+    </itemizedlist>
+    <para>In particular, no UID/GID mapping can be defined on the
+      <literal>default</literal> nodemap.</para>
+    <note>
+      <para>Be careful when altering the <literal>admin</literal> and
+        <literal>trusted</literal> properties of the <literal>default</literal>
+        nodemap, especially if your Lustre servers fall into this nodemap.
+      </para>
+    </note>
+  </section>
+
   <section xml:id="verifyingsettings">
     <title>Verifying Settings</title>