component

Documentation

Index

• Constants
• type BareMetalCluster
  • func NewBareMetalCluster(config *config.Cluster, workingDirs WorkingDirs, wg *sync.WaitGroup, ...) *BareMetalCluster
• type BareMetalClusterComponent
• type DeleteOptions
• type RunOptions
• type WorkingDirs

Constants

const (
	DataNode = "datanode"
	Frontend = "frontend"
	MetaSrv  = "metasrv"
	Etcd     = "etcd"
)

Types

type BareMetalCluster

type BareMetalCluster struct {
	MetaSrv  BareMetalClusterComponent
	Datanode BareMetalClusterComponent
	Frontend BareMetalClusterComponent
	Etcd     BareMetalClusterComponent
}

BareMetalCluster describes all the components need to be deployed under bare-metal mode.

func NewBareMetalCluster

func NewBareMetalCluster(config *config.Cluster, workingDirs WorkingDirs,
	wg *sync.WaitGroup, logger logger.Logger) *BareMetalCluster

type BareMetalClusterComponent

type BareMetalClusterComponent interface {
	// Start starts cluster component by executing binary.
	Start(ctx context.Context, binary string) error

	// BuildArgs build up args for cluster component.
	BuildArgs(ctx context.Context, params ...interface{}) []string

	// IsRunning returns the status of current cluster component.
	IsRunning(ctx context.Context) bool

	// Delete deletes resources that allocated in the system for current component.
	Delete(ctx context.Context, option DeleteOptions) error

	// Name return the name of component.
	Name() string
}

BareMetalClusterComponent is the basic unit of running GreptimeDB Cluster in bare-metal mode.

type DeleteOptions

type DeleteOptions struct {
	RetainLogs bool
}

type RunOptions

type RunOptions struct {
	Binary string
	Name   string
	// contains filtered or unexported fields
}

type WorkingDirs

type WorkingDirs struct {
	DataDir string `yaml:"dataDir"`
	LogsDir string `yaml:"logsDir"`
	PidsDir string `yaml:"pidsDir"`
}

WorkingDirs include all the dirs used in bare-metal mode.