scheduler

type AppConfig struct {
	Replicas     int    `yaml:"replicas"`
	VolumeSize   string `yaml:"volume_size"`
	WorkloadSize string `yaml:"workload_size"`
}

type Context struct {
	// UID unique object identifier
	UID string
	// App defines a k8s application specification
	App *spec.AppSpec
	// ScheduleOptions are options that callers to pass to influence the apps that get schduled
	ScheduleOptions ScheduleOptions
	// SkipVolumeValidation for cases when use volume driver other than portworx
	SkipVolumeValidation bool
	// SkipClusterScopedObject for cases of multi-cluster backup when Storage class does not restored
	SkipClusterScopedObject bool
	// RefreshStorageEndpoint force refresh the storage driver endpoint
	RefreshStorageEndpoint bool
	// ReadinessTimeout time within which context is expected to be up
	ReadinessTimeout time.Duration
}

type DeleteTasksOptions struct {
	api.TriggerOptions
}

type Driver interface {
	spec.Parser

	// Init initializes the scheduler driver
	Init(schedOpts InitOptions) error

	// String returns the string name of this driver.
	String() string

	// IsNodeReady checks if node is in ready state. Returns nil if ready.
	IsNodeReady(n node.Node) error

	// GetNodesForApp returns nodes on which given app context is running
	GetNodesForApp(*Context) ([]node.Node, error)

	// Schedule starts applications and returns a context for each one of them
	Schedule(instanceID string, opts ScheduleOptions) ([]*Context, error)

	// WaitForRunning waits for application to start running.
	WaitForRunning(cc *Context, timeout, retryInterval time.Duration) error

	// AddTasks adds tasks to an existing context
	AddTasks(*Context, ScheduleOptions) error

	// UpdateTasksID updates task IDs in the given context
	UpdateTasksID(*Context, string) error

	// Destroy removes a application. It does not delete the volumes of the task.
	Destroy(*Context, map[string]bool) error

	// WaitForDestroy waits for application to destroy.
	WaitForDestroy(*Context, time.Duration) error

	// DeleteTasks deletes all tasks of the application (not the application). DeleteTasksOptions is optional.
	DeleteTasks(*Context, *DeleteTasksOptions) error

	// GetVolumeDriverVolumeName returns name of volume which is refered by volume driver
	GetVolumeDriverVolumeName(name string, namespace string) (string, error)

	// GetVolumeParameters Returns a maps, each item being a volume and it's options
	GetVolumeParameters(*Context) (map[string]map[string]string, error)

	// ValidateVolumes validates storage volumes in the provided context
	ValidateVolumes(cc *Context, timeout, retryInterval time.Duration, options *VolumeOptions) error

	// DeleteVolumes will delete all storage volumes for the given context
	DeleteVolumes(*Context, *VolumeOptions) ([]*volume.Volume, error)

	// GetVolumes returns all storage volumes for the given context
	GetVolumes(*Context) ([]*volume.Volume, error)

	// ResizeVolume resizes all the volumes of a given context
	ResizeVolume(*Context, string) ([]*volume.Volume, error)

	// GetSnapshots returns all storage snapshots for the given context
	GetSnapshots(*Context) ([]*volume.Snapshot, error)

	// Describe generates a bundle that can be used by support - logs, cores, states, etc
	Describe(*Context) (string, error)

	// ScaleApplication scales the current applications using the new scales from the GetScaleFactorMap.
	ScaleApplication(*Context, map[string]int32) error

	// GetScaleFactorMap gets a map of current applications to their new scales, based on "factor"
	GetScaleFactorMap(*Context) (map[string]int32, error)

	// StopSchedOnNode stops scheduler service on the given node
	StopSchedOnNode(n node.Node) error

	// StartSchedOnNode starts scheduler service on the given node
	StartSchedOnNode(n node.Node) error

	// RefreshNodeRegistry refreshes node registry
	RefreshNodeRegistry() error

	// RescanSpecs specified in specDir
	RescanSpecs(specDir, storageDriver string) error

	// EnableSchedulingOnNode enable apps to be scheduled to a given node
	EnableSchedulingOnNode(n node.Node) error

	// DisableSchedulingOnNode disable apps to be scheduled to a given node
	DisableSchedulingOnNode(n node.Node) error

	// PrepareNodeToDecommission prepares a given node for decommissioning
	PrepareNodeToDecommission(n node.Node, provisioner string) error

	// IsScalable check if a given spec is scalable or not
	IsScalable(spec interface{}) bool

	// ValidateVolumeSnapshotRestore return nil if snapshot is restored successuflly to
	// parent volumes
	ValidateVolumeSnapshotRestore(*Context, time.Time) error

	// GetTokenFromConfigMap gets token for a volume
	GetTokenFromConfigMap(string) (string, error)

	// AddLabelOnNode adds key value labels on the node
	AddLabelOnNode(node.Node, string, string) error

	// IsAutopilotEnabledForVolume checks if autopilot enabled for a given volume
	IsAutopilotEnabledForVolume(*volume.Volume) bool

	// SaveSchedulerLogsToFile gathers all scheduler logs into a file
	SaveSchedulerLogsToFile(node.Node, string) error

	// CreateAutopilotRule creates the AutopilotRule object
	CreateAutopilotRule(apRule apapi.AutopilotRule) (*apapi.AutopilotRule, error)

	// UpdateAutopilotRule updates the AutopilotRule
	UpdateAutopilotRule(apapi.AutopilotRule) (*apapi.AutopilotRule, error)

	// ListAutopilotRules lists AutopilotRules
	ListAutopilotRules() (*apapi.AutopilotRuleList, error)

	// GetEvents should return all the events from the scheduler since the time torpedo started
	GetEvents() map[string][]Event

	// ValidateAutopilotEvents validates events for PVCs injected by autopilot
	ValidateAutopilotEvents(ctx *Context) error

	// GetWorkloadSizeFromAppSpec gets workload size from an application spec
	GetWorkloadSizeFromAppSpec(ctx *Context) (uint64, error)

	// SetConfig sets connnection config (e.g. kubeconfig in case of k8s) for scheduler driver
	SetConfig(configPath string) error
}

type ErrFailedToAddLabelOnNode struct {
	// Key is the label key
	Key string
	// Value is the label value
	Value string
	// Node is the node where label should be added
	Node node.Node
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToDecommissionNode struct {
	// Node where the service is not starting
	Node node.Node
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToDeleteTasks struct {
	// App is the app for which we failed to delete the tasks
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToDeleteVolumeDirForPod struct {
	// App is the app whose volume directories are not deleted
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToDestroyApp struct {
	// App is the app that failed to destroy
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToDestroyPod struct {
	// App is the app that failed to destroy
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToDestroyStorage struct {
	// App is the app that failed to destroy
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToGetAppStatus struct {
	// App is the app for which we want to get the status
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToGetConfigMap struct {
	// Name of config map
	Name string
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToGetCustomSpec struct {
	// Name of config map
	Name string
	// Cause is the underlying cause of the error
	Cause string
	// Type is the underlying type of CRD objects
	Type interface{}
}

type ErrFailedToGetEvents struct {
	// Type is the resource type which we want to get the events
	Type string
	// Name of object
	Name string
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToGetNodesForApp struct {
	// App is the app that failed to get to get nodes
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToGetPodStatus struct {
	// App is the app for which we want to get the status
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToGetSecret struct {
	// App is the spec for which we want to get the secret
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToGetStorage struct {
	// App is the app whose storage could not be retrieved
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToGetStorageStatus struct {
	// App whose storage status couldn't be obtained
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToGetVolumeParameters struct {
	// App is the app for which we failed to get volume parameters
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToResizeStorage struct {
	// App is the app whose storage could not be retrieved
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToScheduleApp struct {
	// App is the app that failed to schedule
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToSchedulePod struct {
	// Pod is the pod that failed to schedule
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToStartSchedOnNode struct {
	// Node where the service is not starting
	Node node.Node
	// SystemService responsible for scheduling
	SystemService string
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToStopSchedOnNode struct {
	// Node where the service is not stopped
	Node node.Node
	// SystemService responsible for scheduling
	SystemService string
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToUpdateApp struct {
	// App is the app whose validation failed
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToValidateApp struct {
	// App is the app whose validation failed
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToValidateAppDestroy struct {
	// App is the app that failed to destroy
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToValidateCustomSpec struct {
	// Name of CRD object
	Name string
	// Cause is the underlying cause of the error
	Cause string
	// Type is the underlying type of CRD objects
	Type interface{}
}

type ErrFailedToValidatePod struct {
	// App is the app whose validation failed
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToValidatePodDestroy struct {
	// App is the app that failed to destroy
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrFailedToValidateStorage struct {
	// App is the app whose storage validation failed
	App *spec.AppSpec
	// Cause is the underlying cause of the error
	Cause string
}

type ErrNodeNotReady struct {
	// Node is not which is not ready
	Node node.Node
	// Cause is the underlying cause of the error
	Cause string
}

type Event struct {
	Message   string
	EventTime v1.MicroTime
	Count     int32
	LastSeen  v1.Time
	Kind      string
	Type      string
}

type InitOptions struct {

	// SpecDir app spec directory
	SpecDir string
	// VolDriverName volume driver name
	VolDriverName string
	// NodeDriverName node driver name
	NodeDriverName string
	// ConfigMap  identifies what config map should be used to
	SecretConfigMapName string
	// CustomAppConfig custom settings for apps
	CustomAppConfig map[string]AppConfig
	// StorageProvisioner name
	StorageProvisioner string
	// SecretType secret used for encryption keys
	SecretType string
	// VaultAddress vault api address
	VaultAddress string
	// VaultToken vault authentication token
	VaultToken string
}

type ScheduleOptions struct {
	// AppKeys identified a list of applications keys that users wants to schedule (Optional)
	AppKeys []string
	// Nodes restricts the applications to get scheduled only on these nodes (Optional)
	Nodes []node.Node
	// StorageProvisioner identifies what storage provider should be used
	StorageProvisioner string
	// ConfigMap  identifies what config map should be used to
	ConfigMap string
	// AutopilotRule identifies options for autopilot (Optional)
	AutopilotRule apapi.AutopilotRule
	// Scheduler  identifies what scheduler will be used
	Scheduler string
	// Labels is a map of {key,value} pairs for labeling spec objects
	Labels map[string]string
}

type UpgradeAutopilotOptions struct {
	api.TriggerOptions
}

type VolumeOptions struct {
	// SkipClusterScopedObjects skips volume operations on cluster scoped objects like storage class
	SkipClusterScopedObjects bool
}