Documentation
¶
Index ¶
- Constants
- func AllDMComponentNames() (roles []string)
- func GetSpecManager() *cspec.SpecManager
- func PortStarted(e executor.Executor, port int, timeout int64) error
- func PortStopped(e executor.Executor, port int, timeout int64) error
- type AlertManagerSpec
- type Component
- type DMMasterComponent
- type DMMasterInstance
- func (i *DMMasterInstance) Arch() string
- func (i *DMMasterInstance) ComponentName() string
- func (i *DMMasterInstance) DataDir() string
- func (i *DMMasterInstance) DeployDir() string
- func (i *DMMasterInstance) GetHost() string
- func (i *DMMasterInstance) GetPort() int
- func (i *DMMasterInstance) GetSSHPort() int
- func (i *DMMasterInstance) ID() string
- func (i *DMMasterInstance) InitConfig(e executor.Executor, clusterName, clusterVersion, deployUser string, ...) error
- func (i *DMMasterInstance) InstanceName() string
- func (i *DMMasterInstance) LogDir() string
- func (i *DMMasterInstance) OS() string
- func (i *DMMasterInstance) PrepareStart() error
- func (i *DMMasterInstance) Ready(e executor.Executor, timeout int64) error
- func (i *DMMasterInstance) ScaleConfig(e executor.Executor, topo spec.Topology, ...) error
- func (i *DMMasterInstance) ServiceName() string
- func (i *DMMasterInstance) Status(masterList ...string) string
- func (i *DMMasterInstance) UsedDirs() []string
- func (i *DMMasterInstance) UsedPorts() []int
- func (i *DMMasterInstance) WaitForDown(e executor.Executor, timeout int64) error
- type DMServerConfigs
- type DMWorkerComponent
- type DMWorkerInstance
- func (i *DMWorkerInstance) Arch() string
- func (i *DMWorkerInstance) ComponentName() string
- func (i *DMWorkerInstance) DataDir() string
- func (i *DMWorkerInstance) DeployDir() string
- func (i *DMWorkerInstance) GetHost() string
- func (i *DMWorkerInstance) GetPort() int
- func (i *DMWorkerInstance) GetSSHPort() int
- func (i *DMWorkerInstance) ID() string
- func (i *DMWorkerInstance) InitConfig(e executor.Executor, clusterName, clusterVersion, deployUser string, ...) error
- func (i *DMWorkerInstance) InstanceName() string
- func (i *DMWorkerInstance) LogDir() string
- func (i *DMWorkerInstance) OS() string
- func (i *DMWorkerInstance) PrepareStart() error
- func (i *DMWorkerInstance) Ready(e executor.Executor, timeout int64) error
- func (i *DMWorkerInstance) ScaleConfig(e executor.Executor, topo spec.Topology, ...) error
- func (i *DMWorkerInstance) ServiceName() string
- func (i *DMWorkerInstance) Status(masterList ...string) string
- func (i *DMWorkerInstance) UsedDirs() []string
- func (i *DMWorkerInstance) UsedPorts() []int
- func (i *DMWorkerInstance) WaitForDown(e executor.Executor, timeout int64) error
- type GlobalOptions
- type GrafanaSpec
- type Instance
- type InstanceSpec
- type MasterSpec
- type Metadata
- type PrometheusSpec
- type ResourceControl
- type Topology
- func (topo *Topology) BaseTopo() *spec.BaseTopo
- func (topo *Topology) ComponentsByStartOrder() (comps []Component)
- func (topo *Topology) ComponentsByStopOrder() (comps []Component)
- func (topo *Topology) ComponentsByUpdateOrder() (comps []Component)
- func (topo *Topology) CountDir(targetHost, dirPrefix string) int
- func (topo *Topology) Endpoints(user string) []*scripts.DMMasterScript
- func (topo *Topology) GetGlobalOptions() spec.GlobalOptions
- func (topo *Topology) GetMasterList() []string
- func (topo *Topology) GetMonitoredOptions() *spec.MonitoredOptions
- func (topo *Topology) IterComponent(fn func(comp Component))
- func (topo *Topology) IterHost(fn func(instance Instance))
- func (topo *Topology) IterInstance(fn func(instance Instance))
- func (topo *Topology) Merge(that *Topology) *Topology
- func (topo *Topology) MergeTopo(rhs spec.Topology) spec.Topology
- func (topo *Topology) NewPart() spec.Topology
- func (topo *Topology) UnmarshalYAML(unmarshal func(interface{}) error) error
- func (topo *Topology) Validate() error
- type WorkerSpec
Constants ¶
const ( ComponentDMMaster = "dm-master" ComponentDMWorker = "dm-worker" ComponentDumpling = "dumpling" ComponentLightning = "lightning" ComponentImporter = "importer" ComponentPrometheus = spec.ComponentPrometheus ComponentGrafana = spec.ComponentGrafana ComponentAlertManager = spec.ComponentAlertManager )
Components names supported by TiOps
Variables ¶
This section is empty.
Functions ¶
func AllDMComponentNames ¶
func AllDMComponentNames() (roles []string)
AllDMComponentNames contains the names of all dm components. should include all components in ComponentsByStartOrder
func GetSpecManager ¶
func GetSpecManager() *cspec.SpecManager
GetSpecManager return the spec manager of dm cluster.
func PortStarted ¶
PortStarted wait until a port is being listened
Types ¶
type AlertManagerSpec ¶
type AlertManagerSpec = spec.AlertManagerSpec
AlertManagerSpec is the spec of Alertmanager
type DMMasterComponent ¶
type DMMasterComponent struct{ *Topology }
DMMasterComponent represents TiDB component.
func (*DMMasterComponent) Instances ¶
func (c *DMMasterComponent) Instances() []Instance
Instances implements Component interface.
func (*DMMasterComponent) Name ¶
func (c *DMMasterComponent) Name() string
Name implements Component interface.
type DMMasterInstance ¶
type DMMasterInstance struct { Name string // contains filtered or unexported fields }
DMMasterInstance represent the TiDB instance
func (*DMMasterInstance) ComponentName ¶
func (i *DMMasterInstance) ComponentName() string
ComponentName implements Instance interface
func (*DMMasterInstance) GetHost ¶
func (i *DMMasterInstance) GetHost() string
GetHost implements Instance interface
func (*DMMasterInstance) GetSSHPort ¶
func (i *DMMasterInstance) GetSSHPort() int
GetSSHPort implements Instance interface
func (*DMMasterInstance) ID ¶
func (i *DMMasterInstance) ID() string
ID returns the identifier of this instance, the ID is constructed by host:port
func (*DMMasterInstance) InitConfig ¶
func (i *DMMasterInstance) InitConfig(e executor.Executor, clusterName, clusterVersion, deployUser string, paths meta.DirPaths) error
InitConfig implement Instance interface
func (*DMMasterInstance) InstanceName ¶
func (i *DMMasterInstance) InstanceName() string
InstanceName implements Instance interface
func (*DMMasterInstance) PrepareStart ¶
func (i *DMMasterInstance) PrepareStart() error
func (*DMMasterInstance) ScaleConfig ¶
func (i *DMMasterInstance) ScaleConfig(e executor.Executor, topo spec.Topology, clusterName, clusterVersion, deployUser string, paths meta.DirPaths) error
ScaleConfig deploy temporary config on scaling
func (*DMMasterInstance) ServiceName ¶
func (i *DMMasterInstance) ServiceName() string
ServiceName implements Instance interface
type DMServerConfigs ¶
type DMServerConfigs struct { Master map[string]interface{} `yaml:"dm_master"` Worker map[string]interface{} `yaml:"dm_worker"` }
DMServerConfigs represents the server runtime configuration
type DMWorkerComponent ¶
type DMWorkerComponent struct {
*Topology
}
DMWorkerComponent represents DM worker component.
func (*DMWorkerComponent) Instances ¶
func (c *DMWorkerComponent) Instances() []Instance
Instances implements Component interface.
func (*DMWorkerComponent) Name ¶
func (c *DMWorkerComponent) Name() string
Name implements Component interface.
type DMWorkerInstance ¶
type DMWorkerInstance struct { Name string // contains filtered or unexported fields }
DMWorkerInstance represent the DM worker instance
func (*DMWorkerInstance) ComponentName ¶
func (i *DMWorkerInstance) ComponentName() string
ComponentName implements Instance interface
func (*DMWorkerInstance) GetHost ¶
func (i *DMWorkerInstance) GetHost() string
GetHost implements Instance interface
func (*DMWorkerInstance) GetSSHPort ¶
func (i *DMWorkerInstance) GetSSHPort() int
GetSSHPort implements Instance interface
func (*DMWorkerInstance) ID ¶
func (i *DMWorkerInstance) ID() string
ID returns the identifier of this instance, the ID is constructed by host:port
func (*DMWorkerInstance) InitConfig ¶
func (i *DMWorkerInstance) InitConfig(e executor.Executor, clusterName, clusterVersion, deployUser string, paths meta.DirPaths) error
InitConfig implement Instance interface
func (*DMWorkerInstance) InstanceName ¶
func (i *DMWorkerInstance) InstanceName() string
InstanceName implements Instance interface
func (*DMWorkerInstance) PrepareStart ¶
func (i *DMWorkerInstance) PrepareStart() error
func (*DMWorkerInstance) ScaleConfig ¶
func (i *DMWorkerInstance) ScaleConfig(e executor.Executor, topo spec.Topology, clusterName, clusterVersion, deployUser string, paths meta.DirPaths) error
ScaleConfig deploy temporary config on scaling
func (*DMWorkerInstance) ServiceName ¶
func (i *DMWorkerInstance) ServiceName() string
ServiceName implements Instance interface
type InstanceSpec ¶
type InstanceSpec interface { Role() string SSH() (string, int) GetMainPort() int IsImported() bool }
InstanceSpec represent a instance specification
type MasterSpec ¶
type MasterSpec struct { Host string `yaml:"host"` SSHPort int `yaml:"ssh_port,omitempty" validate:"ssh_port:editable"` Imported bool `yaml:"imported,omitempty"` // Use Name to get the name with a default value if it's empty. Name string `yaml:"name"` Port int `yaml:"port" default:"8261"` PeerPort int `yaml:"peer_port" default:"8291"` DeployDir string `yaml:"deploy_dir,omitempty"` DataDir string `yaml:"data_dir,omitempty"` LogDir string `yaml:"log_dir,omitempty"` NumaNode string `yaml:"numa_node,omitempty" validate:"numa_node:editable"` Config map[string]interface{} `yaml:"config,omitempty" validate:"config:ignore"` ResourceControl ResourceControl `yaml:"resource_control,omitempty" validate:"resource_control:editable"` Arch string `yaml:"arch,omitempty"` OS string `yaml:"os,omitempty"` }
MasterSpec represents the Master topology specification in topology.yaml
func (MasterSpec) GetMainPort ¶
func (s MasterSpec) GetMainPort() int
GetMainPort returns the main port of the instance
func (MasterSpec) IsImported ¶
func (s MasterSpec) IsImported() bool
IsImported returns if the node is imported from TiDB-Ansible
func (MasterSpec) Role ¶
func (s MasterSpec) Role() string
Role returns the component role of the instance
func (MasterSpec) SSH ¶
func (s MasterSpec) SSH() (string, int)
SSH returns the host and SSH port of the instance
func (MasterSpec) Status ¶
func (s MasterSpec) Status(masterList ...string) string
Status queries current status of the instance
type Metadata ¶
type Metadata struct { User string `yaml:"user"` // the user to run and manage cluster on remote Version string `yaml:"dm_version"` // the version of TiDB cluster Topology *Topology `yaml:"topology"` }
Metadata is the specification of generic cluster metadata
func (*Metadata) GetBaseMeta ¶
GetBaseMeta implements Metadata interface.
func (*Metadata) GetTopology ¶
GetTopology implements Metadata interface.
func (*Metadata) SetTopology ¶
SetTopology implements Metadata interface.
func (*Metadata) SetVersion ¶
SetVersion implement UpgradableMetadata interface.
type PrometheusSpec ¶
type PrometheusSpec = spec.PrometheusSpec
PrometheusSpec is the spec of Prometheus
type ResourceControl ¶
type ResourceControl = meta.ResourceControl
ResourceControl is the spec of ResourceControl
type Topology ¶
type Topology struct { GlobalOptions GlobalOptions `yaml:"global,omitempty" validate:"global:editable"` // MonitoredOptions MonitoredOptions `yaml:"monitored,omitempty" validate:"monitored:editable"` ServerConfigs DMServerConfigs `yaml:"server_configs,omitempty" validate:"server_configs:ignore"` Masters []MasterSpec `yaml:"dm_master_servers"` Workers []WorkerSpec `yaml:"dm_worker_servers"` Monitors []PrometheusSpec `yaml:"monitoring_servers"` Grafana []GrafanaSpec `yaml:"grafana_servers,omitempty"` Alertmanager []AlertManagerSpec `yaml:"alertmanager_servers,omitempty"` }
Topology represents the specification of topology.yaml
func (*Topology) ComponentsByStartOrder ¶
ComponentsByStartOrder return component in the order need to start.
func (*Topology) ComponentsByStopOrder ¶
ComponentsByStopOrder return component in the order need to stop.
func (*Topology) ComponentsByUpdateOrder ¶
ComponentsByUpdateOrder return component in the order need to be updated.
func (*Topology) CountDir ¶
CountDir counts for dir paths used by any instance in the cluster with the same prefix, useful to find potential path conflicts
func (*Topology) Endpoints ¶
func (topo *Topology) Endpoints(user string) []*scripts.DMMasterScript
Endpoints returns the PD endpoints configurations
func (*Topology) GetGlobalOptions ¶
func (topo *Topology) GetGlobalOptions() spec.GlobalOptions
GetGlobalOptions returns cluster topology
func (*Topology) GetMasterList ¶
GetMasterList returns a list of Master API hosts of the current cluster
func (*Topology) GetMonitoredOptions ¶
func (topo *Topology) GetMonitoredOptions() *spec.MonitoredOptions
GetMonitoredOptions returns MonitoredOptions
func (*Topology) IterComponent ¶
IterComponent iterates all components in component starting order
func (*Topology) IterInstance ¶
IterInstance iterates all instances in component starting order
func (*Topology) UnmarshalYAML ¶
UnmarshalYAML sets default values when unmarshaling the topology file
type WorkerSpec ¶
type WorkerSpec struct { Host string `yaml:"host"` SSHPort int `yaml:"ssh_port,omitempty" validate:"ssh_port:editable"` Imported bool `yaml:"imported,omitempty"` // Use Name to get the name with a default value if it's empty. Name string `yaml:"name"` Port int `yaml:"port" default:"8262"` DeployDir string `yaml:"deploy_dir,omitempty"` DataDir string `yaml:"data_dir,omitempty"` LogDir string `yaml:"log_dir,omitempty"` NumaNode string `yaml:"numa_node,omitempty" validate:"numa_node:editable"` Config map[string]interface{} `yaml:"config,omitempty" validate:"config:ignore"` ResourceControl ResourceControl `yaml:"resource_control,omitempty" validate:"resource_control:editable"` Arch string `yaml:"arch,omitempty"` OS string `yaml:"os,omitempty"` }
WorkerSpec represents the Master topology specification in topology.yaml
func (WorkerSpec) GetMainPort ¶
func (s WorkerSpec) GetMainPort() int
GetMainPort returns the main port of the instance
func (WorkerSpec) IsImported ¶
func (s WorkerSpec) IsImported() bool
IsImported returns if the node is imported from TiDB-Ansible
func (WorkerSpec) Role ¶
func (s WorkerSpec) Role() string
Role returns the component role of the instance
func (WorkerSpec) SSH ¶
func (s WorkerSpec) SSH() (string, int)
SSH returns the host and SSH port of the instance
func (WorkerSpec) Status ¶
func (s WorkerSpec) Status(masterList ...string) string
Status queries current status of the instance