[LUDOC-539] Lustre Wiki: Review Introductory Pages

• Type: Improvement
• Resolution: Unresolved
• Priority: Minor
• Labels: dwg
• Severity: 3
• Assignee: Jason Huselton
• Reporter: Ellis Wilson

Description

The following pages are all over 3 years old.  These are being reviewed as part of the efforts of the Lustre Documentation Working Group.  The main intent of this bug is to evaluate if these pages require:

• Reorganization
• Removal due to staleness
• Extension due to missing material
• Correction to fix incorrect or stale material

The author is expected to annotate this work item with the changes expected.  They may or may not make those changes as part of this work item.  If they choose to not make those changes, they are expected to create a new work item where the identified, explicit improvements can be made by another individual within the LUDOC stream.  If they do choose to make those changes, please clarify such in the comment section.

The full list of pages include:

Beginner Pages:

[Getting Started|https://wiki.lustre.org/Getting_Started]‏‎ (11:56, 6 July 2015)

[Lustre 101|https://wiki.lustre.org/Lustre_101]‏‎ (18:09, 18 April 2016)

[Download|https://wiki.lustre.org/Download]‏‎ (08:47, 10 August 2016)

[Lustre with ZFS Install|https://wiki.lustre.org/Lustre_with_ZFS_Install]‏‎ (09:12, 20 September 2018)

[Configuring the Lustre File System|https://wiki.lustre.org/Configuring_the_Lustre_File_System]‏‎ (07:27, 25 August 2016)

[Lustre System Configuration Utilities|https://wiki.lustre.org/Lustre_System_Configuration_Utilities]‏‎ (07:21, 13 October 2016)

[Preparing to Install Lustre|https://wiki.lustre.org/Preparing_to_Install_Lustre]‏‎ (07:43, 2 November 2016)

[Starting and Stopping Lustre Services|https://wiki.lustre.org/Starting_and_Stopping_Lustre_Services]‏‎ (01:31, 16 August 2017)

[Lustre Management Service (MGS)|https://wiki.lustre.org/Lustre_Management_Service_(MGS)]‏‎ (22:44, 30 August 2017)

[Lustre Clients Overview|https://wiki.lustre.org/Lustre_Clients_Overview]‏‎ (22:45, 30 August 2017)

[Lustre Client Requirements Guidelines|https://wiki.lustre.org/Lustre_Client_Requirements_Guidelines]‏‎ (22:46, 30 August 2017)

[Operating System Configuration Guidelines For Lustre|https://wiki.lustre.org/Operating_System_Configuration_Guidelines_For_Lustre]‏‎ (21:39, 7 September 2017)

[Creating the Lustre Management Service (MGS)|https://wiki.lustre.org/Creating_the_Lustre_Management_Service_(MGS)]‏‎ (22:15, 10 September 2017)

[Creating the Lustre Metadata Service (MDS)|https://wiki.lustre.org/Creating_the_Lustre_Metadata_Service_(MDS)]‏‎ (22:17, 10 September 2017)

[Lustre Object Storage Service (OSS)|https://wiki.lustre.org/Lustre_Object_Storage_Service_(OSS)]‏‎ (21:39, 8 November 2017)

[Lustre Metadata Service (MDS)|https://wiki.lustre.org/Lustre_Metadata_Service_(MDS)]‏‎ (21:40, 8 November 2017)

[Creating Lustre Object Storage Services (OSS)|https://wiki.lustre.org/Creating_Lustre_Object_Storage_Services_(OSS)]‏‎ (13:24, 25 May 2018)

[Configuring Lustre File Striping|https://wiki.lustre.org/Configuring_Lustre_File_Striping]‏‎ (13:28, 6 February 2019)

[Upgrading to a New Version of Lustre|https://wiki.lustre.org/Upgrading_to_a_New_Version_of_Lustre]‏‎ (14:06, 1 April 2019)

[Lustre Server Requirements Guidelines|https://wiki.lustre.org/Lustre_Server_Requirements_Guidelines]‏‎ (19:47, 4 October 2019)

Comments

[Jason Huselton]

elliswilson , this took way too much time for such a simple ask. My bad. For Monday, I have gone through each page, I have at least a disposition that I can help speak towards. Additionally, I'd like to take "Getting Started" and compare to other "major open source projects" and perhaps get an idea of "what everyone else is doing". For now, my list

 

Page Name	Address	Evaluation	Notes
Getting Started	https://wiki.lustre.org/Getting_Started	Extension due to missing material	No content exists.
Lustre 101	https://wiki.lustre.org/Lustre_101	Correction to fix incorrect or stale material	External linked content forbidden
Download	https://wiki.lustre.org/Download	Correction to fix incorrect or stale material	May simply want to redirect the page to official source
Lustre with ZFS Install	https://wiki.lustre.org/Lustre_with_ZFS_Install	Correction to fix incorrect or stale material	Per discussion, generic and remove puppet
Configuring the Lustre File System	https://wiki.lustre.org/Configuring_the_Lustre_File_System	Correction to fix incorrect or stale material	Broken link at top, content formatting issues.
Lustre System Configuration Utilities	https://wiki.lustre.org/Lustre_System_Configuration_Utilities	Correction to fix incorrect or stale material	Broken links, there has to be more config utils than this
Preparing to Install Lustre	https://wiki.lustre.org/Preparing_to_Install_Lustre	Extension due to missing material	This entire page just needs a refresh for modern OS flavors
Starting and Stopping Lustre Services	https://wiki.lustre.org/Starting_and_Stopping_Lustre_Services	Removal due to staleness	This content seems better served in a more general page
Lustre Management Service (MGS)	https://wiki.lustre.org/Lustre_Management_Service_(MGS)	Correction to fix incorrect or stale material	Pretty good overall...still holds up imho
Lustre Clients Overview	https://wiki.lustre.org/Lustre_Clients_Overview	Removal due to staleness	I more comprehensive 'Lustre Client' chapter?
Lustre Client Requirements Guidelines	https://wiki.lustre.org/Lustre_Client_Requirements_Guidelines	Removal due to staleness	Intention of this page belongs in a broader "chapter" (see above)
Operating System Configuration Guidelines For Lustre	https://wiki.lustre.org/Operating_System_Configuration_Guidelines_For_Lustre	Removal due to staleness	Seems unwarranted. This content would be better served distributed across a manual or other parts of wiki
Creating the Lustre Management Service (MGS)	https://wiki.lustre.org/Creating_the_Lustre_Management_Service_(MGS)	Reorganization	Suggest removing.
Creating the Lustre Metadata Service (MDS)	https://wiki.lustre.org/Creating_the_Lustre_Metadata_Service_(MDS)	Reorganization	Above
Lustre Object Storage Service (OSS)	https://wiki.lustre.org/Lustre_Object_Storage_Service_(OSS)	Correction to fix incorrect or stale material	This page seems more ideal to what above MGS|Client ought to be
Lustre Metadata Service (MDS)	https://wiki.lustre.org/Lustre_Metadata_Service_(MDS)	Correction to fix incorrect or stale material	This page seems more ideal to what above MGS|Client ought to be
Creating Lustre Object Storage Services (OSS)	https://wiki.lustre.org/Creating_Lustre_Object_Storage_Services_(OSS)	Reorganization	This belongs more in general OSS page above
Configuring Lustre File Striping	https://wiki.lustre.org/Configuring_Lustre_File_Striping	Extension due to missing material	Broken links, and need to update to align with current version
Upgrading to a New Version of Lustre	https://wiki.lustre.org/Upgrading_to_a_New_Version_of_Lustre	Removal due to staleness	Old...very old, deprecated
Lustre Server Requirements Guidelines	https://wiki.lustre.org/Lustre_Server_Requirements_Guidelines	Removal due to staleness	Old, not relevant any longer. Too verbose

[Jason Huselton]

Starting a small xlsx to track these pages and their disposition for now:

https://datadirectnetworks-my.sharepoint.com/:x:/g/personal/jhuselton_ddn_com/Ef3cwkYuxTZAuj2CLD9XtpUBwZ77jzBgC5m9yO-Bn72q7Q?e=rYOYFf

 

[Jason Huselton]

[Getting Started|https://wiki.lustre.org/Getting_Started:] No content. Decision needed weather to develop content for this, or send to trash. I sync'd with cfaber mentioned on page, and he had a really great idea I can make.

Honestly for a single node, "play with the file system" type setup, "llmount.sh" as part of the /usr/lib64/lustre/tests scripts works great to do an instant setup

 You can just walk through the steps in that script and generate a quick start guide pretty fast

 elliswilson , I'll try and make the next meeting, but I have a conflict for a POC expected to be completed this month. ‏‎