-<?xml version="1.0" encoding="UTF-8"?>
-<preface version="5.0" xml:lang="en-US" xmlns="http://docbook.org/ns/docbook" xmlns:xl="http://www.w3.org/1999/xlink">
- <title>Preface</title>
- <para><anchor xml:id="dbdoclet.50438247_pgfId-7593" xreflabel=""/>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>
+<?xml version='1.0' encoding='UTF-8'?>
+<preface xmlns="http://docbook.org/ns/docbook"
+ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en-US">
+ <title>Preface</title>
+ <para>The <emphasis role="italic">Lustre<superscript>*</superscript>Software
+ Release 2.x Operations Manual</emphasis> provides detailed information and
+ procedures to install, configure and tune a Lustre file system. The manual
+ covers topics such as failover, quotas, striping, and bonding. This manual
+ also contains troubleshooting information and tips to improve
+ the operation and performance of a Lustre file system.</para>
<section remap="h2">
- <title><anchor xml:id="dbdoclet.50438247_pgfId-4908" xreflabel=""/></title>
+ <title>About this Document</title>
+ <para>This document is maintained by Whamcloud in Docbook format. The
+ canonical version is available at
+ <link xl:href="https://wiki.whamcloud.com/display/PUB/Documentation">
+ https://wiki.whamcloud.com/display/PUB/Documentation
+ </link>. </para>
+
<section remap="h2">
- <title>UNIX Commands</title>
- <para><anchor xml:id="dbdoclet.50438247_pgfId-4910" xreflabel=""/>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>
- <itemizedlist><listitem>
- <para><anchor xml:id="dbdoclet.50438247_pgfId-4417" xreflabel=""/> Software documentation that you received with your system</para>
+ <title>UNIX<superscript>*</superscript> Commands</title>
+ <para>This document does not contain information about basic
+ UNIX<superscript>*</superscript> operating system commands and
+ procedures such as shutting down the system, booting the system, and
+ configuring devices. Refer to the following for this information:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Software documentation that you received with your system</para>
</listitem>
-<listitem>
- <para><anchor xml:id="dbdoclet.50438247_pgfId-4418" xreflabel=""/> Oracle Solaris Operating System documentation, which is at:</para>
+ <listitem>
+ <para>Red Hat<superscript>*</superscript> Enterprise
+ Linux<superscript>*</superscript> documentation, which is at:
+ <link xl:href="https://docs.redhat.com/docs/en-US/index.html">
+ https://docs.redhat.com/docs/en-US/index.html</link>
+ </para>
+ <note><para>The Lustre client module is available for many different
+ Linux<superscript>*</superscript> versions and distributions. The
+ Red Hat Enterprise Linux distribution is the best supported and
+ tested platform for Lustre servers.</para></note>
</listitem>
-</itemizedlist>
-<para><anchor xml:id="dbdoclet.50438247_pgfId-4419" xreflabel=""/><link xl:href="http://www.oracle.com/technetwork/indexes/documentation/index.html">http://www.oracle.com/technetwork/indexes/documentation/index.html</link></para>
+ </itemizedlist>
</section>
<section remap="h2">
<title>Shell Prompts</title>
- <informaltable frame="all">
+ <para>The shell prompt used in the example text indicates whether a
+ command can or should be executed by a regular user, or whether it
+ requires superuser permission to run. Also, the machine type is often
+ included in the prompt to indicate whether the command should be run
+ on a client node, on an MDS node, an OSS node, or the MGS node.</para>
+ <para>Some examples are listed below, but other prompt combinations
+ are also used as needed for the example.</para>
+ <informaltable frame="all">
<tgroup cols="2">
<colspec colname="c1" colwidth="50*"/>
<colspec colname="c2" colwidth="50*"/>
<thead>
<row>
- <entry><para><emphasis role="bold"><anchor xml:id="dbdoclet.50438247_pgfId-5160" xreflabel=""/>Shell</emphasis></para></entry>
- <entry><para><emphasis role="bold"><anchor xml:id="dbdoclet.50438247_pgfId-5162" xreflabel=""/>Prompt</emphasis></para></entry>
+ <entry>
+ <para><emphasis role="bold">Shell</emphasis></para>
+ </entry>
+ <entry>
+ <para><emphasis role="bold">Prompt</emphasis></para>
+ </entry>
</row>
</thead>
<tbody>
<row>
- <entry><para> <anchor xml:id="dbdoclet.50438247_pgfId-5164" xreflabel=""/>C shell</para></entry>
- <entry><para> <anchor xml:id="dbdoclet.50438247_pgfId-5166" xreflabel=""/><emphasis>machine-name</emphasis>%</para></entry>
+ <entry>
+ <para> Regular user</para>
+ </entry>
+ <entry>
+ <para> <prompt>machine$</prompt></para>
+ </entry>
</row>
<row>
- <entry><para> <anchor xml:id="dbdoclet.50438247_pgfId-5168" xreflabel=""/>C shell superuser</para></entry>
- <entry><para> <anchor xml:id="dbdoclet.50438247_pgfId-5170" xreflabel=""/><emphasis>machine-name</emphasis>#</para></entry>
+ <entry>
+ <para> Superuser (root)</para>
+ </entry>
+ <entry>
+ <para> <prompt>machine#</prompt></para>
+ </entry>
</row>
<row>
- <entry><para> <anchor xml:id="dbdoclet.50438247_pgfId-5172" xreflabel=""/>Bourne shell and Korn shell</para></entry>
- <entry><para> <anchor xml:id="dbdoclet.50438247_pgfId-5174" xreflabel=""/>$</para></entry>
+ <entry>
+ <para> Regular user on the client</para>
+ </entry>
+ <entry>
+ <para> <prompt>client$</prompt></para>
+ </entry>
</row>
<row>
- <entry><para> <anchor xml:id="dbdoclet.50438247_pgfId-5176" xreflabel=""/>Bourne shell and Korn shell superuser</para></entry>
- <entry><para> <anchor xml:id="dbdoclet.50438247_pgfId-5178" xreflabel=""/>#</para></entry>
+ <entry>
+ <para> Superuser on the MDS</para>
+ </entry>
+ <entry>
+ <para> <prompt>mds#</prompt></para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para> Superuser on the OSS</para>
+ </entry>
+ <entry>
+ <para> <prompt>oss#</prompt></para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para> Superuser on the MGS</para>
+ </entry>
+ <entry>
+ <para> <prompt>mgs#</prompt></para>
+ </entry>
</row>
</tbody>
</tgroup>
</informaltable>
- </section>
+ </section>
<section remap="h2">
- <title><anchor xml:id="dbdoclet.50438247_43930" xreflabel=""/>Related Documentation</title>
- <para><anchor xml:id="dbdoclet.50438247_pgfId-8643" xreflabel=""/>The documents listed as online are available at:</para>
- <para><anchor xml:id="dbdoclet.50438247_pgfId-8695" xreflabel=""/><link xl:href="http://wiki.whamcloud.com/display/PUB/Documentation">http://wiki.whamcloud.com/display/PUB/Documentation</link></para>
- <informaltable frame="all">
+ <title>Related Documentation</title>
+ <informaltable frame="all">
<tgroup cols="4">
<colspec colname="c1" colwidth="25*"/>
<colspec colname="c2" colwidth="25*"/>
- <colspec colname="c3" colwidth="25*"/>
- <colspec colname="c4" colwidth="25*"/>
+ <colspec colname="c3" colwidth="15*"/>
+ <colspec colname="c4" colwidth="35*"/>
<thead>
<row>
- <entry><para><emphasis role="bold"><anchor xml:id="dbdoclet.50438247_pgfId-8647" xreflabel=""/>Application</emphasis></para></entry>
- <entry><para><emphasis role="bold"><anchor xml:id="dbdoclet.50438247_pgfId-8649" xreflabel=""/>Title</emphasis></para></entry>
- <entry><para><emphasis role="bold"><anchor xml:id="dbdoclet.50438247_pgfId-8651" xreflabel=""/>Format</emphasis></para></entry>
- <entry><para><emphasis role="bold"><anchor xml:id="dbdoclet.50438247_pgfId-8653" xreflabel=""/>Location</emphasis></para></entry>
+ <entry>
+ <para><emphasis role="bold">Application</emphasis></para>
+ </entry>
+ <entry>
+ <para><emphasis role="bold">Title</emphasis></para>
+ </entry>
+ <entry>
+ <para><emphasis role="bold">Format</emphasis></para>
+ </entry>
+ <entry>
+ <para><emphasis role="bold">Location</emphasis></para>
+ </entry>
</row>
</thead>
<tbody>
<row>
- <entry><para> <anchor xml:id="dbdoclet.50438247_pgfId-8655" xreflabel=""/>Latest information</para></entry>
- <entry><para> <anchor xml:id="dbdoclet.50438247_pgfId-8657" xreflabel=""/><emphasis>Lustre 2.0 Release Notes</emphasis></para></entry>
- <entry><para> <anchor xml:id="dbdoclet.50438247_pgfId-8659" xreflabel=""/>PDF</para></entry>
- <entry><para> <anchor xml:id="dbdoclet.50438247_pgfId-8663" xreflabel=""/>Online</para></entry>
+ <entry>
+ <para> Latest information</para>
+ </entry>
+ <entry>
+ <para>
+ <emphasis>Lustre Software Release 2.x Change Logs</emphasis></para>
+ </entry>
+ <entry>
+ <para> Wiki page</para>
+ </entry>
+ <entry>
+ <para> Online at <link
+ xl:href="https://wiki.whamcloud.com/display/PUB/Documentation"
+ >https://wiki.whamcloud.com/display/PUB/Documentation</link></para>
+ </entry>
</row>
<row>
- <entry><para> <anchor xml:id="dbdoclet.50438247_pgfId-8665" xreflabel=""/>Service</para></entry>
- <entry><para> <anchor xml:id="dbdoclet.50438247_pgfId-8667" xreflabel=""/><emphasis>Lustre 2.0 Operations Manual</emphasis></para></entry>
- <entry><para> <anchor xml:id="dbdoclet.50438247_pgfId-8669" xreflabel=""/>PDF</para><para><anchor xml:id="dbdoclet.50438247_pgfId-8670" xreflabel=""/>HTML</para></entry>
- <entry><para> <anchor xml:id="dbdoclet.50438247_pgfId-8673" xreflabel=""/>Online</para></entry>
+ <entry>
+ <para> Service</para>
+ </entry>
+ <entry>
+ <para>
+ <emphasis>Lustre Software Release 2.x Operations Manual</emphasis></para>
+ </entry>
+ <entry>
+ <para> PDF</para>
+ <para>HTML</para>
+ </entry>
+ <entry>
+ <para> Online at <link
+ xl:href="https://wiki.whamcloud.com/display/PUB/Documentation"
+ >https://wiki.whamcloud.com/display/PUB/Documentation</link></para>
+ </entry>
</row>
</tbody>
</tgroup>
</informaltable>
- </section>
+ </section>
<section remap="h2">
- <title>Documentation, Support, and Training</title>
- <para><anchor xml:id="dbdoclet.50438247_pgfId-8597" xreflabel=""/>These web sites provide additional resources:</para>
- <itemizedlist><listitem>
- <para><anchor xml:id="dbdoclet.50438247_pgfId-8598" xreflabel=""/> Documentation <link xl:href="http://wiki.whamcloud.com/display/PUB/Documentation">http://wiki.whamcloud.com/display/PUB/Documentation</link></para>
- </listitem>
-<listitem>
- <para><anchor xml:id="dbdoclet.50438247_pgfId-8599" xreflabel=""/> Support <link xl:href="http://www.whamcloud.com/">http://www.whamcloud.com/</link></para>
+ <title>Documentation and Support</title>
+ <para>These web sites provide additional resources:</para>
+ <itemizedlist>
+ <listitem>
+ <para> Documentation
+ <link xl:href="https://wiki.whamcloud.com/display/PUB/Documentation">
+ https://wiki.whamcloud.com/display/PUB/Documentation</link>
+ <link xl:href="https://www.lustre.org">https://www.lustre.org</link>
+ </para>
</listitem>
-<listitem>
- <para><anchor xml:id="dbdoclet.50438247_pgfId-8602" xreflabel=""/> Training <link xl:href="http://www.whamcloud.com/">http://www.whamcloud.com/</link><anchor xml:id="dbdoclet.50438247_88598" xreflabel=""/><anchor xml:id="dbdoclet.50438247_83191" xreflabel=""/></para>
+ <listitem>
+ <para> Support <link xl:href="https://jira.whamcloud.com/">https://jira.whamcloud.com/</link></para>
</listitem>
-</itemizedlist>
- <para><anchor xml:id="dbdoclet.50438247_pgfId-4545" xreflabel=""/> </para>
+ </itemizedlist>
</section>
</section>
+ <xi:include href="Revision.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</preface>
+<!--
+ vim:expandtab:shiftwidth=2:tabstop=8:
+ -->
git://git.whamcloud.com / doc / manual.git / blobdiff