The Lustre*Software Release 2.x Operations Manual 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.
This document is maintained by Whamcloud in Docbook format. The canonical version is available at https://wiki.whamcloud.com/display/PUB/Documentation.
This document may not contain information about basic UNIX* operating system commands and procedures such as shutting down the system, booting the system, and configuring devices. Refer to the following for this information:
-
Software documentation that you received with your system
-
Red Hat* Enterprise Linux* documentation, which is at: https://docs.redhat.com/docs/en-US/index.html
The Lustre client module is available for many different Linux* versions and distributions. The Red Hat Enterprise Linux distribution is the best supported and tested platform for Lustre servers.
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.
Some examples are listed below, but other prompt combinations are also used as needed for the example.
| Shell | Prompt |
|---|---|
| Regular user | machine$ |
| Superuser (root) | machine# |
| Regular user on the client | client$ |
| Superuser on the MDS | mds# |
| Superuser on the OSS | oss# |
| Superuser on the MGS | mgs# |
| Application | Title | Format | Location |
|---|---|---|---|
| Latest information | Lustre Software Release 2.x Change Logs | Wiki page | Online at https://wiki.whamcloud.com/display/PUB/Documentation |
| Service | Lustre Software Release 2.x Operations Manual | PDFHTML | Online at https://wiki.whamcloud.com/display/PUB/Documentation |
These web sites provide additional resources:
- Documentation http://wiki.whamcloud.com/display/PUB/Documentation http://www.lustre.org
- Support https://jira.whamcloud.com/
The Lustre* File System Release 2.x Operations Manual is a community maintained work. Versions of the manual are continually built as suggestions for changes and improvements arrive. Suggestions for improvements can be submitted through the ticketing system maintained at https://jira.whamcloud.com/browse/LUDOC. Instructions for providing a patch to the existing manual are available at: http://wiki.lustre.org/Lustre_Manual_Changes.
This manual covers a range of Lustre 2.x software releases, currently starting with the 2.5 release. Features specific to individual releases are identified within the table of contents using a shorthand notation (e.g. this paragraph is tagged as a Lustre 2.5 specific feature so that it will be updated when the 2.5-specific tagging is removed), and within the text using a distinct box.
The current version of Lustre that is in use on the node can be found using the command lctl get_param version on any Lustre client or server, for example:
$ lctl get_param version
version=2.10.5
Only the latest revision of this document is made readily available because changes are continually arriving. The current and latest revision of this manual is available from links maintained at:http://lustre.opensfs.org/documentation/.
| Revision History | ||
|---|---|---|
| Revision 0 | Built on 04 January 2022 21:27:24Z Intel Corporation | |
| Continuous build of Manual. |