[LUDOC-280] Document the Lustre protocols

• Status: Closed
• Project: Lustre Documentation
• Type: Epic
• Priority: Critical
• Reporter: Richard Henwood (Inactive)
• Assignee: Andrew Uselton (Inactive)
• Resolution: Done

Sub-Tasks

Key	Summary	Type	Status	Assignee
LUDOC-266	Produce initial content for the doc/p...	Technical task	Resolved	Andrew Uselton
LUDOC-270	Revise the protocol document outline ...	Technical task	Resolved	Andrew Uselton
LUDOC-275	Document RPCs for getattr	Technical task	Resolved	Andrew Uselton
LUDOC-276	Add commands leading to setattr to th...	Technical task	Closed	Andrew Uselton
LUDOC-277	Add commands leading to statfs to the...	Technical task	Resolved	Andrew Uselton
LUDOC-278	Add commands leading to getxattr to t...	Technical task	Resolved	Andrew Uselton
LUDOC-279	Add commands leading to setxattr to t...	Technical task	Resolved	Andrew Uselton
LUDOC-283	Improve discussion of file IDs.	Technical task	Closed	Andrew Uselton
LUDOC-287	Update connection disucussion	Technical task	Closed	Andrew Uselton
LUDOC-290	Remove Lustre-specfic typedefs from p...	Technical task	Closed	Andrew Uselton
LUDOC-293	Merge patches related to LUDOC-275,27...	Technical task	Resolved	Andrew Uselton
LUDOC-294	Incoporate Mike's latest contribution...	Technical task	Resolved	Andrew Uselton
LUDOC-295	update 'pb_status' discussion	Technical task	Resolved	Andrew Uselton
LUDOC-296	Rearange presentation to be more top-...	Technical task	Resolved	Andrew Uselton
LUDOC-297	Update protocol document	Technical task	Closed	Andrew Uselton
LUDOC-298	Editorial pass through the document.	Technical task	Closed	Andrew Uselton
LUDOC-299	Spell-check document	Technical task	Closed	Andrew Uselton

• Key: Summary
• Summary: Type
• Type: Status
• Status: Assignee
• Epic Name: Protocols Documentation

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.