1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
// Copyright 2021 PingCAP, Inc.
//
// Licensed 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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
package command
import (
"bytes"
"fmt"
"path"
"text/template"
"github.com/pingcap/errors"
"github.com/pingcap/tiup/embed"
"github.com/spf13/cobra"
)
// TemplateOptions contains the options for print topology template.
type TemplateOptions struct {
Full bool // print full template
MultiDC bool // print template for deploying to multiple data center
Local bool // print and render local template
}
// LocalTemplate contains the variables for print local template.
type LocalTemplate struct {
GlobalUser string // global.user in yaml template
GlobalGroup string // global.group in yaml template
GlobalSystemdMode string // global.systemd_mode in yaml template
GlobalSSHPort int // global.ssh_port in yaml template
GlobalDeployDir string // global.deploy_dir in yaml template
GlobalDataDir string // global.data_dir in yaml template
GlobalArch string // global.arch in yaml template
PDServers []string // pd_servers in yaml template
TiDBServers []string // tidb_servers in yaml template
TiKVServers []string // tikv_servers in yaml template
TiFlashServers []string // tiflash_servers in yaml template
MonitoringServers []string // monitoring_servers in yaml template
GrafanaServers []string // grafana_servers in yaml template
AlertManagerServers []string // alertmanager_servers in yaml template
}
// This is used to identify how many bool type options are set, so that an
// error can be throw if more than one is given.
func sumBool(b ...bool) int {
n := 0
for _, v := range b {
if v {
n++
}
}
return n
}
func newTemplateCmd() *cobra.Command {
opt := TemplateOptions{}
localOpt := LocalTemplate{}
cmd := &cobra.Command{
Use: "template",
Short: "Print topology template",
RunE: func(cmd *cobra.Command, args []string) error {
if sumBool(opt.Full, opt.MultiDC, opt.Local) > 1 {
return errors.New("at most one of 'full', 'multi-dc', or 'local' can be specified")
}
name := "minimal.yaml"
switch {
case opt.Full:
name = "topology.example.yaml"
case opt.MultiDC:
name = "multi-dc.yaml"
case opt.Local:
name = "local.tpl"
}
fp := path.Join("examples", "cluster", name)
tpl, err := embed.ReadExample(fp)
if err != nil {
return err
}
if !opt.Local {
// print example yaml and return
fmt.Fprintln(cmd.OutOrStdout(), string(tpl))
return nil
}
// redner template
// validate arch
if localOpt.GlobalArch != "amd64" && localOpt.GlobalArch != "arm64" {
return fmt.Errorf(`supported values are "amd64" or "arm64" in global.arch`)
}
tmpl, err := template.New(name).Parse(string(tpl))
if err != nil {
return err
}
content := bytes.NewBufferString("")
if err := tmpl.Execute(content, &localOpt); err != nil {
return err
}
fmt.Fprintln(cmd.OutOrStdout(), content.String())
return nil
},
}
cmd.Flags().BoolVar(&opt.Full, "full", false, "Print the full topology template for TiDB cluster.")
cmd.Flags().BoolVar(&opt.MultiDC, "multi-dc", false, "Print template for deploying to multiple data center.")
cmd.Flags().BoolVar(&opt.Local, "local", false, "Print and render template for deploying a simple cluster locally.")
// template values for rendering
cmd.Flags().StringVar(&localOpt.GlobalUser, "user", "tidb", "The user who runs the tidb cluster.")
cmd.Flags().StringVar(&localOpt.GlobalGroup, "group", "", "group is used to specify the group name the user belong to if it's not the same as user.")
cmd.Flags().StringVar(&localOpt.GlobalSystemdMode, "systemd_mode", "system", "systemd_mode is used to select whether to use sudo permissions.")
cmd.Flags().IntVar(&localOpt.GlobalSSHPort, "ssh-port", 22, "SSH port of servers in the managed cluster.")
cmd.Flags().StringVar(&localOpt.GlobalDeployDir, "deploy-dir", "/tidb-deploy", "Storage directory for cluster deployment files, startup scripts, and configuration files.")
cmd.Flags().StringVar(&localOpt.GlobalDataDir, "data-dir", "/tidb-data", "TiDB Cluster data storage directory.")
cmd.Flags().StringVar(&localOpt.GlobalArch, "arch", "amd64", "Supported values: \"amd64\", \"arm64\".")
cmd.Flags().StringSliceVar(&localOpt.PDServers, "pd-servers", []string{"127.0.0.1"}, "List of PD servers")
cmd.Flags().StringSliceVar(&localOpt.TiDBServers, "tidb-servers", []string{"127.0.0.1"}, "List of TiDB servers")
cmd.Flags().StringSliceVar(&localOpt.TiKVServers, "tikv-servers", []string{"127.0.0.1"}, "List of TiKV servers")
cmd.Flags().StringSliceVar(&localOpt.TiFlashServers, "tiflash-servers", nil, "List of TiFlash servers")
cmd.Flags().StringSliceVar(&localOpt.MonitoringServers, "monitoring-servers", []string{"127.0.0.1"}, "List of monitor servers")
cmd.Flags().StringSliceVar(&localOpt.GrafanaServers, "grafana-servers", []string{"127.0.0.1"}, "List of grafana servers")
cmd.Flags().StringSliceVar(&localOpt.AlertManagerServers, "alertmanager-servers", nil, "List of alermanager servers")
return cmd
}
|
