From 0648c82d5a2347d007411e6c5930b472aba68b20 Mon Sep 17 00:00:00 2001 From: Ben Zhang Date: Tue, 3 Sep 2024 18:02:13 -0700 Subject: [PATCH] Clarify SLURM login node documentation (#3080) 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 --- pages/docs/compute-cluster/slurm.mdx | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/pages/docs/compute-cluster/slurm.mdx b/pages/docs/compute-cluster/slurm.mdx index 2556433..9f0884b 100644 --- a/pages/docs/compute-cluster/slurm.mdx +++ b/pages/docs/compute-cluster/slurm.mdx @@ -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. @@ -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 +} + + + +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