scripts

package
v1.16.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 30, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetScript added in v1.0.9 

func GetScript(filename string) ([]byte, error)

GetScript returns a raw config file from embed templates

Types

type AlertManagerScript 

type AlertManagerScript struct {
	WebListenAddr     string
	WebExternalURL    string
	ClusterPeers      []string
	ClusterListenAddr string

	DeployDir string
	LogDir    string
	DataDir   string

	NumaNode       string
	AdditionalArgs []string
}

AlertManagerScript represent the data to generate AlertManager start script

func (*AlertManagerScript) ConfigToFile 

func (c *AlertManagerScript) ConfigToFile(file string) error

ConfigToFile write config content to specific path

type BlackboxExporterScript 

type BlackboxExporterScript struct {
	Port      uint64
	DeployDir string
	LogDir    string
	NumaNode  string
}

BlackboxExporterScript represent the data to generate BlackboxExporter config

func NewBlackboxExporterScript 

func NewBlackboxExporterScript(deployDir, logDir string) *BlackboxExporterScript

NewBlackboxExporterScript returns a BlackboxExporterScript with given arguments

func (*BlackboxExporterScript) Config 

func (c *BlackboxExporterScript) Config() ([]byte, error)

Config generate the config file data.

func (*BlackboxExporterScript) ConfigToFile 

func (c *BlackboxExporterScript) ConfigToFile(file string) error

ConfigToFile write config content to specific path

func (*BlackboxExporterScript) ConfigWithTemplate 

func (c *BlackboxExporterScript) ConfigWithTemplate(tpl string) ([]byte, error)

ConfigWithTemplate generate the BlackboxExporter config content by tpl

func (*BlackboxExporterScript) WithNumaNode 

func (c *BlackboxExporterScript) WithNumaNode(numa string) *BlackboxExporterScript

WithNumaNode set NumaNode field of BlackboxExporterScript

func (*BlackboxExporterScript) WithPort 

func (c *BlackboxExporterScript) WithPort(port uint64) *BlackboxExporterScript

WithPort set WebPort field of BlackboxExporterScript

type CDCScript 

type CDCScript struct {
	Addr              string
	AdvertiseAddr     string
	PD                string
	GCTTL             int64
	TZ                string
	ClusterID         string
	DataDirEnabled    bool
	ConfigFileEnabled bool
	TLSEnabled        bool

	DeployDir string
	LogDir    string
	DataDir   string

	NumaNode string
}

CDCScript represent the data to generate cdc config

func (*CDCScript) ConfigToFile 

func (c *CDCScript) ConfigToFile(file string) error

ConfigToFile write config content to specific file.

type DMMasterScaleScript 

type DMMasterScaleScript struct {
	Name             string
	V1SourcePath     string
	MasterAddr       string
	AdvertiseAddr    string
	PeerURL          string
	AdvertisePeerURL string
	Join             string

	DeployDir string
	DataDir   string
	LogDir    string

	NumaNode string
}

DMMasterScaleScript represent the data to generate dm-master config on scaling

func (*DMMasterScaleScript) ConfigToFile 

func (c *DMMasterScaleScript) ConfigToFile(file string) error

ConfigToFile write config content to specific path

type DMMasterScript 

type DMMasterScript struct {
	Name             string
	V1SourcePath     string
	MasterAddr       string
	AdvertiseAddr    string
	PeerURL          string
	AdvertisePeerURL string
	InitialCluster   string

	DeployDir string
	DataDir   string
	LogDir    string

	NumaNode string
}

DMMasterScript represent the data to generate TiDB config

func (*DMMasterScript) ConfigToFile 

func (c *DMMasterScript) ConfigToFile(file string) error

ConfigToFile write config content to specific path

type DMWorkerScript 

type DMWorkerScript struct {
	Name          string
	WorkerAddr    string
	AdvertiseAddr string
	Join          string

	DeployDir string
	LogDir    string

	NumaNode string

	Endpoints []*DMMasterScript
	IP        string
	Port      int
}

DMWorkerScript represent the data to generate TiDB config

func (*DMWorkerScript) ConfigToFile 

func (c *DMWorkerScript) ConfigToFile(file string) error

ConfigToFile write config content to specific path

type DashboardScript added in v1.11.0 

type DashboardScript struct {
	TidbVersion string
	Host        string
	Port        int
	DeployDir   string
	LogDir      string
	DataDir     string
	NumaNode    string
	TLSEnabled  bool
	PD          string
}

DashboardScript represent the data to generate cdc config

func (*DashboardScript) ConfigToFile added in v1.11.0 

func (s *DashboardScript) ConfigToFile(file string) error

ConfigToFile write config content to specific file.

type DrainerScript 

type DrainerScript struct {
	NodeID string
	Addr   string
	PD     string

	DeployDir string
	DataDir   string
	LogDir    string

	NumaNode  string
	IP        string
	Port      int
	Endpoints []*PDScript
}

DrainerScript represent the data to generate drainer config

func (*DrainerScript) ConfigToFile 

func (c *DrainerScript) ConfigToFile(file string) error

ConfigToFile write config content to specific file.

type GrafanaScript 

type GrafanaScript struct {
	DeployDir string
}

GrafanaScript represent the data to generate Grafana config

func (*GrafanaScript) ConfigToFile 

func (c *GrafanaScript) ConfigToFile(file string) error

ConfigToFile write config content to specific path

type NodeExporterScript 

type NodeExporterScript struct {
	Port      uint64
	DeployDir string
	LogDir    string
	NumaNode  string
}

NodeExporterScript represent the data to generate NodeExporter config

func NewNodeExporterScript 

func NewNodeExporterScript(deployDir, logDir string) *NodeExporterScript

NewNodeExporterScript returns a NodeExporterScript with given arguments

func (*NodeExporterScript) Config 

func (c *NodeExporterScript) Config() ([]byte, error)

Config generate the config file data.

func (*NodeExporterScript) ConfigToFile 

func (c *NodeExporterScript) ConfigToFile(file string) error

ConfigToFile write config content to specific path

func (*NodeExporterScript) ConfigWithTemplate 

func (c *NodeExporterScript) ConfigWithTemplate(tpl string) ([]byte, error)

ConfigWithTemplate generate the NodeExporter config content by tpl

func (*NodeExporterScript) WithNumaNode 

func (c *NodeExporterScript) WithNumaNode(numa string) *NodeExporterScript

WithNumaNode set NumaNode field of NodeExporterScript

func (*NodeExporterScript) WithPort 

func (c *NodeExporterScript) WithPort(port uint64) *NodeExporterScript

WithPort set Port field of NodeExporterScript

type PDScaleScript 

type PDScaleScript struct {
	PDScript
	Join string
}

PDScaleScript represent the data to generate pd config on scaling

func NewPDScaleScript 

func NewPDScaleScript(pdScript *PDScript, join string) *PDScaleScript

NewPDScaleScript return a new PDScaleScript

func (*PDScaleScript) ConfigToFile 

func (c *PDScaleScript) ConfigToFile(file string) error

ConfigToFile write config content to specific path

type PDScript 

type PDScript struct {
	Name               string
	ClientURL          string
	AdvertiseClientURL string
	PeerURL            string
	AdvertisePeerURL   string
	InitialCluster     string

	DeployDir string
	DataDir   string
	LogDir    string

	NumaNode string
	MSMode   bool
}

PDScript represent the data to generate pd config

func (*PDScript) ConfigToFile 

func (c *PDScript) ConfigToFile(file string) error

ConfigToFile write config content to specific path

type PrometheusScript 

type PrometheusScript struct {
	Port                int
	WebExternalURL      string
	Retention           string
	EnableNG            bool
	EnablePromAgentMode bool

	DeployDir string
	DataDir   string
	LogDir    string

	NumaNode string

	AdditionalArgs []string
}

PrometheusScript represent the data to generate Prometheus config

func (*PrometheusScript) ConfigToFile 

func (c *PrometheusScript) ConfigToFile(file string) error

ConfigToFile write config content to specific path

type PumpScript 

type PumpScript struct {
	NodeID        string
	Addr          string
	AdvertiseAddr string
	PD            string

	DeployDir string
	DataDir   string
	LogDir    string

	NumaNode string
}

PumpScript represent the data to generate Pump config

func (*PumpScript) ConfigToFile 

func (c *PumpScript) ConfigToFile(file string) error

ConfigToFile write config content to specific file.

type SchedulingScript added in v1.16.0 

type SchedulingScript struct {
	Name               string
	ListenURL          string
	AdvertiseListenURL string
	BackendEndpoints   string

	DeployDir string
	DataDir   string
	LogDir    string

	NumaNode string
}

SchedulingScript represent the data to generate scheduling config

func (*SchedulingScript) ConfigToFile added in v1.16.0 

func (c *SchedulingScript) ConfigToFile(file string) error

ConfigToFile write config content to specific path

type TSOScript added in v1.16.0 

type TSOScript struct {
	Name               string
	ListenURL          string
	AdvertiseListenURL string
	BackendEndpoints   string

	DeployDir string
	DataDir   string
	LogDir    string

	NumaNode string
}

TSOScript represent the data to generate tso config

func (*TSOScript) ConfigToFile added in v1.16.0 

func (c *TSOScript) ConfigToFile(file string) error

ConfigToFile write config content to specific path

type TiDBScript 

type TiDBScript struct {
	Port           int
	StatusPort     int
	ListenHost     string
	AdvertiseAddr  string
	PD             string
	SupportSecboot bool

	DeployDir string
	LogDir    string

	NumaNode  string
	NumaCores string
}

TiDBScript represent the data to generate TiDB config

func (*TiDBScript) ConfigToFile 

func (c *TiDBScript) ConfigToFile(file string) error

ConfigToFile write config content to specific path

type TiFlashScript 

type TiFlashScript struct {
	RequiredCPUFlags string

	DeployDir string
	LogDir    string

	NumaNode  string
	NumaCores string
}

TiFlashScript represent the data to generate TiFlash config

func (*TiFlashScript) ConfigToFile 

func (c *TiFlashScript) ConfigToFile(file string) error

ConfigToFile write config content to specific path

type TiKVCDCScript added in v1.11.0 

type TiKVCDCScript struct {
	Addr          string
	AdvertiseAddr string
	PD            string
	GCTTL         int64
	TZ            string
	TLSEnabled    bool

	DeployDir string
	LogDir    string
	DataDir   string

	NumaNode string
}

TiKVCDCScript represent the data to generate cdc config

func (*TiKVCDCScript) ConfigToFile added in v1.11.0 

func (c *TiKVCDCScript) ConfigToFile(file string) error

ConfigToFile write config content to specific file.

type TiKVScript 

type TiKVScript struct {
	Addr                       string
	AdvertiseAddr              string
	StatusAddr                 string
	SupportAdvertiseStatusAddr bool
	AdvertiseStatusAddr        string
	PD                         string

	DeployDir string
	DataDir   string
	LogDir    string

	NumaNode  string
	NumaCores string
}

TiKVScript represent the data to generate TiKV config

func (*TiKVScript) ConfigToFile 

func (c *TiKVScript) ConfigToFile(file string) error

ConfigToFile write config content to specific path

type TiProxyScript added in v1.14.0 

type TiProxyScript struct {
	DeployDir string
	NumaNode  string
}

TiProxyScript represent the data to generate tiproxy config

func (*TiProxyScript) ConfigToFile added in v1.14.0 

func (c *TiProxyScript) ConfigToFile(file string) error

ConfigToFile write config content to specific file.

type TiSparkEnv added in v1.0.9 

type TiSparkEnv struct {
	Host           string
	TiSparkMaster  string
	TiSparkLocalIP string
	MasterPort     int
	WorkerPort     int
	MasterUIPort   int
	WorkerUIPort   int
	CustomEnvs     map[string]string
}

TiSparkEnv represent the data to generate TiSpark environment config

func NewTiSparkEnv added in v1.0.9 

func NewTiSparkEnv(host string) *TiSparkEnv

NewTiSparkEnv returns a TiSparkConfig

func (*TiSparkEnv) Script added in v1.0.9 

func (c *TiSparkEnv) Script() ([]byte, error)

Script generate the script file data.

func (*TiSparkEnv) ScriptToFile added in v1.0.9 

func (c *TiSparkEnv) ScriptToFile(file string) error

ScriptToFile write script content to specific path

func (*TiSparkEnv) ScriptWithTemplate added in v1.0.9 

func (c *TiSparkEnv) ScriptWithTemplate(tpl string) ([]byte, error)

ScriptWithTemplate parses the template file

func (*TiSparkEnv) SlaveScriptWithTemplate added in v1.0.9 

func (c *TiSparkEnv) SlaveScriptWithTemplate() ([]byte, error)

SlaveScriptWithTemplate parses the template file

func (*TiSparkEnv) WithCustomEnv added in v1.0.9 

func (c *TiSparkEnv) WithCustomEnv(m map[string]string) *TiSparkEnv

WithCustomEnv sets custom setting fields

func (*TiSparkEnv) WithLocalIP added in v1.0.9 

func (c *TiSparkEnv) WithLocalIP(ip string) *TiSparkEnv

WithLocalIP sets custom setting fields

func (*TiSparkEnv) WithMaster added in v1.1.0 

func (c *TiSparkEnv) WithMaster(master string) *TiSparkEnv

WithMaster sets master field

func (*TiSparkEnv) WithMasterPorts added in v1.0.9 

func (c *TiSparkEnv) WithMasterPorts(port, ui int) *TiSparkEnv

WithMasterPorts sets port for masters

func (*TiSparkEnv) WithWorkerPorts added in v1.0.9 

func (c *TiSparkEnv) WithWorkerPorts(port, ui int) *TiSparkEnv

WithWorkerPorts sets port for masters

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.