Whamcloud - gitweb
land b1_5 onto HEAD
[fs/lustre-release.git] / lustre / doc / lustre.7
1 .\" -*- nroff -*-
2 .\" Copyright 2006 by Cluster FileSystems.  All Rights Reserved.
3 .\" This file may be copied under the terms of the GNU Public License.
4 .\"
5 .TH Lustre 7 "2006 Jun 15" Lustre "A high-performance cluster file system"
6 .SH NAME
7 Lustre
8 .SH SYNOPSIS
9 A high-performance file system designed for clusters.
10 .SH DESCRIPTION
11 .B LustreĀ®
12 is a high-performance, massively-scalable, POSIX-compliant network file system
13 designed for the world's largest high-performance compute clusters. Lustre
14 is under active development from Cluster FileSystems (http://clusterfs.com).
15
16 Lustre filesystems are made up of multiple servers typically distributed
17 across multiple nodes.  Lustre clients can contact these server nodes over
18 multiple high-speed network fabrics via LNET, the Lustre NETworking
19 system.  Clients then present the filesystem at a mount point.
20
21 A filesystem is comprised of a 
22 .I MDT
23 , MetaData Target, which stores directory and file meta-information, and a
24 series of 
25 .I OSTs
26 , Object Storage Targets, which hold the file data.  There is typically not
27 a 1:1 mapping of a file on disk and what is presented as a file on a Lustre client.
28
29 Lustre and LNET are implemented as a series of kernel modules, for both
30 servers and clients. LNET networks are defined in the modprobe.conf file on
31 all nodes.  Lustre and LNET make extensive use of /proc files for making
32 system data available, for example
33 .TP
34 .B /proc/sys/lnet/nis
35 to show the local LNET Network Interfaces.
36 .TP
37 .B /proc/fs/lustre/devices
38 to show locally running Lustre objects.
39
40 .SH COMMANDS
41 .TP
42 .B mkfs.lustre(8)
43 Format a physical disk for use as a Lustre server's backend storage (aka
44 target).
45 .TP
46 .B tunefs.lustre(8)
47 Modify configuration information on a Lustre target disk.
48 .TP
49 .B mount.lustre(8)
50 A helper program for
51 .BR mount (8)
52 that starts Lustre servers and clients.
53 .TP
54 .B lctl(8)
55 A low-level interface to control various aspects of Lustre
56 .TP
57 .B lfs(1)
58 A user-level interface to control Lustre-specific information for
59 individual files. 
60 .B lustre_config.sh
61 Format multiple Lustre targets simultaneously from definitions in a CSV
62 file.
63 .SH BUGS
64 Please report all bugs to Cluster FileSystems, support@clusterfs.com
65 .SH AVAILABILITY
66 .B The
67 .BR Lustre (7) 
68 filesystem package is available from CFS
69 .br
70 http://clusterfs.com
71 .SH SEE ALSO
72 .BR mkfs.lustre (8),
73 .BR tunefs.lustre (8),
74 .BR mount.lustre (8),
75 .BR lctl (8),
76 .BR lfs (1)