README

   1   _           _
   2  | |         | |
   3  | |_   _ ___| |_ _ __ ___
   4  | | | | / __| __| '__/ _ \
   5  | | |_| \__ | |_| | |  __/
   6  |_|\__,_|___/\__|_|  \___|
   7
   8 Lustre is an open-source, distributed parallel file system designed for
   9 scalability, high-performance, and high-availability.
  10
  11 Lustre is purpose-built to provide a coherent, global POSIX-compliant
  12 namespace for very large scale computer clusters, including the world's
  13 largest supercomputer platforms.
  14
  15 It can support hundreds of petabytes of data storage and terabytes per
  16 second in simultaneous, aggregate throughput.
  17
  18 +---------------+
  19 | Documentation |
  20 +---------------+
  21
  22 More information about Lustre:
  23     http://www.lustre.org/
  24 Many resources for using, configuring, and troubleshooting Lustre are at:
  25     http://wiki.lustre.org/
  26
  27 For in-tree documentation, see the following directories:
  28     Documentation/
  29     lustre/doc/
  30     lnet/doc/
  31
  32 +-----------+
  33 | Community |
  34 +-----------+
  35
  36 The low-volume list for announcements of new releases is at:
  37     http://lists.lustre.org/listinfo.cgi/lustre-announce-lustre.org
  38 The generic Lustre discussion mailing list is available at:
  39     http://lists.lustre.org/listinfo.cgi/lustre-discuss-lustre.org
  40 The Lustre developer mailing list is at:
  41     http://lists.lustre.org/pipermail/lustre-devel-lustre.org
  42
  43 To report bugs, please visit:
  44     https://jira.whamcloud.com/
  45
  46 The official repository is hosted at:
  47     https://git.whamcloud.com/
  48
  49 +----------+
  50 | Building |
  51 +----------+
  52
  53 Detailed instructions for building, configuring and running Lustre:
  54     http://wiki.lustre.org/Compiling_Lustre
  55 and
  56     https://wiki.whamcloud.com/display/PUB/Getting+started+with+Lustre.
  57
  58
  59 To build Lustre:
  60
  61     bash autogen.sh
  62     ./configure
  63     make
  64
  65 To see all available make targets:
  66
  67     make help
  68
  69 +---------+
  70 | Testing |
  71 +---------+
  72
  73 Explanation of Lustre test suites:
  74     https://wiki.lustre.org/Test_Descriptions
  75 and Lustre test environment variables:
  76     https://wiki.whamcloud.com/display/PUB/Lustre+Test+Tools+Environment+Variables
  77
  78
  79 To play with a test Lustre filesystem:
  80
  81     ./lustre/tests/llmount.sh
  82
  83 To run a test on the filesystem:
  84
  85     ./lustre/tests/auster -v sanity --only 1
  86
  87 To clean up:
  88
  89     ./lustre/tests/llmountcleanup.sh
  90
  91 To run LUTF (LNet Unit Test Framework) in a Python virtual environment:
  92
  93     python3 -m venv venv
  94     source venv/bin/activate
  95     pip3 install -r requirements.txt
  96     ./lustre/tests/lutf.sh
  97
  98 +--------------+
  99 | Contributing |
 100 +--------------+
 101
 102 Instructions for contributing patches for Lustre:
 103     http://wiki.lustre.org/Submitting_Changes
 104 and
 105     http://wiki.lustre.org/Using_Gerrit
 106
 107
 108 The Lustre Coding Style Guidelines can be found at:
 109     http://wiki.lustre.org/Lustre_Coding_Style_Guidelines
 110
 111 The Lustre Test Script Style Guidelines can be found at:
 112     http://wiki.lustre.org/Lustre_Script_Coding_Style
 113
 114
 115 In order to improve the quality of patches submitted to the Lustre tree,
 116 it is possible to automatically check every patch and commit against the
 117 Lustre Coding Guidelines.  To do this, run in the top-level lustre/ tree:
 118
 119     cd .git/hooks
 120     ln -s ../../contrib/git-hooks/{prepare-,}commit-msg ./
 121     cd ../..