Class SlurmConnector

Specialization of BaseConnector that, in addition to offering ssh connection, supports slurm connections with the HPC.

Hierarchy (view full)

SlurmConnector
- SingularityConnector

Constructors

`Protected` constructor

new SlurmConnector(maintainer, connector, is_cvmfs?): SlurmConnector
Parameters
- maintainer: default
  maintainer that this connector was created for
- connector: SSHConnector
  sshconnector this connector should use
- is_cvmfs: boolean = false
  whether this connector is cvmfs
Returns SlurmConnector
- Defined in src/connectors/SlurmConnector.ts:39

Properties

`Protected` isContainer

isContainer: boolean = false

`Protected` is_cvmfs

is_cvmfs: boolean

properties

`Protected` maintainer

maintainer: default

parent pointer

`Protected` modules

modules: string[] = []

`Protected` remoteDataFolderPath

remoteDataFolderPath: string

`Protected` remoteExecutableFolderPath

remoteExecutableFolderPath: string

`Protected` remoteResultFolderPath

remoteResultFolderPath: string

slurm_id

slurm_id: string

`Protected` sshConnector

sshConnector: SSHConnector

config

`Protected` template

template: string

Methods

cancel

cancel(): Promise<void>
cancels the job

Returns Promise<void>
- Defined in src/connectors/SlurmConnector.ts:312

getContainerCVMFSFolderPath

getContainerCVMFSFolderPath(providedPath?): string
Get Container CVMFS folder path
Parameters
- Optional providedPath: null | string = null
  specified path
Returns string
executable path
- Defined in src/connectors/SlurmConnector.ts:424

getContainerDataFolderPath

getContainerDataFolderPath(providedPath?): string
Get Container data folder path
Parameters
- Optional providedPath: null | string = null
  specified path
Returns string
executable path
- Defined in src/connectors/SlurmConnector.ts:434

getContainerExecutableFolderPath

getContainerExecutableFolderPath(providedPath?): string
Get Container executable folder path
Parameters
- Optional providedPath: null | string = null
  specified path
Returns string
executable path
- Defined in src/connectors/SlurmConnector.ts:414

getContainerResultFolderPath

getContainerResultFolderPath(providedPath?): string
Get Container result folder path
Parameters
- Optional providedPath: null | string = null
  specified path
Returns string
executable path
- Defined in src/connectors/SlurmConnector.ts:444

`Private` getModuleLoadString

getModuleLoadString(): string
Creates a string to import the this.modules modules.

Returns string
the module load string
- Defined in src/connectors/SlurmConnector.ts:86

getRemoteDataFolderPath

getRemoteDataFolderPath(providedPath?): null | string
gets remote data folder path
Parameters
- Optional providedPath: null | string = null
  specified path
Returns null | string
command execution output
- Defined in src/connectors/SlurmConnector.ts:390

getRemoteExecutableFolderPath

getRemoteExecutableFolderPath(providedPath?): string
gets remote executable folder path
Parameters
- Optional providedPath: null | string = null
  specified path
Returns string
command execution output
- Defined in src/connectors/SlurmConnector.ts:378

getRemoteResultFolderContent

getRemoteResultFolderContent(): Promise<string[]>
Get remote results folder content

Returns Promise<string[]>
file content
- Defined in src/connectors/SlurmConnector.ts:454

getRemoteResultFolderPath

getRemoteResultFolderPath(providedPath?): string
gets remote result folder path
Parameters
- Optional providedPath: null | string = null
  specified path
Returns string
command execution output
- Defined in src/connectors/SlurmConnector.ts:402

`Private` getSBatchTagsFromArray

getSBatchTagsFromArray(tag, vals): string
Get sbatch tags
Parameters
- tag: string
  sbatch tags
- vals: string[]
  values of sbatch tags
Returns string
sbatch string
- Defined in src/connectors/SlurmConnector.ts:364

getSSHConnection

getSSHConnection(): SSHConnector
Returns SSHConnector
the ssh connection this connector uses
- Defined in src/connectors/SlurmConnector.ts:659

getSlurmStderr

getSlurmStderr(): Promise<void>
gets SlurmStderr and emit it as a log in the maintainer

Returns Promise<void>
- Defined in src/connectors/SlurmConnector.ts:349

getSlurmStdout

getSlurmStdout(): Promise<void>
gets SlurmStdOut and emit it as a log in the maintainer

Returns Promise<void>
- Defined in src/connectors/SlurmConnector.ts:336

getStatus

getStatus(): Promise<string>
checks job status

Returns Promise<string>
job status (RETRY, UNKNOWN, or a slurm job status)
- Defined in src/connectors/SlurmConnector.ts:268

getUsage

getUsage(): Promise<Record<string, null | number>>
Get job usage

Returns Promise<Record<string, null | number>>
- usage dictionary
- Defined in src/connectors/SlurmConnector.ts:514

isCommunityAccount

isCommunityAccount(): boolean
Returns boolean
whether or not this connection is via a community account
- Defined in src/connectors/SlurmConnector.ts:628

pause

pause(): Promise<void>
pauses the job

Returns Promise<void>
- Defined in src/connectors/SlurmConnector.ts:320

`Protected` prepare

prepare(cmd, config): void
Creates slurm string with specified configuation. Saves it to this.template.
Parameters
- cmd: string
  command that needs to be executed
- config: slurm
  slurm configuration
Returns void
- Defined in src/connectors/SlurmConnector.ts:99

registerModules

registerModules(modules): void
Registers all of the specified modules
Parameters
- modules: string[]
  Array of strings
Returns void
- Defined in src/connectors/SlurmConnector.ts:78

resume

resume(): Promise<void>
resumes the job

Returns Promise<void>
- Defined in src/connectors/SlurmConnector.ts:328

setRemoteDataFolderPath

setRemoteDataFolderPath(path): void
Parameters
- path: string
  remote data folder path
Returns void
- Defined in src/connectors/SlurmConnector.ts:644

setRemoteExecutableFolderPath

setRemoteExecutableFolderPath(path): void
Parameters
- path: string
  remote executable folder path
Returns void
- Defined in src/connectors/SlurmConnector.ts:636

setRemoteResultFolderPath

setRemoteResultFolderPath(path): void
Parameters
- path: string
  remote result folder path
Returns void
- Defined in src/connectors/SlurmConnector.ts:652

submit

submit(): Promise<void>
Submit the slurm job.

Returns Promise<void>
Throws
when job cannot be submitted or ssh commands fail
- Defined in src/connectors/SlurmConnector.ts:166

`Static` build

build(maintainer, is_cvmfs?): Promise<undefined | SlurmConnector>
Creates a SlurmConnector, ensuring that the connector is functional while doing so
Parameters
- maintainer: default
  maintainer to create a slurmconnector for
- is_cvmfs: boolean = false
  whether this connector should be cvmfs
Returns Promise<undefined | SlurmConnector>
the desired connector, or undefined if the construction was unsuccessful
- Defined in src/connectors/SlurmConnector.ts:55

Generated using TypeDoc