controller

Documentation

Index

• Constants
• Variables
• func DetermineEngineReplicaTimeout(timeout time.Duration) time.Duration
• func DetermineIscsiTargetRequestTimeout(engineReplicaTimeout time.Duration) time.Duration
• func GetReplicaDisksAndHead(address, volumeName, instanceName string) (map[string]types.DiskInfo, string, error)
• func NewFrontend(frontendType string, iscsiTargetRequestTimeout time.Duration) (types.Frontend, error)
• type BackendError
  • func (b *BackendError) Error() string
• type Controller
  • func NewController(name string, factory types.BackendFactory, frontend types.Frontend, ...) *Controller
  • func (c *Controller) AddReplica(address string, snapshotRequired bool, mode types.Mode) error
  • func (c *Controller) Close() error
  • func (c *Controller) Endpoint() string
  • func (c *Controller) Expand(size int64) error
  • func (c *Controller) Frontend() string
  • func (c *Controller) FrontendState() string
  • func (c *Controller) GetExpansionErrorInfo() (string, string)
  • func (c *Controller) GetLatestMetics() *enginerpc.Metrics
  • func (c *Controller) GetSnapshotMaxCount() int
  • func (c *Controller) GetSnapshotMaxSize() int64
  • func (c *Controller) GetUnmapMarkSnapChainRemoved() bool
  • func (c *Controller) IsExpanding() bool
  • func (c *Controller) ListReplicas() []types.Replica
  • func (c *Controller) PrepareRebuildReplica(address, instanceName string) ([]types.SyncFileInfo, error)
  • func (c *Controller) ReadAt(b []byte, off int64) (int, error)
  • func (c *Controller) RemoveReplica(address string) error
  • func (c *Controller) Revert(name string) error
  • func (c *Controller) SetReplicaMode(address string, mode types.Mode) error
  • func (c *Controller) SetSnapshotMaxCount(count int) error
  • func (c *Controller) SetSnapshotMaxSize(size int64) error
  • func (c *Controller) SetUnmapMarkSnapChainRemoved(enabled bool) error
  • func (c *Controller) Shutdown() error
  • func (c *Controller) ShutdownFrontend() error
  • func (c *Controller) Size() int64
  • func (c *Controller) Snapshot(inputName string, labels map[string]string, shouldFreeze bool) (name string, err error)
  • func (c *Controller) Start(volumeSize, volumeCurrentSize int64, addresses ...string) error
  • func (c *Controller) StartFrontend(frontend string) error
  • func (c *Controller) StartGRPCServer() error
  • func (c *Controller) UnmapAt(length uint32, off int64) (int, error)
  • func (c *Controller) VerifyRebuildReplica(address, instanceName string) error
  • func (c *Controller) WaitForShutdown() error
  • func (c *Controller) WriteAt(b []byte, off int64) (int, error)
• type MultiUnmapperAt
  • func (m *MultiUnmapperAt) UnmapAt(length uint32, off int64) (int, error)
• type MultiUnmapperError
  • func (m *MultiUnmapperError) Error() string
• type MultiWriterAt
  • func (m *MultiWriterAt) WriteAt(p []byte, off int64) (int, error)
• type MultiWriterError
  • func (m *MultiWriterError) Error() string

Constants

const (
	ControllerErrorNoBackendServiceUnavailable = "no available backend due to service unavailable"
	ControllerErrorNoBackendReplicaError       = "no available backend due to replica error"
)

const (
	DefaultEngineReplicaTimeout = 8 * time.Second
)

Variables

var (
	ErrNoBackend = errors.New("no backend available")
)

Functions

func DetermineEngineReplicaTimeout

func DetermineEngineReplicaTimeout(timeout time.Duration) time.Duration

func DetermineIscsiTargetRequestTimeout

func DetermineIscsiTargetRequestTimeout(engineReplicaTimeout time.Duration) time.Duration

func GetReplicaDisksAndHead

func GetReplicaDisksAndHead(address, volumeName, instanceName string) (map[string]types.DiskInfo, string, error)

func NewFrontend

func NewFrontend(frontendType string, iscsiTargetRequestTimeout time.Duration) (types.Frontend, error)

Types

type BackendError

type BackendError struct {
	Errors map[string]error
}

func (*BackendError) Error

func (b *BackendError) Error() string

type Controller

type Controller struct {
	sync.RWMutex
	VolumeName string

	DataServerProtocol types.DataServerProtocol

	SnapshotMaxSize int64

	GRPCAddress string
	GRPCServer  *grpc.Server

	ShutdownWG sync.WaitGroup
	// contains filtered or unexported fields
}

func NewController

func NewController(name string, factory types.BackendFactory, frontend types.Frontend, isUpgrade, disableRevCounter,
	salvageRequested, unmapMarkSnapChainRemoved bool, iscsiTargetRequestTimeout, engineReplicaTimeoutShort,
	engineReplicaTimeoutLong time.Duration, dataServerProtocol types.DataServerProtocol, fileSyncHTTPClientTimeout,
	snapshotMaxCount int, snapshotMaxSize int64) *Controller

func (*Controller) AddReplica

func (c *Controller) AddReplica(address string, snapshotRequired bool, mode types.Mode) error

func (*Controller) Close

func (c *Controller) Close() error

func (*Controller) Endpoint

func (c *Controller) Endpoint() string

func (*Controller) Expand

func (c *Controller) Expand(size int64) error

func (*Controller) Frontend

func (c *Controller) Frontend() string

func (*Controller) FrontendState

func (c *Controller) FrontendState() string

func (*Controller) GetExpansionErrorInfo

func (c *Controller) GetExpansionErrorInfo() (string, string)

func (*Controller) GetLatestMetics

func (c *Controller) GetLatestMetics() *enginerpc.Metrics

func (*Controller) GetSnapshotMaxCount

func (c *Controller) GetSnapshotMaxCount() int

func (*Controller) GetSnapshotMaxSize

func (c *Controller) GetSnapshotMaxSize() int64

func (*Controller) GetUnmapMarkSnapChainRemoved

func (c *Controller) GetUnmapMarkSnapChainRemoved() bool

func (*Controller) IsExpanding

func (c *Controller) IsExpanding() bool

func (*Controller) ListReplicas

func (c *Controller) ListReplicas() []types.Replica

func (*Controller) PrepareRebuildReplica

func (c *Controller) PrepareRebuildReplica(address, instanceName string) ([]types.SyncFileInfo, error)

func (*Controller) ReadAt

func (c *Controller) ReadAt(b []byte, off int64) (int, error)

func (*Controller) RemoveReplica

func (c *Controller) RemoveReplica(address string) error

func (*Controller) Revert

func (c *Controller) Revert(name string) error

func (*Controller) SetReplicaMode

func (c *Controller) SetReplicaMode(address string, mode types.Mode) error

func (*Controller) SetSnapshotMaxCount

func (c *Controller) SetSnapshotMaxCount(count int) error

func (*Controller) SetSnapshotMaxSize

func (c *Controller) SetSnapshotMaxSize(size int64) error

func (*Controller) SetUnmapMarkSnapChainRemoved

func (c *Controller) SetUnmapMarkSnapChainRemoved(enabled bool) error

func (*Controller) Shutdown

func (c *Controller) Shutdown() error

func (*Controller) ShutdownFrontend

func (c *Controller) ShutdownFrontend() error

func (*Controller) Size

func (c *Controller) Size() int64

func (*Controller) Snapshot

func (c *Controller) Snapshot(inputName string, labels map[string]string, shouldFreeze bool) (name string, err error)

If shouldFreeze, Snapshot attempts to freeze the mounted filesystem on the volume's root partition. If it fails to do so, Snapshot attempts to clean up and returns an error. If not shouldFreeze or if a mounted filesystem is not detected on the volume's root partition, Snapshot does a best effort sync and takes a snapshot.

func (*Controller) Start

func (c *Controller) Start(volumeSize, volumeCurrentSize int64, addresses ...string) error

func (*Controller) StartFrontend

func (c *Controller) StartFrontend(frontend string) error

func (*Controller) StartGRPCServer

func (c *Controller) StartGRPCServer() error

func (*Controller) UnmapAt

func (c *Controller) UnmapAt(length uint32, off int64) (int, error)

func (*Controller) VerifyRebuildReplica

func (c *Controller) VerifyRebuildReplica(address, instanceName string) error

func (*Controller) WaitForShutdown

func (c *Controller) WaitForShutdown() error

func (*Controller) WriteAt

func (c *Controller) WriteAt(b []byte, off int64) (int, error)

type MultiUnmapperAt

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

func (*MultiUnmapperAt) UnmapAt

func (m *MultiUnmapperAt) UnmapAt(length uint32, off int64) (int, error)

type MultiUnmapperError

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

func (*MultiUnmapperError) Error

func (m *MultiUnmapperError) Error() string

type MultiWriterAt

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

func (*MultiWriterAt) WriteAt

func (m *MultiWriterAt) WriteAt(p []byte, off int64) (int, error)

type MultiWriterError

type MultiWriterError struct {
	Writers []io.WriterAt
	Errors  []error
}

func (*MultiWriterError) Error

func (m *MultiWriterError) Error() string