Class default

Specialized maintainer for handling jobs submitted to community HPCs (no login). Inherits from BaseMaintainer.

Hierarchy (view full)

default
- default

Constructors

constructor

new default(job): default
Parameters
- job: Job
  job to maintain
Returns default
Overrides default.constructor
- Defined in src/maintainers/CommunityContributionMaintainer.ts:27

Properties

connector

connector: SingularityConnector

envParam

envParam: Record<string, string> = {}

envParamDefault

envParamDefault: Record<string, string> = {}

envParamValidators

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

`Protected` events

events: event[] = []

executableManifest

executableManifest: executableManifest

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

resultFolderContentManager

resultFolderContentManager: ResultFolderContentManager = ...

slurm

slurm: undefined | slurm = undefined

validator

validator: typeof validator = validator

packages

Methods

cancel

cancel(): Promise<void>
Returns Promise<void>
Inherited from default.cancel
- Defined in src/maintainers/BaseMaintainer.ts:222

dumpEvents

dumpEvents(): event[]
Clear all events in this.events

Returns event[]
- List of events that were just deleted.
Inherited from default.dumpEvents
- Defined in src/maintainers/BaseMaintainer.ts:240

dumpLogs

dumpLogs(): string[]
Clear all logs in this.logs

Returns string[]
- List of jobs that were just deleted.
Inherited from default.dumpLogs
- Defined in src/maintainers/BaseMaintainer.ts:230

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
Inherited from default.emitEvent
- Defined in src/maintainers/BaseMaintainer.ts:145

emitLog

emitLog(message): void
Update this.events with the new event
Parameters
- message: string
  Message associated with the event
Returns void
Inherited from default.emitLog
- Defined in src/maintainers/BaseMaintainer.ts:159

getSingCVMFSConnector

getSingCVMFSConnector(): Promise<undefined | SingularityConnector>
Return the Singularity connector associated with this job and hpc.

Returns Promise<undefined | SingularityConnector>
- The singularity connector associated with this job with cvmfs turned on.
Inherited from default.getSingCVMFSConnector
- Defined in src/maintainers/BaseMaintainer.ts:286

getSingularityConnector

getSingularityConnector(): Promise<undefined | SingularityConnector>
Return the singularity connector associated with this job and hpc.

Returns Promise<undefined | SingularityConnector>
- The singularity connector associated with this job.
Inherited from default.getSingularityConnector
- Defined in src/maintainers/BaseMaintainer.ts:276

getSlurmConnector

getSlurmConnector(): Promise<undefined | SlurmConnector>
Return the slurm connector associated with this job and hpc.

Returns Promise<undefined | SlurmConnector>
- The slurm connector associated with this job.
Inherited from default.getSlurmConnector
- Defined in src/maintainers/BaseMaintainer.ts:268

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>
Inherited from default.init
- Defined in src/maintainers/BaseMaintainer.ts:169

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>
Inherited from default.maintain
- Defined in src/maintainers/BaseMaintainer.ts:191

`Protected` onCancel

onCancel(): Promise<void>
Cancel the connector

Returns Promise<void>
Overrides default.onCancel
- Defined in src/maintainers/CommunityContributionMaintainer.ts:259

`Protected` onDefine

onDefine(): undefined
This function is called when the maintainer is created (during the constructor). Can leave empty.

Returns undefined
Overrides default.onDefine
- Defined in src/maintainers/CommunityContributionMaintainer.ts:32

`Protected` onInit

onInit(): Promise<void>
On maintainer initialization, set executableManifest, and give it to the connector. Update the event log to reflect the job being initialized or encountering a system error.

Returns Promise<void>
Overrides default.onInit
- Defined in src/maintainers/CommunityContributionMaintainer.ts:39

`Protected` onMaintain

onMaintain(): Promise<void>
If the job is complete, download the results to the remote result file path, and if it encounters an error, update the event log to reflect this.

Returns Promise<void>
Overrides default.onMaintain
- Defined in src/maintainers/CommunityContributionMaintainer.ts:177

`Protected` onPause

onPause(): Promise<void>
Pause the connector

Returns Promise<void>
Overrides default.onPause
- Defined in src/maintainers/CommunityContributionMaintainer.ts:245

`Protected` onResume

onResume(): Promise<void>
Resume the connector

Returns Promise<void>
Overrides default.onResume
- Defined in src/maintainers/CommunityContributionMaintainer.ts:252

updateJob

updateJob(job): Promise<void>
Update this job to reflect the information in the passed job.
Parameters
- job: jobMaintainerUpdatable
  New information to update this job with.
Returns Promise<void>
Inherited from default.updateJob
- Defined in src/maintainers/BaseMaintainer.ts:250

Class default

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

connector

envParam

envParamDefault

envParamValidators

Protected events

executableManifest

hpc

hpcSettings

id

initRetry

isEnd

isInit

isPaused

job

jobOnHpc

Protected lifeCycleState

Type declaration

createdAt: null | number

initCounter: number

Protected logs

maintainThresholdInHours

maintainerConfig

resultFolderContentManager

slurm

validator

Methods

cancel

Returns Promise<void>

dumpEvents

Returns event[]

dumpLogs

Returns string[]

emitEvent

Parameters

Returns void

emitLog

Parameters

Returns void

getSingCVMFSConnector

Returns Promise<undefined | SingularityConnector>

getSingularityConnector

Returns Promise<undefined | SingularityConnector>

getSlurmConnector

Returns Promise<undefined | SlurmConnector>

init

Returns Promise<void>

maintain

Returns Promise<void>

Protected onCancel

Returns Promise<void>

Protected onDefine

Returns undefined

Protected onInit

Returns Promise<void>

Protected onMaintain

Returns Promise<void>

Protected onPause

Returns Promise<void>

Protected onResume

Returns Promise<void>

updateJob

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Protected` events

`Protected` lifeCycleState

`Protected` logs

`Protected` onCancel

`Protected` onDefine

`Protected` onInit

`Protected` onMaintain

`Protected` onPause

`Protected` onResume