Skip to content

Commit

Permalink
Update Watcloud Website Docs (#2853)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jimmyj30 authored Jun 5, 2024
1 parent a47fbc1 commit b4adcb8
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 10 deletions.
14 changes: 9 additions & 5 deletions pages/docs/compute-cluster/slurm.mdx
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.
- **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
14 changes: 9 additions & 5 deletions pages/docs/compute-cluster/ssh.mdx
Original file line number Diff line number Diff line change
@@ -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/).

<Callout type="warning">
Before proceeding, make sure that you are a registered user of the WATcloud compute cluster. Not registered? Make a request [here](./getting-access)).
</Callout>

## 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

Expand Down

0 comments on commit b4adcb8

Please sign in to comment.