operator

Oct 21, 2024

Changes in this version

+ func GetCommandParamOr[T any](c *Command, key string, defaultValue T) T

Dec 8, 2023

Changes in this version

+ var ErrCleanExit = errors.New("clean exit")

+ type BackupModule interface

+ Backup func(lastSeenBlockNum uint32) (string, error)

+ RequiresStop func() bool

+ type BackupModuleConfig map[string]string

+ type BackupModuleFactory func(conf BackupModuleConfig) (BackupModule, error)

+ type BackupSchedule struct

+ BackuperName string

+ BlocksBetweenRuns int

+ RequiredHostnameMatch string

+ TimeBetweenRuns time.Duration

+ func NewBackupSchedule(freqBlocks, freqTime, requiredHostname, backuperName string) (*BackupSchedule, error)

+ func ParseBackupConfigs(logger *zap.Logger, backupConfigs []string, ...) (mods map[string]BackupModule, scheds []*BackupSchedule, err error)

+ type Bootstrapper interface

+ Bootstrap func() error

+ type Command struct

+ func (c *Command) MarshalLogObject(encoder zapcore.ObjectEncoder) error

+ func (c *Command) Return(err error)

+ type HTTPOption func(r *mux.Router)

+ type Operator struct

+ Superviser nodeManager.ChainSuperviser

+ func New(zlogger *zap.Logger, chainSuperviser nodeManager.ChainSuperviser, ...) (*Operator, error)

+ func (o *Operator) Launch(httpListenAddr string, options ...HTTPOption) error

+ func (o *Operator) LaunchBackupSchedules()

+ func (o *Operator) RegisterBackupModule(name string, mod BackupModule) error

+ func (o *Operator) RegisterBackupSchedule(sched *BackupSchedule)

+ func (o *Operator) RunEveryPeriod(period time.Duration, commandName string, params map[string]string)

+ func (o *Operator) RunEveryXBlock(freq uint32, commandName string, params map[string]string)

+ func (o *Operator) RunHTTPServer(httpListenAddr string, options ...HTTPOption) *http.Server

+ type Options struct

+ Bootstrapper Bootstrapper

+ EnableSupervisorMonitoring bool

+ ShutdownDelay time.Duration

+ type RestorableBackupModule interface

+ Restore func(name string) error