Details
Technical task
Medium Description
This ticket includes all the documentation tasks for the EC feature. The documentation should be made for two parties: users and developers. As a result, the documentation will be placed both in the manual and public header files (for users) and in the codebase (for developers). The latter needs to be further discussed; specifically how this internal documentation should be structured. It is important to use consistent terminology.
We will need documentation for the following areas:
llapi
New functions and existing functions that were modified for EC should be properly documented in the public header file. Further documentation outside the header file is not required.
Lustre manual
The manual should include a design description as a high-level overview for both users and developers. The manual should explain how Lustre EC is used via the command line interface. In addition, it should describe any limitations in detail, e.g., lfs mirror resync must be called to compute the parities, or that a data component can only have one parity mirror.
Lustre internal documentation (for developers)
The internal documentation, e.g., "Documentation/ec.txt" should explain the EC architecture from the engineering perspective, discussing technical details that end-users are not necessarily interested in but help engineers to understand how the feature is implemented.
Man pages
Commands that were modified to support erasure coding need to be updated. If possible, the man page should be updated in the context of the patch that introduced the code changes. This includes:
- lfs setstripe/getstripe
- lfs mirror commands
- New tunables for lctl set_param, e.g., to specify failure domains
Attachments
Issue Links
- duplicates
-
LUDOC-463 Add feature documentation for Erasure Coding
-
- Open
-