physical

Documentation

Overview

Package physical provides jobs for physical initial operations.

Index

• Constants
• type CopyOptions
• type HealthCheck
• type RestoreJob
  • func NewJob(cfg config.JobConfig, global *global.Config) (*RestoreJob, error)
  • func (r *RestoreJob) Name() string
  • func (r *RestoreJob) Reload(cfg map[string]interface{}) (err error)
  • func (r *RestoreJob) Run(ctx context.Context) (err error)
• type Sync

Constants

const (
	// RestoreJobType defines the physical job type.
	RestoreJobType = "physicalRestore"
)

Types

type CopyOptions

type CopyOptions struct {
	Tool        string            `yaml:"tool"`
	DockerImage string            `yaml:"dockerImage"`
	Envs        map[string]string `yaml:"envs"`
	WALG        walgOptions       `yaml:"walg"`
	CustomTool  customOptions     `yaml:"customTool"`
	Sync        Sync              `yaml:"sync"`
}

CopyOptions describes options for physical copying.

type HealthCheck

type HealthCheck struct {
	Interval   int64 `yaml:"interval"`
	MaxRetries int   `yaml:"maxRetries"`
}

HealthCheck describes health check options of a sync instance.

type RestoreJob

type RestoreJob struct {
	CopyOptions
	// contains filtered or unexported fields
}

RestoreJob describes a job for physical restoring.

func NewJob

func NewJob(cfg config.JobConfig, global *global.Config) (*RestoreJob, error)

NewJob creates a new physical restore job.

func (*RestoreJob) Name

func (r *RestoreJob) Name() string

Name returns a name of the job.

func (*RestoreJob) Reload

func (r *RestoreJob) Reload(cfg map[string]interface{}) (err error)

Reload reloads job configuration.

func (*RestoreJob) Run

func (r *RestoreJob) Run(ctx context.Context) (err error)

Run starts the job.

type Sync

type Sync struct {
	Enabled     bool              `yaml:"enabled"`
	HealthCheck HealthCheck       `yaml:"healthCheck"`
	Configs     map[string]string `yaml:"configs"`
	Recovery    map[string]string `yaml:"recovery"`
}

Sync describes sync instance options.