Uploaded image for project: 'Lustre'
  1. Lustre
  2. LU-930 Update or improvement to a Lustre man page, documentation, or messages
  3. LU-17231

Create man pages for tunable parameters

Details

    • Technical task
    • Resolution: Unresolved
    • Minor
    • None
    • None
    • None
    • 3
    • 9223372036854775807

    Description

      Lustre has a number of tunable parameters, but they are not very well documented.

      It would be useful to start adding man pages in section 5 (config files) for each of the tunable parameters and stats files. This will obviously need a bunch of separate patches, but needs to start somewhere.

      Attachments

        Activity

          [LU-17231] Create man pages for tunable parameters
          adilger Andreas Dilger added a comment -

          There should be a consistent naming format used for the man pages related to the parameter name, so that the man page names could be generated automatically by e.g. "lfs get_param". One proposal (possibly a bit lengthy) would be "lctl-param-TARGET..NAME" as a general template, and specifically something like "lctl-param-osc.-.max_dirty_mb.5, with "{{or similar. I don't think it is possible or practical to embed "*" into the filename, so "{}" is one option that could be used to replace it.

          Each file would have the parameter name, a one-line description, sample output, and provide a description of the output. This should include if the parameter is global or per-device, and whether it is only present with certain configurations. If the parameter is readable and/or writeable, and whether writing to the parameter will reset it.

          adilger Andreas Dilger added a comment - There should be a consistent naming format used for the man pages related to the parameter name, so that the man page names could be generated automatically by e.g. " lfs get_param ". One proposal (possibly a bit lengthy) would be " lctl-param- TARGET . . NAME " as a general template, and specifically something like " lctl-param-osc.-.max_dirty_mb.5 , with "{{or similar. I don't think it is possible or practical to embed "*" into the filename, so "{ }" is one option that could be used to replace it. Each file would have the parameter name, a one-line description, sample output, and provide a description of the output. This should include if the parameter is global or per-device, and whether it is only present with certain configurations. If the parameter is readable and/or writeable, and whether writing to the parameter will reset it.

          People

            fdilger Fred Dilger
            adilger Andreas Dilger
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated: