diff --git a/components/affiliation-list.tsx b/components/affiliation-list.tsx index 27f7e90..c5a7545 100644 --- a/components/affiliation-list.tsx +++ b/components/affiliation-list.tsx @@ -15,36 +15,38 @@ export function AffiliationList({ affiliationInfo: AffiliationInfo; }) { return ( - - - - No results found. - - {affiliationInfo.affiliations - .filter((a) => !a.is_legacy) - .map((a) => ( - - {a.name} - - ))} - - - - {affiliationInfo.affiliations - .filter((a) => a.is_legacy) - .map((a) => ( - - {a.name} - - ))} - - - +
+ + + + No results found. + + {affiliationInfo.affiliations + .filter((a) => !a.is_legacy) + .map((a) => ( + + {a.name} + + ))} + + + + {affiliationInfo.affiliations + .filter((a) => a.is_legacy) + .map((a) => ( + + {a.name} + + ))} + + + +
); } diff --git a/pages/docs/_meta.json b/pages/docs/_meta.json index 92110b4..e795a3a 100644 --- a/pages/docs/_meta.json +++ b/pages/docs/_meta.json @@ -1,5 +1,6 @@ { "index": "Introduction", + "services": "Services", "compute-cluster": "Compute Cluster", "registered-affiliations": "Registered Affiliations", "utilities": "Utilities", diff --git a/pages/docs/compute-cluster.mdx b/pages/docs/compute-cluster.mdx index ea752ab..5e2a249 100644 --- a/pages/docs/compute-cluster.mdx +++ b/pages/docs/compute-cluster.mdx @@ -16,13 +16,15 @@ import { TerminalIcon, BookMarkedIcon, HelpCircleIcon, + ServerIcon, } from "lucide-react" import { Card, Cards } from 'nextra/components' } title="Machine List" href="/machines" /> } title="Getting Access" href="./compute-cluster/getting-access" /> - } title="SSH Guide" href="./compute-cluster/ssh" /> } title="Machine Usage Guide" href="./compute-cluster/machine-usage-guide" /> + } title="SSH Guide" href="./compute-cluster/ssh" /> + } title="SLURM Guide" href="./compute-cluster/slurm" /> } title="Support Resources" href="./compute-cluster/support-resources" /> diff --git a/pages/docs/compute-cluster/getting-access.mdx b/pages/docs/compute-cluster/getting-access.mdx index 5d14536..a4720ca 100644 --- a/pages/docs/compute-cluster/getting-access.mdx +++ b/pages/docs/compute-cluster/getting-access.mdx @@ -5,28 +5,15 @@ title: "Getting Access" # Getting Access to the Compute Cluster import { Steps } from 'nextra/components' -import { affiliationInfo } from '@/lib/data' -import { AffiliationList } from '@/components/affiliation-list' ### Determine your WATcloud contact -Every WATcloud compute cluster user has a WATcloud contact. Your WATcloud contact is a designated person within your group (usually your group lead) -who is responsible for approving your access request and assisting you during the onboarding process. - -The following groups are registered with WATcloud: - - - -If your group is not listed or shows up as `[Legacy]`[^legacy-affiliation], please ask your group lead to [register the group][registered-affiliations] with WATcloud. - -[registered-affiliations]: ../registered-affiliations -[^legacy-affiliation]: A legacy affiliation is a group that was onboarded before the current [registered affiliations][registered-affiliations] system was in place. - Members of legacy affiliations can still access the compute cluster, but in order to use newer features like [SLURM](./slurm), the group must be registered. +Your [WATcloud contact](/docs/services#watcloud-contact) will be your primary point of contact for onboarding and support. ### Fill out the onboarding form -Please fill out the [onboarding form](../utilities/onboarding-form) and make sure to enable the "Compute Cluster" option. +Please fill out the [onboarding form](/docs/utilities/onboarding-form) and make sure to enable the "Compute Cluster" option. ### Get approval from your WATcloud contact diff --git a/pages/docs/compute-cluster/machine-usage-guide.mdx b/pages/docs/compute-cluster/machine-usage-guide.mdx index e1d9be2..8fe3b9c 100644 --- a/pages/docs/compute-cluster/machine-usage-guide.mdx +++ b/pages/docs/compute-cluster/machine-usage-guide.mdx @@ -7,6 +7,14 @@ 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). +### General-Use Machines + +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 accessing our general-use machines can be found in our [SSH documentation](./ssh). + ### 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. @@ -20,14 +28,6 @@ Instructions for accessing our SLURM cluster can be found in our [SLURM document 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 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 accessing our general-use machines can be found in our [SSH documentation](./ssh). - ## Hardware Most machines in the cluster come with standard workstation hardware that include CPU, RAM, GPU, and storage[^machine-specs]. In special diff --git a/pages/docs/compute-cluster/ssh.mdx b/pages/docs/compute-cluster/ssh.mdx index f2b676d..e5bf93b 100644 --- a/pages/docs/compute-cluster/ssh.mdx +++ b/pages/docs/compute-cluster/ssh.mdx @@ -6,7 +6,7 @@ SSH stands for Secure Shell. It is a commonly used protocol that allows you to c 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)). +Before proceeding, please make sure that you are a registered user of the WATcloud compute cluster. Not registered? Make a request [here](./getting-access)). ## Quick Start @@ -14,11 +14,6 @@ Before proceeding, make sure that you are a registered user of the WATcloud comp 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 -to use the cluster regularly. It will save time :). - - ### Command Generator Choose your preferred machine and entrypoint[^entrypoint] below. Your personalized SSH command will be generated and displayed below. @@ -47,6 +42,11 @@ that allows you to use your local SSH keys on remote machines. [^ssh-config]: [SSH config](https://www.ssh.com/ssh/config/) is a configuration file that allows you to simplify your SSH commands. + +Once you are able to connect to the cluster, you may want to take a look at the [Tips and Tricks](#tips-and-tricks) +section to speed up your workflow. + + ## Syntax The general syntax for connecting to the cluster is: diff --git a/pages/docs/services.mdx b/pages/docs/services.mdx new file mode 100644 index 0000000..7a49a18 --- /dev/null +++ b/pages/docs/services.mdx @@ -0,0 +1,59 @@ +# Services + +WATcloud offers a variety of services. This page provides an overview of the services available. + +## General Access instructions + +Access to most[^access-otherwise] services listed below can be requested via the [onboarding form](/docs/utilities/onboarding-form). +Requests will be reviewed by your group's WATcloud contact. + +[^access-otherwise]: If a service requires a different access process, it will be mentioned in the service description. + +### WATcloud contact + +A WATcloud contact is a designated person within each group (usually the group lead) who is responsible for approving access request and assisting users during the onboarding process. +The following groups are registered with WATcloud: + +import { affiliationInfo } from '@/lib/data' +import { AffiliationList } from '@/components/affiliation-list' + + + +If your group is not listed or shows up as `[Legacy]`[^legacy-affiliation], please ask your group lead to [register the group][registered-affiliations] with WATcloud. + +[registered-affiliations]: /docs/registered-affiliations +[^legacy-affiliation]: A legacy affiliation is a group that was onboarded before the current [registered affiliations][registered-affiliations] system was in place. Members of legacy affiliations can still access the compute cluster, but in order to use newer features like [SLURM](/docs/compute-cluster/slurm), the group must be registered. + +## Service Directory + +import userSchemaJSON from "@/build/fixtures/user.schema.json"; +import { lookupStringMDX, userSchemaStrings } from "@/lib/data"; + +export function ServiceDescriptions() { + const ret = []; + for (const [serviceKey, service] of Object.entries(userSchemaJSON.properties)) { + if (service.properties?.enabled === undefined) { + // only list services that can be enabled/disabled + continue; + } + + const Description = lookupStringMDX(userSchemaStrings, service["$services_description"] || service.description); + + ret.push( +
+

{service.title}

+ +
+ ); + } + return ret; +} + + + +{ +// Separate footnotes from the main content +} +import { Separator } from "@/components/ui/separator" + + \ No newline at end of file