Accessing Lustre Code

We welcome and encourage contributions to the development and testing of a more robust, feature-rich Lustre. Three options are available for accessing Lustre code:
 * Anonymous access. You can obtain Lustre source code by Accessing the Open CVS repository. When using this option, you will have read-only access to the code. See Contribute for how to submit code.


 * Authorized access. Obtaining Lustre source code by Accessing the Internal Lustre CVS repository requires a password-protected account and authorization from Sun Microsystems.

For all these options, the Concurrent Versions System (CVS) must be installed on your local system. For more information about CVS, see CVS - Concurrent Versions System.

Note: If you have questions or experience problems with using any of these options, send email to the [mailto:lustre-wiki-feedback@sun.com CVS Administrator].

Naming conventions
Stable development branches are named b{major}_{minor} (for example, b1_6 and b1_8). Even-numbered minor releases are considered stable releases. Odd-numbered minor releases correspond to alpha and beta releases and will sometimes be given v{major}_{minor}_{patch} tags to provide a point of reference for internal and external testing.

A release branch is created an official release to isolate it from further development and named b_release_{major}_{minor}_{patch} (for example, b_release_1_8_0). A final release gets a tag in the form v{major}_{minor}_{patch} (for example, v1_8_0 or v1_6_7_1).

Long-range development is done on the HEAD branch.

Lustre Modules
These Lustre modules are needed to build Lustre. They are automatically checked out when the lustrecvs script is run for a specified Lustre branch or tag, such as HEAD, b1_8, or v1_8_1:
 * lustre (top-level directory)
 * ldiskfs (at lustre/ldiskfs)
 * libsysio (at lustre/libsysio)
 * lnet (at lustre/lnet)
 * libcfs (at lustre/libcfs)
 * lustre-build (at lustre/build)
 * lustre-core (at lustre/lustre)
 * lustre-snmp (at lustre/snmp)

See the following sections for details.

Lustre Subsystem Map describes each of the subsystems in the Lustre code.

Accessing the Open CVS repository
The Open CVS repository allows anonymous, read-only access to the Lustre code. See Contribute for more information about submitting a patch to the Lustre code.

Checking out code from Open CVS
To check out Lustre source code from the Open CVS repository, complete these steps. The Open CVS repository is used for public access to Lustre and is synced from the internal CVS repository several times a day.

1. Set CVSROOT in your environment by entering one of these commands: export CVSROOT=":pserver:anonymous@cvs.lustre.org:/lustre"
 * or

cvs -d :pserver:anonymous@cvs.lustre.org:/lustre login


 * No password is needed.

2. Check out the lustre source. cvs co lustre

3. Check out lustre modules. cd lustre ./lustrecvs b1_8
 * In this example, modules for Release 1.8 are checked out.

Example
In this example, Lustre sources are checked out into ~/src/lustre-1_8. This directory can be called anything. The directory name will default to "lustre" if nothing is specified.

To check out the most recent code for the release currently in development, replace b1_8 with HEAD.

Checking out code from Internal Lustre CVS
To check out Lustre source code from the Internal Lustre CVS repository, complete these steps.

1. Test that your account is working by logging into bugzilla. CVS and bugzilla share the same account information.

2. To upload a public ssh key to use in place of typing in a password, go to bugzilla's user preferences. If there is no "Change Public SSH key" field, send email to the [mailto:lustre-wiki-feedback@sun.com CVS Administrator]. (Note: Currently, only SSH2 keys are supported.)

3. Set the CVS_RSH environment variable.


 * For bash users, enter: export CVS_RSH=ssh
 * For csh users, enter: setenv CVS_RSH ssh


 * Consider setting CVS_RSH in your .bashrc or .cshrc.

4. Check out the Lustre code by running the following (change youraccountname to your cvs account name specified on the user preferences page):

$ cvs -d :ext:youraccountname@cvs.lustre.org:/cvsroot/cfs co lustre $ cd lustre $ ./lustrecvs b1_8

Accessing the Internal Lustre CVS repository
The Internal Lustre CVS repository gives access by authorized users to the internal Lustre repository.

Legal Notice

 * All software obtained from this CVS repository is considered pre-release proprietary software and is therefore confidential information. You may not redistribute any software obtained from this CVS repository and must destroy all copies upon request.


 * Unless otherwise authorized, you have a limited license to read, modify, compile, and use software obtained from this CVS repository in a non-production test environment.


 * If you do not agree with these restrictions, do not use this CVS repository. Please email us to have your account disabled.

Checking out code from Internal Lustre CVS
To check out Lustre source code from the Lustre External CVS repository, complete these steps.

1. Check out the top-level lustre directory, where {username} is your Bugzilla account id. When prompted for a password, enter your Bugzilla password.

$ cvs -e ssh -d {username}@cvs.lustre.org:/cvsroot/lcfs co lustre

2. Get the desired CVS tag.


 * Download the Lustre source tree associated with the desired CVS tag using the lustrecvs script, where &lt;tag or branch&gt; is a valid Lustre branch or tag name (e.g. b1_8, HEAD, v1_9_250)

$ cd lustre $ ./lustrecvs &lt;tag or branch&gt;

Note: To update the tree or to change branches, run the "lustrecvs &lt;tag&gt;" command again. Using "cvs update" is not always reliable if there have been layout changes in the repository.