Skip to content

Commit

Permalink
Clarify SLURM login node documentation (#3080)
Browse files Browse the repository at this point in the history
This PR lists the SLURM login nodes in the documentation to be extra
clear on which nodes can be used to submit jobs to the SLURM cluster.

cc @Jimmyj30
  • Loading branch information
ben-z authored Sep 4, 2024
1 parent 3243c69 commit 0648c82
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions pages/docs/compute-cluster/slurm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ or [let us know](/docs/compute-cluster/support-resources).

Before we dive into the details, let's define some common terms used in SLURM:

- **Login node**: A node that users log into to submit jobs to the SLURM cluster. This is where you will interact with the SLURM cluster.
- **Compute node**: A node that runs jobs submitted to the SLURM cluster. This is where your job will run.
- **SLURM Login node**: A node that users log into to submit jobs to the SLURM cluster. This is where you will interact with the SLURM cluster.
- **SLURM Compute node**: A node that runs jobs submitted to the SLURM cluster. This is where your job will run.
- **Partition**: A logical grouping of nodes in the SLURM cluster. Partitions can have different properties (e.g. different resource limits) and are used to organize resources.
- **Job**: A unit of work submitted to the SLURM cluster. A job can be interactive or batch.
- **Interactive job**: A job that runs interactively on a compute node. This is useful for debugging or running short tasks.
Expand All @@ -34,13 +34,22 @@ Before we dive into the details, let's define some common terms used in SLURM:

## Quick Start

### SSH Into a SLURM Node
### SSH into a SLURM login node

To submit jobs to the SLURM cluster, you must first SSH into one of the SLURM login nodes.
During the beta, they are machines labelled `SL` in the [machine list](/machines#general-use-machines).
After the beta, all general-use machines will be SLURM login nodes.
To submit jobs to the SLURM cluster, you must first SSH into one of the SLURM login nodes[^slurm-login-nodes]:

You can find steps to SSH into our machines [here](/docs/compute-cluster/ssh).
import { machineInfo } from '@/lib/data'

export function SLURMLoginNodes() {
const slurmLoginNodes = machineInfo.machines.dev_vms.filter((machine) => machine.tags.map((tag) => tag.name).includes('SL'))
return <ul>{slurmLoginNodes.map((machine) => <li key={machine.name}>{machine.name}</li>)}</ul>
}

<SLURMLoginNodes />

Instructions on how to SSH into machines can be found [here](./ssh).

[^slurm-login-nodes]: SLURM login nodes are also labelled `SL` in the [machine list](/machines#general-use-machines). These machines are subject to change. [Announcements](https://github.com/WATonomous/infrastructure-support/discussions) will be made if changes occur.

### Interactive shell

Expand Down

0 comments on commit 0648c82

Please sign in to comment.