Skip to content

Commit

Permalink
Fix docs about general use machines (#2861)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jimmyj30 authored Jun 11, 2024
1 parent ca68503 commit 69a555f
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 7 deletions.
10 changes: 6 additions & 4 deletions pages/docs/compute-cluster/machine-usage-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,26 @@ It also includes guidelines for using the machines, troubleshoot instructions fo

There are two main types of machines in the cluster: [general-use machines](/machines#general-use-machines) and [SLURM compute nodes](/machines#slurm-compute-nodes).

### SLURM Machines
### SLURM Compute Nodes

Simple Linux Utility for Resource Management (SLURM) is an open-source job scheduler that allocates resources to jobs on a cluster of computers.
It is widely used in HPC[^hpc] environments.

SLURM machines can be used for both interactive development as well as job scheduling. They provide fair, stable, and secure access to WATcloud's most precious resources (eg. GPUs).

[Instructions for using our SLURM cluster can be found here.](./slurm)
Instructions for accessing our SLURM cluster can be found in our [SLURM documentation](./slurm).

[^hpc]: [High-performance computing](https://en.wikipedia.org/wiki/High-performance_computing) (HPC) is the use of supercomputers and parallel processing
techniques to solve complex computational problems. Examples of HPC clusters include [Cedar](https://docs.computecanada.ca/wiki/Cedar) and
[Graham](https://docs.computecanada.ca/wiki/Graham).

### General-Use Machines

General-use machines are meant for interactive use only. They are an insecure and unstable resource shared amongst all users in the cluster. Going forward, WATcloud will be phasing out General-use Machines in favour of SLURM.
General-use machines are meant for interactive use and are shared among all users in the cluster.
Additionally, SLURM compute nodes are accessible through general use machines marked as SLURM login
nodes (`SL`) in the [machine list](/machines#general-use-machines).

[Instructions for using our General-Use Machines can be found here.](./ssh)
Instructions for accessing our general-use machines can be found in our [SSH documentation](./ssh).

## Hardware

Expand Down
4 changes: 2 additions & 2 deletions pages/docs/compute-cluster/slurm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ Before we dive into the details, let's define some common terms used in SLURM:
### 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.
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.

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

Expand Down
6 changes: 5 additions & 1 deletion pages/docs/compute-cluster/ssh.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,12 @@ Before proceeding, make sure that you are a registered user of the WATcloud comp
## 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. We highly recommend you take a look at the [Tips and Tricks](#tips-and-tricks) section if you are looking
Note that the commands generated by this tool are only tested on Linux and macOS.

<Callout type="info">
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 :).
</Callout>

### Command Generator

Expand Down

0 comments on commit 69a555f

Please sign in to comment.