Uploaded image for project: 'Lustre'
  1. Lustre
  2. LU-11846

add proper documentation for replace_nids command

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: Lustre 2.12.0, Lustre 2.13.0, Lustre 2.10.6
    • Fix Version/s: Lustre 2.14.0
    • Labels:
    • Rank (Obsolete):
      9223372036854775807

      Description

      Can you please add a separate lctl-replace_nids.8 man page for the replace_nids command, and update the user manual in a similar manner. The current entry in the lctl.8 man page and manual entry are totally lacking in explanation of what the various NIDs mean:

             replace_nids <devicename> <nid1>[,nid2,nid3:nid4,nid5:nid6 ...]
                    Replace the LNET Network Identifiers for a given device, as when
                    the server's IP address has changed.  This command must  be  run
                    on  the  MGS  node.   Only MGS server should be started (command
                    execution returns error in another cases). To start the MGS ser-
                    vice  only:  mount  -t  lustre  <MDT  partition> -o nosvc <mount
                    point> Note  the  replace_nids  command  skips  any  invalidated
                    records in the configuration log.  The previous log is backed up
                    with the suffix '.bak'.  Failover nids must be passed after  ':'
                    symbol.  More  then one failover can be set (every failover nids
                    after ':' symbol).
      

      This could be improved in several ways:

      • don't use "nid1,nid2,nid3,nid4" in the description, but rather names like original_nid and nodeA_nid1,nodeA_nid2:nodeB_nid1,nodeB_nid2 or similar.
      • it should have an explanation of the behaviour for failover NIDs, as was described in the patch https://review.whamcloud.com/30624 "LU-10384 mgs: replace_nids large string and failover support" commit message.

      The choice of syntax for the replace_nids command is also very confusing, since the nid1,nid2,nid3:nid4,nid5 part could easily be mis-parsed if only the "new" NIDs are given as nid2,nid3:nid4,nid5. It would be better to use getopt_long() and provide named arguments like:

      lctl replace_nids <target> --orig <original_nid> --new <nodeA_nid1>,<nodeA_nid2> --failnode <nodeB_nid1>,<nodeB_nid2>
      

      or --servicenode or something similar. This would make it clear which NID is being replaced, and which NIDs are being added, and allows for other options to be added in the future.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                artem_blagodarenko Artem Blagodarenko
                Reporter:
                adilger Andreas Dilger
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated: