LUDOC-394 manual: Add meaningful ref names under UnderstandingLustre.xml

[doc/manual.git] / LustreNodemap.xml

diff --git a/LustreNodemap.xml b/LustreNodemap.xml
index f5ce501..76d1ff3 100644 (file)
--- a/LustreNodemap.xml
+++ b/LustreNodemap.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<chapter version="5.0" xml:id="lustrenodemap" xml:lang="en-US"
-         condition='l29'
-         xmlns="http://docbook.org/ns/docbook">
+<chapter xmlns="http://docbook.org/ns/docbook"
+ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en-US"
+ xml:id="lustrenodemap" condition='l29'>
   <title xml:id="lustrenodemap.title">Mapping UIDs and GIDs with
   Nodemap</title>
 
@@ -23,6 +23,10 @@
     </listitem>
 
     <listitem>
+      <para><xref linkend="defaultNodemap"/></para>
+    </listitem>
+
+    <listitem>
       <para><xref linkend="verifyingsettings"/></para>
     </listitem>
 
@@ -197,7 +201,7 @@ drwxr-xr-x 3 root root     4096 Jul 23 09:02 ..
       <para>If UID 11002 or GID 11001 do not exist on the Lustre MDS or MGS,
       create them in LDAP or other data sources, or trust clients by setting
       <literal>identity_upcall</literal> to <literal>NONE</literal>. For more
-      information, see <xref linkend="dbdoclet.50438291_32926"/>.</para>
+      information, see <xref linkend="dbdoclet.identity_upcall"/>.</para>
 
       <para>Building a larger and more complex configuration is possible by
       iterating through the <literal>lctl</literal> commands above. In
@@ -363,22 +367,60 @@ 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>
 
-    <para>By using <literal>lctl nodemap_info all</literal>, existing
-    nodemap configuration is listed for easy export. This command
-    acts as a shortcut into the /proc interface for nodemap.
-    Within /proc/fs/lustre/nodemap/ on the Lustre MGS, the
-    file <literal>active</literal> contains a 1 if nodemap is active on the
-    system. Each policy group creates a directory containing the
-    following parameters:</para>
+    <para>By using <literal>lctl nodemap_info all</literal>, existing nodemap
+    configuration is listed for easy export. This command acts as a shortcut
+    into the configuration interface for nodemap.  On the Lustre MGS, the
+    <literal>nodemap.active</literal> parameter contains a <literal>1</literal>
+    if nodemap is active on the system. Each policy group
+    creates a directory containing the following parameters:</para>
 
     <itemizedlist>
       <listitem>
-        <para><literal>admin</literal> and
-        <literal>trusted</literal> each contain a ‘1’ if the values
-        are set, and a ‘0’ otherwise.</para>
+        <para><literal>admin</literal> and <literal>trusted</literal> each
+          contain a <literal>1</literal> if the values are set, and
+          <literal>0</literal> otherwise.</para>
       </listitem>
 
       <listitem>
@@ -477,3 +519,6 @@ oss# lctl set_param nodemap.add_nodemap_idmap='<replaceable>SiteName</replaceabl
     </itemizedlist>
   </section>
 </chapter>
+<!--
+  vim:expandtab:shiftwidth=2:tabstop=8:
+  -->