[edit] WARNING: This is the _old_ Lustre wiki, and it is in the process of being retired. The information found here is all likely to be out of date. Please search the new wiki for more up to date information.

Lustre Documentation

From Obsolete Lustre Wiki
(Difference between revisions)
Jump to: navigation, search
(Additional Resources)
 
(48 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__TOC__  
 
__TOC__  
A number of different documents are available to support the Lustre user community. The Lustre Operations Manual provides comprehensive information about the Lustre product and is updated frequently.  
+
The ''Lustre Operations Manual'' is the primary source of documentation about the Lustre product. The manual covers the Lustre product and provides users with installation, configuration, tuning, monitoring and troubleshooting information.  
  
High-level designs (HLDs) and detailed-level designs (DLDs) for Lustre are available, as are Lustre Internals, describing complex, internal topics. For these documents, see Additional Resources, below.
+
Different versions of the ''Lustre Operations Manual'' support different versions of Lustre software. To determine which version of the ''Lustre Operations Manual'' supports the Lustre software you are using, refer to the table below. The latest version of the Operations Manual is available in both HTML and PDF formats.  
 
+
In the spirit of the open-source community, the Lustre Group is committed to making Lustre 'more open', including its documentation. Look for more Lustre documents to be made available in the near future.
+
{| border="1" cellspacing=0 cellpadding="10"
 
+
! <small>Manual Part No.</small> !! <small>Supported Lustre Version</small> !! <small>Release Date</small> !! <small>HTML</small> !! <small>PDF</small>
== Lustre Manual ==
+
|-
 
+
| <small>821-2076-10'''</small>
The Lustre Manual is the primary source of documentation about the Lustre product.
+
| <small>'''2.0'''</small>
 
+
| <small>January 2011</small>
The manual provides Lustre installation, configuration, tuning, monitoring and troubleshooting. Different versions of the Operations Manual support different versions of Lustre software.
+
| <small>[http://wiki.lustre.org/manual/LustreManual20_HTML/index.html Lustre Manual 2.0]</small>
 
+
| <small>[[Media:821-2076-10.pdf|Lustre 2.0 Manual]]</small>
=== Lustre 1.6 ===
+
|-
For your convenience, links to the current version (v1.15) of the Lustre Operations Manual (available in both HTML and PDF) are provided below.
+
| <small>821-2077-10'''</small>
 
+
| <small>'''2.0'''</small>
==== Lustre Manual version 1.15 ====
+
| <small>July 2010</small>
(Released November 21, 2008)
+
| <small>n/a</small>
 
+
| <small>[[Media:821-2077-10.pdf|Lustre 2.0 Release Notes]]</small>
* '''Lustre Manual (HTML) '''[http://manual.lustre.org/manual/LustreManual16_HTML/index.html Lustre 1.6 Operations Manual v1.15]
+
|-
 
+
| <small>821-0035-12'''</small>
* '''Lustre Manual (PDF) '''[http://manual.lustre.org/images/8/86/820-3681_v15.pdf Lustre 1.6 Operations Manual v1.15]
+
| <small>'''1.8'''</small>
 
+
| <small>December 2010</small>
* '''Lustre Manual Version Log '''[http://manual.lustre.org/manual/LustreManual16_HTML/VersionLog.html#50548890_pgfId-1000005 Lustre 1.6 manual version log] (describes additions and updates to the Lustre 1.6 manual)
+
| <small>[http://wiki.lustre.org/manual/LustreManual18_HTML/index.html Lustre Manual 1.8]</small>
 
+
| <small>[[Media:821-0035-12.pdf|Lustre 1.8 Manual]]</small>
=== Lustre 1.4.8 ===
+
|-
* '''Lustre Manual (HTML) '''[http://wiki.lustre.org/images/7/78/LustreManual.html Lustre 1.4.8 manual v1.37]
+
| <small>820-3681-12'''</small>
 
+
| <small>'''1.6'''</small>
* '''Lustre Manual (PDF) '''[http://wiki.lustre.org/images/7/78/LustreManual37.pdf Lustre 1.4.8 manual v1.37 (A4)]
+
| <small>June 2010</small>
 
+
| <small>[http://wiki.lustre.org/manual/LustreManual16_HTML/index.html Lustre Manual 1.6]</small>
* '''Lustre Manual Change Log '''[http://wiki.lustre.org/images/7/78/manual-changelog.html Lustre 1.4.8 manual change log] (describes additions and changes to the Lustre 1.4.8 manual)
+
| <small>[[Media:820-3681_v1_18.pdf|Lustre 1.6 Manual]]</small>
 
+
|}
== Additional Resources ==
+
 
+
[http://arch.lustre.org/index.php?title=LustreHLDs Lustre HLDs] - Lustre High-Level Designs (HLDs) are now available to the public and downloadable as PDFs or in their original LyX format.
+
 
+
[http://arch.lustre.org/index.php?title=LustreDLDs Lustre DLDs] - Lustre High-Level Designs (DLDs) are now available to the public and downloadable as PDFs or in their original LyX format.
+
 
+
[http://wiki.lustre.org/index.php?title=Lustre_Internals Lustre Internals] - Lustre internals are now available to the public as PDFs. Historically, Lustre internals have been presented as part of the Lustre Advanced (L2) training class.
+
 
+
== Interim Lustre 1.8 Documentation ==
+
* '''[http://wiki.lustre.org/index.php?title=Kerb_Lustre KerbLustre]''' - The 1.8 interim Lustre documentation (Kerberos....)
+
 
+
== Older Documentation ==
+
This documentation will be incorporated into the manual. Until that is done you may find useful bits and pieces here.
+
 
+
* '''Frequently Asked Questions'''
+
** [http://www.clusterfs.com/faq.html Lustre Faq]
+
* '''Knowledge Base'''
+
** [http://bugzilla.lustre.org/showdependencytree.cgi?id=2374 Lustre Knowledge Base] - questions and answers
+
* '''Configuration'''
+
** [http://wiki.lustre.org/index.php?title=Lustre_Howto LustreHowto]''' - A guide to getting Lustre cluster started.
+
** [http://wiki.lustre.org/index.php?title=Lustre_LDAP LustreLDAP]''' - A guide for using LDAP with Lustre.
+
** [http://wiki.lustre.org/index.php?title=Lustre_Wizard LustreWizard]''' - The ''Lustre wizard'' or ''lwizard'' is a utility that helps with creation of configuration file for a cluster through asking some simple questions.
+
** [http://wiki.lustre.org/index.php?title=Lustre_Failover LustreFailover]''' - Managing failover
+
** [http://wiki.lustre.org/index.php?title=Filesystem_Backup FilesystemBackup]''' - How to back up a Lustre filesystem
+
** [http://wiki.lustre.org/index.php?title=Fsck_Support FsckSupport]''' - The lustre fsck tool and Lustre-patched e2fsck (extents, large inode/EA support)
+
** '''Filesystem Tuning'''
+
*** [http://wiki.lustre.org/images/7/78/LustreManual.html#Chapter_III-2._LustreProc LustreProc] - A guide on the '''proc''' tunables parameters for Lustre and their usage. It describes several of the ''proc'' tunables including those that effect the client's RPC behaviour and prepare for a substantial reorganization of proc entries.
+
*** '''[http://wiki.lustre.org/images/7/78/LustreManual.html#3.2_DDN_Tuning LustreDdnTuning]''' - A brief guide on tuning DDN S2A 8500 (and maybe 9500) storage optimally for Lustre
+

Latest revision as of 18:04, 20 January 2011

The Lustre Operations Manual is the primary source of documentation about the Lustre product. The manual covers the Lustre product and provides users with installation, configuration, tuning, monitoring and troubleshooting information.

Different versions of the Lustre Operations Manual support different versions of Lustre software. To determine which version of the Lustre Operations Manual supports the Lustre software you are using, refer to the table below. The latest version of the Operations Manual is available in both HTML and PDF formats.

Manual Part No. Supported Lustre Version Release Date HTML PDF
821-2076-10 2.0 January 2011 Lustre Manual 2.0 Lustre 2.0 Manual
821-2077-10 2.0 July 2010 n/a Lustre 2.0 Release Notes
821-0035-12 1.8 December 2010 Lustre Manual 1.8 Lustre 1.8 Manual
820-3681-12 1.6 June 2010 Lustre Manual 1.6 Lustre 1.6 Manual
Personal tools
Navigation