Skip to content

user_settings

SlurmSshUserSettings

Bases: BaseModel

Subset of user settings which must be present for task collection and job execution when using the Slurm-SSH runner.

Attributes:

Name Type Description
ssh_host str

SSH-reachable host where a SLURM client is available.
ssh_username str

User on ssh_host.
ssh_private_key_path str

Path of private SSH key for ssh_username.
ssh_tasks_dir str

Task-venvs base folder on ssh_host.
ssh_jobs_dir str

Jobs base folder on ssh_host.
slurm_accounts list[str]

List of SLURM accounts, to be used upon Fractal job submission.
Source code in fractal_server/app/user_settings.py 
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
class SlurmSshUserSettings(BaseModel):
    """
    Subset of user settings which must be present for task collection and job
    execution when using the Slurm-SSH runner.

    Attributes:
        ssh_host: SSH-reachable host where a SLURM client is available.
        ssh_username: User on `ssh_host`.
        ssh_private_key_path: Path of private SSH key for `ssh_username`.
        ssh_tasks_dir: Task-venvs base folder on `ssh_host`.
        ssh_jobs_dir: Jobs base folder on `ssh_host`.
        slurm_accounts:
            List of SLURM accounts, to be used upon Fractal job submission.
    """

    ssh_host: str
    ssh_username: str
    ssh_private_key_path: str
    ssh_tasks_dir: str
    ssh_jobs_dir: str
    slurm_accounts: list[str]

SlurmSudoUserSettings

Bases: BaseModel

Subset of user settings which must be present for task collection and job execution when using the Slurm-sudo runner.

Attributes:

Name Type Description
slurm_user str

User to be impersonated via sudo -u.
cache_dir str

Folder where slurm_user can write.
slurm_accounts list[str]

List of SLURM accounts, to be used upon Fractal job submission.
Source code in fractal_server/app/user_settings.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
class SlurmSudoUserSettings(BaseModel):
    """
    Subset of user settings which must be present for task collection and job
    execution when using the Slurm-sudo runner.

    Attributes:
        slurm_user: User to be impersonated via `sudo -u`.
        cache_dir: Folder where `slurm_user` can write.
        slurm_accounts:
            List of SLURM accounts, to be used upon Fractal job submission.
    """

    slurm_user: str
    cache_dir: str
    slurm_accounts: list[str]