Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Better Stress the Need to SSH into a Login Node #18

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Better Stress the Need to SSH into a Login Node #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions pages/docs/compute-cluster/slurm.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ 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. Compute nodes are not directly accessible by users.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this comment is confusing because interactive job definition clashes with this. IMO, better to leave this out because its a technical detail that doesn't affect people much, and creates confusion

- **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,17 @@ Before we dive into the details, let's define some common terms used in SLURM:

## Quick Start

To submit jobs to the SLURM cluster, you will need to log into one of the SLURM login nodes.
During the beta, they are labelled `SL` in the [machine list](/machines).
After the beta, all general-use machines will be SLURM login nodes.
### SSH Into a SLURM 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).
After the beta, all general-use machines will be SLURM login nodes.

You can find steps to SSH into our machines [here](/docs/compute-cluster/ssh).

### Interactive shell

Execute the following command to submit a job to the SLURM cluster:
Once SSHed into a SLURM login node, you can execute the following command to submit a simple job to the SLURM cluster:

```bash copy
srun --pty bash
Expand Down
Loading