diff --git a/docs/services/on-prem/Pantarhei/RunningJobs/computenode.md b/docs/services/on-prem/Pantarhei/RunningJobs/computenode.md new file mode 100644 index 0000000..37e65e2 --- /dev/null +++ b/docs/services/on-prem/Pantarhei/RunningJobs/computenode.md @@ -0,0 +1,18 @@ +--- +sidebar_position: 1 +title: "Accessing the Compute Nodes" +description: "" +tags: + - HPC + - On-Premises + - Slurm + - Pantarhei +--- + +Pantarhei employs the [Slurm Workload Manager](https://slurm.schedmd.com/documentation.html) for the purpose of job scheduling and management. Utilizing Slurm, a user initiates a request for resources and submits a job to a designated queue. Subsequently, the system undertakes the task of extracting jobs from the queues, assigning the requisite compute nodes, and executing the submitted tasks. Although users typically access the Slurm job scheduler by SSH-ing to a Pantarhei login node, it is imperative to emphasize that the recommended practice entails utilizing Slurm to submit work as a job, as opposed to executing computationally intensive tasks directly on a login node. Given that all users share the login nodes, running anything beyond minimal test jobs can adversely affect the collective ability of users to effectively utilize Pantarhei resources. + +Pantarhei's framework is tailored to accommodate the moderate-scale computational and data requirements of the majority of CIROH users. Users with allocations possess the capability to submit tasks to a diverse array of queues, each featuring distinct job size and walltime constraints. Dedicated sets of queues are allocated for CPU, GPU, and FPGA nodes, with typically shorter walltime and smaller job size limits translating to expedited turnaround times. Several additional considerations regarding Pantarhei queues merit attention: + +1. Pantarhei facilitates shared jobs, whereby multiple tasks can be executed on a single node. This approach enhances job throughput, maximizes overall system utilization, and fosters increased user accessibility to Pantarhei resources. +2. Pantarhei accommodates long-running jobs, with run times extendable up to seven days for tasks utilizing up to 6 full nodes. +3. The maximum permissible job size on Pantarhei is 240 cores. For tasks exceeding this threshold, users are advised to initiate a consulting ticket to engage in further discussion with Pantarhei support personnel. \ No newline at end of file diff --git a/docs/services/on-prem/Pantarhei/RunningJobs/index.md b/docs/services/on-prem/Pantarhei/RunningJobs/index.md new file mode 100644 index 0000000..e475d0b --- /dev/null +++ b/docs/services/on-prem/Pantarhei/RunningJobs/index.md @@ -0,0 +1,19 @@ +--- +sidebar_position: 4 +title: "Running Jobs" +tags: + - HPC + - On-Premises + - Slurm + - Pantarhei +--- + +Proficient users acquainted with the Linux command line interface have the option to utilize standard job submission utilities for the purpose of managing and executing tasks on the computational nodes within the Pantarhei system. + +------------------------------------------------ + +### Navigational Resources + +import DocCardList from '@theme/DocCardList'; + + \ No newline at end of file diff --git a/docs/services/on-prem/Pantarhei/access.md b/docs/services/on-prem/Pantarhei/access.md index f0c28af..86c6e50 100644 --- a/docs/services/on-prem/Pantarhei/access.md +++ b/docs/services/on-prem/Pantarhei/access.md @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 3 title: "Accessing the System" description: "Access of On-Premises Cluster Pantarhei" tags: @@ -13,120 +13,104 @@ Pantarhei curretly only supports the Secure Shell (SSH) mechanisms for logging i ### General overview -To connect to Pantarhei using SSH, you must follow three high-level steps: +To connect to Pantarhei using SSH, you must follow two high-level steps: * [Connect to the University of Alabama (UA) Network](#connect-to-the-network) * [Connect to the Secure Shell (SSH)](#connect-to-the-ssh) +:::info[Obtain Pantarhei Access] +In the case that access to the Pantarhei system is unavailable to you, please follow the instructions on [Obtaining an Account](/docs/services/on-prem/Pantarhei/obtain). +::: + ### Connect to the Network -University of Alabama (UA) requires that you use the Virtual private network (VPN) to connect to the UA campus network in order to connect to the Pantarhei cluster. +University of Alabama (UA) requires users to use the Virtual private network (VPN) to connect to the UA campus network in order to connect to the Pantarhei cluster. :::tip -To request credentials for VPN Access, please fill this form [CIROH Service Request Form](https://forms.office.com/Pages/DesignPageV2.aspx?subpage=design&token=eaeef2bd5f894e62ab350cafb3b5ea76&id=jnIAKtDwtECk6M5DPz-8p4IIpHdEnmhNgjOa9FjrwGtUME1GV1JXRFVSQzQxM1FFRUc4SDhCOFNONy4u) -::: -:::tip -For more information on setting up a VPN, please visit the [Office of Information Technology (OIT) website](https://oit.ua.edu/services/internet-networking/vpn/) +For more information on setting up a VPN, please visit the [Office of Information Technology (OIT) website](https://oit.ua.edu/services/internet-networking/vpn/). ::: ### Connect to the SSH - -#### Mac and Linux: - -Once you are connected to the VPN, follow these steps to access Pantarhei: - -1. **Open a Terminal:** Find `Terminal` in your local machine and open it. - :::tip - In MacOS, use Spotlight search (**Command** + **Spacebar**) and type `Terminal` to open a new terminal window. - ::: - -2. **Connect via SSH:** In the terminal, - * Use the SSH command to connect to Pantarhei. - ```Shell - ssh @pantarhei.ua.edu - ``` - :::note - Replace `` with your actual Pantarhei username. - ::: - * Enter your Pantarhei password - - -#### Windows: - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Windows SSH Instruction
ProgramsInstructions
MobaXtermOpen a local terminal and [follow above steps](#mac-and-linux)             
Git Bash[Follow above steps](#mac-and-linux)
Windows 10 PowerShell[Follow above steps](#mac-and-linux)
Windows 10 Subsystem for Linux[Follow above steps](#mac-and-linux)
PuTTY[Follow steps below](#putty)
- -#### PuTTY: -PuTTY, initially developed by Simon Tatham for the Windows operating system, serves as a client application for both SSH (Secure Shell) and telnet protocols. It is characterized by its open-source nature, providing access to its source code, and is maintained through collaborative efforts by a community of volunteers. - +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + Once you are connected to the VPN, follow these steps to access Pantarhei: + + 1. **Open a Terminal:** Find `Terminal` in your local machine and open it. + + :::tip + In MacOS, use Spotlight search (**Command** + **Spacebar**) and type `Terminal` to open a new terminal window. + ::: + + 2. **Connect via SSH:** In the terminal, + * Use the SSH command to connect to Pantarhei. + ```Shell + ssh @pantarhei.ua.edu + ``` + :::note + Replace `` with your actual Pantarhei username. + ::: + * Enter your Pantarhei password + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Windows SSH Instruction
ProgramsInstructions
MobaXtermOpen a local terminal and [follow steps](/docs/services/on-prem/Pantarhei/access?current-os=mac#connect-to-the-ssh)             
Git Bash[follow steps](/docs/services/on-prem/Pantarhei/access?current-os=mac#connect-to-the-ssh)
Windows 10 PowerShell[follow steps](/docs/services/on-prem/Pantarhei/access?current-os=mac#connect-to-the-ssh)
Windows 10 Subsystem for Linux[follow steps](/docs/services/on-prem/Pantarhei/access?current-os=mac#connect-to-the-ssh)
PuTTY + [Follow steps below](/docs/services/on-prem/Pantarhei/access?current-os=win#putty) +
+ +------------------------------------------------ + + #### PuTTY + + PuTTY, initially developed by Simon Tatham for the Windows operating system, serves as a client application for both SSH (Secure Shell) and telnet protocols. It is characterized by its open-source nature, providing access to its source code, and is maintained through collaborative efforts by a community of volunteers. :::tip For more information on PuTTY, please visit the [PuTTY website](https://www.putty.org/) ::: - -1. **Download PuTTY:** To download PuTTY, click [download page](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) -2. **Open PuTTY:** Open downloaded file `putty.exe` -

- putty -

-3. **Host Name:** In the ___Host Name (or IP address)___ field enter the `pantarhei.ua.edu` -4. **Port:** In the ___Port___ field enter the `22` -5. **Open:** Click on the ___Open___ button. This will prompt a new login Secure Shell window. -6. **User Name:** In given new window, enter your Pantarhei ___User Name___. -

- putty -

-7. **Password:** Enter your Pantarhei account ___Password___. -

- putty -

- - + 1. **Download PuTTY:** To download PuTTY, click [download page](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) + 2. **Open PuTTY:** Open downloaded file `putty.exe` +

+ putty +

+ 3. **Host Name:** In the ___Host Name (or IP address)___ field enter the `pantarhei.ua.edu` + 4. **Port:** In the ___Port___ field enter the `22` + 5. **Open:** Click on the ___Open___ button. This will prompt a new login Secure Shell window. + 6. **User Name:** In given new window, enter your Pantarhei ___User Name___. +

+ putty +

+ 7. **Password:** Enter your Pantarhei account ___Password___. +

+ putty +

+ + We hope this guide helps you efficiently utilize the Pantarhei HPC system for your research needs. Happy computing! \ No newline at end of file diff --git a/docs/services/on-prem/Pantarhei/index.md b/docs/services/on-prem/Pantarhei/index.md index 2a717d2..4a7f7e1 100644 --- a/docs/services/on-prem/Pantarhei/index.md +++ b/docs/services/on-prem/Pantarhei/index.md @@ -17,16 +17,10 @@ Use of this resource is governed by the University of Alabama Acceptable Use Pol 2. [Information Classification Policy](https://ua-public.policystat.com/policy/14809337/latest/) 3. [Information Protection Procedure](https://oit.ua.edu/internaldocs/20210205-UA%20Information%20Protection%20Procedures.pdf) - - - - ------------------------------------------------ +### Navigational Resources + import DocCardList from '@theme/DocCardList'; \ No newline at end of file diff --git a/docs/services/on-prem/Pantarhei/obtain.md b/docs/services/on-prem/Pantarhei/obtain.md new file mode 100644 index 0000000..e7f375a --- /dev/null +++ b/docs/services/on-prem/Pantarhei/obtain.md @@ -0,0 +1,43 @@ +--- +sidebar_position: 2 +title: "Obtaining an Account" +description: "Obtain an account on Pantarhei" +tags: + - HPC + - On-Premises + - Account + - Pantarhei +--- + +Pantarhei cluster is accessible to the research community of the Cooperative Institute for Research to Operations in Hydrology (CIROH). + +### General overview + +To obtain an account, users will need to follow these step: + +1. Submit [On-premises Infrastructure Request Form](/docs/services/access#on-premises) and describe full project information and resouce requirements. + + ::::::warning + This GitHub issue must be submitted by Principal Investigator (PI) of the project. + + :::info[Hint] + In the GitHub issue PI should mention following details: + 1. PI's __Full Name__ + 2. PI's __Affiliated Institute__ + 3. PI's __Affiliated Email Address__ + 4. List of students who will need access, also please provide following details of each student + * __Full Name__ of student + * __GitHub User Name__ of student + * __Affiliated Email Address__ of student + ::: + :::::: +2. Submit On-premise Access Request form in [CIROH Service Request](https://forms.office.com/r/CQucJqqADx). + ::::::tip + The administration of the Pantarhei cluster falls under the purview of the CIROH IT Computing group at the University of Alabama (UA). Consequently, individuals lacking UA credentials (*MyBama ID*, *VPN User Name*, and *CWID*) are obliged to complete the __`VPN Access Request`__ form, followed by the __`On-premise Access Request`__ form within [CIROH Service Request](https://forms.office.com/r/CQucJqqADx). + + :::warning[Account Creation] + Creation of accounts on the Pantarhei system necessitates submission of individual forms by each respective user. + + For instance, a Principal Investigator (PI) submits a GitHub issue pertaining to a project, and three students require access to the Pantarhei system for project-related work, three separate account creation forms must be duly submitted during this process. + ::: + :::::: diff --git a/docs/services/on-prem/Wukong/access.md b/docs/services/on-prem/Wukong/access.md new file mode 100644 index 0000000..ceda080 --- /dev/null +++ b/docs/services/on-prem/Wukong/access.md @@ -0,0 +1,116 @@ +--- +sidebar_position: 3 +title: "Accessing the System" +description: "Access of On-Premises Cluster Wukong" +tags: + - HPC + - On-Premises + - Access + - Wukong +--- + +Wukong curretly only supports the Secure Shell (SSH) mechanisms for logging in. The Secure Shell mechanism uses SSH keys. If you need help creating or uploading your SSH keys, please see the Managing SSH Public Keys page for that information. + +### General overview + +To connect to Wukong using SSH, you must follow two high-level steps: +* [Connect to the University of Alabama (UA) Network](#connect-to-the-network) +* [Connect to the Secure Shell (SSH)](#connect-to-the-ssh) + +:::info[Obtain Wukong Access] +In the case that access to the Wukong system is unavailable to you, please follow the instructions on [Obtaining an Account](/docs/services/on-prem/Wukong/obtain). +::: + +### Connect to the Network + +University of Alabama (UA) requires users to use the Virtual private network (VPN) to connect to the UA campus network in order to connect to the Wukong cluster. + +:::tip +For more information on setting up a VPN, please visit the [Office of Information Technology (OIT) website](https://oit.ua.edu/services/internet-networking/vpn/). +::: + +### Connect to the SSH +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + Once you are connected to the VPN, follow these steps to access Wukong: + + 1. **Open a Terminal:** Find `Terminal` in your local machine and open it. + + :::tip + In MacOS, use Spotlight search (**Command** + **Spacebar**) and type `Terminal` to open a new terminal window. + ::: + + 2. **Connect via SSH:** In the terminal, + * Use the SSH command to connect to Wukong. + ```Shell + ssh @Wukong.ua.edu + ``` + :::note + Replace `` with your actual Wukong username. + ::: + * Enter your Wukong password + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Windows SSH Instruction
ProgramsInstructions
MobaXtermOpen a local terminal and [follow steps](/docs/services/on-prem/Wukong/access?current-os=mac#connect-to-the-ssh)             
Git Bash[follow steps](/docs/services/on-prem/Wukong/access?current-os=mac#connect-to-the-ssh)
Windows 10 PowerShell[follow steps](/docs/services/on-prem/Wukong/access?current-os=mac#connect-to-the-ssh)
Windows 10 Subsystem for Linux[follow steps](/docs/services/on-prem/Wukong/access?current-os=mac#connect-to-the-ssh)
PuTTY + [Follow steps below](/docs/services/on-prem/Wukong/access?current-os=win#putty) +
+ +------------------------------------------------ + + #### PuTTY + + PuTTY, initially developed by Simon Tatham for the Windows operating system, serves as a client application for both SSH (Secure Shell) and telnet protocols. It is characterized by its open-source nature, providing access to its source code, and is maintained through collaborative efforts by a community of volunteers. +:::tip +For more information on PuTTY, please visit the [PuTTY website](https://www.putty.org/) +::: + 1. **Download PuTTY:** To download PuTTY, click [download page](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) + 2. **Open PuTTY:** Open downloaded file `putty.exe` +

+ putty +

+ 3. **Host Name:** In the ___Host Name (or IP address)___ field enter the `Wukong.ua.edu` + 4. **Port:** In the ___Port___ field enter the `22` + 5. **Open:** Click on the ___Open___ button. This will prompt a new login Secure Shell window. + 6. **User Name:** In given new window, enter your Wukong ___User Name___. +

+ putty +

+ 7. **Password:** Enter your Wukong account ___Password___. +

+ putty +

+ + + +We hope this guide helps you efficiently utilize the Wukong HPC system for your research needs. Happy computing! \ No newline at end of file diff --git a/docs/services/on-prem/Wukong/index.md b/docs/services/on-prem/Wukong/index.md index 4d10d44..60da7bf 100644 --- a/docs/services/on-prem/Wukong/index.md +++ b/docs/services/on-prem/Wukong/index.md @@ -7,6 +7,7 @@ tags: - On-Premises - Overview - Intro + - Wukong --- Wukong serves as an analytical and computational resource accessible to the research community of the Cooperative Institute for Research to Operations in Hydrology (CIROH). @@ -23,6 +24,8 @@ Protection Procedure. Please review these policies on-line: ------------------------------------------------ +### Navigational Resources + import DocCardList from '@theme/DocCardList'; \ No newline at end of file diff --git a/docs/services/on-prem/Wukong/obtain.md b/docs/services/on-prem/Wukong/obtain.md new file mode 100644 index 0000000..34f907f --- /dev/null +++ b/docs/services/on-prem/Wukong/obtain.md @@ -0,0 +1,43 @@ +--- +sidebar_position: 2 +title: "Obtaining an Account" +description: "Obtain an account on Wukong" +tags: + - HPC + - On-Premises + - Account + - Wukong +--- + +Wukong cluster is accessible to the research community of the Cooperative Institute for Research to Operations in Hydrology (CIROH). + +### General overview + +To obtain an account, users will need to follow these step: + +1. Submit [On-premises Infrastructure Request Form](/docs/services/access#on-premises) and describe full project information and resouce requirements. + + ::::::warning + This GitHub issue must be submitted by Principal Investigator (PI) of the project. + + :::info[Hint] + In the GitHub issue PI should mention following details: + 1. PI's __Full Name__ + 2. PI's __Affiliated Institute__ + 3. PI's __Affiliated Email Address__ + 4. List of students who will need access, also please provide following details of each student + * __Full Name__ of student + * __GitHub User Name__ of student + * __Affiliated Email Address__ of student + ::: + :::::: +2. Submit On-premise Access Request form in [CIROH Service Request](https://forms.office.com/r/CQucJqqADx). + ::::::tip + The administration of the Wukong cluster falls under the purview of the CIROH IT Computing group at the University of Alabama (UA). Consequently, individuals lacking UA credentials (*MyBama ID*, *VPN User Name*, and *CWID*) are obliged to complete the __`VPN Access Request`__ form, followed by the __`On-premise Access Request`__ form within [CIROH Service Request](https://forms.office.com/r/CQucJqqADx). + + :::warning[Account Creation] + Creation of accounts on the Wukong system necessitates submission of individual forms by each respective user. + + For instance, a Principal Investigator (PI) submits a GitHub issue pertaining to a project, and three students require access to the Wukong system for project-related work, three separate account creation forms must be duly submitted during this process. + ::: + ::::::