diff --git a/docs/access.md b/docs/access.md index 1b4507bd4c721ad438ebd576bdf42413f150cc0d..ff4dc209e365792f42d90e8096be943d9348192b 100644 --- a/docs/access.md +++ b/docs/access.md @@ -51,14 +51,14 @@ The procedure is documented below for some popular choices: JuDoor offers users the option to enable Multi-Factor Authentication (MFA), which adds an extra layer of security to your account. With MFA enabled, you'll be required to provide a secondary factor of authentication in addition to your password. For example, when logging in to JSC services, you'll be prompted to enter a time-based one-time password (TOTP) as the second factor. In addition, JuDoor allows users to enable MFA for SSH login. Once enabled, when accessing the ssh service on the login hosts of the JSC system, users will be prompted to enter a 6-digit token after successfully authenticating using the ssh public key. -To enable MFA in JuDoor please navigate to the "Account Security" page by clicking the fingerprint icon in the navigation bar or using the account dropdown menu. There you see a list of your accounts. You can start the setup process using the "Start MFA Setup" button. On this page you can find our recommendations for TOTP Apps to use, but any other TOTP App should probably work just as well. You will need to install a compatible App, scan the QR-Code with the App to add the account, and then insert into the form both your current password and the code the App generates. After pressing "Continue" you will be presented with 10 reset codes. These can be used to disable MFA again in case you lose access to your second factor. You should save these at a secure location or print them.MFA will be enabled for your account only after you have confirmed that you have saved these reset codes. MFA is now enabled. The Fingerprint Icon in the Navigation bar now shows your MFA authentication state. Because you have just entered a valid code, you are MFA authenticated and can continue to use JuDoor as normal. The MFA authentication expires after 24 hours or if you open JuDoor from a different browser/device or clear your cookies. +To enable MFA in JuDoor please navigate to the "Account Security" page by clicking the fingerprint icon in the navigation bar or using the account dropdown menu. There you see a list of your accounts. You can start the setup process using the "Start MFA Setup" button. On this page you can find our recommendations for TOTP Apps to use, but any other TOTP App should probably work just as well. You will need to install a compatible App, scan the QR-Code with the App to add the account, and then insert into the form both your current password and the code the App generates. After pressing "Continue" you will be presented with 10 reset codes. These can be used to disable MFA again in case you lose access to your second factor. You should save these at a secure location or print them. MFA will be enabled for your account only after you have confirmed that you have saved these reset codes. MFA is now enabled. The Fingerprint Icon in the Navigation bar now shows your MFA authentication state. Because you have just entered a valid code, you are MFA authenticated and can continue to use JuDoor as normal. The MFA authentication expires after 24 hours or if you open JuDoor from a different browser/device or clear your cookies. The following actions are secured by MFA in JuDoor and therefore a valid token is needed: * Joining a project * Adding an SSH Key * Removing an SSH Key -* Changing someone’s access in a project if you are a PI or PA -Actions that require TOTP are marked with a fingerprint icon. +* Changing someone's access in a project if you are a PI or PA +* Actions that require TOTP are marked with a fingerprint icon. Currently, MFA is an opt-in feature (can be activated on demand). However, at some point in the future, it will become an opt-out feature (activated by default but can be deactivated if desired). diff --git a/docs/custom-software.md b/docs/custom-software.md index 84a37dffca259ba9b25fab19760663866e43cb4a..6aac3e34c19ac9435f8ddc76c189821d03e27091 100644 --- a/docs/custom-software.md +++ b/docs/custom-software.md @@ -84,4 +84,4 @@ We will explain how to run the program in a later chapter. More Python packages are available as modules. For scientific computing, the `SciPy-Stack` collection is especially interesting. -See also Supercomputing Environment Template using Python Virtual Environments [venv](https://gitlab.jsc.fz-juelich.de/kesselheim1/sc_venv_template/-/tree/master) to create project-based virtual environments that leverage the already installed Python modules on our systems, which are often significantly more performant than defaults from package managers. +See also [Supercomputing Environment Template using Python Virtual Environments](https://gitlab.jsc.fz-juelich.de/kesselheim1/sc_venv_template/-/tree/master) to create project-based virtual environments that leverage the already installed Python modules on our systems, which are often significantly more performant than defaults from package managers. diff --git a/docs/environment.md b/docs/environment.md index d119de8dda388813b930852362400405a3c235c9..5a005c7d5d27e7643093a7f9e84fc7547263d1d3 100644 --- a/docs/environment.md +++ b/docs/environment.md @@ -47,7 +47,7 @@ In case you are working on different compute budgets we recommend to set the bud Every user account on the systems has a home directory (reachable through the `HOME` environment variable) where the user can store his personal files. However, there is a limit on the volume of data and also the number of files that can be stored in this directory (see more details [here](./budgeting.md#data-quotas)). -Files stored here are also accessible only to you, which can cause issues if collaborators need them and you do not have access. +Files stored here are also accessible only to you, which can cause issues if collaborators need them and only you have access. Furthermore, the file system performance in `HOME` is reduced. It is recommended to use `HOME` only for configuration files. More storage space is granted to computing time projects. diff --git a/docs/running-jobs.md b/docs/running-jobs.md index 2832e699bdad71646bbc5d52cbf2615edd72d51d..460c1ea86f5670ffeb04c8135b128479ef6ecd0d 100644 --- a/docs/running-jobs.md +++ b/docs/running-jobs.md @@ -34,7 +34,7 @@ Two modes of operation are possible: The `srun` command is used to execute commands on a set of allocated resources. If no resources are currently allocated, `srun` can infer from its command line arguments what resources are needed, request them from the resource manager and defer the execution of the associated commands until the resources are available. -After the associated commands have been run, the resources are relinquished and running further commands will have to ask for resources again. +After the associated commands have been run, the resources are relinquished/freed and to run further commands you will have to ask for resources again. This one-shot mode can be useful when you want to interactively run a few quick jobs with varying sets of resources allocated for them. Run the `hostname` command to see how `srun` will run commands on different nodes than the log in nodes. The `hostname` command lets you see or change the name of your computer (e.g. name of the login or compute node), which is useful for recognising it on a network or setting it up for different tasks. On JURECA and JUSUF, use this command): @@ -54,7 +54,7 @@ jrc0454 ``` For the JUWELS Cluster and JUWELS Booster, there are a few differences: -The name of the reservation on JUWELS Cluster is hands-on-cluster-YYYYMMDD and hands-on-booster-YYYYMMDD on JUWELS Booster. +The name of the reservation on JUWELS Cluster is `hands-on-cluster-YYYYMMDD` and `hands-on-booster-YYYYMMDD` on JUWELS Booster. To submit to JUWELS Cluster, you want to be logged in to the Cluster login nodes: @@ -92,7 +92,7 @@ Above we have seen four `srun` options: :::info -The training account budget can be used till the end of the month. After one would need to specify another budget from an active compute time project. +The training account budget can be used till the end of the month. After this, one would need to specify another budget from an active compute time project. ::: @@ -541,14 +541,14 @@ LLview is an excellent tool that provides an overview of currently running and f Your jobs crash and you do not know why? This is the first place to check. There is a website for each of our large systems. -You can find the link for every system at the lower left corner of the [documentation webpage of LLview](https://apps.fz-juelich.de/jsc/llview/docu/). +You can find the link for every system in the lower left corner of the [documentation webpage of LLview](https://apps.fz-juelich.de/jsc/llview/docu/). To begin check out your system of interest, ideally one you have run jobs on. ### Currently Active Jobs When opening LLview by default it will first show you the list of your currently active jobs, either pending or running. If you are the Principal Investigator (PI) or Project Administrator (PA) for a project and you are in the project view you will see all active jobs from your project. Project mentors also have access to this view. -You filter the list based on the filters below any of the column headings. Clicking on any column heading will cause the jobs to be sorted in ascending or descending order, an arrow will appear next to the column title indicating either ascending (upwards-pointing arrow) or decending (downwards-pointing arrow). In the case a of sort conflict the submission time of a job is used to resolve the conflict, with jobs that were submitted more recently appearing above jobs that started earlier, if sorted ascending. By default jobs are sorted according to ascending job start submit time with your most recently submitted jobs at the top. +You filter the list based on the filters below any of the column headings. Clicking on any column heading will cause the jobs to be sorted in ascending or descending order, an arrow will appear next to the column title indicating either ascending (upwards-pointing arrow) or descending (downwards-pointing arrow). In the case a of sort conflict the submission time of a job is used to resolve the conflict, with jobs that were submitted more recently appearing above jobs that started earlier, if sorted ascending. By default, jobs are sorted according to ascending job start submit time with your most recently submitted jobs at the top. Values in red in the list indicate that something may be wrong. For example the average load on a node may be high. Note that this is reported in fractions of the utilization of a single core. A 1.0 therefore means that a single core was fully utilized. This value should ideally be as close as possible to the number of cores a node has.