From 7b38b71c272947a4eaee522087daea1cf188d9a4 Mon Sep 17 00:00:00 2001 From: awat31 Date: Thu, 26 Sep 2024 11:54:56 +0100 Subject: [PATCH 1/2] Experimental Services gateway docs --- docs/access/index.md | 1 + docs/services/experimental/index.md | 38 +++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 100644 docs/services/experimental/index.md diff --git a/docs/access/index.md b/docs/access/index.md index 2e9028e24..df0d0a784 100644 --- a/docs/access/index.md +++ b/docs/access/index.md @@ -28,6 +28,7 @@ Includes access to the following services: * [Cerebras CS-2](../services/cs2/index.md) * [Ultra2](../services/ultra2/index.md) +* [EIDF Interim and Experimental Systems](../services/experimental/index.md) To login to most command-line services with `ssh` you should use the username and password you obtained from SAFE when you applied for access, along with the SSH Key you diff --git a/docs/services/experimental/index.md b/docs/services/experimental/index.md new file mode 100644 index 000000000..3e18e3c05 --- /dev/null +++ b/docs/services/experimental/index.md @@ -0,0 +1,38 @@ +# Experimental System Access + +## Introduction + +A pair of redundant SSH Gateways were built to replace the aging Hydra-VPN Service. This service replicates the requirements of Hydra-VPn, while implementing much higher security standards, with greater ease of use. + +In order to access these gateways, you need to be a member of a project which uses them, for example a NextGenIO Project. If you're unsure if you need access, speak to your EPCC Project Contact. + +These gateways act as a jump host only, you can't SSH to them directly. See the [Using the Gateway](#using-the-gateway) section for more information. + +## Gaining Access + +1. Access [SAFE](https://safe.epcc.ed.ac.uk) +1. Select 'Projects' and 'Request Access' +1. Search for your project code, e.g. nx04 +1. Select 'Request machine account' then 'Apply' +1. Under the 'Select a machine for the login account' select 'gateways' +1. Select 'Next' +1. Specify the username you'd like. This can't be the same as an account name in another project +1. Upload an SSH public key. This is required to access these gateways. +1. Select 'Request' +1. You'll get an email when your account has been accepted. + +### Set MFA Token + +Once your account has been added, you need to enable MFA. Like the SSH key, this is required to use these gateways. + +1. Access [SAFE](https://safe.epcc.ed.ac.uk) +1. Select 'Login Accounts' and select the username you just made +1. Select 'Set MFA-Token' +1. Scan the QR Code into the authenticator of your choice, and verify the code displayed in your app in the 'Verification Code' box. +1. MFA has now been enabled. + +## Using the Gateway + +See the [EIDF-Gateway](../../access/ssh.md) docs for instructions on how to use the gateways from [Linux/MacOS](../../access/ssh.md#accessing-from-macoslinux) or [Windows](../../access/ssh.md#accessing-from-windows). + +Substitute all mentions of `eidf-gateway.epcc.ed.ac.uk` to be `gateway.epcc.ed.ac.uk` in your config. These are two seperate services and you cannot access experimental services through `eidf-gateway.epcc.ed.ac.uk` From df7ff32f5b84f9e733e4517a8e2ce40bb1713545 Mon Sep 17 00:00:00 2001 From: Amy Krause Date: Thu, 26 Sep 2024 12:27:01 +0100 Subject: [PATCH 2/2] whitespace fixes --- docs/services/experimental/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/services/experimental/index.md b/docs/services/experimental/index.md index 3e18e3c05..9e84a28f4 100644 --- a/docs/services/experimental/index.md +++ b/docs/services/experimental/index.md @@ -4,7 +4,7 @@ A pair of redundant SSH Gateways were built to replace the aging Hydra-VPN Service. This service replicates the requirements of Hydra-VPn, while implementing much higher security standards, with greater ease of use. -In order to access these gateways, you need to be a member of a project which uses them, for example a NextGenIO Project. If you're unsure if you need access, speak to your EPCC Project Contact. +In order to access these gateways, you need to be a member of a project which uses them, for example a NextGenIO Project. If you're unsure if you need access, speak to your EPCC Project Contact. These gateways act as a jump host only, you can't SSH to them directly. See the [Using the Gateway](#using-the-gateway) section for more information. @@ -33,6 +33,6 @@ Once your account has been added, you need to enable MFA. Like the SSH key, this ## Using the Gateway -See the [EIDF-Gateway](../../access/ssh.md) docs for instructions on how to use the gateways from [Linux/MacOS](../../access/ssh.md#accessing-from-macoslinux) or [Windows](../../access/ssh.md#accessing-from-windows). +See the [EIDF-Gateway](../../access/ssh.md) docs for instructions on how to use the gateways from [Linux/MacOS](../../access/ssh.md#accessing-from-macoslinux) or [Windows](../../access/ssh.md#accessing-from-windows). Substitute all mentions of `eidf-gateway.epcc.ed.ac.uk` to be `gateway.epcc.ed.ac.uk` in your config. These are two seperate services and you cannot access experimental services through `eidf-gateway.epcc.ed.ac.uk`