job

Documentation

Index

• func FakeActiveSideDirectMethodInvocationClientIdentity(jobId endpoint.JobID) string
• type ActiveSide
  • func (j *ActiveSide) Name() string
  • func (j *ActiveSide) OwnedDatasetSubtreeRoot() (rfs *zfs.DatasetPath, ok bool)
  • func (j *ActiveSide) RegisterMetrics(registerer prometheus.Registerer)
  • func (j *ActiveSide) Run(ctx context.Context)
  • func (j *ActiveSide) SenderConfig() *endpoint.SenderConfig
  • func (j *ActiveSide) Status() *Status
• type ActiveSideState
  • func ActiveSideStateString(s string) (ActiveSideState, error)
  • func ActiveSideStateValues() []ActiveSideState
  • func (i ActiveSideState) IsAActiveSideState() bool
  • func (i ActiveSideState) String() string
• type ActiveSideStatus
• type Job
  • func JobsFromConfig(c *config.Config) ([]Job, error)
• type Logger
  • func GetLogger(ctx context.Context) Logger
• type PassiveSide
  • func (j *PassiveSide) Name() string
  • func (j *PassiveSide) OwnedDatasetSubtreeRoot() (rfs *zfs.DatasetPath, ok bool)
  • func (*PassiveSide) RegisterMetrics(registerer prometheus.Registerer)
  • func (j *PassiveSide) Run(ctx context.Context)
  • func (j *PassiveSide) SenderConfig() *endpoint.SenderConfig
  • func (s *PassiveSide) Status() *Status
• type PassiveStatus
• type ReceivingJobConfig
• type SendingJobConfig
• type SnapJob
  • func (j *SnapJob) Name() string
  • func (j *SnapJob) OwnedDatasetSubtreeRoot() (rfs *zfs.DatasetPath, ok bool)
  • func (j *SnapJob) RegisterMetrics(registerer prometheus.Registerer)
  • func (j *SnapJob) Run(ctx context.Context)
  • func (j *SnapJob) SenderConfig() *endpoint.SenderConfig
  • func (j *SnapJob) Status() *Status
  • func (j *SnapJob) Type() Type
• type SnapJobStatus
• type Status
  • func (s *Status) MarshalJSON() ([]byte, error)
  • func (s *Status) UnmarshalJSON(in []byte) (err error)
• type Type

Functions

func FakeActiveSideDirectMethodInvocationClientIdentity

func FakeActiveSideDirectMethodInvocationClientIdentity(jobId endpoint.JobID) string

The active side of a replication uses one end (sender or receiver) directly by method invocation, without going through a transport that provides a client identity. However, in order to avoid the need to distinguish between direct-method-invocating clients and RPC client, we use an invalid client identity as a sentinel value.

Types

type ActiveSide

type ActiveSide struct {
	// contains filtered or unexported fields
}

func (*ActiveSide) Name

func (j *ActiveSide) Name() string

func (*ActiveSide) OwnedDatasetSubtreeRoot

func (j *ActiveSide) OwnedDatasetSubtreeRoot() (rfs *zfs.DatasetPath, ok bool)

func (*ActiveSide) RegisterMetrics

func (j *ActiveSide) RegisterMetrics(registerer prometheus.Registerer)

func (*ActiveSide) Run

func (j *ActiveSide) Run(ctx context.Context)

func (*ActiveSide) SenderConfig

func (j *ActiveSide) SenderConfig() *endpoint.SenderConfig

func (*ActiveSide) Status

func (j *ActiveSide) Status() *Status

type ActiveSideState

type ActiveSideState int

const (
	ActiveSideReplicating ActiveSideState = 1 << iota
	ActiveSidePruneSender
	ActiveSidePruneReceiver
	ActiveSideDone // also errors
)

func ActiveSideStateString

func ActiveSideStateString(s string) (ActiveSideState, error)

ActiveSideStateString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func ActiveSideStateValues

func ActiveSideStateValues() []ActiveSideState

ActiveSideStateValues returns all values of the enum

func (ActiveSideState) IsAActiveSideState

func (i ActiveSideState) IsAActiveSideState() bool

IsAActiveSideState returns "true" if the value is listed in the enum definition. "false" otherwise

func (ActiveSideState) String

func (i ActiveSideState) String() string

type ActiveSideStatus

type ActiveSideStatus struct {
	Replication                    *report.Report
	PruningSender, PruningReceiver *pruner.Report
	Snapshotting                   *snapper.Report
}

type Job

type Job interface {
	Name() string
	Run(ctx context.Context)
	Status() *Status
	RegisterMetrics(registerer prometheus.Registerer)
	// Jobs that return a subtree of the dataset hierarchy
	// must return the root of that subtree as rfs and ok = true
	OwnedDatasetSubtreeRoot() (rfs *zfs.DatasetPath, ok bool)
	SenderConfig() *endpoint.SenderConfig
}

func JobsFromConfig

func JobsFromConfig(c *config.Config) ([]Job, error)

type Logger

type Logger = logger.Logger

func GetLogger

func GetLogger(ctx context.Context) Logger

type PassiveSide

type PassiveSide struct {
	// contains filtered or unexported fields
}

func (*PassiveSide) Name

func (j *PassiveSide) Name() string

func (*PassiveSide) OwnedDatasetSubtreeRoot

func (j *PassiveSide) OwnedDatasetSubtreeRoot() (rfs *zfs.DatasetPath, ok bool)

func (*PassiveSide) RegisterMetrics

func (*PassiveSide) RegisterMetrics(registerer prometheus.Registerer)

func (*PassiveSide) Run

func (j *PassiveSide) Run(ctx context.Context)

func (*PassiveSide) SenderConfig

func (j *PassiveSide) SenderConfig() *endpoint.SenderConfig

func (*PassiveSide) Status

func (s *PassiveSide) Status() *Status

type PassiveStatus

type PassiveStatus struct {
	Snapper *snapper.Report
}

type ReceivingJobConfig

type ReceivingJobConfig interface {
	GetRootFS() string
	GetAppendClientIdentity() bool
	GetRecvOptions() *config.RecvOptions
}

type SendingJobConfig

type SendingJobConfig interface {
	GetFilesystems() config.FilesystemsFilter
	GetSendOptions() *config.SendOptions // must not be nil
}

type SnapJob

type SnapJob struct {
	// contains filtered or unexported fields
}

func (*SnapJob) Name

func (j *SnapJob) Name() string

func (*SnapJob) OwnedDatasetSubtreeRoot

func (j *SnapJob) OwnedDatasetSubtreeRoot() (rfs *zfs.DatasetPath, ok bool)

func (*SnapJob) RegisterMetrics

func (j *SnapJob) RegisterMetrics(registerer prometheus.Registerer)

func (*SnapJob) Run

func (j *SnapJob) Run(ctx context.Context)

func (*SnapJob) SenderConfig

func (j *SnapJob) SenderConfig() *endpoint.SenderConfig

func (*SnapJob) Status

func (j *SnapJob) Status() *Status

func (*SnapJob) Type

func (j *SnapJob) Type() Type

type SnapJobStatus

type SnapJobStatus struct {
	Pruning      *pruner.Report
	Snapshotting *snapper.Report // may be nil
}

type Status

type Status struct {
	Type        Type
	JobSpecific interface{}
}

func (*Status) MarshalJSON

func (s *Status) MarshalJSON() ([]byte, error)

func (*Status) UnmarshalJSON

func (s *Status) UnmarshalJSON(in []byte) (err error)

type Type

type Type string

const (
	TypeInternal Type = "internal"
	TypeSnap     Type = "snap"
	TypePush     Type = "push"
	TypeSink     Type = "sink"
	TypePull     Type = "pull"
	TypeSource   Type = "source"
)