Class KubernetesGoalScheduler

GoalScheduler implementation that schedules SDM goals as Kubernetes jobs.

Hierarchy

KubernetesGoalScheduler

Implements

GoalScheduler

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new KubernetesGoalScheduler(options?: KubernetesGoalSchedulerOptions): KubernetesGoalScheduler

- Defined in lib/pack/k8s/scheduler/KubernetesGoalScheduler.ts:93
Parameters
- Default value options: KubernetesGoalSchedulerOptions = { isolateAll: false }
Returns KubernetesGoalScheduler

Properties

Private Readonly options

options: KubernetesGoalSchedulerOptions

podSpec

podSpec: V1PodSpec

Methods

Protected afterCreation

afterCreation(gi: GoalInvocation, jobSpec: V1Job): Promise<void>

- Defined in lib/pack/k8s/scheduler/KubernetesGoalScheduler.ts:191
Extension point for sub classes to modify k8s resources after the job has been created. The provided jobSpec contains the result of the job creation API call.

Parameters
- gi: GoalInvocation
- jobSpec: V1Job
Returns Promise<void>

Protected beforeCreation

beforeCreation(gi: GoalInvocation, jobSpec: V1Job): Promise<V1Job>

- Defined in lib/pack/k8s/scheduler/KubernetesGoalScheduler.ts:181
Extension point for sub classes to modify the provided jobSpec before the Job gets created in k8s. It should return the modified jobSpec.

Parameters
- gi: GoalInvocation
  
  goal invocation
- jobSpec: V1Job
  
  Default job spec
Returns Promise<V1Job>

desired job spec

Protected cleanUp

cleanUp(configuration: Configuration): Promise<void>

- Defined in lib/pack/k8s/scheduler/KubernetesGoalScheduler.ts:236
Extension point to allow for custom clean up logic.

Parameters
- configuration: Configuration
Returns Promise<void>

initialize

initialize(configuration: Configuration): Promise<void>

Implementation of GoalScheduler.initialize
- Defined in lib/pack/k8s/scheduler/KubernetesGoalScheduler.ts:200
If running in Kubernetes, read current pod spec. Populate this.podSpec with a merge of this.options.podSpec and the current pod spec. If neither is available, throw an error.

Parameters
- configuration: Configuration
Returns Promise<void>

schedule

schedule(gi: GoalInvocation): Promise<ExecuteGoalResult>

Implementation of GoalScheduler.schedule
- Defined in lib/pack/k8s/scheduler/KubernetesGoalScheduler.ts:112
Parameters
- gi: GoalInvocation
Returns Promise<ExecuteGoalResult>

supports

supports(gi: GoalInvocation): Promise<boolean>

Implementation of GoalScheduler.supports
- Defined in lib/pack/k8s/scheduler/KubernetesGoalScheduler.ts:98
Parameters
- gi: GoalInvocation
Returns Promise<boolean>

Generated using TypeDoc