Obsolete Lustre Wiki - User contributions [en]

Contribution Policy

2007-05-21T16:12:39Z

Lucy: /* Submitting Patches for Review */

= Lustre Check-in Policy =

== Submitting Patches for Review ==

To have your changes accepted into a mainline Lustre branch, you must have your code reviewed and approved. The following steps will speed up your review and increase the likelihood of success:

1. Read, complete, and return the form found at http://www.lustre.org/contribute.html We can't accept your contributions without it.

2. Generate a patch with the "-upN" flags to diff or cvs diff. Please don't send other kinds of patches unless your reviewer requests them.

3. Find or file a bug for your issue at http://bugzilla.lustre.org/ . Read the Bugzilla user guide for more information.

4. Attach your patch as an Attachment (not a comment):
* Provide the patch as an Attachment, and select the Patch box.
* Edit the new attachment. Under "Flags" select "Review" and the question mark.
* Enter the email address of the person who should review. If you haven't been collaborating with someone, and don't know who should review your work, try [mailto:bugs@clusterfs.com bugs@clusterfs.com]
* Submit the attachment update.

5. One or more reviewers will submit comments regarding your patch. Iterate until you receive approval on the patch or the bug is closed.

6. Once you have approval, commit the patch (or ask for it to be committed for you, if you don't have CVS access). Note the bug number and reviewer in the commit message, along with a concise description of the change.

This applies even if you have write access to the CVS tree -- if you don't follow these steps, expect your changes to be backed out of the tree without warning. We have to be strict, or the chaos becomes unbearable.

== Branches ==

Our current policy is that anyone may create and maintain a private branch in CVS. We ask, however, that you observe the best practices outlined in this document. It will save you a lot of effort, I promise.

----
*'''[http://wiki.lustre.org/index.php?title=Front_Page FrontPage]'''

Patchless Client

2007-05-21T15:34:00Z

Lucy: /* Patchless Client */

== Patchless Client ==
As of Lustre 1.6.0, Lustre supports running the client modules on some unpatched "stock" kernels.
This results in some small performance losses, but may be worthwhile to some users for maintenance or contract reasons.

We will typically post a "patchless" RPM at the [http://www.lustre.org/downloads.html download site]. Instead, if building from source, the Lustre configure script will automatically detect the unpatched kernel and disable building the servers.

[lustre]$ ./configure --with-linux=/unpatched/kernel/source

=== Versions ===
Currently, the patchless client works with these kernel versions

Vanilla kernel:
* 2.6.15 (1.6.0)
* 2.6.16 (1.6.0)
* 2.6.17 (1.6.0) Mandriva's 2.6.17 is also reported working.
* 2.6.18 (1.6.0)
* 2.6.19 (1.6.0)
* 2.6.20 (1.6.1 [https://bugzilla.lustre.org/show_bug.cgi?id=11647 bug 11647])
* 2.6.21 (1.6.1 [https://bugzilla.lustre.org/show_bug.cgi?id=11647 bug 11647])

Red Hat Enterprise Linux:
* RHEL4 [2.6.9-42.0.8EL] (1.6.0) with the following caveats:
- Nested Symlinks: due to improper lookup_continue logic with unpatched 2.6.15
kernels and earlier, nested symlinks will lead to unpredictable results
- FMODE_EXEC missing: Lustre will incorrectly allow a user from one client to
write/truncate a binary simultaneously while a user from a different client
executes the same binary
* RHEL4U5 [2.6.9-55EL] (1.6.0) Red Hat has includesd a Lustre-specific patch
with RHEL4U5 which resolves the above issues.

* RHEL5 (1.6.1 [https://bugzilla.lustre.org/show_bug.cgi?id=11647 bug 11647])

Fedora Core:
* FC6 (1.6.1 [https://bugzilla.lustre.org/show_bug.cgi?id=11647 bug 11647])

Suse:
* SLES 10 (tbd)

=== Known Issues ===

many NFS-related bugs are also addressed by the patchless client fixes.

Contribution Policy

2007-05-18T09:52:59Z

Lucy: /* Submitting Patches for Review */

= Lustre Check-in Policy =

== Submitting Patches for Review ==

To have your changes accepted into a mainline Lustre branch, you must have your code reviewed and approved. The following steps will speed up your review and increase the likelihood of success:

1. Read, complete, and return the form found at http://www.lustre.org/contribute.html We can't accept your contributions without it.

2. Generate a patch with the "-upN" flags to diff or cvs diff. Please don't send other kinds of patches unless your reviewer requests them.

3. Find or file a bug for your issue at http://bugzilla.lustre.org/ . Read the Bugzilla user guide for more information.

4. Attach your patch as an Attachment (not a comment):
* Provide the patch as an Attachment, and select the Patch box.
* Edit the new attachment. Under "Flags" select "Review" and the question mark.
* Enter the email address of the person who should review. If you haven't been collaborating with someone, and don't know who should review your work, try bugs@clusterfs.com
* Submit the attachment update.

5. One or more reviewers will submit comments regarding your patch. Iterate until you receive approval on the patch or the bug is closed.

6. Once you have approval, commit the patch (or ask for it to be committed for you, if you don't have CVS access). Note the bug number and reviewer in the commit message, along with a concise description of the change.

This applies even if you have write access to the CVS tree -- if you don't follow these steps, expect your changes to be backed out of the tree without warning. We have to be strict, or the chaos becomes unbearable.

== Branches ==

Our current policy is that anyone may create and maintain a private branch in CVS. We ask, however, that you observe the best practices outlined in this document. It will save you a lot of effort, I promise.

----
*'''[http://wiki.lustre.org/index.php?title=Front_Page FrontPage]'''

Coding Guidelines

2007-05-18T09:51:30Z

Lucy: /* Great detail */

All Lustre developers should follow the guidelines in this page very strictly to avoid problems during code merges later on. Please make the required changes to the default formatting rules in the editor you use to comply to the guidelines below.

== Guidelines ==

1. There should be no tabs in any files.

2. Blocks should be indented by 8 spaces.

3. New files should contain the following along with the license boilerplate. This will cause vim and emacs to use spaces instead of tabs for indenting. If you use a different editor, it also needs to be set to use spaces for indening Lustre code.

/* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
* vim:expandtab:shiftwidth=8:tabstop=8:
*/

4. All lines should wrap at 80 characters. If it's getting too hard to wrap there, you probably need to break it up into more functions. In some cases, it is acceptable to remove a few spaces between function arguments to avoid overflowing onto the next line.

5. Don't have spaces or tabs on blank lines or at the end of lines.

6. Don't use "inline" unless you're doing something so performance critical that the function call overhead will make a difference -- in other words: never. It makes debugging harder.

All of our wrapping, parenthesis, brace placement, etc. rules are basically Linux kernel rules, which are basically K&R. For those of you in need of a refresher, great detail is provided below.

== Great detail ==

a. When you wrap, the next line should start after the parenthesis:

right:

variable = do_something_complicated(long_argument, longer_argument,
longest_argument(sub_argument,
foo_argument),
last_argument);

if (some_long_condition(arg1, arg2, arg3) < some_long_value &&
another_long_condition(very_long_argument_name,
another_long_argument_name) >
second_long_value) {
}

wrong:

variable = do_something_complicated(long_argument, longer_argument,
longest_argument(sub_argument, foo_argument),
last_argument);

if (some_long_condition(arg1, arg2, arg3) < some_long_value &&
another_long_condition(very_long_argument_name,
another_long_argument_name) >
second_long_value) {
}

b. If you're wrapping put the operators at the end of the line, and if there are no parentheses indent 8 more:

off = le32_to_cpu(fsd->fsd_client_start) +
cl_idx * le16_to_cpu(fsd->fsd_client_size);

c. Binary and ternary (but not unary) operators should be separated from their arguments by one space.

a++;
b |= c;
d = f > g ? 0 : 1;

d. Function calls should be nestled against the parentheses, the parentheses should crowd the arguments, and one space after commas:

right: do_foo(bar, baz);
wrong: do_foo ( bar,baz );

e. All ''if'', ''for'', ''while'', etc. expressions should be separated by a space from the parenthesis, one space after the semicolons:

for (a = 0; a < b; a++)
if (a < b || a == c)
while (1)

f. Opening braces should be on the same line as the line that introduces the block, except for function calls. Closing braces get their own line, except for "else".

int foo(void)
{
if (bar) {
this();
that();
} else if (baz) {
;
} else {
;
}
do {
cow();
} while (0);
}

g. If one part of a compound ''if'' block has braces, all should.

right:

if (foo) {
bar();
baz();
} else {
salmon();
}

wrong:

if (foo) {
bar();
baz();
} else
moose();

h. When you make a macro, protect those who might call it by using do/while and parentheses; line up your backslashes:

right:

#define DO_STUFF(a) \
do { \
int b = (a) + MAGIC; \
do_other_stuff(b); \
} while (0)

wrong:

#define DO_STUFF(a) \
{ \
int b = a + MAGIC; \
do_other_stuff(b); \
}

i. If you nest preprocessor commands, use spaces to visually delineate:

#ifdef __KERNEL__
# include <goose>
# define MOOSE steak
#else
# include <mutton>
# define MOOSE prancing
#endif

j. For very long #ifdefs include the conditional with each #endif to make it readable:

#ifdef __KERNEL__
# if LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0)
/* lots
of
stuff */
# endif /* KERNEL_VERSION(2,5,0) */
#else /* !__KERNEL__ */
# if HAVE_FEATURE
/* more
* stuff */
# endif
#endif /* __KERNEL__ */

k. Comments should have the leading '''/*''' on the same line as the comment, and the trailing '''*/''' at the end of the last comment line. Intermediate lines should start with a '''*''' aligned with the first line's '''*''':
/* This is a short comment */

/* This is a multi-line comment. I wish the line would wrap already,
* as I don't have much to write about. */

l. Function declarations absolutely should NOT go into .c files, unless they are forward declarations for static functions that can't otherwise be moved before the caller. Instead, the declaration should go into the most "local" header available (preferrably *_internal.h for a given piece of code).

m. Structure and constant declarations should not be declared in multiple places. Put the struct into the most "local" header possible. If it is something that is passed over the wire it needs to go into lustre_idl.h, and needs to be correctly swabbed when the RPC message is unpacked.

n. The types and printf/printk formats used by Lustre code are:

__u64 LPU64/LPX64/LPD64 (unsigned, hex, signed)
size_t LPSZ (or cast to int and use %u / %d)
__u32/int %u/%x/%d (unsigned, hex, signed)
(unsigned) long long %llu/%llx/%lld
loff_t %lld after a cast to long long (unfortunately)

----
*'''[http://wiki.lustre.org/index.php?title=Front_Page FrontPage]'''

Coding Guidelines

2007-05-18T09:50:49Z

Lucy: /* Guidelines */

All Lustre developers should follow the guidelines in this page very strictly to avoid problems during code merges later on. Please make the required changes to the default formatting rules in the editor you use to comply to the guidelines below.

== Guidelines ==

1. There should be no tabs in any files.

2. Blocks should be indented by 8 spaces.

3. New files should contain the following along with the license boilerplate. This will cause vim and emacs to use spaces instead of tabs for indenting. If you use a different editor, it also needs to be set to use spaces for indening Lustre code.

/* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
* vim:expandtab:shiftwidth=8:tabstop=8:
*/

4. All lines should wrap at 80 characters. If it's getting too hard to wrap there, you probably need to break it up into more functions. In some cases, it is acceptable to remove a few spaces between function arguments to avoid overflowing onto the next line.

5. Don't have spaces or tabs on blank lines or at the end of lines.

6. Don't use "inline" unless you're doing something so performance critical that the function call overhead will make a difference -- in other words: never. It makes debugging harder.

All of our wrapping, parenthesis, brace placement, etc. rules are basically Linux kernel rules, which are basically K&R. For those of you in need of a refresher, great detail is provided below.

== Great detail ==

a. When you wrap, the next line should start after the parenthesis:

right:

variable = do_something_complicated(long_argument, longer_argument,
longest_argument(sub_argument,
foo_argument),
last_argument);

if (some_long_condition(arg1, arg2, arg3) < some_long_value &&
another_long_condition(very_long_argument_name,
another_long_argument_name) >
second_long_value) {
}

wrong:

variable = do_something_complicated(long_argument, longer_argument,
longest_argument(sub_argument, foo_argument),
last_argument);

if (some_long_condition(arg1, arg2, arg3) < some_long_value &&
another_long_condition(very_long_argument_name,
another_long_argument_name) >
second_long_value) {
}

b. If you're wrapping put the operators at the end of the line, and if there are no parentheses indent 8 more:

off = le32_to_cpu(fsd->fsd_client_start) +
cl_idx * le16_to_cpu(fsd->fsd_client_size);

c. Binary and ternary (but not unary) operators should be separated from their arguments by one space.

a++;
b |= c;
d = f > g ? 0 : 1;

d. Function calls should be nestled against the parentheses, the parentheses should crowd the arguments, and one space after commas:

right: do_foo(bar, baz);
wrong: do_foo ( bar,baz );

e. All ''if'', ''for'', ''while'', etc. expressions should be separated by a space from the parenthesis, one space after the semicolons:

for (a = 0; a < b; a++)
if (a < b || a == c)
while (1)

f. Opening braces should be on the same line as the line that introduces the block, except for function calls. Closing braces get their own line, except for "else".

int foo(void)
{
if (bar) {
this();
that();
} else if (baz) {
;
} else {
;
}
do {
cow();
} while (0);
}

g. If one part of a compound ''if'' block has braces, all should.

right:

if (foo) {
bar();
baz();
} else {
salmon();
}

wrong:

if (foo) {
bar();
baz();
} else
moose();

h. When you make a macro, protect those who might call it by using do/while and parentheses; line up your backslashes:

right:

#define DO_STUFF(a) \
do { \
int b = (a) + MAGIC; \
do_other_stuff(b); \
} while (0)

wrong:

#define DO_STUFF(a) \
{ \
int b = a + MAGIC; \
do_other_stuff(b); \
}

i. If you nest preprocessor commands, use spaces to visually delineate:

#ifdef __KERNEL__
# include <goose>
# define MOOSE steak
#else
# include <mutton>
# define MOOSE prancing
#endif

j. For very long #ifdefs include the conditional with each #endif to make it readable:

#ifdef __KERNEL__
# if LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0)
/* lots
of
stuff */
# endif /* KERNEL_VERSION(2,5,0) */
#else /* !__KERNEL__ */
# if HAVE_FEATURE
/* more
* stuff */
# endif
#endif /* __KERNEL__ */

k. Comments should have the leading '''/*''' on the same line as the comment, and the trailing '''*/''' at the end of the last comment line. Intermediate lines should start with a '''*''' aligned with the first line's '''*''':

/* This is a short comment */

/* This is a multi-line comment. I wish the line would wrap already,
* as I don't have much to write about. */

l. Function declarations absolutely should NOT go into .c files, unless they are forward declarations for static functions that can't otherwise be moved before the caller. Instead, the declaration should go into the most "local" header available (preferrably *_internal.h for a given piece of code).

m. Structure and constant declarations should not be declared in multiple places. Put the struct into the most "local" header possible. If it is something that is passed over the wire it needs to go into lustre_idl.h, and needs to be correctly swabbed when the RPC message is unpacked.

n. The types and printf/printk formats used by Lustre code are:

__u64 LPU64/LPX64/LPD64 (unsigned, hex, signed)
size_t LPSZ (or cast to int and use %u / %d)
__u32/int %u/%x/%d (unsigned, hex, signed)
(unsigned) long long %llu/%llx/%lld
loff_t %lld after a cast to long long (unfortunately)

----
*'''[http://wiki.lustre.org/index.php?title=Front_Page FrontPage]'''

Simul Parallel File System Test Tool

2007-05-18T08:54:12Z

Lucy: /* simul */

== simul ==

simul (available in the usual spot on the ftp site, or in ~morrone on MCR) tests most filesystem syscalls from one or more threads on one or more nodes. Building simul is straightforward.

It is easily run with either pdsh or prun. On MCR, this amounts to:

pdsh -E -w <node list> [-n tasks-per-node] /path/simul -d /mnt/lustre/path/

Using prun is left as an exercise to the reader.

----
* '''[http://wiki.lustre.org/index.php?title=Front_Page FrontPage]'''

Lustre Documentation

2007-05-18T04:17:40Z

Lucy: /* Older Documentation */

= Lustre Documentation =
== Lustre Manual ==

=== Lustre 1.6 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual1_6.html Lustre 1.6 manual V1.1]
* '''Lustre Manual - PDF'''
** ''''''[http://wiki.lustre.org/images/7/78/LustreManual1_6.pdf Lustre 1.6 manual V1.1(A4)]
**''''''[http://wiki.lustre.org/images/7/78/LustreManual-letter1_6.pdf Lustre 1.6 manual V1.1(Letter)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog1_6.html Lustre Manual-Change log]
* '''[http://wiki.lustre.org/index.php?title=Mount_Conf MountConf wiki]''' - A quick reference for those familiar with older versions of Lustre

=== Lustre 1.4.8 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual.html Lustre 1.4.8 manual V1.37]
* '''Lustre Manual - PDF'''
** ''''''[http://wiki.lustre.org/images/7/78/LustreManual37.pdf Lustre 1.4.8 manual V1.37(A4)]
** '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog.html Lustre Manual-Change log]

== Interim Lustre 1.8 Documentation ==
* '''[http://wiki.lustre.org/index.php?title=Kerb_Lustre KerbLustre]''' - The 1.8 interim Lustre documentation (Kerberos....)

== Older Documentation ==
This documentation will be incorporated into the manual. Until that is done you may find useful bits and pieces here.

* '''Frequently Asked Questions'''
** [http://www.clusterfs.com/faq.html Lustre Faq]
* '''Knowledge Base'''
** [http://bugzilla.lustre.org/showdependencytree.cgi?id=2374 Lustre Knowledge Base] - questions and answers
* '''Configuration'''
** [http://wiki.lustre.org/index.php?title=Lustre_Howto LustreHowto]''' - A guide to getting Lustre cluster started.
** [http://wiki.lustre.org/index.php?title=Lustre_LDAP LustreLDAP]''' - A guide for using LDAP with Lustre.
** [http://wiki.lustre.org/index.php?title=Lustre_Wizard LustreWizard]''' - The ''Lustre wizard'' or ''lwizard'' is a utility that helps with creation of configuration file for a cluster through asking some simple questions.
** [http://wiki.lustre.org/index.php?title=Lustre_Failover LustreFailover]''' - Managing failover
** [http://wiki.lustre.org/index.php?title=Filesystem_Backup FilesystemBackup]''' - How to back up a Lustre filesystem
** [http://wiki.lustre.org/index.php?title=Fsck_Suppor FsckSupport]''' - The lustre fsck tool and Lustre-patched e2fsck (extents, large inode/EA support)
** '''Filesystem Tuning'''
*** [http://wiki.lustre.org/images/7/78/LustreManual.html#Chapter_III-2._LustreProc LustreProc] - A guide on the '''proc''' tunables parameters for Lustre and their usage. It describes several of the ''proc'' tunables including those that effect the client's RPC behaviour and prepare for a substantial reorganization of proc entries.
*** '''[http://wiki.lustre.org/images/7/78/LustreManual.html#3.2_DDN_Tuning LustreDdnTuning]''' - A brief guide on tuning DDN S2A 8500 (and maybe 9500) storage optimally for Lustre

LibLustre How-To Guide

2007-05-18T03:53:20Z

Lucy: /* running programs over liblustre */

= Liblustre A How to Guide =
== Liblustre Introduction ==

A library version of the Lustre client file system is now available for some versions of Lustre, it gives an user application linked with the library access to Lustre file systems without the need to mount Lustre (VFS) on the client. The key goals for the library are to provide a portable mechanism to access Lustre from different POSIX compliant operating systems, to provide access from microkernel based systems and from the Windows operating system.

Currently, liblustre is still under development and only works on linux (i386 & x86_64, not tested on ia64).

In this document, we will discuss how to use liblustre.

'''Note that liblustre is NOT a required element of Lustre.'''
liblustre is not required or even recommended for running Lustre on Linux, you should instead use the Lustre (VFS) client filesystem to mount Lustre directly.

Generally speaking, liblustre implements the Lustre client filesystem in user space. The liblustre component links LNET and libsysio together to form a shared library which could be used by applications to perform File I/O.

== Building clients and servers for the Lustre library version ==

When using liblustre, servers are first built/configured in the usual way as described in [https://projects.clusterfs.com/lustre/LustreHowto Guide to Lustre]. liblustre is built by default unless "./configure --disable-liblustre" is specified.

The liblustre files are located in lustre/liblustre:
* liblustre/liblustre.so
* liblustre/tests/

== How to use liblustre ==

First of all you must be running Lustre servers (MDS/OSTs) without ACLs and accepting connections on insecure ports. For example, add '''options lnet networks=tcp(eth0) accept=all''' to /etc/modprobe.conf, then run the script '''MDS_MOUNT_OPTS="noacl" sh llmount.sh'''. This will set up a MDS, OST, and client on the local machine. You should umount the Lustre client at /mnt/lustre.

=== Mount Target ===

liblustre needs to know ''mount target'' before connect to lustre server. the format is like following:

mds_nid:/mds_name/profile_name

* '''mds_nid''' is actually the hostname of MDS (or IP address if you don't have proper name resolution set up).
* '''mds_name''' is the name of the MDS. In the .xml file, it appears in following line:

<mds uuid='mds_uuid' name='mds_name'>

* '''profile''' is the profile name of the client mountpoint, often '''client''' in many configs.

Please refer to lustre documents for more mount target explaination. This can be passed to most liblustre programs via the environment variable LIBLUSTRE_MOUNT_TARGET.

=== sanity test ===

there's a statically built-in liblustre test program at ''lustre/liblustre/tests/sanity''. you could use it to verify whether liblustre work properly:

sanity --target mds_nid:/mdsname/profile_name

=== How It Works ===
If we run a program, e.g. iozone, we'll use LD_PRELOAD to load ''liblustre.so'' at first. The start function of ''liblustre.so'' will mount a lustre partion on certain dir, e.g. /mnt/lustre. Furthermore, following loaded iozone's functions calls such as open/read/write... will dynamically linked with the implementations in ''liblustre.so'' instead of ''libc'' in the usually case. Thus we could intercept the filesystem related system calls and translate into lustre commands.

=== Necessary Environment Variables ===
There's a simple script ''lustre/utils/lrun'' which set some ENVs:
a. mount point

LIBLUSTRE_MOUNT_POINT=${LIBLUSTRE_MOUNT_POINT:-"/mnt/lustre"}

this is where liblustre will mount remote lustre filesystem. default is ''/mnt/lustre'', please make sure it exist on your system:

b. mount target

LIBLUSTRE_MOUNT_TARGET=${LIBLUSTRE_MOUNT_TARGET:-"your_mount_target"}

you need fill in the actual target before using liblustre (e.g. mdshost:/mdsname/client).

c. shared library

LD_PRELOAD=${LD_PRELOAD:-"/usr/lib/liblustre.so"}

make sure you'v install lustre/liblustre/liblustre.so into the this place.

=== running programs over liblustre ===
Until now, only a very small number of applications have been tested with liblustre:
* iozone
* IOR
* simul

and also several standard unix command:
* ls
* touch
* rm
* mkdir
* rmdir
* mv
* cp
* find
* grep

You need prepend 'lrun' before the programs you intend to run:

lrun iozone -f /mnt/lustre/ioz_testfile -r 256k -s 1g

lrun mkdir /mnt/lustre/testdir
lrun touch /mnt/lustre/testdir/testfile
lrun cp /etc/fstab /mnt/lustre/testdir
lrun ls /mnt/lustre/testdir
lrun find /mnt/lustre/
lrun .....

'''Important Note'''
liblustre is somewhat sensitive to glibc version, what we are using is glibc-2.2.5 and glic-2.3.2.
----
*'''[http://wiki.lustre.org/index.php?title=Front_Page FrontPage]'''

LibLustre How-To Guide

2007-05-18T03:50:17Z

Lucy: /* Necessary Environment Variables */

= Liblustre A How to Guide =
== Liblustre Introduction ==

A library version of the Lustre client file system is now available for some versions of Lustre, it gives an user application linked with the library access to Lustre file systems without the need to mount Lustre (VFS) on the client. The key goals for the library are to provide a portable mechanism to access Lustre from different POSIX compliant operating systems, to provide access from microkernel based systems and from the Windows operating system.

Currently, liblustre is still under development and only works on linux (i386 & x86_64, not tested on ia64).

In this document, we will discuss how to use liblustre.

'''Note that liblustre is NOT a required element of Lustre.'''
liblustre is not required or even recommended for running Lustre on Linux, you should instead use the Lustre (VFS) client filesystem to mount Lustre directly.

Generally speaking, liblustre implements the Lustre client filesystem in user space. The liblustre component links LNET and libsysio together to form a shared library which could be used by applications to perform File I/O.

== Building clients and servers for the Lustre library version ==

When using liblustre, servers are first built/configured in the usual way as described in [https://projects.clusterfs.com/lustre/LustreHowto Guide to Lustre]. liblustre is built by default unless "./configure --disable-liblustre" is specified.

The liblustre files are located in lustre/liblustre:
* liblustre/liblustre.so
* liblustre/tests/

== How to use liblustre ==

First of all you must be running Lustre servers (MDS/OSTs) without ACLs and accepting connections on insecure ports. For example, add '''options lnet networks=tcp(eth0) accept=all''' to /etc/modprobe.conf, then run the script '''MDS_MOUNT_OPTS="noacl" sh llmount.sh'''. This will set up a MDS, OST, and client on the local machine. You should umount the Lustre client at /mnt/lustre.

=== Mount Target ===

liblustre needs to know ''mount target'' before connect to lustre server. the format is like following:

mds_nid:/mds_name/profile_name

* '''mds_nid''' is actually the hostname of MDS (or IP address if you don't have proper name resolution set up).
* '''mds_name''' is the name of the MDS. In the .xml file, it appears in following line:

<mds uuid='mds_uuid' name='mds_name'>

* '''profile''' is the profile name of the client mountpoint, often '''client''' in many configs.

Please refer to lustre documents for more mount target explaination. This can be passed to most liblustre programs via the environment variable LIBLUSTRE_MOUNT_TARGET.

=== sanity test ===

there's a statically built-in liblustre test program at ''lustre/liblustre/tests/sanity''. you could use it to verify whether liblustre work properly:

sanity --target mds_nid:/mdsname/profile_name

=== How It Works ===
If we run a program, e.g. iozone, we'll use LD_PRELOAD to load ''liblustre.so'' at first. The start function of ''liblustre.so'' will mount a lustre partion on certain dir, e.g. /mnt/lustre. Furthermore, following loaded iozone's functions calls such as open/read/write... will dynamically linked with the implementations in ''liblustre.so'' instead of ''libc'' in the usually case. Thus we could intercept the filesystem related system calls and translate into lustre commands.

=== Necessary Environment Variables ===
There's a simple script ''lustre/utils/lrun'' which set some ENVs:
a. mount point

LIBLUSTRE_MOUNT_POINT=${LIBLUSTRE_MOUNT_POINT:-"/mnt/lustre"}

this is where liblustre will mount remote lustre filesystem. default is ''/mnt/lustre'', please make sure it exist on your system:

b. mount target

LIBLUSTRE_MOUNT_TARGET=${LIBLUSTRE_MOUNT_TARGET:-"your_mount_target"}

you need fill in the actual target before using liblustre (e.g. mdshost:/mdsname/client).

c. shared library

LD_PRELOAD=${LD_PRELOAD:-"/usr/lib/liblustre.so"}

make sure you'v install lustre/liblustre/liblustre.so into the this place.

=== running programs over liblustre ===
Until now, only a very small number of applications have been tested with liblustre:
* iozone
* IOR
* simul

and also several standard unix command:
* ls
* touch
* rm
* mkdir
* rmdir
* mv
* cp
* find
* grep

You need prepend 'lrun' before the programs you intend to run:
{{{
lrun iozone -f /mnt/lustre/ioz_testfile -r 256k -s 1g

lrun mkdir /mnt/lustre/testdir
lrun touch /mnt/lustre/testdir/testfile
lrun cp /etc/fstab /mnt/lustre/testdir
lrun ls /mnt/lustre/testdir
lrun find /mnt/lustre/
lrun .....
}}}

'''Important Note'''
liblustre is somewhat sensitive to glibc version, what we are using is glibc-2.2.5 and glic-2.3.2.
----
*'''FrontPage'''

LibLustre How-To Guide

2007-05-18T03:49:23Z

Lucy: /* sanity test */

= Liblustre A How to Guide =
== Liblustre Introduction ==

A library version of the Lustre client file system is now available for some versions of Lustre, it gives an user application linked with the library access to Lustre file systems without the need to mount Lustre (VFS) on the client. The key goals for the library are to provide a portable mechanism to access Lustre from different POSIX compliant operating systems, to provide access from microkernel based systems and from the Windows operating system.

Currently, liblustre is still under development and only works on linux (i386 & x86_64, not tested on ia64).

In this document, we will discuss how to use liblustre.

'''Note that liblustre is NOT a required element of Lustre.'''
liblustre is not required or even recommended for running Lustre on Linux, you should instead use the Lustre (VFS) client filesystem to mount Lustre directly.

Generally speaking, liblustre implements the Lustre client filesystem in user space. The liblustre component links LNET and libsysio together to form a shared library which could be used by applications to perform File I/O.

== Building clients and servers for the Lustre library version ==

When using liblustre, servers are first built/configured in the usual way as described in [https://projects.clusterfs.com/lustre/LustreHowto Guide to Lustre]. liblustre is built by default unless "./configure --disable-liblustre" is specified.

The liblustre files are located in lustre/liblustre:
* liblustre/liblustre.so
* liblustre/tests/

== How to use liblustre ==

First of all you must be running Lustre servers (MDS/OSTs) without ACLs and accepting connections on insecure ports. For example, add '''options lnet networks=tcp(eth0) accept=all''' to /etc/modprobe.conf, then run the script '''MDS_MOUNT_OPTS="noacl" sh llmount.sh'''. This will set up a MDS, OST, and client on the local machine. You should umount the Lustre client at /mnt/lustre.

=== Mount Target ===

liblustre needs to know ''mount target'' before connect to lustre server. the format is like following:

mds_nid:/mds_name/profile_name

* '''mds_nid''' is actually the hostname of MDS (or IP address if you don't have proper name resolution set up).
* '''mds_name''' is the name of the MDS. In the .xml file, it appears in following line:

<mds uuid='mds_uuid' name='mds_name'>

* '''profile''' is the profile name of the client mountpoint, often '''client''' in many configs.

Please refer to lustre documents for more mount target explaination. This can be passed to most liblustre programs via the environment variable LIBLUSTRE_MOUNT_TARGET.

=== sanity test ===

there's a statically built-in liblustre test program at ''lustre/liblustre/tests/sanity''. you could use it to verify whether liblustre work properly:

sanity --target mds_nid:/mdsname/profile_name

=== How It Works ===
If we run a program, e.g. iozone, we'll use LD_PRELOAD to load ''liblustre.so'' at first. The start function of ''liblustre.so'' will mount a lustre partion on certain dir, e.g. /mnt/lustre. Furthermore, following loaded iozone's functions calls such as open/read/write... will dynamically linked with the implementations in ''liblustre.so'' instead of ''libc'' in the usually case. Thus we could intercept the filesystem related system calls and translate into lustre commands.

=== Necessary Environment Variables ===
There's a simple script ''lustre/utils/lrun'' which set some ENVs:
a. mount point
{{{
LIBLUSTRE_MOUNT_POINT=${LIBLUSTRE_MOUNT_POINT:-"/mnt/lustre"}
}}}
this is where liblustre will mount remote lustre filesystem. default is ''/mnt/lustre'', please make sure it exist on your system:

a. mount target
{{{
LIBLUSTRE_MOUNT_TARGET=${LIBLUSTRE_MOUNT_TARGET:-"your_mount_target"}
}}}
you need fill in the actual target before using liblustre (e.g. mdshost:/mdsname/client).

a. shared library
{{{
LD_PRELOAD=${LD_PRELOAD:-"/usr/lib/liblustre.so"}
}}}
make sure you'v install lustre/liblustre/liblustre.so into the this place.

=== running programs over liblustre ===
Until now, only a very small number of applications have been tested with liblustre:
* iozone
* IOR
* simul

and also several standard unix command:
* ls
* touch
* rm
* mkdir
* rmdir
* mv
* cp
* find
* grep

You need prepend 'lrun' before the programs you intend to run:
{{{
lrun iozone -f /mnt/lustre/ioz_testfile -r 256k -s 1g

lrun mkdir /mnt/lustre/testdir
lrun touch /mnt/lustre/testdir/testfile
lrun cp /etc/fstab /mnt/lustre/testdir
lrun ls /mnt/lustre/testdir
lrun find /mnt/lustre/
lrun .....
}}}

'''Important Note'''
liblustre is somewhat sensitive to glibc version, what we are using is glibc-2.2.5 and glic-2.3.2.
----
*'''FrontPage'''

LibLustre How-To Guide

2007-05-18T03:48:52Z

Lucy: /* Mount Target */

= Liblustre A How to Guide =
== Liblustre Introduction ==

A library version of the Lustre client file system is now available for some versions of Lustre, it gives an user application linked with the library access to Lustre file systems without the need to mount Lustre (VFS) on the client. The key goals for the library are to provide a portable mechanism to access Lustre from different POSIX compliant operating systems, to provide access from microkernel based systems and from the Windows operating system.

Currently, liblustre is still under development and only works on linux (i386 & x86_64, not tested on ia64).

In this document, we will discuss how to use liblustre.

'''Note that liblustre is NOT a required element of Lustre.'''
liblustre is not required or even recommended for running Lustre on Linux, you should instead use the Lustre (VFS) client filesystem to mount Lustre directly.

Generally speaking, liblustre implements the Lustre client filesystem in user space. The liblustre component links LNET and libsysio together to form a shared library which could be used by applications to perform File I/O.

== Building clients and servers for the Lustre library version ==

When using liblustre, servers are first built/configured in the usual way as described in [https://projects.clusterfs.com/lustre/LustreHowto Guide to Lustre]. liblustre is built by default unless "./configure --disable-liblustre" is specified.

The liblustre files are located in lustre/liblustre:
* liblustre/liblustre.so
* liblustre/tests/

== How to use liblustre ==

First of all you must be running Lustre servers (MDS/OSTs) without ACLs and accepting connections on insecure ports. For example, add '''options lnet networks=tcp(eth0) accept=all''' to /etc/modprobe.conf, then run the script '''MDS_MOUNT_OPTS="noacl" sh llmount.sh'''. This will set up a MDS, OST, and client on the local machine. You should umount the Lustre client at /mnt/lustre.

=== Mount Target ===

liblustre needs to know ''mount target'' before connect to lustre server. the format is like following:

mds_nid:/mds_name/profile_name

* '''mds_nid''' is actually the hostname of MDS (or IP address if you don't have proper name resolution set up).
* '''mds_name''' is the name of the MDS. In the .xml file, it appears in following line:

<mds uuid='mds_uuid' name='mds_name'>

* '''profile''' is the profile name of the client mountpoint, often '''client''' in many configs.

Please refer to lustre documents for more mount target explaination. This can be passed to most liblustre programs via the environment variable LIBLUSTRE_MOUNT_TARGET.

=== sanity test ===

there's a statically built-in liblustre test program at ''lustre/liblustre/tests/sanity''. you could use it to verify whether liblustre work properly:
{{{
sanity --target mds_nid:/mdsname/profile_name
}}}

=== How It Works ===
If we run a program, e.g. iozone, we'll use LD_PRELOAD to load ''liblustre.so'' at first. The start function of ''liblustre.so'' will mount a lustre partion on certain dir, e.g. /mnt/lustre. Furthermore, following loaded iozone's functions calls such as open/read/write... will dynamically linked with the implementations in ''liblustre.so'' instead of ''libc'' in the usually case. Thus we could intercept the filesystem related system calls and translate into lustre commands.

=== Necessary Environment Variables ===
There's a simple script ''lustre/utils/lrun'' which set some ENVs:
a. mount point
{{{
LIBLUSTRE_MOUNT_POINT=${LIBLUSTRE_MOUNT_POINT:-"/mnt/lustre"}
}}}
this is where liblustre will mount remote lustre filesystem. default is ''/mnt/lustre'', please make sure it exist on your system:

a. mount target
{{{
LIBLUSTRE_MOUNT_TARGET=${LIBLUSTRE_MOUNT_TARGET:-"your_mount_target"}
}}}
you need fill in the actual target before using liblustre (e.g. mdshost:/mdsname/client).

a. shared library
{{{
LD_PRELOAD=${LD_PRELOAD:-"/usr/lib/liblustre.so"}
}}}
make sure you'v install lustre/liblustre/liblustre.so into the this place.

=== running programs over liblustre ===
Until now, only a very small number of applications have been tested with liblustre:
* iozone
* IOR
* simul

and also several standard unix command:
* ls
* touch
* rm
* mkdir
* rmdir
* mv
* cp
* find
* grep

You need prepend 'lrun' before the programs you intend to run:
{{{
lrun iozone -f /mnt/lustre/ioz_testfile -r 256k -s 1g

lrun mkdir /mnt/lustre/testdir
lrun touch /mnt/lustre/testdir/testfile
lrun cp /etc/fstab /mnt/lustre/testdir
lrun ls /mnt/lustre/testdir
lrun find /mnt/lustre/
lrun .....
}}}

'''Important Note'''
liblustre is somewhat sensitive to glibc version, what we are using is glibc-2.2.5 and glic-2.3.2.
----
*'''FrontPage'''

LibLustre How-To Guide

2007-05-18T03:47:45Z

Lucy: /* Building clients and servers for the Lustre library version */

= Liblustre A How to Guide =
== Liblustre Introduction ==

A library version of the Lustre client file system is now available for some versions of Lustre, it gives an user application linked with the library access to Lustre file systems without the need to mount Lustre (VFS) on the client. The key goals for the library are to provide a portable mechanism to access Lustre from different POSIX compliant operating systems, to provide access from microkernel based systems and from the Windows operating system.

Currently, liblustre is still under development and only works on linux (i386 & x86_64, not tested on ia64).

In this document, we will discuss how to use liblustre.

'''Note that liblustre is NOT a required element of Lustre.'''
liblustre is not required or even recommended for running Lustre on Linux, you should instead use the Lustre (VFS) client filesystem to mount Lustre directly.

Generally speaking, liblustre implements the Lustre client filesystem in user space. The liblustre component links LNET and libsysio together to form a shared library which could be used by applications to perform File I/O.

== Building clients and servers for the Lustre library version ==

When using liblustre, servers are first built/configured in the usual way as described in [https://projects.clusterfs.com/lustre/LustreHowto Guide to Lustre]. liblustre is built by default unless "./configure --disable-liblustre" is specified.

The liblustre files are located in lustre/liblustre:
* liblustre/liblustre.so
* liblustre/tests/

== How to use liblustre ==

First of all you must be running Lustre servers (MDS/OSTs) without ACLs and accepting connections on insecure ports. For example, add '''options lnet networks=tcp(eth0) accept=all''' to /etc/modprobe.conf, then run the script '''MDS_MOUNT_OPTS="noacl" sh llmount.sh'''. This will set up a MDS, OST, and client on the local machine. You should umount the Lustre client at /mnt/lustre.

=== Mount Target ===

liblustre needs to know ''mount target'' before connect to lustre server. the format is like following:
{{{
mds_nid:/mds_name/profile_name
}}}
* '''mds_nid''' is actually the hostname of MDS (or IP address if you don't have proper name resolution set up).
* '''mds_name''' is the name of the MDS. In the .xml file, it appears in following line:
{{{
<mds uuid='mds_uuid' name='mds_name'>
}}}
* '''profile''' is the profile name of the client mountpoint, often '''client''' in many configs.

Please refer to lustre documents for more mount target explaination. This can be passed to most liblustre programs via the environment variable LIBLUSTRE_MOUNT_TARGET.

=== sanity test ===

there's a statically built-in liblustre test program at ''lustre/liblustre/tests/sanity''. you could use it to verify whether liblustre work properly:
{{{
sanity --target mds_nid:/mdsname/profile_name
}}}

=== How It Works ===
If we run a program, e.g. iozone, we'll use LD_PRELOAD to load ''liblustre.so'' at first. The start function of ''liblustre.so'' will mount a lustre partion on certain dir, e.g. /mnt/lustre. Furthermore, following loaded iozone's functions calls such as open/read/write... will dynamically linked with the implementations in ''liblustre.so'' instead of ''libc'' in the usually case. Thus we could intercept the filesystem related system calls and translate into lustre commands.

=== Necessary Environment Variables ===
There's a simple script ''lustre/utils/lrun'' which set some ENVs:
a. mount point
{{{
LIBLUSTRE_MOUNT_POINT=${LIBLUSTRE_MOUNT_POINT:-"/mnt/lustre"}
}}}
this is where liblustre will mount remote lustre filesystem. default is ''/mnt/lustre'', please make sure it exist on your system:

a. mount target
{{{
LIBLUSTRE_MOUNT_TARGET=${LIBLUSTRE_MOUNT_TARGET:-"your_mount_target"}
}}}
you need fill in the actual target before using liblustre (e.g. mdshost:/mdsname/client).

a. shared library
{{{
LD_PRELOAD=${LD_PRELOAD:-"/usr/lib/liblustre.so"}
}}}
make sure you'v install lustre/liblustre/liblustre.so into the this place.

=== running programs over liblustre ===
Until now, only a very small number of applications have been tested with liblustre:
* iozone
* IOR
* simul

and also several standard unix command:
* ls
* touch
* rm
* mkdir
* rmdir
* mv
* cp
* find
* grep

You need prepend 'lrun' before the programs you intend to run:
{{{
lrun iozone -f /mnt/lustre/ioz_testfile -r 256k -s 1g

lrun mkdir /mnt/lustre/testdir
lrun touch /mnt/lustre/testdir/testfile
lrun cp /etc/fstab /mnt/lustre/testdir
lrun ls /mnt/lustre/testdir
lrun find /mnt/lustre/
lrun .....
}}}

'''Important Note'''
liblustre is somewhat sensitive to glibc version, what we are using is glibc-2.2.5 and glic-2.3.2.
----
*'''FrontPage'''

Coding Guidelines

2007-05-13T20:12:08Z

Lucy: /* Great detail */

All Lustre developers should follow the guidelines in this page very strictly to avoid problems during code merges later on. Please make the required changes to the default formatting rules in the editor you use to comply to the guidelines below.

== Guidelines ==

1. There should be no tabs in any files.
2. Blocks should be indented by 8 spaces.
3. New files should contain the following along with the license boilerplate. This will cause vim and emacs to use spaces instead of tabs for indenting. If you use a different editor, it also needs to be set to use spaces for indening Lustre code.

/* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
* vim:expandtab:shiftwidth=8:tabstop=8:
*/

4. All lines should wrap at 80 characters. If it's getting too hard to wrap there, you probably need to break it up into more functions. In some cases, it is acceptable to remove a few spaces between function arguments to avoid overflowing onto the next line.
5. Don't have spaces or tabs on blank lines or at the end of lines.
6. Don't use "inline" unless you're doing something so performance critical that the function call overhead will make a difference -- in other words: never. It makes debugging harder.

All of our wrapping, parenthesis, brace placement, etc. rules are basically Linux kernel rules, which are basically K&R. For those of you in need of a refresher, great detail is provided below.

== Great detail ==

a. When you wrap, the next line should start after the parenthesis:

right:

variable = do_something_complicated(long_argument, longer_argument,
longest_argument(sub_argument,
foo_argument),
last_argument);

if (some_long_condition(arg1, arg2, arg3) < some_long_value &&
another_long_condition(very_long_argument_name,
another_long_argument_name) >
second_long_value) {
}

wrong:

variable = do_something_complicated(long_argument, longer_argument,
longest_argument(sub_argument, foo_argument),
last_argument);

if (some_long_condition(arg1, arg2, arg3) < some_long_value &&
another_long_condition(very_long_argument_name,
another_long_argument_name) >
second_long_value) {
}

b. If you're wrapping put the operators at the end of the line, and if there are no parentheses indent 8 more:

off = le32_to_cpu(fsd->fsd_client_start) +
cl_idx * le16_to_cpu(fsd->fsd_client_size);

c. Binary and ternary (but not unary) operators should be separated from their arguments by one space.

a++;
b |= c;
d = f > g ? 0 : 1;

d. Function calls should be nestled against the parentheses, the parentheses should crowd the arguments, and one space after commas:

right: do_foo(bar, baz);
wrong: do_foo ( bar,baz );

e. All ''if'', ''for'', ''while'', etc. expressions should be separated by a space from the parenthesis, one space after the semicolons:

for (a = 0; a < b; a++)
if (a < b || a == c)
while (1)

f. Opening braces should be on the same line as the line that introduces the block, except for function calls. Closing braces get their own line, except for "else".

int foo(void)
{
if (bar) {
this();
that();
} else if (baz) {
;
} else {
;
}
do {
cow();
} while (0);
}

g. If one part of a compound ''if'' block has braces, all should.

right:

if (foo) {
bar();
baz();
} else {
salmon();
}

wrong:

if (foo) {
bar();
baz();
} else
moose();

h. When you make a macro, protect those who might call it by using do/while and parentheses; line up your backslashes:

right:

#define DO_STUFF(a) \
do { \
int b = (a) + MAGIC; \
do_other_stuff(b); \
} while (0)

wrong:

#define DO_STUFF(a) \
{ \
int b = a + MAGIC; \
do_other_stuff(b); \
}

i. If you nest preprocessor commands, use spaces to visually delineate:

#ifdef __KERNEL__
# include <goose>
# define MOOSE steak
#else
# include <mutton>
# define MOOSE prancing
#endif

j. For very long #ifdefs include the conditional with each #endif to make it readable:

#ifdef __KERNEL__
# if LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0)
/* lots
of
stuff */
# endif /* KERNEL_VERSION(2,5,0) */
#else /* !__KERNEL__ */
# if HAVE_FEATURE
/* more
* stuff */
# endif
#endif /* __KERNEL__ */

k. Comments should have the leading '''/*''' on the same line as the comment, and the trailing '''*/''' at the end of the last comment line. Intermediate lines should start with a '''*''' aligned with the first line's '''*''':

/* This is a short comment */

/* This is a multi-line comment. I wish the line would wrap already,
* as I don't have much to write about. */

l. Function declarations absolutely should NOT go into .c files, unless they are forward declarations for static functions that can't otherwise be moved before the caller. Instead, the declaration should go into the most "local" header available (preferrably *_internal.h for a given piece of code).

m. Structure and constant declarations should not be declared in multiple places. Put the struct into the most "local" header possible. If it is something that is passed over the wire it needs to go into lustre_idl.h, and needs to be correctly swabbed when the RPC message is unpacked.

n. The types and printf/printk formats used by Lustre code are:

__u64 LPU64/LPX64/LPD64 (unsigned, hex, signed)
size_t LPSZ (or cast to int and use %u / %d)
__u32/int %u/%x/%d (unsigned, hex, signed)
(unsigned) long long %llu/%llx/%lld
loff_t %lld after a cast to long long (unfortunately)

----
*'''[http://wiki.lustre.org/index.php?title=Front_Page FrontPage]'''

Coding Guidelines

2007-05-13T20:11:28Z

Lucy: /* Great detail */

All Lustre developers should follow the guidelines in this page very strictly to avoid problems during code merges later on. Please make the required changes to the default formatting rules in the editor you use to comply to the guidelines below.

== Guidelines ==

1. There should be no tabs in any files.
2. Blocks should be indented by 8 spaces.
3. New files should contain the following along with the license boilerplate. This will cause vim and emacs to use spaces instead of tabs for indenting. If you use a different editor, it also needs to be set to use spaces for indening Lustre code.

/* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
* vim:expandtab:shiftwidth=8:tabstop=8:
*/

4. All lines should wrap at 80 characters. If it's getting too hard to wrap there, you probably need to break it up into more functions. In some cases, it is acceptable to remove a few spaces between function arguments to avoid overflowing onto the next line.
5. Don't have spaces or tabs on blank lines or at the end of lines.
6. Don't use "inline" unless you're doing something so performance critical that the function call overhead will make a difference -- in other words: never. It makes debugging harder.

All of our wrapping, parenthesis, brace placement, etc. rules are basically Linux kernel rules, which are basically K&R. For those of you in need of a refresher, great detail is provided below.

== Great detail ==

a. When you wrap, the next line should start after the parenthesis:

right:

variable = do_something_complicated(long_argument, longer_argument,
longest_argument(sub_argument,
foo_argument),
last_argument);

if (some_long_condition(arg1, arg2, arg3) < some_long_value &&
another_long_condition(very_long_argument_name,
another_long_argument_name) >
second_long_value) {
}

wrong:

variable = do_something_complicated(long_argument, longer_argument,
longest_argument(sub_argument, foo_argument),
last_argument);

if (some_long_condition(arg1, arg2, arg3) < some_long_value &&
another_long_condition(very_long_argument_name,
another_long_argument_name) >
second_long_value) {
}

b. If you're wrapping put the operators at the end of the line, and if there are no parentheses indent 8 more:

off = le32_to_cpu(fsd->fsd_client_start) +
cl_idx * le16_to_cpu(fsd->fsd_client_size);

c. Binary and ternary (but not unary) operators should be separated from their arguments by one space.

a++;
b |= c;
d = f > g ? 0 : 1;

d. Function calls should be nestled against the parentheses, the parentheses should crowd the arguments, and one space after commas:

{{{
right: do_foo(bar, baz);
wrong: do_foo ( bar,baz );
}}}

e. All ''if'', ''for'', ''while'', etc. expressions should be separated by a space from the parenthesis, one space after the semicolons:

for (a = 0; a < b; a++)
if (a < b || a == c)
while (1)

f. Opening braces should be on the same line as the line that introduces the block, except for function calls. Closing braces get their own line, except for "else".

int foo(void)
{
if (bar) {
this();
that();
} else if (baz) {
;
} else {
;
}
do {
cow();
} while (0);
}

g. If one part of a compound ''if'' block has braces, all should.

right:

if (foo) {
bar();
baz();
} else {
salmon();
}

wrong:

if (foo) {
bar();
baz();
} else
moose();

h. When you make a macro, protect those who might call it by using do/while and parentheses; line up your backslashes:

right:

#define DO_STUFF(a) \
do { \
int b = (a) + MAGIC; \
do_other_stuff(b); \
} while (0)

wrong:

#define DO_STUFF(a) \
{ \
int b = a + MAGIC; \
do_other_stuff(b); \
}

i. If you nest preprocessor commands, use spaces to visually delineate:

#ifdef __KERNEL__
# include <goose>
# define MOOSE steak
#else
# include <mutton>
# define MOOSE prancing
#endif

j. For very long #ifdefs include the conditional with each #endif to make it readable:

#ifdef __KERNEL__
# if LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0)
/* lots
of
stuff */
# endif /* KERNEL_VERSION(2,5,0) */
#else /* !__KERNEL__ */
# if HAVE_FEATURE
/* more
* stuff */
# endif
#endif /* __KERNEL__ */

k. Comments should have the leading '''/*''' on the same line as the comment, and the trailing '''*/''' at the end of the last comment line. Intermediate lines should start with a '''*''' aligned with the first line's '''*''':

/* This is a short comment */

/* This is a multi-line comment. I wish the line would wrap already,
* as I don't have much to write about. */

l. Function declarations absolutely should NOT go into .c files, unless they are forward declarations for static functions that can't otherwise be moved before the caller. Instead, the declaration should go into the most "local" header available (preferrably *_internal.h for a given piece of code).

m. Structure and constant declarations should not be declared in multiple places. Put the struct into the most "local" header possible. If it is something that is passed over the wire it needs to go into lustre_idl.h, and needs to be correctly swabbed when the RPC message is unpacked.

n. The types and printf/printk formats used by Lustre code are:

__u64 LPU64/LPX64/LPD64 (unsigned, hex, signed)
size_t LPSZ (or cast to int and use %u / %d)
__u32/int %u/%x/%d (unsigned, hex, signed)
(unsigned) long long %llu/%llx/%lld
loff_t %lld after a cast to long long (unfortunately)

----
*'''[http://wiki.lustre.org/index.php?title=Front_Page FrontPage]'''

Coding Guidelines

2007-05-13T20:10:50Z

Lucy: /* Great detail */

All Lustre developers should follow the guidelines in this page very strictly to avoid problems during code merges later on. Please make the required changes to the default formatting rules in the editor you use to comply to the guidelines below.

== Guidelines ==

1. There should be no tabs in any files.
2. Blocks should be indented by 8 spaces.
3. New files should contain the following along with the license boilerplate. This will cause vim and emacs to use spaces instead of tabs for indenting. If you use a different editor, it also needs to be set to use spaces for indening Lustre code.

/* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
* vim:expandtab:shiftwidth=8:tabstop=8:
*/

4. All lines should wrap at 80 characters. If it's getting too hard to wrap there, you probably need to break it up into more functions. In some cases, it is acceptable to remove a few spaces between function arguments to avoid overflowing onto the next line.
5. Don't have spaces or tabs on blank lines or at the end of lines.
6. Don't use "inline" unless you're doing something so performance critical that the function call overhead will make a difference -- in other words: never. It makes debugging harder.

All of our wrapping, parenthesis, brace placement, etc. rules are basically Linux kernel rules, which are basically K&R. For those of you in need of a refresher, great detail is provided below.

== Great detail ==

a. When you wrap, the next line should start after the parenthesis:

right:

variable = do_something_complicated(long_argument, longer_argument,
longest_argument(sub_argument,
foo_argument),
last_argument);

if (some_long_condition(arg1, arg2, arg3) < some_long_value &&
another_long_condition(very_long_argument_name,
another_long_argument_name) >
second_long_value) {
}

wrong:

variable = do_something_complicated(long_argument, longer_argument,
longest_argument(sub_argument, foo_argument),
last_argument);

if (some_long_condition(arg1, arg2, arg3) < some_long_value &&
another_long_condition(very_long_argument_name,
another_long_argument_name) >
second_long_value) {
}

b. If you're wrapping put the operators at the end of the line, and if there are no parentheses indent 8 more:

off = le32_to_cpu(fsd->fsd_client_start) +
cl_idx * le16_to_cpu(fsd->fsd_client_size);

c. Binary and ternary (but not unary) operators should be separated from their arguments by one space.

a++;
b |= c;
d = f > g ? 0 : 1;

d. Function calls should be nestled against the parentheses, the parentheses should crowd the arguments, and one space after commas:

{{{
right: do_foo(bar, baz);
wrong: do_foo ( bar,baz );
}}}

e. All ''if'', ''for'', ''while'', etc. expressions should be separated by a space from the parenthesis, one space after the semicolons:

for (a = 0; a < b; a++)
if (a < b || a == c)
while (1)

f. Opening braces should be on the same line as the line that introduces the block, except for function calls. Closing braces get their own line, except for "else".

int foo(void)
{
if (bar) {
this();
that();
} else if (baz) {
;
} else {
;
}
do {
cow();
} while (0);
}

g. If one part of a compound ''if'' block has braces, all should.

right:

if (foo) {
bar();
baz();
} else {
salmon();
}

wrong:

if (foo) {
bar();
baz();
} else
moose();

h. When you make a macro, protect those who might call it by using do/while and parentheses; line up your backslashes:

right:

#define DO_STUFF(a) \
do { \
int b = (a) + MAGIC; \
do_other_stuff(b); \
} while (0)

wrong:

#define DO_STUFF(a) \
{ \
int b = a + MAGIC; \
do_other_stuff(b); \
}

i. If you nest preprocessor commands, use spaces to visually delineate:

#ifdef __KERNEL__
# include <goose>
# define MOOSE steak
#else
# include <mutton>
# define MOOSE prancing
#endif

j. For very long #ifdefs include the conditional with each #endif to make it readable:

#ifdef __KERNEL__
# if LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0)
/* lots
of
stuff */
# endif /* KERNEL_VERSION(2,5,0) */
#else /* !__KERNEL__ */
# if HAVE_FEATURE
/* more
* stuff */
# endif
#endif /* __KERNEL__ */

k. Comments should have the leading '''/*''' on the same line as the comment, and the trailing '''*/''' at the end of the last comment line. Intermediate lines should start with a '''*''' aligned with the first line's '''*''':

/* This is a short comment */

/* This is a multi-line comment. I wish the line would wrap already,
* as I don't have much to write about. */

l. Function declarations absolutely should NOT go into .c files, unless they are forward declarations for static functions that can't otherwise be moved before the caller. Instead, the declaration should go into the most "local" header available (preferrably *_internal.h for a given piece of code).

m. Structure and constant declarations should not be declared in multiple places. Put the struct into the most "local" header possible. If it is something that is passed over the wire it needs to go into lustre_idl.h, and needs to be correctly swabbed when the RPC message is unpacked.

n. The types and printf/printk formats used by Lustre code are:

__u64 LPU64/LPX64/LPD64 (unsigned, hex, signed)
size_t LPSZ (or cast to int and use %u / %d)
__u32/int %u/%x/%d (unsigned, hex, signed)
(unsigned) long long %llu/%llx/%lld
loff_t %lld after a cast to long long (unfortunately)

----
*'''[http://wiki.lustre.org/index.php?title=Front_Page FrontPage]'''

Coding Guidelines

2007-05-13T20:09:58Z

Lucy:

All Lustre developers should follow the guidelines in this page very strictly to avoid problems during code merges later on. Please make the required changes to the default formatting rules in the editor you use to comply to the guidelines below.

== Guidelines ==

1. There should be no tabs in any files.
2. Blocks should be indented by 8 spaces.
3. New files should contain the following along with the license boilerplate. This will cause vim and emacs to use spaces instead of tabs for indenting. If you use a different editor, it also needs to be set to use spaces for indening Lustre code.

/* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
* vim:expandtab:shiftwidth=8:tabstop=8:
*/

4. All lines should wrap at 80 characters. If it's getting too hard to wrap there, you probably need to break it up into more functions. In some cases, it is acceptable to remove a few spaces between function arguments to avoid overflowing onto the next line.
5. Don't have spaces or tabs on blank lines or at the end of lines.
6. Don't use "inline" unless you're doing something so performance critical that the function call overhead will make a difference -- in other words: never. It makes debugging harder.

All of our wrapping, parenthesis, brace placement, etc. rules are basically Linux kernel rules, which are basically K&R. For those of you in need of a refresher, great detail is provided below.

== Great detail ==

a. When you wrap, the next line should start after the parenthesis:

right:

variable = do_something_complicated(long_argument, longer_argument,
longest_argument(sub_argument,
foo_argument),
last_argument);

if (some_long_condition(arg1, arg2, arg3) < some_long_value &&
another_long_condition(very_long_argument_name,
another_long_argument_name) >
second_long_value) {
}

wrong:

variable = do_something_complicated(long_argument, longer_argument,
longest_argument(sub_argument, foo_argument),
last_argument);

if (some_long_condition(arg1, arg2, arg3) < some_long_value &&
another_long_condition(very_long_argument_name,
another_long_argument_name) >
second_long_value) {
}

b. If you're wrapping put the operators at the end of the line, and if there are no parentheses indent 8 more:

off = le32_to_cpu(fsd->fsd_client_start) +
cl_idx * le16_to_cpu(fsd->fsd_client_size);

c. Binary and ternary (but not unary) operators should be separated from their arguments by one space.

a++;
b |= c;
d = f > g ? 0 : 1;

d. Function calls should be nestled against the parentheses, the parentheses should crowd the arguments, and one space after commas:

{{{
right: do_foo(bar, baz);
wrong: do_foo ( bar,baz );
}}}

e. All ''if'', ''for'', ''while'', etc. expressions should be separated by a space from the parenthesis, one space after the semicolons:

for (a = 0; a < b; a++)
if (a < b || a == c)
while (1)

f. Opening braces should be on the same line as the line that introduces the block, except for function calls. Closing braces get their own line, except for "else".

int foo(void)
{
if (bar) {
this();
that();
} else if (baz) {
;
} else {
;
}
do {
cow();
} while (0);
}

g. If one part of a compound ''if'' block has braces, all should.

right:

if (foo) {
bar();
baz();
} else {
salmon();
}

wrong:

if (foo) {
bar();
baz();
} else
moose();

h. When you make a macro, protect those who might call it by using do/while and parentheses; line up your backslashes:

right:

#define DO_STUFF(a) \
do { \
int b = (a) + MAGIC; \
do_other_stuff(b); \
} while (0)

wrong:

#define DO_STUFF(a) \
{ \
int b = a + MAGIC; \
do_other_stuff(b); \
}

i. If you nest preprocessor commands, use spaces to visually delineate:

#ifdef __KERNEL__
# include <goose>
# define MOOSE steak
#else
# include <mutton>
# define MOOSE prancing
#endif

j. For very long #ifdefs include the conditional with each #endif to make it readable:

#ifdef __KERNEL__
# if LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0)
/* lots
of
stuff */
# endif /* KERNEL_VERSION(2,5,0) */
#else /* !__KERNEL__ */
# if HAVE_FEATURE
/* more
* stuff */
# endif
#endif /* __KERNEL__ */

k. Comments should have the leading '''/*''' on the same line as the comment, and the trailing '''*/''' at the end of the last comment line. Intermediate lines should start with a '''*''' aligned with the first line's '''*''':

/* This is a short comment */

/* This is a multi-line comment. I wish the line would wrap already,
* as I don't have much to write about. */

l. Function declarations absolutely should NOT go into .c files, unless they are forward declarations for static functions that can't otherwise be moved before the caller. Instead, the declaration should go into the most "local" header available (preferrably *_internal.h for a given piece of code).

m. Structure and constant declarations should not be declared in multiple places. Put the struct into the most "local" header possible. If it is something that is passed over the wire it needs to go into lustre_idl.h, and needs to be correctly swabbed when the RPC message is unpacked.

n. The types and printf/printk formats used by Lustre code are:

__u64 LPU64/LPX64/LPD64 (unsigned, hex, signed)
size_t LPSZ (or cast to int and use %u / %d)
__u32/int %u/%x/%d (unsigned, hex, signed)
(unsigned) long long %llu/%llx/%lld
loff_t %lld after a cast to long long (unfortunately)

----
*'''[http://wiki.lustre.org/index.php?title=Front_Page FrontPage]'''

Contribution Policy

2007-05-13T19:53:45Z

Lucy:

= Lustre Check-in Policy =

== Submitting Patches for Review ==

To have your changes accepted into a mainline Lustre branch, you must have your code reviewed and approved. The following steps will speed up your review and increase the likelihood of success:

1. Read, complete, and return the form found at http://www.lustre.org/contribute.html We can't accept your contributions without it.
2. Generate a patch with the "-upN" flags to diff or cvs diff. Please don't send other kinds of patches unless your reviewer requests them.
3. Find or file a bug for your issue at http://bugzilla.lustre.org/ . Read the Bugzilla user guide for more information.
4. Attach your patch as an Attachment (not a comment):
* Provide the patch as an Attachment, and select the Patch box.
* Edit the new attachment. Under "Flags" select "Review" and the question mark.
* Enter the email address of the person who should review. If you haven't been collaborating with someone, and don't know who should review your work, try bugs@clusterfs.com
* Submit the attachment update.
5. One or more reviewers will submit comments regarding your patch. Iterate until you receive approval on the patch or the bug is closed.
6. Once you have approval, commit the patch (or ask for it to be committed for you, if you don't have CVS access). Note the bug number and reviewer in the commit message, along with a concise description of the change.

This applies even if you have write access to the CVS tree -- if you don't follow these steps, expect your changes to be backed out of the tree without warning. We have to be strict, or the chaos becomes unbearable.

== Branches ==

Our current policy is that anyone may create and maintain a private branch in CVS. We ask, however, that you observe the best practices outlined in this document. It will save you a lot of effort, I promise.

----
*'''[http://wiki.lustre.org/index.php?title=Front_Page FrontPage]'''

Simul Parallel File System Test Tool

2007-05-13T19:38:39Z

Lucy: /* simul */

Lustre Documentation

2007-05-10T03:17:48Z

Lucy: /* Older Documentation */

= Lustre Documentation =
== Lustre Manual ==

=== Lustre 1.6 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual1_6.html Lustre 1.6 manual V1.1]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual1_6.pdf Lustre 1.6 manual V1.1(A4)]
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual-letter1_6.pdf Lustre 1.6 manual V1.1(Letter)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog1_6.html Lustre Manual-Change log]
* '''[http://wiki.lustre.org/index.php?title=Mount_Conf MountConf wiki]''' - A quick reference for those familiar with older versions of Lustre

=== Lustre 1.4.8 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual.html Lustre 1.4.8 manual V1.37]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual37.pdf Lustre 1.4.8 manual V1.37(A4)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog.html Lustre Manual-Change log]

== Interim Lustre 1.8 Documentation ==
* '''[http://wiki.lustre.org/index.php?title=Kerb_Lustre KerbLustre]''' - The 1.8 interim Lustre documentation (Kerberos....)

== Older Documentation ==
This documentation will be incorporated into the manual. Until that is done you may find useful bits and pieces here.

* '''Frequently Asked Questions'''
. [http://www.clusterfs.com/faq.html Lustre Faq]
* '''Knowledge Base'''
. [http://bugzilla.lustre.org/showdependencytree.cgi?id=2374 Lustre Knowledge Base] - questions and answers
* '''Configuration'''
. [http://wiki.lustre.org/index.php?title=Lustre_Howto LustreHowto]''' - A guide to getting Lustre cluster started.
. [http://wiki.lustre.org/index.php?title=Lustre_LDAP LustreLDAP]''' - A guide for using LDAP with Lustre.
. [http://wiki.lustre.org/index.php?title=Lustre_Wizard LustreWizard]''' - The ''Lustre wizard'' or ''lwizard'' is a utility that helps with creation of configuration file for a cluster through asking some simple questions.
. [http://wiki.lustre.org/index.php?title=Lustre_Failover LustreFailover]''' - Managing failover
. [http://wiki.lustre.org/index.php?title=Filesystem_Backup FilesystemBackup]''' - How to back up a Lustre filesystem
. [http://wiki.lustre.org/index.php?title=Fsck_Suppor FsckSupport]''' - The lustre fsck tool and Lustre-patched e2fsck (extents, large inode/EA support)
. '''Filesystem Tuning'''
*[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#Chapter_III-2._LustreProc LustreProc] - A guide on the '''proc''' tunables parameters for Lustre and their usage. It describes several of the ''proc'' tunables including those that effect the client's RPC behaviour and prepare for a substantial reorganization of proc entries.
*'''[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#3.2_DDN_Tuning LustreDdnTuning]''' - A brief guide on tuning DDN S2A 8500 (and maybe 9500) storage optimally for Lustre

Lustre Documentation

2007-05-10T03:16:21Z

Lucy: /* Older Documentation */

= Lustre Documentation =
== Lustre Manual ==

=== Lustre 1.6 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual1_6.html Lustre 1.6 manual V1.1]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual1_6.pdf Lustre 1.6 manual V1.1(A4)]
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual-letter1_6.pdf Lustre 1.6 manual V1.1(Letter)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog1_6.html Lustre Manual-Change log]
* '''[http://wiki.lustre.org/index.php?title=Mount_Conf MountConf wiki]''' - A quick reference for those familiar with older versions of Lustre

=== Lustre 1.4.8 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual.html Lustre 1.4.8 manual V1.37]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual37.pdf Lustre 1.4.8 manual V1.37(A4)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog.html Lustre Manual-Change log]

== Interim Lustre 1.8 Documentation ==
* '''[http://wiki.lustre.org/index.php?title=Kerb_Lustre KerbLustre]''' - The 1.8 interim Lustre documentation (Kerberos....)

== Older Documentation ==
This documentation will be incorporated into the manual. Until that is done you may find useful bits and pieces here.

* '''Frequently Asked Questions'''
. [http://www.clusterfs.com/faq.html Lustre Faq]
* '''Knowledge Base'''
. [http://bugzilla.lustre.org/showdependencytree.cgi?id=2374 Lustre Knowledge Base] - questions and answers
* '''Configuration'''
. [http://wiki.lustre.org/index.php?title=Lustre_Howto LustreHowto]''' - A guide to getting Lustre cluster started.
. [http://wiki.lustre.org/index.php?title=Lustre_LDAP LustreLDAP]''' - A guide for using LDAP with Lustre.
. [http://wiki.lustre.org/index.php?title=Lustre_Wizard LustreWizard]''' - The ''Lustre wizard'' or ''lwizard'' is a utility that helps with creation of configuration file for a cluster through asking some simple questions.
. [http://wiki.lustre.org/index.php?title=Lustre_Failover LustreFailover]''' - Managing failover
. [http://wiki.lustre.org/index.php?title=Filesystem_Backup FilesystemBackup]''' - How to back up a Lustre filesystem
. [http://wiki.lustre.org/index.php?title=Fsck_Suppor FsckSupport]''' - The lustre fsck tool and Lustre-patched e2fsck (extents, large inode/EA support)
. '''Filesystem Tuning'''
*[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#Chapter_III-2._LustreProc LustreProc] - A guide on the '''proc''' tunables parameters for Lustre and their usage. It describes several of the ''proc'' tunables including those that effect the client's RPC behaviour and prepare for a substantial reorganization of proc entries.
*'''[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#3.2_DDN_Tuning LustreDdnTuning]''' - A brief guide on tuning DDN S2A 8500 (and maybe 9500) storage optimally for Lustre

Lustre Documentation

2007-05-10T03:15:41Z

Lucy: /* Older Documentation */

= Lustre Documentation =
== Lustre Manual ==

=== Lustre 1.6 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual1_6.html Lustre 1.6 manual V1.1]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual1_6.pdf Lustre 1.6 manual V1.1(A4)]
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual-letter1_6.pdf Lustre 1.6 manual V1.1(Letter)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog1_6.html Lustre Manual-Change log]
* '''[http://wiki.lustre.org/index.php?title=Mount_Conf MountConf wiki]''' - A quick reference for those familiar with older versions of Lustre

=== Lustre 1.4.8 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual.html Lustre 1.4.8 manual V1.37]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual37.pdf Lustre 1.4.8 manual V1.37(A4)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog.html Lustre Manual-Change log]

== Interim Lustre 1.8 Documentation ==
* '''[http://wiki.lustre.org/index.php?title=Kerb_Lustre KerbLustre]''' - The 1.8 interim Lustre documentation (Kerberos....)

== Older Documentation ==
This documentation will be incorporated into the manual. Until that is done you may find useful bits and pieces here.

* '''Frequently Asked Questions'''
. [http://www.clusterfs.com/faq.html Lustre Faq]
* '''Knowledge Base'''
. [http://bugzilla.lustre.org/showdependencytree.cgi?id=2374 Lustre Knowledge Base] - questions and answers
* '''Configuration'''
. [http://wiki.lustre.org/index.php?title=Lustre_Howto LustreHowto]''' - A guide to getting Lustre cluster started.
. [http://wiki.lustre.org/index.php?title=Lustre_LDAP LustreLDAP]''' - A guide for using LDAP with Lustre.
. [http://wiki.lustre.org/index.php?title=Lustre_Wizard LustreWizard]''' - The ''Lustre wizard'' or ''lwizard'' is a utility that helps with creation of configuration file for a cluster through asking some simple questions.
. [http://wiki.lustre.org/index.php?title=Lustre_Failover LustreFailover]''' - Managing failover
. [http://wiki.lustre.org/index.php?title=Filesystem_Backup FilesystemBackup]''' - How to back up a Lustre filesystem
. [http://wiki.lustre.org/index.php?title=Fsck_Suppor FsckSupport]''' - The lustre fsck tool and Lustre-patched e2fsck (extents, large inode/EA support)
. '''Filesystem Tuning'''

*[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#Chapter_III-2._LustreProc LustreProc] - A guide on the '''proc''' tunables parameters for Lustre and their usage. It describes several of the ''proc'' tunables including those that effect the client's RPC behaviour and prepare for a substantial reorganization of proc entries.
*'''[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#3.2_DDN_Tuning LustreDdnTuning]''' - A brief guide on tuning DDN S2A 8500 (and maybe 9500) storage optimally for Lustre

Lustre Documentation

2007-05-10T03:15:11Z

Lucy: /* Older Documentation */

= Lustre Documentation =
== Lustre Manual ==

=== Lustre 1.6 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual1_6.html Lustre 1.6 manual V1.1]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual1_6.pdf Lustre 1.6 manual V1.1(A4)]
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual-letter1_6.pdf Lustre 1.6 manual V1.1(Letter)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog1_6.html Lustre Manual-Change log]
* '''[http://wiki.lustre.org/index.php?title=Mount_Conf MountConf wiki]''' - A quick reference for those familiar with older versions of Lustre

=== Lustre 1.4.8 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual.html Lustre 1.4.8 manual V1.37]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual37.pdf Lustre 1.4.8 manual V1.37(A4)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog.html Lustre Manual-Change log]

== Interim Lustre 1.8 Documentation ==
* '''[http://wiki.lustre.org/index.php?title=Kerb_Lustre KerbLustre]''' - The 1.8 interim Lustre documentation (Kerberos....)

== Older Documentation ==
This documentation will be incorporated into the manual. Until that is done you may find useful bits and pieces here.

* '''Frequently Asked Questions'''
. [http://www.clusterfs.com/faq.html Lustre Faq]
* '''Knowledge Base'''
. [http://bugzilla.lustre.org/showdependencytree.cgi?id=2374 Lustre Knowledge Base] - questions and answers
* '''Configuration'''
. [http://wiki.lustre.org/index.php?title=Lustre_Howto LustreHowto]''' - A guide to getting Lustre cluster started.
. [http://wiki.lustre.org/index.php?title=Lustre_LDAP LustreLDAP]''' - A guide for using LDAP with Lustre.
. [http://wiki.lustre.org/index.php?title=Lustre_Wizard LustreWizard]''' - The ''Lustre wizard'' or ''lwizard'' is a utility that helps with creation of configuration file for a cluster through asking some simple questions.
. [http://wiki.lustre.org/index.php?title=Lustre_Failover LustreFailover]''' - Managing failover
. [http://wiki.lustre.org/index.php?title=Filesystem_Backup FilesystemBackup]''' - How to back up a Lustre filesystem
. [http://wiki.lustre.org/index.php?title=Fsck_Suppor FsckSupport]''' - The lustre fsck tool and Lustre-patched e2fsck (extents, large inode/EA support)
. '''Filesystem Tuning'''
*[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#Chapter_III-2._LustreProc LustreProc] - A guide on the '''proc''' tunables parameters for Lustre and their usage. It describes several of the ''proc'' tunables including those that effect the client's RPC behaviour and prepare for a substantial reorganization of proc entries. *'''[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#3.2_DDN_Tuning LustreDdnTuning]''' - A brief guide on tuning DDN S2A 8500 (and maybe 9500) storage optimally for Lustre

Lustre Documentation

2007-05-10T03:14:18Z

Lucy: /* Older Documentation */

= Lustre Documentation =
== Lustre Manual ==

=== Lustre 1.6 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual1_6.html Lustre 1.6 manual V1.1]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual1_6.pdf Lustre 1.6 manual V1.1(A4)]
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual-letter1_6.pdf Lustre 1.6 manual V1.1(Letter)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog1_6.html Lustre Manual-Change log]
* '''[http://wiki.lustre.org/index.php?title=Mount_Conf MountConf wiki]''' - A quick reference for those familiar with older versions of Lustre

=== Lustre 1.4.8 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual.html Lustre 1.4.8 manual V1.37]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual37.pdf Lustre 1.4.8 manual V1.37(A4)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog.html Lustre Manual-Change log]

== Interim Lustre 1.8 Documentation ==
* '''[http://wiki.lustre.org/index.php?title=Kerb_Lustre KerbLustre]''' - The 1.8 interim Lustre documentation (Kerberos....)

== Older Documentation ==
This documentation will be incorporated into the manual. Until that is done you may find useful bits and pieces here.

* '''Frequently Asked Questions'''
. [http://www.clusterfs.com/faq.html Lustre Faq]
* '''Knowledge Base'''
. [http://bugzilla.lustre.org/showdependencytree.cgi?id=2374 Lustre Knowledge Base] - questions and answers
* '''Configuration'''
. [http://wiki.lustre.org/index.php?title=Lustre_Howto LustreHowto]''' - A guide to getting Lustre cluster started.
. [http://wiki.lustre.org/index.php?title=Lustre_LDAP LustreLDAP]''' - A guide for using LDAP with Lustre.
. [http://wiki.lustre.org/index.php?title=Lustre_Wizard LustreWizard]''' - The ''Lustre wizard'' or ''lwizard'' is a utility that helps with creation of configuration file for a cluster through asking some simple questions.
. [http://wiki.lustre.org/index.php?title=Lustre_Failover LustreFailover]''' - Managing failover
. [http://wiki.lustre.org/index.php?title=Filesystem_Backup FilesystemBackup]''' - How to back up a Lustre filesystem
. [http://wiki.lustre.org/index.php?title=Fsck_Suppor FsckSupport]''' - The lustre fsck tool and Lustre-patched e2fsck (extents, large inode/EA support)
. '''Filesystem Tuning'''
*[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#Chapter_III-2._LustreProc LustreProc] - A guide on the '''proc''' tunables parameters for Lustre and their usage. It describes several of the ''proc'' tunables including those that effect the client's RPC behaviour and prepare for a substantial reorganization of proc entries.
*'''[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#3.2_DDN_Tuning LustreDdnTuning]''' - A brief guide on tuning DDN S2A 8500 (and maybe 9500) storage optimally for Lustre

Lustre Documentation

2007-05-10T03:13:41Z

Lucy: /* Older Documentation */

= Lustre Documentation =
== Lustre Manual ==

=== Lustre 1.6 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual1_6.html Lustre 1.6 manual V1.1]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual1_6.pdf Lustre 1.6 manual V1.1(A4)]
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual-letter1_6.pdf Lustre 1.6 manual V1.1(Letter)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog1_6.html Lustre Manual-Change log]
* '''[http://wiki.lustre.org/index.php?title=Mount_Conf MountConf wiki]''' - A quick reference for those familiar with older versions of Lustre

=== Lustre 1.4.8 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual.html Lustre 1.4.8 manual V1.37]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual37.pdf Lustre 1.4.8 manual V1.37(A4)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog.html Lustre Manual-Change log]

== Interim Lustre 1.8 Documentation ==
* '''[http://wiki.lustre.org/index.php?title=Kerb_Lustre KerbLustre]''' - The 1.8 interim Lustre documentation (Kerberos....)

== Older Documentation ==
This documentation will be incorporated into the manual. Until that is done you may find useful bits and pieces here.

* '''Frequently Asked Questions'''
. [http://www.clusterfs.com/faq.html Lustre Faq]
* '''Knowledge Base'''
. [http://bugzilla.lustre.org/showdependencytree.cgi?id=2374 Lustre Knowledge Base] - questions and answers
* '''Configuration'''
. [http://wiki.lustre.org/index.php?title=Lustre_Howto LustreHowto]''' - A guide to getting Lustre cluster started.
. [http://wiki.lustre.org/index.php?title=Lustre_LDAP LustreLDAP]''' - A guide for using LDAP with Lustre.
. [http://wiki.lustre.org/index.php?title=Lustre_Wizard LustreWizard]''' - The ''Lustre wizard'' or ''lwizard'' is a utility that helps with creation of configuration file for a cluster through asking some simple questions.
. [http://wiki.lustre.org/index.php?title=Lustre_Failover LustreFailover]''' - Managing failover
. [http://wiki.lustre.org/index.php?title=Filesystem_Backup FilesystemBackup]''' - How to back up a Lustre filesystem
. [http://wiki.lustre.org/index.php?title=Fsck_Suppor FsckSupport]''' - The lustre fsck tool and Lustre-patched e2fsck (extents, large inode/EA support)
. '''Filesystem Tuning''' *[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#Chapter_III-2._LustreProc LustreProc] - A guide on the '''proc''' tunables parameters for Lustre and their usage. It describes several of the ''proc'' tunables including those that effect the client's RPC behaviour and prepare for a substantial reorganization of proc entries.
*'''[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#3.2_DDN_Tuning LustreDdnTuning]''' - A brief guide on tuning DDN S2A 8500 (and maybe 9500) storage optimally for Lustre

Lustre Documentation

2007-05-10T03:12:13Z

Lucy: /* Older Documentation */

= Lustre Documentation =
== Lustre Manual ==

=== Lustre 1.6 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual1_6.html Lustre 1.6 manual V1.1]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual1_6.pdf Lustre 1.6 manual V1.1(A4)]
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual-letter1_6.pdf Lustre 1.6 manual V1.1(Letter)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog1_6.html Lustre Manual-Change log]
* '''[http://wiki.lustre.org/index.php?title=Mount_Conf MountConf wiki]''' - A quick reference for those familiar with older versions of Lustre

=== Lustre 1.4.8 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual.html Lustre 1.4.8 manual V1.37]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual37.pdf Lustre 1.4.8 manual V1.37(A4)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog.html Lustre Manual-Change log]

== Interim Lustre 1.8 Documentation ==
* '''[http://wiki.lustre.org/index.php?title=Kerb_Lustre KerbLustre]''' - The 1.8 interim Lustre documentation (Kerberos....)

== Older Documentation ==
This documentation will be incorporated into the manual. Until that is done you may find useful bits and pieces here.

* '''Frequently Asked Questions'''
. [http://www.clusterfs.com/faq.html Lustre Faq]
* '''Knowledge Base'''
. [http://bugzilla.lustre.org/showdependencytree.cgi?id=2374 Lustre Knowledge Base] - questions and answers
* '''Configuration'''
. [http://wiki.lustre.org/index.php?title=Lustre_Howto LustreHowto]''' - A guide to getting Lustre cluster started.
. [http://wiki.lustre.org/index.php?title=Lustre_LDAP LustreLDAP]''' - A guide for using LDAP with Lustre.
. [http://wiki.lustre.org/index.php?title=Lustre_Wizard LustreWizard]''' - The ''Lustre wizard'' or ''lwizard'' is a utility that helps with creation of configuration file for a cluster through asking some simple questions.
. [http://wiki.lustre.org/index.php?title=Lustre_Failover LustreFailover]''' - Managing failover
. [http://wiki.lustre.org/index.php?title=Filesystem_Backup FilesystemBackup]''' - How to back up a Lustre filesystem
. [http://wiki.lustre.org/index.php?title=Fsck_Suppor FsckSupport]''' - The lustre fsck tool and Lustre-patched e2fsck (extents, large inode/EA support)
. '''Filesystem Tuning'''
*[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#Chapter_III-2._LustreProc LustreProc] - A guide on the '''proc''' tunables parameters for Lustre and their usage. It describes several of the ''proc'' tunables including those that effect the client's RPC behaviour and prepare for a substantial reorganization of proc entries.
*'''[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#3.2_DDN_Tuning LustreDdnTuning]''' - A brief guide on tuning DDN S2A 8500 (and maybe 9500) storage optimally for Lustre

Lustre Documentation

2007-05-10T03:10:15Z

Lucy: /* Older Documentation */

= Lustre Documentation =
== Lustre Manual ==

=== Lustre 1.6 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual1_6.html Lustre 1.6 manual V1.1]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual1_6.pdf Lustre 1.6 manual V1.1(A4)]
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual-letter1_6.pdf Lustre 1.6 manual V1.1(Letter)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog1_6.html Lustre Manual-Change log]
* '''[http://wiki.lustre.org/index.php?title=Mount_Conf MountConf wiki]''' - A quick reference for those familiar with older versions of Lustre

=== Lustre 1.4.8 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual.html Lustre 1.4.8 manual V1.37]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual37.pdf Lustre 1.4.8 manual V1.37(A4)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog.html Lustre Manual-Change log]

== Interim Lustre 1.8 Documentation ==
* '''[http://wiki.lustre.org/index.php?title=Kerb_Lustre KerbLustre]''' - The 1.8 interim Lustre documentation (Kerberos....)

== Older Documentation ==
This documentation will be incorporated into the manual. Until that is done you may find useful bits and pieces here.

* '''Frequently Asked Questions'''
. [http://www.clusterfs.com/faq.html Lustre Faq]
* '''Knowledge Base'''
. [http://bugzilla.lustre.org/showdependencytree.cgi?id=2374 Lustre Knowledge Base] - questions and answers
* '''Configuration'''
* '''[http://wiki.lustre.org/index.php?title=Lustre_Howto LustreHowto]''' - A guide to getting Lustre cluster started.
* '''[http://wiki.lustre.org/index.php?title=Lustre_LDAP LustreLDAP]''' - A guide for using LDAP with Lustre.
* '''[http://wiki.lustre.org/index.php?title=Lustre_Wizard LustreWizard]''' - The ''Lustre wizard'' or ''lwizard'' is a utility that helps with creation of configuration file for a cluster through asking some simple questions.
* '''[http://wiki.lustre.org/index.php?title=Lustre_Failover LustreFailover]''' - Managing failover
* '''[http://wiki.lustre.org/index.php?title=Filesystem_Backup FilesystemBackup]''' - How to back up a Lustre filesystem
* '''[http://wiki.lustre.org/index.php?title=Fsck_Suppor FsckSupport]''' - The lustre fsck tool and Lustre-patched e2fsck (extents, large inode/EA support)
* '''Filesystem Tuning'''
*[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#Chapter_III-2._LustreProc LustreProc] - A guide on the '''proc''' tunables parameters for Lustre and their usage. It describes several of the ''proc'' tunables including those that effect the client's RPC behaviour and prepare for a substantial reorganization of proc entries.
*'''[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#3.2_DDN_Tuning LustreDdnTuning]''' - A brief guide on tuning DDN S2A 8500 (and maybe 9500) storage optimally for Lustre

Lustre Documentation

2007-05-10T03:07:51Z

Lucy: /* Older Documentation */

= Lustre Documentation =
== Lustre Manual ==

=== Lustre 1.6 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual1_6.html Lustre 1.6 manual V1.1]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual1_6.pdf Lustre 1.6 manual V1.1(A4)]
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual-letter1_6.pdf Lustre 1.6 manual V1.1(Letter)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog1_6.html Lustre Manual-Change log]
* '''[http://wiki.lustre.org/index.php?title=Mount_Conf MountConf wiki]''' - A quick reference for those familiar with older versions of Lustre

=== Lustre 1.4.8 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual.html Lustre 1.4.8 manual V1.37]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual37.pdf Lustre 1.4.8 manual V1.37(A4)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog.html Lustre Manual-Change log]

== Interim Lustre 1.8 Documentation ==
* '''[http://wiki.lustre.org/index.php?title=Kerb_Lustre KerbLustre]''' - The 1.8 interim Lustre documentation (Kerberos....)

== Older Documentation ==
This documentation will be incorporated into the manual. Until that is done you may find useful bits and pieces here.

* '''Frequently Asked Questions'''
. [http://www.clusterfs.com/faq.html Lustre Faq]
* '''Knowledge Base'''
. [http://bugzilla.lustre.org/showdependencytree.cgi?id=2374 Lustre Knowledge Base] - questions and answers
* '''Configuration'''
* '''[http://wiki.lustre.org/index.php?title=Lustre_Howto LustreHowto]''' - A guide to getting Lustre cluster started.
* '''[http://wiki.lustre.org/index.php?title=Lustre_LDAP LustreLDAP]''' - A guide for using LDAP with Lustre.
* '''[http://wiki.lustre.org/index.php?title=Lustre_Wizard LustreWizard]''' - The ''Lustre wizard'' or ''lwizard'' is a utility that helps with creation of configuration file for a cluster through asking some simple questions.
* '''[http://wiki.lustre.org/index.php?title=Lustre_Failover LustreFailover]''' - Managing failover
* '''[http://wiki.lustre.org/index.php?title=Filesystem_Backup FilesystemBackup]''' - How to back up a Lustre filesystem
* '''[http://wiki.lustre.org/index.php?title=Fsck_Suppor FsckSupport]''' - The lustre fsck tool and Lustre-patched e2fsck (extents, large inode/EA support)
* '''Filesystem Tuning'''
*[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#Chapter_III-2._LustreProc LustreProc] - A guide on the '''proc''' tunables parameters for Lustre and their usage. It describes several of the ''proc'' tunables including those that effect the client's RPC behaviour and prepare for a substantial reorganization of proc entries.
*'''[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#3.2_DDN_Tuning LustreDdnTuning]''' - A brief guide on tuning DDN S2A 8500 (and maybe 9500) storage optimally for Lustre

Lustre Documentation

2007-05-10T03:06:54Z

Lucy: /* Older Documentation */

= Lustre Documentation =
== Lustre Manual ==

=== Lustre 1.6 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual1_6.html Lustre 1.6 manual V1.1]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual1_6.pdf Lustre 1.6 manual V1.1(A4)]
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual-letter1_6.pdf Lustre 1.6 manual V1.1(Letter)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog1_6.html Lustre Manual-Change log]
* '''[http://wiki.lustre.org/index.php?title=Mount_Conf MountConf wiki]''' - A quick reference for those familiar with older versions of Lustre

=== Lustre 1.4.8 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual.html Lustre 1.4.8 manual V1.37]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual37.pdf Lustre 1.4.8 manual V1.37(A4)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog.html Lustre Manual-Change log]

== Interim Lustre 1.8 Documentation ==
* '''[http://wiki.lustre.org/index.php?title=Kerb_Lustre KerbLustre]''' - The 1.8 interim Lustre documentation (Kerberos....)

== Older Documentation ==
This documentation will be incorporated into the manual. Until that is done you may find useful bits and pieces here.

* '''Frequently Asked Questions'''
. [http://www.clusterfs.com/faq.html Lustre Faq]
* '''Knowledge Base'''
. [http://bugzilla.lustre.org/showdependencytree.cgi?id=2374 Lustre Knowledge Base] - questions and answers
* '''Configuration'''
* '''[http://wiki.lustre.org/index.php?title=Lustre_Howto LustreHowto]''' - A guide to getting Lustre cluster started.
* '''[http://wiki.lustre.org/index.php?title=Lustre_LDAP LustreLDAP]''' - A guide for using LDAP with Lustre.
* '''[http://wiki.lustre.org/index.php?title=Lustre_Wizard LustreWizard]''' - The ''Lustre wizard'' or ''lwizard'' is a utility that helps with creation of configuration file for a cluster through asking some simple questions.
* '''[http://wiki.lustre.org/index.php?title=Lustre_Failover LustreFailover]''' - Managing failover
* '''[http://wiki.lustre.org/index.php?title=Filesystem_Backup FilesystemBackup]''' - How to back up a Lustre filesystem
* '''[http://wiki.lustre.org/index.php?title=Fsck_Suppor FsckSupport]''' - The lustre fsck tool and Lustre-patched e2fsck (extents, large inode/EA support)
* '''Filesystem Tuning'''
*[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#Chapter_III-2._LustreProc LustreProc] - A guide on the '''proc''' tunables parameters for Lustre and their usage. It describes several of the ''proc'' tunables including those that effect the client's RPC behaviour and prepare for a substantial reorganization of proc entries.
*'''[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#3.2_DDN_Tuning LustreDdnTuning]''' - A brief guide on tuning DDN S2A 8500 (and maybe 9500) storage optimally for Lustre

Lustre Documentation

2007-05-10T03:06:13Z

Lucy: /* Interim Lustre 1.8 Documentation */

= Lustre Documentation =
== Lustre Manual ==

=== Lustre 1.6 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual1_6.html Lustre 1.6 manual V1.1]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual1_6.pdf Lustre 1.6 manual V1.1(A4)]
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual-letter1_6.pdf Lustre 1.6 manual V1.1(Letter)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog1_6.html Lustre Manual-Change log]
* '''[http://wiki.lustre.org/index.php?title=Mount_Conf MountConf wiki]''' - A quick reference for those familiar with older versions of Lustre

=== Lustre 1.4.8 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual.html Lustre 1.4.8 manual V1.37]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual37.pdf Lustre 1.4.8 manual V1.37(A4)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog.html Lustre Manual-Change log]

== Interim Lustre 1.8 Documentation ==
* '''[http://wiki.lustre.org/index.php?title=Kerb_Lustre KerbLustre]''' - The 1.8 interim Lustre documentation (Kerberos....)

== Older Documentation ==
This documentation will be incorporated into the manual. Until that is done you may find useful bits and pieces here.

* '''Frequently Asked Questions'''
. [http://www.clusterfs.com/faq.html Lustre Faq]
* '''Knowledge Base'''
. [http://bugzilla.lustre.org/showdependencytree.cgi?id=2374 Lustre Knowledge Base] - questions and answers
* '''Configuration'''
* '''[http://wiki.lustre.org/index.php?title=Lustre_Howto LustreHowto]''' - A guide to getting Lustre cluster started.
* '''[http://wiki.lustre.org/index.php?title=Lustre_LDAP LustreLDAP]''' - A guide for using LDAP with Lustre.
* '''[http://wiki.lustre.org/index.php?title=Lustre_Wizard LustreWizard]''' - The ''Lustre wizard'' or ''lwizard'' is a utility that helps with creation of configuration file for a cluster through asking some simple questions.
* '''[http://wiki.lustre.org/index.php?title=Lustre_Failover LustreFailover]''' - Managing failover
* '''[http://wiki.lustre.org/index.php?title=Filesystem_Backup FilesystemBackup]''' - How to back up a Lustre filesystem
* '''[http://wiki.lustre.org/index.php?title=Fsck_Suppor FsckSupport]''' - The lustre fsck tool and Lustre-patched e2fsck (extents, large inode/EA support)
* '''Filesystem Tuning'''
* [https://mail.clusterfs.com/wikis/attachments/LustreManual.html#Chapter_III-2._LustreProc LustreProc] - A guide on the '''proc''' tunables parameters for Lustre and their usage. It describes several of the ''proc'' tunables including those that effect the client's RPC behaviour and prepare for a substantial reorganization of proc entries.
* '''[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#3.2_DDN_Tuning LustreDdnTuning]''' - A brief guide on tuning DDN S2A 8500 (and maybe 9500) storage optimally for Lustre

Lustre Documentation

2007-05-10T03:05:51Z

Lucy: /* Older Documentation */

= Lustre Documentation =
== Lustre Manual ==

=== Lustre 1.6 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual1_6.html Lustre 1.6 manual V1.1]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual1_6.pdf Lustre 1.6 manual V1.1(A4)]
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual-letter1_6.pdf Lustre 1.6 manual V1.1(Letter)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog1_6.html Lustre Manual-Change log]
* '''[http://wiki.lustre.org/index.php?title=Mount_Conf MountConf wiki]''' - A quick reference for those familiar with older versions of Lustre

=== Lustre 1.4.8 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual.html Lustre 1.4.8 manual V1.37]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual37.pdf Lustre 1.4.8 manual V1.37(A4)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog.html Lustre Manual-Change log]

== Interim Lustre 1.8 Documentation ==
* '''[http://wiki.lustre.org/index.php?title=Kerb_Lustre KerbLustre]''' - The 1.8 interim Lustre documentation (Kerberos....)

== Older Documentation ==
This documentation will be incorporated into the manual. Until that is done you may find useful bits and pieces here.

* '''Frequently Asked Questions'''
. [http://www.clusterfs.com/faq.html Lustre Faq]
* '''Knowledge Base'''
. [http://bugzilla.lustre.org/showdependencytree.cgi?id=2374 Lustre Knowledge Base] - questions and answers
* '''Configuration'''
* '''[http://wiki.lustre.org/index.php?title=Lustre_Howto LustreHowto]''' - A guide to getting Lustre cluster started.
* '''[http://wiki.lustre.org/index.php?title=Lustre_LDAP LustreLDAP]''' - A guide for using LDAP with Lustre.
* '''[http://wiki.lustre.org/index.php?title=Lustre_Wizard LustreWizard]''' - The ''Lustre wizard'' or ''lwizard'' is a utility that helps with creation of configuration file for a cluster through asking some simple questions.
* '''[http://wiki.lustre.org/index.php?title=Lustre_Failover LustreFailover]''' - Managing failover
* '''[http://wiki.lustre.org/index.php?title=Filesystem_Backup FilesystemBackup]''' - How to back up a Lustre filesystem
* '''[http://wiki.lustre.org/index.php?title=Fsck_Suppor FsckSupport]''' - The lustre fsck tool and Lustre-patched e2fsck (extents, large inode/EA support)
* '''Filesystem Tuning'''
* [https://mail.clusterfs.com/wikis/attachments/LustreManual.html#Chapter_III-2._LustreProc LustreProc] - A guide on the '''proc''' tunables parameters for Lustre and their usage. It describes several of the ''proc'' tunables including those that effect the client's RPC behaviour and prepare for a substantial reorganization of proc entries.
* '''[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#3.2_DDN_Tuning LustreDdnTuning]''' - A brief guide on tuning DDN S2A 8500 (and maybe 9500) storage optimally for Lustre

Lustre Documentation

2007-05-10T03:05:01Z

Lucy: /* Lustre 1.4.8 */

= Lustre Documentation =
== Lustre Manual ==

=== Lustre 1.6 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual1_6.html Lustre 1.6 manual V1.1]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual1_6.pdf Lustre 1.6 manual V1.1(A4)]
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual-letter1_6.pdf Lustre 1.6 manual V1.1(Letter)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog1_6.html Lustre Manual-Change log]
* '''[http://wiki.lustre.org/index.php?title=Mount_Conf MountConf wiki]''' - A quick reference for those familiar with older versions of Lustre

=== Lustre 1.4.8 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual.html Lustre 1.4.8 manual V1.37]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual37.pdf Lustre 1.4.8 manual V1.37(A4)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog.html Lustre Manual-Change log]

== Interim Lustre 1.8 Documentation ==
* '''[http://wiki.lustre.org/index.php?title=Kerb_Lustre KerbLustre]''' - The 1.8 interim Lustre documentation (Kerberos....)

== Older Documentation ==
This documentation will be incorporated into the manual. Until that is done you may find useful bits and pieces here.

* '''Frequently Asked Questions'''
. [http://www.clusterfs.com/faq.html Lustre Faq]
* '''Knowledge Base'''
. [http://bugzilla.lustre.org/showdependencytree.cgi?id=2374 Lustre Knowledge Base] - questions and answers
* '''Configuration'''
* '''[http://wiki.lustre.org/index.php?title=Lustre_Howto LustreHowto]''' - A guide to getting Lustre cluster started.
* '''[http://wiki.lustre.org/index.php?title=Lustre_LDAP LustreLDAP]''' - A guide for using LDAP with Lustre.
* '''[http://wiki.lustre.org/index.php?title=Lustre_Wizard LustreWizard]''' - The ''Lustre wizard'' or ''lwizard'' is a utility that helps with creation of configuration file for a cluster through asking some simple questions.
* '''[http://wiki.lustre.org/index.php?title=Lustre_Failover LustreFailover]''' - Managing failover
* '''[http://wiki.lustre.org/index.php?title=Filesystem_Backup FilesystemBackup]''' - How to back up a Lustre filesystem
* '''[http://wiki.lustre.org/index.php?title=Fsck_Suppor FsckSupport]''' - The lustre fsck tool and Lustre-patched e2fsck (extents, large inode/EA support)
* '''Filesystem Tuning'''
* [https://mail.clusterfs.com/wikis/attachments/LustreManual.html#Chapter_III-2._LustreProc LustreProc] - A guide on the '''proc''' tunables parameters for Lustre and their usage. It describes several of the ''proc'' tunables including those that effect the client's RPC behaviour and prepare for a substantial reorganization of proc entries.
* '''[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#3.2_DDN_Tuning LustreDdnTuning]''' - A brief guide on tuning DDN S2A 8500 (and maybe 9500) storage optimally for Lustre

Lustre Documentation

2007-05-10T03:04:02Z

Lucy: /* Lustre 1.6 */

= Lustre Documentation =
== Lustre Manual ==

=== Lustre 1.6 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual1_6.html Lustre 1.6 manual V1.1]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual1_6.pdf Lustre 1.6 manual V1.1(A4)]
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual-letter1_6.pdf Lustre 1.6 manual V1.1(Letter)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog1_6.html Lustre Manual-Change log]
* '''[http://wiki.lustre.org/index.php?title=Mount_Conf MountConf wiki]''' - A quick reference for those familiar with older versions of Lustre

=== Lustre 1.4.8 ===
* '''Lustre Manual - HTML '''[http://wiki.lustre.org/images/7/78/LustreManual.html Lustre 1.4.8 manual V1.37]
* '''Lustre Manual - PDF'''
. ''''''[http://wiki.lustre.org/images/7/78/LustreManual37.pdf Lustre 1.4.8 manual V1.37(A4)]
* '''Lustre Manual Changelog '''[http://wiki.lustre.org/images/7/78/manual-changelog.html Lustre Manual-Change log]

== Interim Lustre 1.8 Documentation ==
* '''[http://wiki.lustre.org/index.php?title=Kerb_Lustre KerbLustre]''' - The 1.8 interim Lustre documentation (Kerberos....)

== Older Documentation ==
This documentation will be incorporated into the manual. Until that is done you may find useful bits and pieces here.

* '''Frequently Asked Questions'''
. [http://www.clusterfs.com/faq.html Lustre Faq]
* '''Knowledge Base'''
. [http://bugzilla.lustre.org/showdependencytree.cgi?id=2374 Lustre Knowledge Base] - questions and answers
* '''Configuration'''
* '''[http://wiki.lustre.org/index.php?title=Lustre_Howto LustreHowto]''' - A guide to getting Lustre cluster started.
* '''[http://wiki.lustre.org/index.php?title=Lustre_LDAP LustreLDAP]''' - A guide for using LDAP with Lustre.
* '''[http://wiki.lustre.org/index.php?title=Lustre_Wizard LustreWizard]''' - The ''Lustre wizard'' or ''lwizard'' is a utility that helps with creation of configuration file for a cluster through asking some simple questions.
* '''[http://wiki.lustre.org/index.php?title=Lustre_Failover LustreFailover]''' - Managing failover
* '''[http://wiki.lustre.org/index.php?title=Filesystem_Backup FilesystemBackup]''' - How to back up a Lustre filesystem
* '''[http://wiki.lustre.org/index.php?title=Fsck_Suppor FsckSupport]''' - The lustre fsck tool and Lustre-patched e2fsck (extents, large inode/EA support)
* '''Filesystem Tuning'''
* [https://mail.clusterfs.com/wikis/attachments/LustreManual.html#Chapter_III-2._LustreProc LustreProc] - A guide on the '''proc''' tunables parameters for Lustre and their usage. It describes several of the ''proc'' tunables including those that effect the client's RPC behaviour and prepare for a substantial reorganization of proc entries.
* '''[https://mail.clusterfs.com/wikis/attachments/LustreManual.html#3.2_DDN_Tuning LustreDdnTuning]''' - A brief guide on tuning DDN S2A 8500 (and maybe 9500) storage optimally for Lustre