Class defaultAbstract

This is an abstract class for compute core job maintainers, which are responsible for submitting jobs and monitoring them.

Hierarchy (view full)

Constructors

constructor

Properties

_lock envParam envParamDefault envParamValidators events hpc hpcSettings id initRetry isEnd isInit isPaused job jobOnHpc lifeCycleState logs maintainThresholdInHours maintainerConfig slurm validator

Methods

cancel dumpEvents dumpLogs emitEvent emitLog getSingCVMFSConnector getSingularityConnector getSlurmConnector init maintain onCancel onDefine onInit onMaintain onPause onResume updateJob

Constructors

constructor

Properties

Private _lock

_lock: boolean = false

mutex

envParam

envParam: Record<string, string> = {}

envParamDefault

envParamDefault: Record<string, string> = {}

envParamValidators

envParamValidators: undefined | Record<string, ((_val) => boolean)> = undefined

Protected events

events: event[] = []

hpc

hpc: string

hpcSettings

hpcSettings: hpcConfig

id

id: string

initRetry

initRetry: number = 3

parameters

isEnd

isEnd: boolean = false

isInit

isInit: boolean = false

states

isPaused

isPaused: boolean = false

job

job: Job

config

jobOnHpc

jobOnHpc: boolean = false

Protected lifeCycleState

lifeCycleState: {
    createdAt: null | number;
    initCounter: number;
} = ...

Type declaration

  • createdAt: null | number
  • initCounter: number

Protected logs

logs: string[] = []

data

maintainThresholdInHours

maintainThresholdInHours: number = 100000

maintainerConfig

maintainerConfig: undefined | maintainerConfig = undefined

slurm

slurm: undefined | slurm = undefined

validator

validator: typeof validator = validator

packages

Methods

cancel

dumpEvents

dumpLogs

emitEvent

  • emitEvent(type, message): void

  • Update this.events with the new event, and this.isInit or this.isEnd as appropriate

    Parameters

    • type: string

      Type of event to be recorded

    • message: string

      Message associated with the event

    Returns void

emitLog

getSingCVMFSConnector

getSingularityConnector

getSlurmConnector

init

  • init(): Promise<void>

  • Initialize job in the maintainer. If the job has been retried too many times, terminate and update events.

    Returns Promise<void>

maintain

  • maintain(): Promise<void>

  • Ensure that the job is still running, and if the runtime has exceeded the maintain threshold, terminate and update events.

    Returns Promise<void>

Protected Abstract onCancel

Protected Abstract onDefine

Protected Abstract onInit

  • onInit(): Promise<void>

  • This function is called when the maintainer is initialized--i.e., it begins work on maintaining the job. Called in the supervisor-facing init() function.

    Returns Promise<void>

Protected Abstract onMaintain

  • onMaintain(): Promise<void>

  • This function is called when the supervisor-facing maintain() function is called to maintain (monitor the status of) the job.

    Returns Promise<void>

Protected Abstract onPause

  • onPause(): Promise<void>

  • This function is called when the supervisor tries to pause the current job/maintainer. Not used.

    Returns Promise<void>

Protected Abstract onResume

  • onResume(): Promise<void>

  • This function is called when the supervisor tries to resume the current job/maintainer after pause. Not used.

    Returns Promise<void>

updateJob

Settings

Member Visibility

Theme

On This Page

constructor_lockenvParamenvParamDefaultenvParamValidatorseventshpchpcSettingsidinitRetryisEndisInitisPausedjobjobOnHpclifeCycleStatelogsmaintainThresholdInHoursmaintainerConfigslurmvalidatorcanceldumpEventsdumpLogsemitEventemitLoggetSingCVMFSConnectorgetSingularityConnectorgetSlurmConnectorinitmaintainonCancelonDefineonInitonMaintainonPauseonResumeupdateJob

Generated using TypeDoc