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 hundreds of
  16 gigabytes per second in simultaneous, aggregate throughput.
  17
  18
  19 More information about Lustre:
  20     http://www.lustre.org/
  21 Many resources for using, configuring, and troubleshooting Lustre are at:
  22     http://wiki.lustre.org/
  23
  24 +-----------+
  25 | Community |
  26 +-----------+
  27
  28 The low-volume list for announcements of new releases is at:
  29     http://lists.lustre.org/listinfo.cgi/lustre-announce-lustre.org
  30 The generic Lustre discussion mailing list is available at:
  31     http://lists.lustre.org/listinfo.cgi/lustre-discuss-lustre.org
  32 The Lustre developer mailing list is at:
  33     http://lists.lustre.org/pipermail/lustre-devel-lustre.org
  34
  35 To report bugs, please visit:
  36     https://jira.whamcloud.com/
  37
  38 The official repository is hosted at:
  39     https://git.whamcloud.com/
  40
  41 +----------------------+
  42 | Building and Testing |
  43 +----------------------+
  44
  45 Detailed instructions for building, configuring and running Lustre:
  46     http://wiki.lustre.org/Compiling_Lustre
  47 and
  48     https://wiki.whamcloud.com/display/PUB/Getting+started+with+Lustre.
  49
  50
  51 To build Lustre:
  52
  53     bash autogen.sh
  54     ./configure
  55     make
  56
  57 To see all available make targets:
  58
  59     make help
  60
  61 To play with a test Lustre filesystem:
  62
  63     ./lustre/tests/llmount.sh
  64
  65 To clean up:
  66
  67     ./lustre/tests/llmountcleanup.sh
  68
  69 +--------------+
  70 | Contributing |
  71 +--------------+
  72
  73 Instructions for contributing patches for Lustre:
  74     http://wiki.lustre.org/Submitting_Changes
  75 and
  76     http://wiki.lustre.org/Using_Gerrit
  77
  78
  79 The Lustre Coding Style Guidelines can be found at:
  80     http://wiki.lustre.org/Lustre_Coding_Style_Guidelines
  81
  82 The Lustre Test Script Style Guidelines can be found at:
  83     http://wiki.lustre.org/Lustre_Script_Coding_Style
  84
  85
  86 In order to improve the quality of patches submitted to the Lustre tree,
  87 it is possible to automatically check every patch and commit against the
  88 Lustre Coding Guidelines.  To do this, run in the top-level lustre/ tree:
  89
  90     cd .git/hooks
  91     ln -s ../../contrib/git-hooks/{prepare-,}commit-msg ./
  92     cd ../..