Contents |
Lustre Documentation
This is home to documentation supporting the Lustre software. Currently, our documentation consists of the Lustre Operations Manual. We are also developing a web-based RAS tool, RAS for Lustre, that offers support pages for various Lustre error messages. Preliminary documentation may be stored on wiki pages. This page contains links to various bits of Lustre documentation.
Lustre Operations Manual
The Lustre Operations Manual is the primary source of documentation about the Lustre file system.
The manual covers the Lustre product, providing users with installation, configuration, tuning, monitoring and troubleshooting information. Different versions of the Operations Manual support different versions of Lustre software.
To determine which version of the Operations Manual supports the Lustre software you are using, refer to the table below. For your convenience, the latest version of the Lustre Operations Manual are available in both HTML and PDF.
| Lustre Manual Version | Supported Lustre Version | Manual Release Date | HTML | |
|---|---|---|---|---|
| Lustre_1.8_man_v1.2 | 1.8 | October 20, 2009 | Lustre Manual 1.8 | Lustre Manual 1.8 |
| Lustre_1.6_man_v1.17 | 1.6 | October 29, 2009 | Lustre Manual 1.6 | Lustre Manual 1.6 |
| Lustre_1.4.8.1_man_v37 | 1.4.10 | February 9, 2007 | N/A | Lustre Manual 1.4.8 |
| 1.4.9 | ||||
| 1.4.8 | ||||
| Lustre_1.4.7.1_man_v36 | 1.4.7 | November 30, 2006 | N/A | Lustre Manual 1.4.7 |
| Lustre_1.4.6.1_man_v34 | 1.4.6 | August 8, 2006 | N/A | Lustre Manual 1.4.6 |
To see the specific changes and updates to each version of the Lustre Operations Manual, refer to the Version Log at the back of the manual.
Additional Resources
In addition to the Lustre manual, there are a number of other Lustre resources that users may find helpful.
HLDs and DLDs
High-Level Designs (HLDs) and Detail-Level Designs (DLDs) for Lustre are now publicly available.
HLDs describe overall system design in terms of functional architecture. HLDs in their native LyX format can be downloaded from the CVS repository. Alternately, PDFs of the HLDs are also available. Lustre HLDs
DLDs are created from HLDs, and provide detailed designs of features and functionality. DLDs in their native LyX format can be downloaded from the CVS repository. Alternately, PDFs of the DLDs are also available. Lustre DLDs
Lustre Internals
Lustre internals are now publicly available, and include Lustre architecture, log analysis, and a sample Lustre implementation. This information was previously taught as an extension of the Lustre Advanced (L2) training course. Lustre Internals
pCIFS
pCIFS(tm) is an enhancement of the Windows OS that gives Windows parallel I/O access to Lustre. pCIFS is not a full client file system, it is just a filter driver. pCIFS uses the CIFS protocol to communicate with CIFS servers (Samba) running on Lustre nodes.
pCIFS is a proprietary product, available under commercial license from Sun Microsystems, Inc. Beta evaluations are available to current Lustre customers through your sales representative.
Documentation to install and configuration pCIFS for use with Lustre is available here.
RAS for Lustre
RAS for Lustre is a web-based tool that helps users understand and interpret events in Lustre and take appropriate steps to recover from errors. Visit ras.lustre.org to look up error codes generated by Lustre, find detailed explanations of error messages, and link to recommended actions for Lustre events.
