Preface.xml

   1 <?xml version='1.0' encoding='UTF-8'?>
   2 <preface xmlns="http://docbook.org/ns/docbook"
   3  xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en-US">
   4   <title>Preface</title>
   5   <para>The <emphasis role="italic">Lustre<superscript>*</superscript>Software
   6     Release 2.x Operations Manual</emphasis> provides detailed information and
   7     procedures to install, configure and tune a Lustre file system. The manual
   8     covers topics such as failover, quotas, striping, and bonding. This manual
   9     also contains troubleshooting information and tips to improve
  10     the operation and performance of a Lustre file system.</para>
  11   <section remap="h2">
  12     <title>About this Document</title>
  13     <para>This document is maintained by Whamcloud in Docbook format. The
  14     canonical version is available at
  15     <link xl:href="https://wiki.whamcloud.com/display/PUB/Documentation">
  16       https://wiki.whamcloud.com/display/PUB/Documentation
  17     </link>. </para>
  18
  19     <section remap="h2">
  20       <title>UNIX<superscript>*</superscript> Commands</title>
  21       <para>This document does not contain information about basic
  22         UNIX<superscript>*</superscript> operating system commands and
  23         procedures such as shutting down the system, booting the system, and
  24         configuring devices. Refer to the following for this information:</para>
  25       <itemizedlist>
  26         <listitem>
  27           <para>Software documentation that you received with your system</para>
  28         </listitem>
  29         <listitem>
  30           <para>Red Hat<superscript>*</superscript> Enterprise
  31             Linux<superscript>*</superscript> documentation, which is at:
  32             <link xl:href="https://docs.redhat.com/docs/en-US/index.html">
  33             https://docs.redhat.com/docs/en-US/index.html</link>
  34           </para>
  35           <note><para>The Lustre client module is available for many different
  36             Linux<superscript>*</superscript> versions and distributions. The
  37             Red Hat Enterprise Linux distribution is the best supported and
  38             tested platform for Lustre servers.</para></note>
  39         </listitem>
  40       </itemizedlist>
  41     </section>
  42     <section remap="h2">
  43       <title>Shell Prompts</title>
  44       <para>The shell prompt used in the example text indicates whether a
  45       command can or should be executed by a regular user, or whether it
  46       requires superuser permission to run.  Also, the machine type is often
  47       included in the prompt to indicate whether the command should be run
  48       on a client node, on an MDS node, an OSS node, or the MGS node.</para>
  49       <para>Some examples are listed below, but other prompt combinations
  50       are also used as needed for the example.</para>
  51       <informaltable frame="all">
  52         <tgroup cols="2">
  53           <colspec colname="c1" colwidth="50*"/>
  54           <colspec colname="c2" colwidth="50*"/>
  55           <thead>
  56             <row>
  57               <entry>
  58                 <para><emphasis role="bold">Shell</emphasis></para>
  59               </entry>
  60               <entry>
  61                 <para><emphasis role="bold">Prompt</emphasis></para>
  62               </entry>
  63             </row>
  64           </thead>
  65           <tbody>
  66             <row>
  67               <entry>
  68                 <para> Regular user</para>
  69               </entry>
  70               <entry>
  71                 <para> <prompt>machine$</prompt></para>
  72               </entry>
  73             </row>
  74             <row>
  75               <entry>
  76                 <para> Superuser (root)</para>
  77               </entry>
  78               <entry>
  79                 <para> <prompt>machine#</prompt></para>
  80               </entry>
  81             </row>
  82             <row>
  83               <entry>
  84                 <para> Regular user on the client</para>
  85               </entry>
  86               <entry>
  87                 <para> <prompt>client$</prompt></para>
  88               </entry>
  89             </row>
  90             <row>
  91               <entry>
  92                 <para> Superuser on the MDS</para>
  93               </entry>
  94               <entry>
  95                 <para> <prompt>mds#</prompt></para>
  96               </entry>
  97             </row>
  98             <row>
  99               <entry>
 100                 <para> Superuser on the OSS</para>
 101               </entry>
 102               <entry>
 103                 <para> <prompt>oss#</prompt></para>
 104               </entry>
 105             </row>
 106             <row>
 107               <entry>
 108                 <para> Superuser on the MGS</para>
 109               </entry>
 110               <entry>
 111                 <para> <prompt>mgs#</prompt></para>
 112               </entry>
 113             </row>
 114           </tbody>
 115         </tgroup>
 116       </informaltable>
 117     </section>
 118     <section remap="h2">
 119       <title>Related Documentation</title>
 120       <informaltable frame="all">
 121         <tgroup cols="4">
 122           <colspec colname="c1" colwidth="25*"/>
 123           <colspec colname="c2" colwidth="25*"/>
 124           <colspec colname="c3" colwidth="15*"/>
 125           <colspec colname="c4" colwidth="35*"/>
 126           <thead>
 127             <row>
 128               <entry>
 129                 <para><emphasis role="bold">Application</emphasis></para>
 130               </entry>
 131               <entry>
 132                 <para><emphasis role="bold">Title</emphasis></para>
 133               </entry>
 134               <entry>
 135                 <para><emphasis role="bold">Format</emphasis></para>
 136               </entry>
 137               <entry>
 138                 <para><emphasis role="bold">Location</emphasis></para>
 139               </entry>
 140             </row>
 141           </thead>
 142           <tbody>
 143             <row>
 144               <entry>
 145                 <para> Latest information</para>
 146               </entry>
 147               <entry>
 148                 <para>
 149                   <emphasis>Lustre Software Release 2.x Change Logs</emphasis></para>
 150               </entry>
 151               <entry>
 152                 <para> Wiki page</para>
 153               </entry>
 154               <entry>
 155                 <para> Online at <link
 156                     xl:href="https://wiki.whamcloud.com/display/PUB/Documentation"
 157                     >https://wiki.whamcloud.com/display/PUB/Documentation</link></para>
 158               </entry>
 159             </row>
 160             <row>
 161               <entry>
 162                 <para> Service</para>
 163               </entry>
 164               <entry>
 165                 <para>
 166                   <emphasis>Lustre Software Release 2.x Operations Manual</emphasis></para>
 167               </entry>
 168               <entry>
 169                 <para> PDF</para>
 170                 <para>HTML</para>
 171               </entry>
 172               <entry>
 173                 <para> Online at <link
 174                     xl:href="https://wiki.whamcloud.com/display/PUB/Documentation"
 175                     >https://wiki.whamcloud.com/display/PUB/Documentation</link></para>
 176               </entry>
 177             </row>
 178           </tbody>
 179         </tgroup>
 180       </informaltable>
 181     </section>
 182     <section remap="h2">
 183       <title>Documentation and Support</title>
 184       <para>These web sites provide additional resources:</para>
 185       <itemizedlist>
 186         <listitem>
 187           <para> Documentation
 188           <link xl:href="https://wiki.whamcloud.com/display/PUB/Documentation">
 189             https://wiki.whamcloud.com/display/PUB/Documentation</link>
 190           <link xl:href="https://www.lustre.org">https://www.lustre.org</link>
 191           </para>
 192         </listitem>
 193         <listitem>
 194           <para> Support <link xl:href="https://jira.whamcloud.com/">https://jira.whamcloud.com/</link></para>
 195         </listitem>
 196       </itemizedlist>
 197     </section>
 198   </section>
 199   <xi:include href="Revision.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 200 </preface>
 201 <!--
 202   vim:expandtab:shiftwidth=2:tabstop=8:
 203   -->