cluster: Add JSON output option for 'display'

#1355
pingcap · May 11, 2021 · 8d19108 · 8d19108
1 parent a229992
commit 8d19108
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 1 deletion.
diff --git a/1 b/1
diff --git a/components/cluster/command/display.go b/components/cluster/command/display.go
@@ -84,6 +84,7 @@ func newDisplayCmd() *cobra.Command {
 	cmd.Flags().BoolVar(&gOpt.ShowUptime, "uptime", false, "Display with uptime")
 	cmd.Flags().BoolVar(&showDashboardOnly, "dashboard", false, "Only display TiDB Dashboard information")
 	cmd.Flags().BoolVar(&showVersionOnly, "version", false, "Only display TiDB cluster version")
+	cmd.Flags().BoolVar(&gOpt.Json, "json", false, "Output in JSON format when applicable")
 
 	return cmd
 }

diff --git a/pkg/cluster/manager/display.go b/pkg/cluster/manager/display.go
@@ -15,6 +15,7 @@ package manager
 
 import (
 	"context"
+	"encoding/json"
 	"errors"
 	"fmt"
 	"math"
@@ -53,6 +54,18 @@ type InstInfo struct {
 	Port          int
 }
 
+type DashboardInfo struct {
+	ClusterType    string `json:cluster_type`
+	ClusterName    string `json:cluster_name`
+	ClusterVersion string `json:cluster_version`
+	SSHType        string `json:ssh_type`
+}
+
+type JsonOutput struct {
+	DashboardInfo DashboardInfo
+	InstanceInfos []InstInfo
+}
+
 // Display cluster meta and topology.
 func (m *Manager) Display(name string, opt operator.Options) error {
 	if err := clusterutil.ValidateClusterNameOrError(name); err != nil {
@@ -68,6 +81,24 @@ func (m *Manager) Display(name string, opt operator.Options) error {
 	topo := metadata.GetTopology()
 	base := metadata.GetBaseMeta()
 	// display cluster meta
+	if opt.Json {
+		j := &JsonOutput{
+			DashboardInfo: DashboardInfo{
+				m.sysName,
+				name,
+				base.Version,
+				string(topo.BaseTopo().GlobalOptions.SSHType),
+			},
+			InstanceInfos: clusterInstInfos,
+		}
+
+		d, err := json.MarshalIndent(j, "", "  ")
+		if err != nil {
+			return err
+		}
+		fmt.Println(string(d))
+		return nil
+	}
 	cyan := color.New(color.FgCyan, color.Bold)
 	fmt.Printf("Cluster type:       %s\n", cyan.Sprint(m.sysName))
 	fmt.Printf("Cluster name:       %s\n", cyan.Sprint(name))

diff --git a/pkg/cluster/operation/operation.go b/pkg/cluster/operation/operation.go
@@ -43,7 +43,9 @@ type Options struct {
 
 	// Show uptime or not
 	ShowUptime bool
-	Operation  Operation
+
+	Json      bool
+	Operation Operation
 }
 
 // Operation represents the type of cluster operation