Lustre Documentation

= Lustre Documentation =

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.

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.

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.

Lustre Manual
The Lustre Manual is the primary source of documentation about the Lustre product.

The manual provides Lustre installation, configuration, tuning, monitoring and troubleshooting. Different versions of the Operations Manual support different versions of Lustre software.

Lustre 1.6
For your convenience, links to the current version (v1.12) of the Lustre Operations Manual (available in both HTML and PDF) are provided below.

Lustre Manual version 1.14 (released September 19, 2008)

 * Lustre Manual (HTML) Lustre 1.6 Operations Manual v1.14


 * Lustre Manual (PDF) Lustre 1.6 Operations Manual v1.14


 * Lustre Manual Version Log Lustre 1.6 manual version log (describes additions and updates to the Lustre 1.6 manual)


 * MountConf wiki - A quick reference for those familiar with older versions of Lustre

Lustre 1.4.8

 * Lustre Manual (HTML) Lustre 1.4.8 manual v1.37


 * Lustre Manual (PDF) Lustre 1.4.8 manual v1.37 (A4)


 * Lustre Manual Change Log Lustre 1.4.8 manual change log (describes additions and changes to the Lustre 1.4.8 manual)

Additional Resources
Lustre HLDs

Lustre DLDs

Lustre Internals

Interim Lustre 1.8 Documentation

 * 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
 * Lustre Faq
 * Knowledge Base
 * Lustre Knowledge Base - questions and answers
 * Configuration
 * LustreHowto''' - A guide to getting Lustre cluster started.
 * LustreLDAP''' - A guide for using LDAP with Lustre.
 * LustreWizard' - The Lustre wizard or lwizard'' is a utility that helps with creation of configuration file for a cluster through asking some simple questions.
 * LustreFailover''' - Managing failover
 * FilesystemBackup''' - How to back up a Lustre filesystem
 * FsckSupport''' - The lustre fsck tool and Lustre-patched e2fsck (extents, large inode/EA support)
 * Filesystem Tuning
 * 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.
 * LustreDdnTuning - A brief guide on tuning DDN S2A 8500 (and maybe 9500) storage optimally for Lustre