Preface.xml

   1 <?xml version='1.0' encoding='UTF-8'?>
   2 <preface xmlns="http://docbook.org/ns/docbook" xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en-US">
   3   <title>Preface</title>
   4   <para>This operations manual provides detailed information and procedures to install, configure and tune the Lustre file system. The manual covers topics such as failover, quotas, striping and bonding. The Lustre manual also contains troubleshooting information and tips to improve Lustre operation and performance.</para>
   5   <section remap="h2">
   6     <title>About this Document</title>
   7     <para>This document is maintained by Whamcloud, Inc in Docbook format. The canonical version is available at <link xl:href="http://wiki.whamcloud.com">http://wiki.whamcloud.com/</link>. </para>
   8
   9     <section remap="h2">
  10       <title>UNIX Commands</title>
  11       <para>This document might not contain information about basic UNIX commands and procedures such as shutting down the system, booting the system, and configuring devices. Refer to the following for this information:</para>
  12       <itemizedlist>
  13         <listitem>
  14           <para> Software documentation that you received with your system</para>
  15         </listitem>
  16         <listitem>
  17           <para> Red Hat Enterprise Linux documentation, which is at:
  18       <link xl:href="http://docs.redhat.com/docs/en-US/index.html">http://docs.redhat.com/docs/en-US/index.html</link></para>
  19   <note><para>
  20           The Lustre client module is available for many different Linux versions and distributions. Red Hat Enterprise is the best supported and tested platform for Lustre Servers.
  21   </para></note>
  22         </listitem>
  23       </itemizedlist>
  24     </section>
  25     <section remap="h2">
  26       <title>Shell Prompts</title>
  27       <informaltable frame="all">
  28         <tgroup cols="2">
  29           <colspec colname="c1" colwidth="50*"/>
  30           <colspec colname="c2" colwidth="50*"/>
  31           <thead>
  32             <row>
  33               <entry>
  34                 <para><emphasis role="bold">Shell</emphasis></para>
  35               </entry>
  36               <entry>
  37                 <para><emphasis role="bold">Prompt</emphasis></para>
  38               </entry>
  39             </row>
  40           </thead>
  41           <tbody>
  42             <row>
  43               <entry>
  44                 <para> C shell</para>
  45               </entry>
  46               <entry>
  47                 <para> <emphasis>machine-name</emphasis>%</para>
  48               </entry>
  49             </row>
  50             <row>
  51               <entry>
  52                 <para> C shell superuser</para>
  53               </entry>
  54               <entry>
  55                 <para> <emphasis>machine-name</emphasis>#</para>
  56               </entry>
  57             </row>
  58             <row>
  59               <entry>
  60                 <para> Bourne shell and Korn shell</para>
  61               </entry>
  62               <entry>
  63                 <para> <prompt>$</prompt></para>
  64               </entry>
  65             </row>
  66             <row>
  67               <entry>
  68                 <para> Bourne shell and Korn shell superuser</para>
  69               </entry>
  70               <entry>
  71                 <para> <prompt>#</prompt></para>
  72               </entry>
  73             </row>
  74           </tbody>
  75         </tgroup>
  76       </informaltable>
  77     </section>
  78     <section remap="h2">
  79       <title>Related Documentation</title>
  80       <para>The documents listed as online are available at:</para>
  81       <para><link xl:href="http://wiki.whamcloud.com/display/PUB/Documentation">http://wiki.whamcloud.com/display/PUB/Documentation</link></para>
  82       <informaltable frame="all">
  83         <tgroup cols="4">
  84           <colspec colname="c1" colwidth="25*"/>
  85           <colspec colname="c2" colwidth="25*"/>
  86           <colspec colname="c3" colwidth="25*"/>
  87           <colspec colname="c4" colwidth="25*"/>
  88           <thead>
  89             <row>
  90               <entry>
  91                 <para><emphasis role="bold">Application</emphasis></para>
  92               </entry>
  93               <entry>
  94                 <para><emphasis role="bold">Title</emphasis></para>
  95               </entry>
  96               <entry>
  97                 <para><emphasis role="bold">Format</emphasis></para>
  98               </entry>
  99               <entry>
 100                 <para><emphasis role="bold">Location</emphasis></para>
 101               </entry>
 102             </row>
 103           </thead>
 104           <tbody>
 105             <row>
 106               <entry>
 107                 <para> Latest information</para>
 108               </entry>
 109               <entry>
 110                 <para> <emphasis>Lustre 2.0 Release Notes</emphasis></para>
 111               </entry>
 112               <entry>
 113                 <para> PDF</para>
 114               </entry>
 115               <entry>
 116                 <para> Online</para>
 117               </entry>
 118             </row>
 119             <row>
 120               <entry>
 121                 <para> Service</para>
 122               </entry>
 123               <entry>
 124                 <para> <emphasis>Lustre 2.0 Operations Manual</emphasis></para>
 125               </entry>
 126               <entry>
 127                 <para> PDF</para>
 128                 <para>HTML</para>
 129               </entry>
 130               <entry>
 131                 <para> Online</para>
 132               </entry>
 133             </row>
 134           </tbody>
 135         </tgroup>
 136       </informaltable>
 137     </section>
 138     <section remap="h2">
 139       <title>Documentation, Support, and Training</title>
 140       <para>These web sites provide additional resources:</para>
 141       <itemizedlist>
 142         <listitem>
 143           <para> Documentation <link xl:href="http://wiki.whamcloud.com/display/PUB/Documentation">http://wiki.whamcloud.com/display/PUB/Documentation</link></para>
 144         </listitem>
 145         <listitem>
 146           <para> Support <link xl:href="http://www.whamcloud.com/">http://www.whamcloud.com/</link></para>
 147         </listitem>
 148         <listitem>
 149           <para> Training <link xl:href="http://www.whamcloud.com/">http://www.whamcloud.com/</link></para>
 150         </listitem>
 151       </itemizedlist>
 152     </section>
 153   </section>
 154     <xi:include href="Revision.xml"  xmlns:xi="http://www.w3.org/2001/XInclude"/>
 155 </preface>