|
|
| (54 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| = Lustre Documentation =
| | __TOC__ |
| | 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. |
|
| |
|
| 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.
| | 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. |
| | | |
| 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.
| | {| 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> |
| 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.
| | |- |
| | | | <small>821-2076-10'''</small> |
| == Lustre Manual ==
| | | <small>'''2.0'''</small> |
| | | | <small>January 2011</small> |
| The Lustre Manual is the primary source of documentation about the Lustre product.
| | | <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> |
| The manual provides Lustre installation, configuration, tuning, monitoring and troubleshooting. Different versions of the Operations Manual support different versions of Lustre software.
| | |- |
| | | | <small>821-2077-10'''</small> |
| === Lustre 1.6 ===
| | | <small>'''2.0'''</small> |
| For your convenience, links to the current version (v1.12) of the Lustre Operations Manual (available in both HTML and PDF) are provided below.
| | | <small>July 2010</small> |
| | | | <small>n/a</small> |
| ==== Lustre Manual version 1.14 (released September 19, 2008) ==== | | | <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.14]
| | | <small>821-0035-12'''</small> |
| | | | <small>'''1.8'''</small> |
| * '''Lustre Manual (PDF) '''[http://manual.lustre.org/images/9/92/LustreManual_v1_14.pdf Lustre 1.6 Operations Manual v1.14]
| | | <small>December 2010</small> |
| | | | <small>[http://wiki.lustre.org/manual/LustreManual18_HTML/index.html Lustre Manual 1.8]</small> |
| * '''Lustre Manual Version Log '''[http://manual.lustre.org/manual/LustreManual16_HTML/VersionLog.html#50544713_pgfId-1000005 Lustre 1.6 manual version log] (describes additions and updates to the Lustre 1.6 manual)
| | | <small>[[Media:821-0035-12.pdf|Lustre 1.8 Manual]]</small> |
| | | |- |
| * '''[http://wiki.lustre.org/index.php?title=Mount_Conf MountConf wiki]''' - A quick reference for those familiar with older versions of Lustre
| | | <small>820-3681-12'''</small> |
| | | | <small>'''1.6'''</small> |
| === Lustre 1.4.8 ===
| | | <small>June 2010</small> |
| * '''Lustre Manual (HTML) '''[http://wiki.lustre.org/images/7/78/LustreManual.html Lustre 1.4.8 manual v1.37]
| | | <small>[http://wiki.lustre.org/manual/LustreManual16_HTML/index.html Lustre Manual 1.6]</small> |
| | | | <small>[[Media:820-3681_v1_18.pdf|Lustre 1.6 Manual]]</small> |
| * '''Lustre Manual (PDF) '''[http://wiki.lustre.org/images/7/78/LustreManual37.pdf Lustre 1.4.8 manual v1.37 (A4)]
| | |} |
| | |
| * '''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)
| |
| | |
| == Additional Resources ==
| |
| | |
| [http://arch.lustre.org/index.php?title=LustreHLDs Lustre HLDs] | |
| | |
| [http://arch.lustre.org/index.php?title=LustreDLDs Lustre DLDs]
| |
| | |
| [http://wiki.lustre.org/index.php?title=Lustre_Internals Lustre Internals]
| |
| | |
| == 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
| |
