From 2a0931ee9f431117fd59ddb369733c69990afa1b Mon Sep 17 00:00:00 2001 From: Nathan Nguyen <159226326+Indigo5684@users.noreply.github.com> Date: Tue, 24 Sep 2024 16:10:41 -0500 Subject: [PATCH] Docs Update --- .../01-user-management.md} | 0 docs/index.md | 41 +++++++++++++++++++ docs/{01-users/02-policies.md => policies.md} | 0 docs/{01-users/01-hpc.md => slurm.md} | 9 ++-- .../ldap-kerberos.md | 2 + .../storage.md | 0 6 files changed, 46 insertions(+), 6 deletions(-) rename docs/{02-admin/01-users.md => administration/01-user-management.md} (100%) create mode 100644 docs/index.md rename docs/{01-users/02-policies.md => policies.md} (100%) rename docs/{01-users/01-hpc.md => slurm.md} (93%) rename docs/{03-sysadmin => sytem-administration}/ldap-kerberos.md (97%) rename docs/{03-sysadmin => sytem-administration}/storage.md (100%) diff --git a/docs/02-admin/01-users.md b/docs/administration/01-user-management.md similarity index 100% rename from docs/02-admin/01-users.md rename to docs/administration/01-user-management.md diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..a9abe62 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,41 @@ +# Getting Started + +## Account Creation + +Create an account with the cluster at [Account Console](https://auth.cms.physics.ua.edu/realms/ua-cms/account/), or ask an administrator to create one on your behalf. + +Once an account has been created, it will not have access to any resources until granted such by an administrator. + +## FPGA Access + +FPGAs can be accessed via [JupyterHub](https://jupyter.cms.physics.ua.edu). There are two notebook options availible that support FPGAS: + +- MATLAB with FPGA (1x Alveo U200) +- MATLAB without FPGA + +Currently, the cluster has **0** FPGAs installed. If all FPGAs are in use, your notebook will not launch. + +Each notebook is provided with MATLAB Online, as well as VNC access to the Desktop version via the "Desktop" option. + +To launch MATLAB in the Desktop option, from a terminal window, run `DISPLAY=:1 /opt/matlab/bin/matlab` + +### Installation of HDL Toolbox / Coder FPGA Support Libraries + +During the extension install process, the Xilinx support libraries are written to the `$HOME/Documents` folder, which is overwritten by your user data volume. As such, to enable the support packages, run the following command: + +```bash +wget -q https://www.mathworks.com/mpm/glnxa64/mpm \ + && chmod +x mpm \ + && ./mpm install \ + --release=r2024b \ + --destination=/opt/matlab \ + --products Deep_Learning_HDL_Toolbox_Support_Package_for_Xilinx_FPGA_and_SoC_Devices HDL_Coder_Support_Package_for_Xilinx_FPGA_and_SoC_Devices +``` + +This only needs to be ran once per-user. + +## Docker Registry + +When deploying images to run on the cluster, the cluster's [Docker Registry](https://registry.cms.physics.ua.edu) should be used. + +Note that when authenticating the registry via the command-line, the password prompt should be filled with a token generated from the registry's web GUI, not your actual password. \ No newline at end of file diff --git a/docs/01-users/02-policies.md b/docs/policies.md similarity index 100% rename from docs/01-users/02-policies.md rename to docs/policies.md diff --git a/docs/01-users/01-hpc.md b/docs/slurm.md similarity index 93% rename from docs/01-users/01-hpc.md rename to docs/slurm.md index 974e062..06d0d2d 100644 --- a/docs/01-users/01-hpc.md +++ b/docs/slurm.md @@ -1,4 +1,4 @@ -# HPC Usage +# HPC with Slurm ## Login @@ -45,11 +45,8 @@ conda create --name JupyterTutorial # Activate the sample environment conda activate JupyterTutorial -# Install Jupyter, NodeJS (for slurm extension) -conda install jupyter nodejs - -# Install Jupyter Slurm Extension -jupyter labextension install jupyterlab-slurm +# Install Jupyter +conda install jupyter ``` Next, we will create a script to launch a Jupyter environment, to be executed via `srun`. Note that the port below, `30000`, may not be availible on your particular node. See the [Network Ports](#network-ports) section above for potentially availible ports. diff --git a/docs/03-sysadmin/ldap-kerberos.md b/docs/sytem-administration/ldap-kerberos.md similarity index 97% rename from docs/03-sysadmin/ldap-kerberos.md rename to docs/sytem-administration/ldap-kerberos.md index e76c0b9..fc0c015 100644 --- a/docs/03-sysadmin/ldap-kerberos.md +++ b/docs/sytem-administration/ldap-kerberos.md @@ -7,6 +7,8 @@ Query why we want read by * ```bash +ldapsearch -Q -LLL -Y EXTERNAL -H ldapi:/// -b cn=%sysadmin,ou=sudoers,dc=cms,dc=physics,dc=ua,dc=edu + ldapsearch -Q -LLL -Y EXTERNAL -H ldapi:/// -b cn=config '(olcDatabase={2}mdb)' olcAccess ldapmodify -Q -Y EXTERNAL -H ldapi:///<