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 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
|
// 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"
"slices"
"strings"
"time"
"github.com/pingcap/errors"
"github.com/pingcap/kvproto/pkg/pdpb"
"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/tidbver"
"github.com/pingcap/tiup/pkg/utils"
)
// PDSpec represents the PD topology specification in topology.yaml
type PDSpec struct {
Host string `yaml:"host"`
ManageHost string `yaml:"manage_host,omitempty" validate:"manage_host:editable"`
ListenHost string `yaml:"listen_host,omitempty"`
AdvertiseClientAddr string `yaml:"advertise_client_addr,omitempty"`
AdvertisePeerAddr string `yaml:"advertise_peer_addr,omitempty"`
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"`
// Use Name to get the name with a default value if it's empty.
Name string `yaml:"name"`
ClientPort int `yaml:"client_port" default:"2379"`
PeerPort int `yaml:"peer_port" default:"2380"`
DeployDir string `yaml:"deploy_dir,omitempty"`
DataDir string `yaml:"data_dir,omitempty"`
LogDir string `yaml:"log_dir,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 *PDSpec) Status(ctx context.Context, timeout time.Duration, tlsCfg *tls.Config, _ ...string) string {
if timeout < time.Second {
timeout = statusQueryTimeout
}
addr := utils.JoinHostPort(s.GetManageHost(), s.ClientPort)
pc := api.NewPDClient(ctx, []string{addr}, timeout, tlsCfg)
// check health
err := pc.CheckHealth()
if err != nil {
return "Down"
}
// find leader node
leader, err := pc.GetLeader()
if err != nil {
return "ERR"
}
res := "Up"
if s.Name == leader.Name {
res += "|L"
}
return res
}
// Role returns the component role of the instance
func (s *PDSpec) Role() string {
return ComponentPD
}
// SSH returns the host and SSH port of the instance
func (s *PDSpec) 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 *PDSpec) GetMainPort() int {
return s.ClientPort
}
// GetManageHost returns the manage host of the instance
func (s *PDSpec) GetManageHost() string {
if s.ManageHost != "" {
return s.ManageHost
}
return s.Host
}
// IsImported returns if the node is imported from TiDB-Ansible
func (s *PDSpec) IsImported() bool {
return s.Imported
}
// IgnoreMonitorAgent returns if the node does not have monitor agents available
func (s *PDSpec) IgnoreMonitorAgent() bool {
return s.IgnoreExporter
}
// GetAdvertiseClientURL returns AdvertiseClientURL
func (s *PDSpec) GetAdvertiseClientURL(enableTLS bool) string {
if s.AdvertiseClientAddr != "" {
return s.AdvertiseClientAddr
}
scheme := utils.Ternary(enableTLS, "https", "http").(string)
return fmt.Sprintf("%s://%s", scheme, utils.JoinHostPort(s.Host, s.ClientPort))
}
// GetAdvertisePeerURL returns AdvertisePeerURL
func (s *PDSpec) GetAdvertisePeerURL(enableTLS bool) string {
if s.AdvertisePeerAddr != "" {
return s.AdvertisePeerAddr
}
scheme := utils.Ternary(enableTLS, "https", "http").(string)
return fmt.Sprintf("%s://%s", scheme, utils.JoinHostPort(s.Host, s.PeerPort))
}
// PDComponent represents PD component.
type PDComponent struct{ Topology *Specification }
// Name implements Component interface.
func (c *PDComponent) Name() string {
return ComponentPD
}
// Role implements Component interface.
func (c *PDComponent) Role() string {
return ComponentPD
}
// Source implements Component interface.
func (c *PDComponent) Source() string {
source := c.Topology.ComponentSources.PD
if source != "" {
return source
}
return ComponentPD
}
// CalculateVersion implements the Component interface
func (c *PDComponent) CalculateVersion(clusterVersion string) string {
version := c.Topology.ComponentVersions.PD
if version == "" {
version = clusterVersion
}
return version
}
// SetVersion implements Component interface.
func (c *PDComponent) SetVersion(version string) {
c.Topology.ComponentVersions.PD = version
}
// Instances implements Component interface.
func (c *PDComponent) Instances() []Instance {
ins := make([]Instance, 0, len(c.Topology.PDServers))
for _, s := range c.Topology.PDServers {
ins = append(ins, &PDInstance{
Name: s.Name,
BaseInstance: BaseInstance{
InstanceSpec: s,
Name: c.Name(),
Host: s.Host,
ManageHost: s.ManageHost,
ListenHost: utils.Ternary(s.ListenHost != "", s.ListenHost, c.Topology.BaseTopo().GlobalOptions.ListenHost).(string),
Port: s.ClientPort,
SSHP: s.SSHPort,
Source: s.Source,
NumaNode: s.NumaNode,
NumaCores: "",
Ports: []int{
s.ClientPort,
s.PeerPort,
},
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.ClientPort, timeout, tlsCfg)
},
Component: c,
},
topo: c.Topology,
})
}
return ins
}
// PDInstance represent the PD instance
type PDInstance struct {
Name string
BaseInstance
topo Topology
}
// InitConfig implement Instance interface
func (i *PDInstance) 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.(*PDSpec)
scheme := utils.Ternary(enableTLS, "https", "http").(string)
version := i.CalculateVersion(clusterVersion)
initialCluster := []string{}
for _, pdspec := range topo.PDServers {
initialCluster = append(initialCluster, fmt.Sprintf("%s=%s", pdspec.Name, pdspec.GetAdvertisePeerURL(enableTLS)))
}
cfg := &scripts.PDScript{
Name: spec.Name,
ClientURL: fmt.Sprintf("%s://%s", scheme, utils.JoinHostPort(i.GetListenHost(), spec.ClientPort)),
AdvertiseClientURL: spec.GetAdvertiseClientURL(enableTLS),
PeerURL: fmt.Sprintf("%s://%s", scheme, utils.JoinHostPort(i.GetListenHost(), spec.PeerPort)),
AdvertisePeerURL: spec.GetAdvertisePeerURL(enableTLS),
DeployDir: paths.Deploy,
DataDir: paths.Data[0],
LogDir: paths.Log,
InitialCluster: strings.Join(initialCluster, ","),
NumaNode: spec.NumaNode,
MSMode: topo.GlobalOptions.PDMode == "ms",
}
fp := filepath.Join(paths.Cache, fmt.Sprintf("run_pd_%s_%d.sh", i.GetHost(), i.GetPort()))
if err := cfg.ConfigToFile(fp); err != nil {
return err
}
dst := filepath.Join(paths.Deploy, "scripts", "run_pd.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.PD
// 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
}
if err := i.MergeServerConfig(ctx, e, globalConfig, spec.Config, paths); err != nil {
return err
}
return checkConfig(ctx, e, i.ComponentName(), i.ComponentSource(), version, i.OS(), i.Arch(), i.ComponentName()+".toml", paths)
}
// setTLSConfig set TLS Config to support enable/disable TLS
func (i *PDInstance) 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.cacert-path"] = fmt.Sprintf(
"%s/tls/%s",
paths.Deploy,
TLSCACert,
)
configs["security.cert-path"] = fmt.Sprintf(
"%s/tls/%s.crt",
paths.Deploy,
i.Role())
configs["security.key-path"] = fmt.Sprintf(
"%s/tls/%s.pem",
paths.Deploy,
i.Role())
} else {
// drainer tls config list
tlsConfigs := []string{
"security.cacert-path",
"security.cert-path",
"security.key-path",
}
// delete TLS configs
if configs != nil {
for _, config := range tlsConfigs {
delete(configs, config)
}
}
}
return configs, nil
}
// ScaleConfig deploy temporary config on scaling
func (i *PDInstance) ScaleConfig(
ctx context.Context,
e ctxt.Executor,
topo Topology,
clusterName,
clusterVersion,
deployUser string,
paths meta.DirPaths,
) error {
// We need pd.toml here, but we don't need to check it
if err := i.InitConfig(ctx, e, clusterName, clusterVersion, deployUser, paths); err != nil &&
errors.Cause(err) != ErrorCheckConfig {
return err
}
cluster := mustBeClusterTopo(topo)
spec := i.InstanceSpec.(*PDSpec)
scheme := utils.Ternary(cluster.GlobalOptions.TLSEnabled, "https", "http").(string)
initialCluster := []string{}
for _, pdspec := range cluster.PDServers {
initialCluster = append(initialCluster, fmt.Sprintf("%s=%s", pdspec.Name, pdspec.GetAdvertisePeerURL(cluster.GlobalOptions.TLSEnabled)))
}
cfg0 := &scripts.PDScript{
Name: spec.Name,
ClientURL: fmt.Sprintf("%s://%s", scheme, utils.JoinHostPort(i.GetListenHost(), spec.ClientPort)),
AdvertiseClientURL: spec.GetAdvertiseClientURL(cluster.GlobalOptions.TLSEnabled),
PeerURL: fmt.Sprintf("%s://%s", scheme, utils.JoinHostPort(i.GetListenHost(), spec.PeerPort)),
AdvertisePeerURL: spec.GetAdvertisePeerURL(cluster.GlobalOptions.TLSEnabled),
DeployDir: paths.Deploy,
DataDir: paths.Data[0],
LogDir: paths.Log,
InitialCluster: strings.Join(initialCluster, ","),
NumaNode: spec.NumaNode,
MSMode: cluster.GlobalOptions.PDMode == "ms",
}
join := []string{}
for _, pdspec := range cluster.PDServers {
join = append(join, pdspec.GetAdvertiseClientURL(cluster.GlobalOptions.TLSEnabled))
}
cfg := scripts.NewPDScaleScript(cfg0, strings.Join(join, ","))
fp := filepath.Join(paths.Cache, fmt.Sprintf("run_pd_%s_%d.sh", i.GetHost(), i.GetPort()))
if err := cfg.ConfigToFile(fp); err != nil {
return err
}
dst := filepath.Join(paths.Deploy, "scripts", "run_pd.sh")
if err := e.Transfer(ctx, fp, dst, false, 0, false); err != nil {
return err
}
if _, _, err := e.Execute(ctx, "chmod +x "+dst, false); err != nil {
return err
}
return nil
}
var _ RollingUpdateInstance = &PDInstance{}
// IsLeader checks if the instance is PD leader
func (i *PDInstance) IsLeader(ctx context.Context, topo Topology, apiTimeoutSeconds int, tlsCfg *tls.Config) (bool, error) {
tidbTopo, ok := topo.(*Specification)
if !ok {
panic("topo should be type of tidb topology")
}
pdClient := api.NewPDClient(ctx, tidbTopo.GetPDListWithManageHost(), time.Second*5, tlsCfg)
return i.checkLeader(pdClient)
}
func (i *PDInstance) checkLeader(pdClient *api.PDClient) (bool, error) {
leader, err := pdClient.GetLeader()
if err != nil {
return false, errors.Annotatef(err, "failed to get PD leader %s", i.GetHost())
}
return leader.Name == i.Name, nil
}
// PreRestart implements RollingUpdateInstance interface.
func (i *PDInstance) PreRestart(ctx context.Context, topo Topology, apiTimeoutSeconds int, tlsCfg *tls.Config, updcfg *UpdateConfig) error {
timeoutOpt := &utils.RetryOption{
Timeout: time.Second * time.Duration(apiTimeoutSeconds),
Delay: time.Second * 2,
}
tidbTopo, ok := topo.(*Specification)
if !ok {
panic("topo should be type of tidb topology")
}
pdClient := api.NewPDClient(ctx, tidbTopo.GetPDListWithManageHost(), time.Second*5, tlsCfg)
isLeader, err := i.checkLeader(pdClient)
if err != nil {
return err
}
if len(tidbTopo.PDServers) > 1 && isLeader {
members, err := pdClient.GetMembers()
if err != nil {
return err
}
var oldPriority int32
if m := slices.IndexFunc(members.Members, func(j *pdpb.Member) bool {
return i.Name == j.Name
}); m != -1 && members.Members[m].LeaderPriority != 0 {
oldPriority = members.Members[m].LeaderPriority
}
if oldPriority != 0 {
if err := pdClient.SetLeaderPriority(i.Name, 0); err != nil {
return errors.Annotatef(err, "failed to clear PD leader priority[%d] %s", oldPriority, i.GetHost())
}
}
if err := pdClient.EvictPDLeader(timeoutOpt); err != nil {
return errors.Annotatef(err, "failed to evict PD leader %s", i.GetHost())
}
if err := pdClient.SetLeaderPriority(i.Name, oldPriority); err != nil {
return errors.Annotatef(err, "failed to recover PD leader priority[%d] %s", oldPriority, i.GetHost())
}
}
return nil
}
// PostRestart implements RollingUpdateInstance interface.
func (i *PDInstance) PostRestart(ctx context.Context, topo Topology, tlsCfg *tls.Config, updcfg *UpdateConfig) error {
// When restarting the next PD, if the PD has not been fully started and has become the target of
// the transfer leader, this may cause the PD service to be unavailable for about 10 seconds.
timeoutOpt := utils.RetryOption{
Attempts: 100,
Delay: time.Second,
Timeout: 120 * time.Second,
}
currentPDAddrs := []string{utils.JoinHostPort(i.GetManageHost(), i.Port)}
pdClient := api.NewPDClient(ctx, currentPDAddrs, 5*time.Second, tlsCfg)
if err := utils.Retry(pdClient.CheckHealth, timeoutOpt); err != nil {
return errors.Annotatef(err, "failed to start PD peer %s", i.GetHost())
}
if updcfg.TargetVersion != "" && tidbver.PDSupportReadyAPI(updcfg.TargetVersion) {
if err := utils.Retry(pdClient.CheckReady, timeoutOpt); err != nil {
return errors.Annotatef(err, "failed to wait PD load all regions %s", i.GetHost())
}
}
return nil
}
|