HDDS-1612. Add 'scmcli printTopology' shell command to print datanode topology. Contributed by Sammi Chen.(#910)

Author: ChenSammi

hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/protocol/DatanodeDetails.java

@@ -212,6 +212,8 @@ public HddsProtos.DatanodeDetailsProto getProtoBufMessage() {
     if (certSerialId != null) {
       builder.setCertSerialId(certSerialId);
     }
+    builder.setNetworkLocation(getNetworkLocation());
+
     for (Port port : ports) {
       builder.addPorts(HddsProtos.Port.newBuilder()
           .setName(port.getName().toString())

hadoop-hdds/common/src/main/proto/hdds.proto

@@ -34,6 +34,7 @@ message DatanodeDetailsProto {
     required string hostName = 3;      // hostname
     repeated Port ports = 4;
     optional string certSerialId = 5;   // Certificate serial id.
+    optional string networkLocation = 6; // Network topology location
 }
 
 /**

hadoop-hdds/tools/src/main/java/org/apache/hadoop/hdds/scm/cli/SCMCLI.java

@@ -84,7 +84,8 @@
         CreateSubcommand.class,
         CloseSubcommand.class,
         ListPipelinesSubcommand.class,
-        ClosePipelineSubcommand.class
+        ClosePipelineSubcommand.class,
+        TopologySubcommand.class
     },
     mixinStandardHelpOptions = true)
 public class SCMCLI extends GenericCli {

hadoop-hdds/tools/src/main/java/org/apache/hadoop/hdds/scm/cli/TopologySubcommand.java

@@ -0,0 +1,80 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.hadoop.hdds.scm.cli;
+
+import org.apache.hadoop.hdds.cli.HddsVersionProvider;
+import org.apache.hadoop.hdds.protocol.proto.HddsProtos;
+import org.apache.hadoop.hdds.scm.client.ScmClient;
+import picocli.CommandLine;
+import static org.apache.hadoop.hdds.protocol.proto.HddsProtos.NodeState.DEAD;
+import static org.apache.hadoop.hdds.protocol.proto.HddsProtos.NodeState.DECOMMISSIONED;
+import static org.apache.hadoop.hdds.protocol.proto.HddsProtos.NodeState.DECOMMISSIONING;
+import static org.apache.hadoop.hdds.protocol.proto.HddsProtos.NodeState.HEALTHY;
+import static org.apache.hadoop.hdds.protocol.proto.HddsProtos.NodeState.STALE;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.concurrent.Callable;
+
+/**
+ * Handler of printTopology command.
+ */
+@CommandLine.Command(
+    name = "printTopology",
+    description = "Print a tree of the network topology as reported by SCM",
+    mixinStandardHelpOptions = true,
+    versionProvider = HddsVersionProvider.class)
+public class TopologySubcommand implements Callable<Void> {
+
+  @CommandLine.ParentCommand
+  private SCMCLI parent;
+
+  private static List<HddsProtos.NodeState> stateArray = new ArrayList<>();
+
+  static {
+    stateArray.add(HEALTHY);
+    stateArray.add(STALE);
+    stateArray.add(DEAD);
+    stateArray.add(DECOMMISSIONING);
+    stateArray.add(DECOMMISSIONED);
+  }
+
+  @Override
+  public Void call() throws Exception {
+    try (ScmClient scmClient = parent.createScmClient()) {
+      for (HddsProtos.NodeState state : stateArray) {
+        List<HddsProtos.Node> nodes = scmClient.queryNode(state,
+            HddsProtos.QueryScope.CLUSTER, "");
+        if (nodes != null && nodes.size() > 0) {
+          // show node state
+          System.out.println("State = " + state.toString());
+          // format "hostname/ipAddress    networkLocation"
+          nodes.forEach(node -> {
+            System.out.print(node.getNodeID().getHostName() + "/" +
+                node.getNodeID().getIpAddress());
+            System.out.println("    " +
+                (node.getNodeID().getNetworkLocation() != null ?
+                    node.getNodeID().getNetworkLocation() : "NA"));
+          });
+        }
+      }
+      return null;
+    }
+  }
+}