supervisor

Documentation

Index

• type BackupProvisioner
• type BackupSupervisor
  • func NewBackupSupervisor(store installationBackupStore, backupOperator BackupProvisioner, aws aws.AWS, ...) *BackupSupervisor
  • func (s *BackupSupervisor) Do() error
  • func (s *BackupSupervisor) Shutdown()
  • func (s *BackupSupervisor) Supervise(backup *model.InstallationBackup)
• type ClusterInstallationSupervisor
  • func NewClusterInstallationSupervisor(store clusterInstallationStore, ...) *ClusterInstallationSupervisor
  • func (s *ClusterInstallationSupervisor) Do() error
  • func (s *ClusterInstallationSupervisor) Shutdown()
  • func (s *ClusterInstallationSupervisor) Supervise(clusterInstallation *model.ClusterInstallation)
• type ClusterSupervisor
  • func NewClusterSupervisor(store clusterStore, clusterProvisioner clusterProvisioner, aws aws.AWS, ...) *ClusterSupervisor
  • func (s *ClusterSupervisor) Do() error
  • func (s *ClusterSupervisor) Shutdown()
  • func (s *ClusterSupervisor) Supervise(cluster *model.Cluster)
• type Doer
• type GroupSupervisor
  • func NewGroupSupervisor(store groupStore, instanceID string, logger log.FieldLogger) *GroupSupervisor
  • func (s *GroupSupervisor) Do() error
  • func (s *GroupSupervisor) Shutdown()
  • func (s *GroupSupervisor) Supervise(group *model.Group)
• type InstallationSupervisor
  • func NewInstallationSupervisor(store installationStore, installationProvisioner installationProvisioner, ...) *InstallationSupervisor
  • func (s *InstallationSupervisor) Do() error
  • func (s *InstallationSupervisor) Shutdown()
  • func (s *InstallationSupervisor) Supervise(installation *model.Installation)
• type InstallationSupervisorSchedulingOptions
  • func NewInstallationSupervisorSchedulingOptions(balanceInstallations bool, ...) InstallationSupervisorSchedulingOptions
• type MultiDoer
  • func (md MultiDoer) Do() error
  • func (md MultiDoer) Shutdown()
• type Scheduler
  • func NewScheduler(doer Doer, period time.Duration) *Scheduler
  • func (s *Scheduler) Close() error
  • func (s *Scheduler) Do() error

Types

type BackupProvisioner

type BackupProvisioner interface {
	TriggerBackup(backupMeta *model.InstallationBackup, cluster *model.Cluster, installation *model.Installation) (*model.S3DataResidence, error)
	CheckBackupStatus(backupMeta *model.InstallationBackup, cluster *model.Cluster) (int64, error)
	CleanupBackupJob(backup *model.InstallationBackup, cluster *model.Cluster) error
}

BackupProvisioner provisions backup jobs on a cluster.

type BackupSupervisor

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

BackupSupervisor finds backup pending work and effects the required changes.

The degree of parallelism is controlled by a weighted semaphore, intended to be shared with other clients needing to coordinate background jobs.

func NewBackupSupervisor

func NewBackupSupervisor(
	store installationBackupStore,
	backupOperator BackupProvisioner,
	aws aws.AWS,
	instanceID string,
	logger log.FieldLogger) *BackupSupervisor

NewBackupSupervisor creates a new BackupSupervisor.

func (*BackupSupervisor) Do

func (s *BackupSupervisor) Do() error

Do looks for work to be done on any pending backups and attempts to schedule the required work.

func (*BackupSupervisor) Shutdown

func (s *BackupSupervisor) Shutdown()

Shutdown performs graceful shutdown tasks for the backup supervisor.

func (*BackupSupervisor) Supervise

func (s *BackupSupervisor) Supervise(backup *model.InstallationBackup)

Supervise schedules the required work on the given backup.

type ClusterInstallationSupervisor

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

ClusterInstallationSupervisor finds cluster installations pending work and effects the required changes.

The degree of parallelism is controlled by a weighted semaphore, intended to be shared with other clients needing to coordinate background jobs.

func NewClusterInstallationSupervisor

func NewClusterInstallationSupervisor(store clusterInstallationStore, clusterInstallationProvisioner clusterInstallationProvisioner, aws aws.AWS, instanceID string, logger log.FieldLogger) *ClusterInstallationSupervisor

NewClusterInstallationSupervisor creates a new ClusterInstallationSupervisor.

func (*ClusterInstallationSupervisor) Do

func (s *ClusterInstallationSupervisor) Do() error

Do looks for work to be done on any pending cluster installations and attempts to schedule the required work.

func (*ClusterInstallationSupervisor) Shutdown

func (s *ClusterInstallationSupervisor) Shutdown()

Shutdown performs graceful shutdown tasks for the cluster installation supervisor.

func (*ClusterInstallationSupervisor) Supervise

func (s *ClusterInstallationSupervisor) Supervise(clusterInstallation *model.ClusterInstallation)

Supervise schedules the required work on the given cluster installation.

type ClusterSupervisor

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

ClusterSupervisor finds clusters pending work and effects the required changes.

The degree of parallelism is controlled by a weighted semaphore, intended to be shared with other clients needing to coordinate background jobs.

func NewClusterSupervisor

func NewClusterSupervisor(store clusterStore, clusterProvisioner clusterProvisioner, aws aws.AWS, instanceID string, logger log.FieldLogger) *ClusterSupervisor

NewClusterSupervisor creates a new ClusterSupervisor.

func (*ClusterSupervisor) Do

func (s *ClusterSupervisor) Do() error

Do looks for work to be done on any pending clusters and attempts to schedule the required work.

func (*ClusterSupervisor) Shutdown

func (s *ClusterSupervisor) Shutdown()

Shutdown performs graceful shutdown tasks for the cluster supervisor.

func (*ClusterSupervisor) Supervise

func (s *ClusterSupervisor) Supervise(cluster *model.Cluster)

Supervise schedules the required work on the given cluster.

type Doer

type Doer interface {
	Do() error
	Shutdown()
}

Doer describes an action to be done.

type GroupSupervisor

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

GroupSupervisor finds installations belonging to groups that need to have their configuration reconciled to match a new group configuration setting.

The degree of parallelism is controlled by a weighted semaphore, intended to be shared with other clients needing to coordinate background jobs.

func NewGroupSupervisor

func NewGroupSupervisor(store groupStore, instanceID string, logger log.FieldLogger) *GroupSupervisor

NewGroupSupervisor creates a new GroupSupervisor.

func (*GroupSupervisor) Do

func (s *GroupSupervisor) Do() error

Do looks for work to be done on any pending groups and attempts to schedule the required work.

func (*GroupSupervisor) Shutdown

func (s *GroupSupervisor) Shutdown()

Shutdown performs graceful shutdown tasks for the group supervisor.

func (*GroupSupervisor) Supervise

func (s *GroupSupervisor) Supervise(group *model.Group)

Supervise schedules the required work on the given group.

type InstallationSupervisor

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

InstallationSupervisor finds installations pending work and effects the required changes.

The degree of parallelism is controlled by a weighted semaphore, intended to be shared with other clients needing to coordinate background jobs.

func NewInstallationSupervisor

func NewInstallationSupervisor(
	store installationStore,
	installationProvisioner installationProvisioner,
	aws aws.AWS,
	instanceID string,
	keepDatabaseData,
	keepFilestoreData bool,
	scheduling InstallationSupervisorSchedulingOptions,
	resourceUtil *utils.ResourceUtil,
	logger log.FieldLogger,
	metrics *metrics.CloudMetrics,
	forceCRUpgrade bool) *InstallationSupervisor

NewInstallationSupervisor creates a new InstallationSupervisor.

func (*InstallationSupervisor) Do

func (s *InstallationSupervisor) Do() error

Do looks for work to be done on any pending installations and attempts to schedule the required work.

func (*InstallationSupervisor) Shutdown

func (s *InstallationSupervisor) Shutdown()

Shutdown performs graceful shutdown tasks for the installation supervisor.

func (*InstallationSupervisor) Supervise

func (s *InstallationSupervisor) Supervise(installation *model.Installation)

Supervise schedules the required work on the given installation.

type InstallationSupervisorSchedulingOptions

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

InstallationSupervisorSchedulingOptions are the various options that control how installation scheduling occurs.

func NewInstallationSupervisorSchedulingOptions

func NewInstallationSupervisorSchedulingOptions(balanceInstallations bool, clusterResourceThreshold, clusterResourceThresholdScaleValue int) InstallationSupervisorSchedulingOptions

NewInstallationSupervisorSchedulingOptions creates a new InstallationSupervisorSchedulingOptions.

type MultiDoer

type MultiDoer []Doer

MultiDoer is a slice of doers.

func (MultiDoer) Do

func (md MultiDoer) Do() error

Do executes each doer in turn, returning the first error.

func (MultiDoer) Shutdown

func (md MultiDoer) Shutdown()

Shutdown tells each doer to perform shutdown tasks.

type Scheduler

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

Scheduler schedules a doer for periodic, serial execution.

func NewScheduler

func NewScheduler(doer Doer, period time.Duration) *Scheduler

NewScheduler creates a new scheduler.

If the period is zero, the scheduler is never run, even if manually run. Otherwise, the period specifies how long to wait after its last successful execution.

func (*Scheduler) Close

func (s *Scheduler) Close() error

Close waits for any active doer to finish, terminates the main thread of the scheduler, and ensures the doer is no longer invoked.

func (*Scheduler) Do

func (s *Scheduler) Do() error

Do requests an execution of the scheduled doer.

The scheduler will never be run if the period is 0. If already running, the doer will be run again when done. Multiple calls to Notify while the doer is running will only trigger a single additional execution. Do never blocks.