HDDS-13137. Specify which roles need to be stopped for repair on per command basis

hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/repair/OzoneRepair.java

@@ -27,8 +27,8 @@
  * Ozone Repair Command line tool.
  */
 @CommandLine.Command(name = "ozone repair",
-    description = "Advanced tool to repair Ozone. The nodes being repaired " +
-        "must be stopped before the tool is run.",
+    description = "Advanced tool to repair Ozone. Check subcommand help for respective" +
+        " role status requirements.",
     versionProvider = HddsVersionProvider.class,
     mixinStandardHelpOptions = true)
 public class OzoneRepair extends GenericCli implements ExtensibleParentCommand {

hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/repair/TransactionInfoRepair.java

@@ -44,7 +44,8 @@
  */
 @CommandLine.Command(
     name = "update-transaction",
-    description = "CLI to update the highest index in transaction info table.",
+    description = "CLI to update the highest index in transaction info table." +
+        " The corresponding OM or SCM role should be stopped for this tool.",
     mixinStandardHelpOptions = true,
     versionProvider = HddsVersionProvider.class
 )

hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/repair/datanode/schemaupgrade/UpgradeContainerSchema.java

@@ -73,8 +73,8 @@
  */
 @Command(
     name = "upgrade-container-schema",
-    description = "Offline upgrade all schema V2 containers to schema V3 " +
-        "for this datanode.",
+    description = "Offline upgrade all schema V2 containers to schema V3 for this datanode." + 
+        " DataNode should be stopped for this command.",
     mixinStandardHelpOptions = true,
     versionProvider = HddsVersionProvider.class)
 public class UpgradeContainerSchema extends RepairTool {

hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/repair/ldb/RocksDBManualCompaction.java

@@ -41,7 +41,8 @@
     name = "compact",
     description = "CLI to compact a column-family in the DB while the service is offline.\n" +
         "Note: If om.db is compacted with this tool then it will negatively impact " +
-        "the Ozone Manager's efficient snapshot diff.",
+        "the Ozone Manager's efficient snapshot diff." + 
+        " The corresponding OM or SCM or DataNode role should be stopped for this tool.",
     mixinStandardHelpOptions = true,
     versionProvider = HddsVersionProvider.class
 )

hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/repair/om/CompactOMDB.java

@@ -32,7 +32,8 @@
 @CommandLine.Command(
     name = "compact",
     description = "CLI to compact a column family in the om.db. " +
-        "The compaction happens asynchronously. Requires admin privileges.",
+        "The compaction happens asynchronously. Requires admin privileges." +
+        " OM should be running for this tool.",
     mixinStandardHelpOptions = true,
     versionProvider = HddsVersionProvider.class
 )

hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/repair/om/FSORepairTool.java

@@ -82,7 +82,7 @@
 @CommandLine.Command(
     name = "fso-tree",
     description = "Identify and repair a disconnected FSO tree by marking unreferenced (orphaned) entries for " +
-        "deletion. OM should be stopped while this tool is run."
+        "deletion. OM should be stopped for this tool."
 )
 public class FSORepairTool extends RepairTool {
   private static final Logger LOG = LoggerFactory.getLogger(FSORepairTool.class);

hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/repair/om/OMRatisLogRepair.java

@@ -50,7 +50,8 @@
         "The command should be run for the same transaction on all 3 OMs only when all the OMs are crashing " +
         "while applying the same transaction. If only one OM is crashing and the " +
         "other OMs have executed the log successfully, then the DB should be manually copied " +
-        "from one of the good OMs to the crashing OM instead.",
+        "from one of the good OMs to the crashing OM instead." + 
+        " OM should be stopped for this tool",
     mixinStandardHelpOptions = true,
     versionProvider = HddsVersionProvider.class
 )

hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/repair/om/SnapshotChainRepair.java

@@ -51,6 +51,7 @@
 @CommandLine.Command(
     name = "chain",
     description = "CLI to update global and path previous snapshot for a snapshot in case snapshot chain is corrupted."
+        + " OM should be stopped for this tool."
 )
 public class SnapshotChainRepair extends RepairTool {
 

hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/repair/om/quota/QuotaRepair.java

@@ -44,7 +44,7 @@
         QuotaStatus.class,
         QuotaTrigger.class,
     },
-    description = "Operational tool to repair quota in OM DB.")
+    description = "Operational tool to repair quota in OM DB." + " OM should be running for this tool.")
 public class QuotaRepair extends AbstractSubcommand {
 
   public OzoneManagerProtocolClientSideTranslatorPB createOmClient(

hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/repair/scm/cert/RecoverSCMCertificate.java

@@ -63,7 +63,8 @@
  */
 @CommandLine.Command(
     name = "recover",
-    description = "Recover Deleted SCM Certificate from RocksDB")
+    description = "Recover Deleted SCM Certificate from RocksDB."  +
+        " SCM should be stopped for this tool.")
 public class RecoverSCMCertificate extends RepairTool {
   @CommandLine.Option(names = {"--db"},
       required = true,