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 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
|
// Copyright 2020 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 spec
import (
"context"
"crypto/tls"
"fmt"
"os"
"path/filepath"
"strings"
"time"
"github.com/pingcap/tiup/pkg/cluster/api"
"github.com/pingcap/tiup/pkg/cluster/ctxt"
"github.com/pingcap/tiup/pkg/cluster/template/scripts"
"github.com/pingcap/tiup/pkg/meta"
"github.com/pingcap/tiup/pkg/utils"
)
// PumpSpec represents the Pump topology specification in topology.yaml
type PumpSpec struct {
Host string `yaml:"host"`
ManageHost string `yaml:"manage_host,omitempty" validate:"manage_host:editable"`
SSHPort int `yaml:"ssh_port,omitempty" validate:"ssh_port:editable"`
Imported bool `yaml:"imported,omitempty"`
Patched bool `yaml:"patched,omitempty"`
IgnoreExporter bool `yaml:"ignore_exporter,omitempty"`
Port int `yaml:"port" default:"8250"`
DeployDir string `yaml:"deploy_dir,omitempty"`
DataDir string `yaml:"data_dir,omitempty"`
LogDir string `yaml:"log_dir,omitempty"`
Offline bool `yaml:"offline,omitempty"`
Source string `yaml:"source,omitempty" validate:"source:editable"`
NumaNode string `yaml:"numa_node,omitempty" validate:"numa_node:editable"`
Config map[string]any `yaml:"config,omitempty" validate:"config:ignore"`
ResourceControl meta.ResourceControl `yaml:"resource_control,omitempty" validate:"resource_control:editable"`
Arch string `yaml:"arch,omitempty"`
OS string `yaml:"os,omitempty"`
}
// Status queries current status of the instance
func (s *PumpSpec) Status(ctx context.Context, timeout time.Duration, tlsCfg *tls.Config, pdList ...string) string {
if timeout < time.Second {
timeout = statusQueryTimeout
}
state := statusByHost(s.GetManageHost(), s.Port, "/status", timeout, tlsCfg)
if s.Offline {
binlogClient, err := api.NewBinlogClient(pdList, timeout, tlsCfg)
if err != nil {
return state
}
id := utils.JoinHostPort(s.Host, s.Port)
tombstone, _ := binlogClient.IsPumpTombstone(ctx, id)
if tombstone {
state = "Tombstone"
} else {
state = "Pending Offline"
}
}
return state
}
// Role returns the component role of the instance
func (s *PumpSpec) Role() string {
return ComponentPump
}
// SSH returns the host and SSH port of the instance
func (s *PumpSpec) SSH() (string, int) {
host := s.Host
if s.ManageHost != "" {
host = s.ManageHost
}
return host, s.SSHPort
}
// GetMainPort returns the main port of the instance
func (s *PumpSpec) GetMainPort() int {
return s.Port
}
// GetManageHost returns the manage host of the instance
func (s *PumpSpec) GetManageHost() string {
if s.ManageHost != "" {
return s.ManageHost
}
return s.Host
}
// IsImported returns if the node is imported from TiDB-Ansible
func (s *PumpSpec) IsImported() bool {
return s.Imported
}
// IgnoreMonitorAgent returns if the node does not have monitor agents available
func (s *PumpSpec) IgnoreMonitorAgent() bool {
return s.IgnoreExporter
}
// PumpComponent represents Pump component.
type PumpComponent struct{ Topology *Specification }
// Name implements Component interface.
func (c *PumpComponent) Name() string {
return ComponentPump
}
// Role implements Component interface.
func (c *PumpComponent) Role() string {
return ComponentPump
}
// Source implements Component interface.
func (c *PumpComponent) Source() string {
source := c.Topology.ComponentSources.Pump
if source != "" {
return source
}
return ComponentPump
}
// CalculateVersion implements the Component interface
func (c *PumpComponent) CalculateVersion(clusterVersion string) string {
version := c.Topology.ComponentVersions.Pump
if version == "" {
version = clusterVersion
}
return version
}
// SetVersion implements Component interface.
func (c *PumpComponent) SetVersion(version string) {
c.Topology.ComponentVersions.Pump = version
}
// Instances implements Component interface.
func (c *PumpComponent) Instances() []Instance {
ins := make([]Instance, 0, len(c.Topology.PumpServers))
for _, s := range c.Topology.PumpServers {
ins = append(ins, &PumpInstance{BaseInstance{
InstanceSpec: s,
Name: c.Name(),
Host: s.Host,
ManageHost: s.ManageHost,
ListenHost: c.Topology.BaseTopo().GlobalOptions.ListenHost,
Port: s.Port,
SSHP: s.SSHPort,
Source: s.Source,
NumaNode: s.NumaNode,
NumaCores: "",
Ports: []int{
s.Port,
},
Dirs: []string{
s.DeployDir,
s.DataDir,
},
StatusFn: s.Status,
UptimeFn: func(_ context.Context, timeout time.Duration, tlsCfg *tls.Config) time.Duration {
return UptimeByHost(s.GetManageHost(), s.Port, timeout, tlsCfg)
},
Component: c,
}, c.Topology})
}
return ins
}
// PumpInstance represent the Pump instance.
type PumpInstance struct {
BaseInstance
topo Topology
}
// ScaleConfig deploy temporary config on scaling
func (i *PumpInstance) ScaleConfig(
ctx context.Context,
e ctxt.Executor,
topo Topology,
clusterName,
clusterVersion,
deployUser string,
paths meta.DirPaths,
) error {
s := i.topo
defer func() {
i.topo = s
}()
i.topo = mustBeClusterTopo(topo)
return i.InitConfig(ctx, e, clusterName, clusterVersion, deployUser, paths)
}
// InitConfig implements Instance interface.
func (i *PumpInstance) InitConfig(
ctx context.Context,
e ctxt.Executor,
clusterName,
clusterVersion,
deployUser string,
paths meta.DirPaths,
) error {
topo := i.topo.(*Specification)
if err := i.BaseInstance.InitConfig(ctx, e, topo.GlobalOptions, deployUser, paths); err != nil {
return err
}
enableTLS := topo.GlobalOptions.TLSEnabled
spec := i.InstanceSpec.(*PumpSpec)
nodeID := i.ID()
// keep origin node id if is imported
if i.IsImported() {
nodeID = ""
}
pds := []string{}
for _, pdspec := range topo.PDServers {
pds = append(pds, pdspec.GetAdvertiseClientURL(enableTLS))
}
cfg := &scripts.PumpScript{
NodeID: nodeID,
Addr: utils.JoinHostPort(i.GetListenHost(), spec.Port),
AdvertiseAddr: utils.JoinHostPort(spec.Host, spec.Port),
PD: strings.Join(pds, ","),
DeployDir: paths.Deploy,
DataDir: paths.Data[0],
LogDir: paths.Log,
NumaNode: spec.NumaNode,
}
fp := filepath.Join(paths.Cache, fmt.Sprintf("run_pump_%s_%d.sh", i.GetHost(), i.GetPort()))
if err := cfg.ConfigToFile(fp); err != nil {
return err
}
dst := filepath.Join(paths.Deploy, "scripts", "run_pump.sh")
if err := e.Transfer(ctx, fp, dst, false, 0, false); err != nil {
return err
}
_, _, err := e.Execute(ctx, "chmod +x "+dst, false)
if err != nil {
return err
}
globalConfig := topo.ServerConfigs.Pump
// merge config files for imported instance
if i.IsImported() {
configPath := ClusterPath(
clusterName,
AnsibleImportedConfigPath,
fmt.Sprintf(
"%s-%s-%d.toml",
i.ComponentName(),
i.GetHost(),
i.GetPort(),
),
)
importConfig, err := os.ReadFile(configPath)
if err != nil {
return err
}
globalConfig, err = mergeImported(importConfig, globalConfig)
if err != nil {
return err
}
}
// set TLS configs
spec.Config, err = i.setTLSConfig(ctx, enableTLS, spec.Config, paths)
if err != nil {
return err
}
return i.MergeServerConfig(ctx, e, globalConfig, spec.Config, paths)
}
// setTLSConfig set TLS Config to support enable/disable TLS
func (i *PumpInstance) setTLSConfig(ctx context.Context, enableTLS bool, configs map[string]any, paths meta.DirPaths) (map[string]any, error) {
// set TLS configs
if enableTLS {
if configs == nil {
configs = make(map[string]any)
}
configs["security.ssl-ca"] = fmt.Sprintf(
"%s/tls/%s",
paths.Deploy,
TLSCACert,
)
configs["security.ssl-cert"] = fmt.Sprintf(
"%s/tls/%s.crt",
paths.Deploy,
i.Role())
configs["security.ssl-key"] = fmt.Sprintf(
"%s/tls/%s.pem",
paths.Deploy,
i.Role())
} else {
// drainer tls config list
tlsConfigs := []string{
"security.ssl-ca",
"security.ssl-cert",
"security.ssl-key",
}
// delete TLS configs
if configs != nil {
for _, config := range tlsConfigs {
delete(configs, config)
}
}
}
return configs, nil
}
|