Skip to content

Commit

Permalink
further tidy
Browse files Browse the repository at this point in the history
  • Loading branch information
mjpritchard committed Jan 30, 2024
1 parent d3ff108 commit 0c288f3
Show file tree
Hide file tree
Showing 21 changed files with 78 additions and 94 deletions.
2 changes: 1 addition & 1 deletion content/docs/batch-computing/lotus-overview.md
Expand Up @@ -63,7 +63,7 @@ HPC infrastructure such as [ARCHER](http://www.archer.ac.uk/) or

In order to maintain a safe and reliable working environment for all within
LOTUS and more widely within JASMIN, users are expected to follow [the best
practice outlined in this documentation]({{< ref "jasmin-users-guide" >}}).
practice outlined in this documentation]({{< ref "tips-for-new-users" >}}).

## How to gain access to LOTUS

Expand Down
@@ -1,13 +1,14 @@
---
aliases: /article/4981-hands-on-workshop
date: 2021-03-09 11:29:40
description: Hands-on workshop - training materials
slug: hands-on-workshop
description: Beginners training workshop - materials
slug: beginners-training-workshop
tags:
- training
- best practice
- workshop
title: Hands-on workshop - training materials
- beginner
title: beginners training workshop - materials
weight: 50
---

The [CEDA team](https://jasmin.ac.uk/about/team/) regularly run hands-on
Expand Down
2 changes: 1 addition & 1 deletion content/docs/getting-started/generate-ssh-key-pair.md
@@ -1,9 +1,9 @@
---
aliases: /article/185-generate-ssh-key-pair
date: 2021-10-05 10:10:50
description: Generate an SSH key pair
slug: generate-ssh-key-pair
title: Generate an SSH key pair
weight: 20
---

This article explains how to create an SSH key pair for logging in to JASMIN.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/getting-started/get-a-jasmin-account.md
@@ -1,9 +1,9 @@
---
aliases: /article/4435-get-a-jasmin-account
date: 2020-05-19 14:33:45
description: Get a JASMIN portal account
slug: get-a-jasmin-account
title: Get a JASMIN portal account
weight: 30
---

This article explains how to register on the JASMIN accounts portal.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/getting-started/get-login-account.md
@@ -1,12 +1,12 @@
---
aliases: /article/161-get-login-account
date: 2023-01-24 10:48:03
description: Get a login account
slug: get-login-account
tags:
- login
- account
title: Get a login account
weight: 40
---

This article explains how to apply for access to the shared JASMIN servers.
Expand Down
5 changes: 1 addition & 4 deletions content/docs/getting-started/get-started-with-jasmin.md
@@ -1,12 +1,9 @@
---
aliases: /article/189-get-started-with-jasmin
categories:
- Getting Started
collection: jasmin-documentation
date: 2023-01-26 15:36:11
description: Get Started with JASMIN
slug: get-started-with-jasmin
title: Get Started with JASMIN
weight: 10
---

This article explains the steps involved for most users to gain
Expand Down
@@ -1,21 +1,21 @@
---
aliases: /article/4703-how-to-contact-us-about-jasmin-issues
date: 2021-10-29 11:25:42
description: How to contact us about JASMIN issues
slug: how-to-contact-us-about-jasmin-issues
title: How to contact us about JASMIN issues
weight: 60
---

If you are experiencing difficulties or slow performance and are unsure why,
please first consult all relevant documentation, then if needed, contact our
[helpdesk](http://www.jasmin.ac.uk/contact/) but please include the following
please first consult all relevant documentation, then if needed, contact our Helpdesk
using the help beacon below, but please include the following
information with your initial query:

- What is the full name of the JASMIN server were you using? ( e.g. sci1.jasmin.ac.uk)
- The full path of your current working directory e.g. /gws/nopw/j04/mygws
- What is the full name of the JASMIN server were you using? ( e.g. `sci1.jasmin.ac.uk`)
- The full path of your current working directory e.g. `/gws/nopw/j04/mygws``
- Date & time that the issue occurred
- Your JASMIN account username
- Your description of the issue and any error messages
- Your description of the issue and copy/paste any error messages from the terminal
- Location of code/script used - if possible, so one of the CEDA/JASMIN team can reproduce the issue
- A batch job ID if it relates to LOTUS jobs

Expand Down
4 changes: 2 additions & 2 deletions content/docs/getting-started/jasmin-status.md
@@ -1,9 +1,9 @@
---
aliases: /article/194-jasmin-live-status
date: 2020-04-28 08:01:41
description: JASMIN status
slug: jasmin-status
title: JASMIN status
weight: 70
---

This article lists sources of information about the status of JASMIN services.
Expand All @@ -21,4 +21,4 @@ The JASMIN dashboard is currently under re-development and will be returining so
Please also keep an eye on:
- `JASMIN-USERS` email list (all users should be on this list. If not, please ask)
- {{< link ceda_news >}}CEDA News{{< /link >}} articles on the CEDA website
- {{< link ceda_x >}}@cedanews on X (formerly Twitter){{</link>}}
- {{< link ceda_x >}}@cedanews on X (formerly Twitter){{</link>}}
3 changes: 1 addition & 2 deletions content/docs/getting-started/jasmin-training-accounts.md
@@ -1,12 +1,11 @@
---
aliases: /article/4996-jasmin-training-accounts
date: 2023-01-26 15:41:00
description: JASMIN training accounts
slug: jasmin-training-accounts
title: JASMIN training accounts
weight: 80
---


## What are training accounts?

JASMIN training accounts are TEMPORARY accounts that provide a person with
Expand Down
66 changes: 31 additions & 35 deletions content/docs/getting-started/login.md
@@ -1,18 +1,18 @@
---
aliases: /article/187-login
date: 2022-10-27 09:37:13
description: How to login
slug: login
title: How to login
weight: 100
---

This article explains how to login to JASMIN. It covers:

* Preparing your credentials: loading your private key
* The JASMIN login servers
* Logging in to JASMIN
* X-forwarding for graphical applications (within JASMIN only)
* Where next?
- Preparing your credentials: loading your private key
- The JASMIN login servers
- Logging in to JASMIN
- X-forwarding for graphical applications (within JASMIN only)
- Where next?

The instructions below cover the process of logging in using a terminal client
only. For a graphical linux desktop, please see alternative instructions using
Expand All @@ -37,8 +37,8 @@ load your private key so that it can be presented at the time of logging in.

**Linux and MacOS users:** `ssh-agent` can be used (see instructions below).

**Windows users:** we recommend the [MobAgent utility within MobaXterm]({{<
ref "mobaxterm" >}}). MobXterm is a linux terminal emulator for Windows.
**Windows users:** we recommend the [MobAgent utility within MobaXterm]({{<ref "mobaxterm" >}}).
MobXterm is a linux terminal emulator for Windows.

`ssh-agent` is a utility that stores private keys and makes them available to
other software that use the SSH protocol to connect to remote clients.
Expand All @@ -51,13 +51,12 @@ this:
example represents the shell prompt as displayed in your terminal - it does
not need to be typed!**



$ eval $(ssh-agent -s)
$ ssh-add ~/.ssh/id_rsa_jasmin
Enter passphrase for /home/users/jpax/.ssh/id_rsa_jasmin:
Identity added: /home/users/jpax/.ssh/id_rsa_jasmin (/home/users/jpax/.ssh/id_rsa_jasmin)

{{<command>}}
eval $(ssh-agent -s)
ssh-add ~/.ssh/id_rsa_jasmin
(out)Enter passphrase for /home/users/jpax/.ssh/id_rsa_jasmin:
(out)Identity added: /home/users/jpax/.ssh/id_rsa_jasmin (/home/users/jpax/.ssh/id_rsa_jasmin)
{{</command>}}

When you run the `ssh-add` command you will be prompted to enter the
passphrase that you specified when generating your SSH key pair. (If you use
Expand All @@ -67,21 +66,20 @@ $SHELL")
You can test whether your key has been loaded by using the "-l" option to list
the currently loaded keys in your agent:



$ ssh-add -l
2048 SHA256:iqX3NkPCpschVdqPxVde/ujap2cM0mYaAYYedzBGPaI /Users/jpax/.ssh/id_rsa_jasmin (RSA)

{{<command>}}
ssh-add -l
(out)2048 SHA256:iqX3NkPCpschVdqPxVde/ujap2cM0mYaAYYedzBGPaI /Users/jpax/.ssh/id_rsa_jasmin (RSA)
{{</command>}}

This confirms that the key in `id_rsa_jasmin` has been loaded and is ready for
use.

**Notes:**

* The `ssh-agent` session should persist until killed or until system shutdown, even if you close the terminal in which you set it up.
* It is very important that you protect your private key with a strong passphrase, known only to you. Keys must not be shared between individuals.
* If you get an error when attempting the above commands please see [login problems]({{< ref "login-problems" >}}).
* Your public key will have been automatically propagated by the JASMIN accounts system to all the machines to which you have access rights, so should already be present in the correct place. Do not attempt to place the public key manually on any host within JASMIN: it will get automatically overwritten.
- The `ssh-agent` session should persist until killed or until system shutdown, even if you close the terminal in which you set it up.
- It is very important that you protect your private key with a strong passphrase, known only to you. Keys must not be shared between individuals.
- If you get an error when attempting the above commands please see [login problems]({{< ref "login-problems" >}}).
- Your public key will have been automatically propagated by the JASMIN accounts system to all the machines to which you have access rights, so should already be present in the correct place. Do not attempt to place the public key manually on any host within JASMIN: it will get automatically overwritten.

Mac users (OS X Leopard onwards) can optionally benefit from linking the SSH
key to Keychain, which securely stores the passphrase as well. This means that
Expand All @@ -98,28 +96,26 @@ See this article for a [description and listing of the login servers]({{< ref
## Logging in to JASMIN

Assuming that you have loaded your SSH private key using one of the methods
described above, then you can login to a login server as follows:
described above, then you can login to a login server as follows (do this on your own/local machine):



$ ssh -A <user_id>@<login_server>

{{<command>}}
ssh -A <user_id>@<login_server>
{{</command>}}

For example, user "jpax" might login to the JASMIN login server with:



$ ssh -A jpax@login1.jasmin.ac.uk

{{<command>}}
ssh -A jpax@login1.jasmin.ac.uk
{{</command>}}

The **"-A"** **argument is important** because it enables "agent-forwarding".
The `-A` **argument is important** because it enables "agent-forwarding".
This means that your the information about your SSH private key is forwarded
to your remote session on the login server so that you can use it for further
SSH connections. (Windows users can [enable X-forwarding in
MobaXterm](https://mobaxterm.mobatek.net/documentation.html#4_1_6) saved
sessions).

**Can't login?**
## Can't login?

* Check our troubleshooting guide: [login problems]({{< ref "login-problems" >}})

Expand Down
2 changes: 1 addition & 1 deletion content/docs/getting-started/multiple-account-types.md
@@ -1,13 +1,13 @@
---
aliases: /article/5091-multiple-account-types
date: 2023-06-15 15:48:29
description: Multiple account types
slug: multiple-account-types
tags:
- shared
- service
- account
title: Multiple account types
weight: 110
---

_**Trial period extended**_
Expand Down
4 changes: 2 additions & 2 deletions content/docs/getting-started/reconfirm-email-address.md
@@ -1,9 +1,9 @@
---
aliases: /article/4807-reconfirm-email-address
date: 2020-04-27 10:41:52
description: Reconfirm JASMIN account email address
slug: reconfirm-email-address
title: Reconfirm JASMIN account email address
weight: 120
---

This article describes how to reconfirm the email address associated with your
Expand All @@ -21,7 +21,7 @@ date: the sooner the better.
1. Visit your profile at the JASMIN Accounts Portal <https://accounts.jasmin.ac.uk> If you are already signed in you can get to your profile by following the link to "My JASMIN Account", otherwise you will be automatically taken to your profile when you sign in.
2. **Click the “Confirm now” button** in your JASMIN profile to request that an email containing a confirmation link is sent to your email address. If this button is not visible and instead you see the message "confirmed" next to your email address:

{{<image src="img/docs/reconfirm-email-address/file-hEfcP6vF1r.png" caption="already confirmed">}}
{{<image src="img/docs/reconfirm-email-address/file-hEfcP6vF1r.png" caption="already confirmed" ratio="3x2" wrapper="col-1 mx-auto">}}

this indicates that your email address has already been confirmed and no
further action is necessary.
Expand Down
@@ -1,12 +1,9 @@
---
aliases: /article/4726-reset-jasmin-account-password
categories:
- Getting Started
collection: jasmin-documentation
date: 2023-01-24 12:03:21
description: Reset JASMIN account password
slug: reset-jasmin-account-password
title: Reset JASMIN account password
weight: 130
---

This article illustrates how to reset the password of your JASMIN account to
Expand Down
5 changes: 1 addition & 4 deletions content/docs/getting-started/ssh-auth.md
@@ -1,12 +1,9 @@
---
aliases: /article/166-ssh-auth
categories:
- Getting Started
collection: jasmin-documentation
date: 2021-04-15 13:41:58
description: SSH public key authentication
slug: ssh-auth
title: SSH public key authentication
weight: 140
---

JASMIN employs SSH public key authentication for login instead of username and
Expand Down
2 changes: 1 addition & 1 deletion content/docs/getting-started/storage.md
@@ -1,6 +1,5 @@
---
aliases: /article/176-storage
date: 2022-11-16 08:45:06
description: Access to storage
slug: storage
tags:
Expand All @@ -12,6 +11,7 @@ tags:
- ssd
- smf
title: Access to storage
weight: 150
---

This article provides information about JASMIN storage. It covers:
Expand Down
@@ -1,31 +1,30 @@
---
aliases: /article/4856-jasmin-users-guide
date: 2022-03-08 10:30:53
description: JASMIN User's Guide
slug: jasmin-users-guide
title: JASMIN User's Guide
description: Tips for new users
slug: tips-for-new-users
title: tips-for-new-users
weight: 90
---

The JASMIN user's guide was set out based on user queries and issues
encountered by the JASMIN team.
These tips for new users are based on users' queries encountered by our helpdesk. They are not exhaustive but may help solve some initial problems and set out best practice.

* Sci machines
* LOTUS
* Xfer servers
* How to report an issue;
- Sci machines
- LOTUS
- Xfer servers
- How to report an issue

## "Sci" machines usage guidelines

1. Check the current load and number of users on the sci machines, as shown by the login servers, to select a less-used sci machine. [The available Sci machines and their specifications are listed in the table of this help page]({{< ref "sci-servers" >}})
2. The sci machines are not for running large, long-running tasks, or scripts that spawn multiple child processes. The batch processing cluster LOTUS is available for heavier processing. The sci machines are for development, testing, and light interactive use. Overloading these with processing seriously impairs performance for interactive use by others.
3. Do not write to the temporary partition ` /tmp`on sci machines. [Use your home directory, a scratch volume or a Group Workspace ]({{< ref "understanding-new-jasmin-storage" >}}). Any temporary data files can reside in a subdirectory of your group workspace instead of /tmp. To do this, please add the following lines (or similar) to your $HOME/.bashrc file:
3. Do not write to the temporary partition ` /tmp`on sci machines. [Use your home directory, a scratch volume or a Group Workspace ]({{< ref "understanding-new-jasmin-storage" >}}). Any temporary data files can reside in a subdirectory of your group workspace instead of `/tmp`. To do this, please add the following lines (or similar) to your `$HOME/.bashrc` file:

export TMPDIR=/group_workspaces/jasmin/<your_project>/<your_username>/tmp


* # create the directory if needed

```bash
export TMPDIR=/group_workspaces/jasmin/<your_project>/<your_username>/tmp
## create the directory if needed
[ -d $TMPDIR ] || mkdir -p $TMPDIR
```

4. If a process hangs, do not simply close the terminal window. Please contact the helpdesk and alert the team so that the process can be shut down. Otherwise hung processes build up and contribute to machine overloading.
5. Do not “hog” IDL development licenses. A limited number of these are available for _development_ and compilation of IDL code which should then be run on LOTUS [using IDL runtime licenses]({{< ref "idl-and-midl" >}}), of which there are many more.
Expand All @@ -49,7 +48,7 @@ When you do experience an issue, please;

1. Make it clear whether you are simply advising the helpdesk of a general issue (which will be noted, but not necessarily investigated for a specific response), or
2. Provide FULL and SPECIFIC details of your problem so that it can be investigated. JASMIN is a complex infrastructure with many hundreds of hosts and storage volumes, so reporting that “JASMIN” or “Storage” is slow, is not sufficient.
3. If you are experiencing difficulties accessing a particular storage volume from a particular sci machine, please state
3. If you are experiencing difficulties accessing a particular storage volume from a particular sci machine, please state
* the full path to the data you are trying to access
* The full hostname of the machine (but please try the same access from at least one other machine to help establish whether it’s related to the machine or the storage)
* The date and time of the issue (for matching up with system reports/log files. Using the date and time of the email is not sufficient: please be specific in your report)
Expand Down

0 comments on commit 0c288f3

Please sign in to comment.