[LUDOC-280] Document the Lustre protocols

• Type: Epic
• Resolution: Done
• Priority: Critical
• Epic Name: Protocols Documentation
• Assignee: Andrew Uselton (Inactive)
• Reporter: Richard Henwood (Inactive)

Description

The Lustre file system contains two main protocols: LNET and PTLRPC. PTLRPC is an RPC protocol layered over LNET. In addition to LNET and PTLRPC, Lustre must also interact with external protocols for communication such as IB and TCP/IP. The scope of the work in this project
will be focused on creating documentation for PTLRPC as described as follows:

1. Document the Client-MDS RPCs for POSIX namespace operations (mount, unmount, create, open, close, unlink, rmdir, rename, link, symlink, getattr, setattr, statfs, etc.)

2. Document the Client-MDS RPCs for internal state management (connect, disconnect, FLD, SEQ, PING, LDLM, etc.)

3. Document the Client-OSS RPCs for IO operations (read, write, truncate, setattr, grant, etc.)

4. Document the MDS-OSS RPCs for internal state management (object precreation, orphan recovery, UID/GID change, unlink, etc.)

5. Document the MDS-OSS RPCs for quota management

6. Document the MDS-OSS OUT RPCs for distributed updates (DNE1 remote directories, DNE2 striped directories, LFSCK2/3 verification and repair)

More information on this project, and how to get involved, can be found here: http://wiki.opensfs.org/Contract_SFS-DEV-005

Comments

[Andrew Uselton (Inactive)]

Within the context of the protocol doc project all of the scheduled work is complete.