From b4adcb87ee8e7cb52f45e25c39ab159b0ea3a2d7 Mon Sep 17 00:00:00 2001 From: Jimmy Jiang <71370434+Jimmyj30@users.noreply.github.com> Date: Wed, 5 Jun 2024 01:21:58 -0400 Subject: [PATCH] Update Watcloud Website Docs (#2853) @Edwardius --- pages/docs/compute-cluster/slurm.mdx | 14 +++++++++----- pages/docs/compute-cluster/ssh.mdx | 14 +++++++++----- 2 files changed, 18 insertions(+), 10 deletions(-) diff --git a/pages/docs/compute-cluster/slurm.mdx b/pages/docs/compute-cluster/slurm.mdx index 6c7f788..936fec7 100644 --- a/pages/docs/compute-cluster/slurm.mdx +++ b/pages/docs/compute-cluster/slurm.mdx @@ -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. +- **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,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 diff --git a/pages/docs/compute-cluster/ssh.mdx b/pages/docs/compute-cluster/ssh.mdx index 2530f9f..24ebccf 100644 --- a/pages/docs/compute-cluster/ssh.mdx +++ b/pages/docs/compute-cluster/ssh.mdx @@ -1,15 +1,19 @@ -# SSH +import { Callout } from 'nextra/components' -Now that you have access to the WATcloud compute cluster (Don't have access yet? Make a request [here](./getting-access)), -you can use SSH[^ssh] to connect to the cluster. +# SSH -[^ssh]: SSH stands for Secure Shell. It is a protocol that allows you to connect to a remote machine and execute commands on it. +SSH stands for Secure Shell. It is a commonly used protocol that allows you to connect to a remote machine and execute commands on it. Learn more about SSH [here](https://www.cloudflare.com/learning/access-management/what-is-ssh/). + +Before proceeding, make sure that you are a registered user of the WATcloud compute cluster. Not registered? Make a request [here](./getting-access)). + + ## Quick Start Here's a tool to help you generate a personalized SSH command. This tool will generate a command that you can copy and paste into your terminal. -Note that the commands generated by this tool are only tested on Linux and macOS. +Note that the commands generated by this tool are only tested on Linux and macOS. We highly recommend you take a look at the [Tips and Tricks](#tips-and-tricks) section if you are looking +to use the cluster regularly. It will save time :). ### Command Generator