Uploaded image for project: 'Lustre Documentation'
  1. Lustre Documentation
  2. LUDOC-86

DNE Phase I Doc Changes

Details

    • Improvement
    • Resolution: Fixed
    • Critical
    • None
    • None
    • None
    • OpenSFS SFS-DEV-001
    • 7131

    Description

      A considerable amount of updates to the manual: description of feature, configuration, administration, troubleshooting and repair of MDT failures

      Attachments

        Issue Links

          is duplicated by

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. LUDOC-108 add documentation for DNE

          • Blocker - Blocks development and/or testing work, production could not run.
          • Closed
          is related to

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. LU-1187 DNE Phase 1: Remote Directories

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Activity

            [LUDOC-86] DNE Phase I Doc Changes
            rhenwood Richard Henwood (Inactive) added a comment -

            This got closed with LU-108

            rhenwood Richard Henwood (Inactive) added a comment - This got closed with LU-108
            jessica Jessica A. Popp (Inactive) added a comment -

            Richard -

            Should this ticket be assigned to Di and tracked as part of DNE deliverables?

            -Jessica

            jessica Jessica A. Popp (Inactive) added a comment - Richard - Should this ticket be assigned to Di and tracked as part of DNE deliverables? -Jessica
            adilger Andreas Dilger added a comment -

            It would also be useful to have a paragraph or six that provides an overview of the DNE Phase 1 functionality, in particular describing that it is mostly intended for administrator use (and by default limited only to administrators), only provides static directory distribution, that there is not yet a migration tool besides "copy all data", etc. This could easily be copy-pasted from the Project Scope, Solution Architecture, and/or HLD into the manual.

            adilger Andreas Dilger added a comment - It would also be useful to have a paragraph or six that provides an overview of the DNE Phase 1 functionality, in particular describing that it is mostly intended for administrator use (and by default limited only to administrators), only provides static directory distribution, that there is not yet a migration tool besides "copy all data", etc. This could easily be copy-pasted from the Project Scope, Solution Architecture, and/or HLD into the manual.
            adilger Andreas Dilger added a comment -

            There are a couple of gaps in the user manual related to DNE Phase 1:

            • the glossary should define "DNE" since this is what users know the feature as
            • it might make sense to use DNE in a few places where multiple MDTs are described, so that this is more easily found in the manual. As it stands, there is no one place to find out about DNE in the manual.
            • add "lfs mkdir" to the UserUtilities section, per LU-4237
            adilger Andreas Dilger added a comment - There are a couple of gaps in the user manual related to DNE Phase 1: the glossary should define "DNE" since this is what users know the feature as it might make sense to use DNE in a few places where multiple MDTs are described, so that this is more easily found in the manual. As it stands, there is no one place to find out about DNE in the manual. add "lfs mkdir" to the UserUtilities section, per LU-4237
            rhenwood Richard Henwood (Inactive) added a comment -

            This ticket is a duplicate of LUDOC-108. LUDOC-108 is closed as complete.

            rhenwood Richard Henwood (Inactive) added a comment - This ticket is a duplicate of LUDOC-108 . LUDOC-108 is closed as complete.
            adilger Andreas Dilger added a comment -

            Update the user manual to describe changes to the user tools:

            • formatting, mounting, usage, configuration, etc.
            • potentially some of the example output (if relevant to the examples)
            • /proc tunables, module parameters, etc.

            Since we use a single manual for all of the Lustre releases, when changing any significant sections of text the content should include the version in which the change was made (i.e. 2.4) and leave the old comments in place (at least back to 2.1, older 1.x sections can be removed), for example:

            Starting with Lustre 2.4, it is possible to add multiple MDTs to a single Lustre filesystem, by specifying a non-zero index for the later MDTs, like mkfs.lustre --mdt --index 1 ... /dev/mdt0001

            adilger Andreas Dilger added a comment - Update the user manual to describe changes to the user tools: formatting, mounting, usage, configuration, etc. potentially some of the example output (if relevant to the examples) /proc tunables, module parameters, etc. Since we use a single manual for all of the Lustre releases, when changing any significant sections of text the content should include the version in which the change was made (i.e. 2.4) and leave the old comments in place (at least back to 2.1, older 1.x sections can be removed), for example: Starting with Lustre 2.4, it is possible to add multiple MDTs to a single Lustre filesystem, by specifying a non-zero index for the later MDTs, like mkfs.lustre --mdt --index 1 ... /dev/mdt0001

            People

              rhenwood Richard Henwood (Inactive)
              jlevi Jodi Levi (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: