Skip to content

Commit

Permalink
content updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@mjpritchard
mjpritchard committed Feb 13, 2024
1 parent 80e4666 commit 1148a30
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 50 deletions.
37 changes: 17 additions & 20 deletions ...nts/tenancy-based-sci-vm-managed-cloud.md → ...visioning-tenancy-sci-vm-managed-cloud.md
View file
@@ -1,37 +1,34 @@
---
aliases: /article/4581-tenancy-based-sci-vm-managed-cloud
categories:
- For Cloud Tenants
collection: jasmin-documentation
date: 2023-07-05 10:02:59
description: Provisioning a Sci VM in a Managed Cloud Tenancy
slug: tenancy-based-sci-vm-managed-cloud
slug: provisioning-tenancy-sci-vm-managed-cloud
title: Provisioning a Sci VM in a Managed Cloud Tenancy
layout: docs
---

This article is for admin and manager of the JASMIN managed-cloud Sci tenancy.
It illustrates how to provision a sci VM within a JASMIN managed-cloud Sci
tenancy. It involves the following:
This article is for admin and manager of the JASMIN managed-cloud tenancy
and shows how to provision a sci VM. It involves the following:

- Becoming a member of a managed cloud Sci tenancy
- Becoming a member of a managed cloud tenancy
- Provisioning a VM

The Sci tenancy has four access roles:
A "sci vm" is essentially the same as the general-access scientific analysis
servers, but created within a specific tenancy aimed at a certain group of users.
The manager/deputy then has the responsibility to stop/start/restart or redeploy the VM, and to
control who can access it.

The managed cloud tenancy has four access roles:

- `MANAGER` role: can approve `DEPUTY`, `ADMIN`, and `USER` role access requests
- `DEPUTY` manager role: can approve `ADMIN` and `USER` role access requests
- `ADMIN` role: can access the cloud portal and can restart or provision the Sci VM
- `USER` role: can log in into the Sci VM from a JASMIN login node

**Note:** `MANAGER`, `DEPUTY` and `ADMIN` have access to the JASMIN cloud portal
- `USER` role: can log in into the sci VM from a JASMIN login node

### 1\. Apply for access to the Sci tenancy
## Apply for access to the Sci tenancy

A managed cloud Sci tenancy is accessible via the [JASMIN cloud portal](https://cloud.jasmin.ac.uk/) and this access is controlled by the "Sci Analysis VMs" service via the [JASMIN accounts
portal](https://accounts.jasmin.ac.uk). See MISSING LINK for instructions about requesting access to the `USER` and `ADMIN` roles via the Sci Analysis VMs service on the JASMIN accounts portal.
A managed cloud tenancy is accessible via the {{<link "jasmin_cloud_portal">}}JASMIN cloud portal{{</link>}}.
Access is controlled by a service corresponding to the name of the tenancy: these services are listed under {{<link "https://accounts.jasmin.ac.uk/services/analysis_vms/">}}Sci Analysis VMs{{</link>}} category of "My Services".

### 2\. Access the tenancy
## Access the tenancy

With an ADMIN role, you can log in to the [JASMIN cloud portal](https://cloud.jasmin.ac.uk/) using the same credentials for signing into the JASMIN accounts portal.

Expand All @@ -44,7 +41,7 @@ tenancy to find out the VM provisioned within a given tenancy, e.g ncas-sci-M
Note: The "ncas-sci-M" tenancy shown below has 0 machines as this is a new tenancy.
We will proceed next to the provisioning of a virtual machine.

### 3\. Provision a virtual machine
## Provision a virtual machine

**Step 1:** Select "Machines" from the top menu, then click "New machine" to
create a new VM. Choose a name for the new VM. Then select a size from the
Expand Down Expand Up @@ -97,7 +94,7 @@ not be granted root access.
**Note 2:** ADMIN and MANAGER roles will not allow you to SSH into the Sci VM.
It is necessary to have a USER role to do so.

### 4\. Connect to Sci analysis VMs
## Connect to the VM

From a JASMIN login server, login to the machine using the External IP address.
In the same way, as you login to a JASMIN scientific server via login1. Your
Expand Down
46 changes: 22 additions & 24 deletions content/docs/getting-started/get-started-with-jasmin.md
View file
Expand Up @@ -9,8 +9,8 @@ weight: 10
This article explains the steps involved for most users to gain
access to the JASMIN environment.

The [JASMIN](http://www.jasmin.ac.uk/) scientific data analysis environment is
administered by [CEDA](http://www.ceda.ac.uk/) and supports a wide variety of
The {{<link "jasmin_site">}}JASMIN{{</link>}} scientific data analysis environment is
administered by {{<link "ceda_site">}}CEDA{{</link>}} and supports a wide variety of
scientific workflows across environmental science domains.

## Essential steps
Expand All @@ -20,7 +20,7 @@ to gain ssh access to the JASMIN login machines which are the "front door" for
most users. Other services are available once these basic steps have been
completed.

An overview of JASMIN compute & storage components are summarised in the
An overview of JASMIN compute & storage components is given in the
presentation given at the [JASMIN workshop](https://github.com/cedadev/jasmin-workshop) \- we strongly encourage all new users to watch this video recording
and take a look at the [accompanying
exercises](https://github.com/cedadev/jasmin-workshop). These go into detail
Expand All @@ -32,15 +32,15 @@ each step.

Step | Details | Comments
---|---|---
1 | [Generate an SSH key]({{< ref "generate-ssh-key-pair" >}}) | Create this locally, ready to upload it to your JASMIN Account profile (see Step 2)
2 | [Get a JASMIN portal account]({{< ref "get-jasmin-portal-account" >}}) | Access to JASMIN services is controlled by the [JASMIN Accounts Portal](https://accounts.jasmin.ac.uk/) \- you must register for an account. Using the JASMIN Accounts portal, you will then need to make a request to access JASMIN services and privileges you require (as described in the steps below). Some of these services will require manual approval by individuals external to the CEDA/JASMIN team. Please note that registering on the JASMIN accounts portal does not by itself provide you with any access to JASMIN machines or services. You must complete all the steps below to gain full access. For further information [See Getting started with JASMIN Webinar - section 2](https://www.ceda.ac.uk/events/getting-started-with-jasmin-webinar/)
3 | [Check network details]({{< ref "check-network-details" >}}) | In order to maintain a secure and reliable scientific infrastructure for its users, JASMIN restricts login access by maintaining an "allow list" of network domains. Check details of your network connection to JASMIN to ensure you are able to connect.
4 | [Request ssh login access to JASMIN]({{< ref "get-login-account" >}}) | Your account so far is just a profile on the accounts portal but has no privileges. If you intend to use JASMIN computing resources you need to apply for the "jasmin-login" service, which will allow you to connect to JASMIN machines using ssh. [See Getting started with JASMIN Webinar - section 2](https://www.ceda.ac.uk/events/getting-started-with-jasmin-webinar/)
5 | Apply for access to additional services on JASMIN | JASMIN has a vast number of additional services, access to these is all managed in the Accounts Portal. Search and apply for any services you require in the portal. In most cases, users will "belong" to a particular scientific project which may already have a presence on JASMIN, often in the form of a [Group Workspace]({{< ref "short-term-project-storage" >}}). See here how to [Apply for access to a Group Workspace]({{< ref "apply-for-access-to-a-gws" >}}).
6 | [How to login]({{< ref "login" >}}) | The 'how to login' document explains all the basic steps about logging in to JASMIN via ssh, but we also have several other tutorials that may be useful - see [Exercises 1-3 here](https://github.com/cedadev/jasmin-workshop).
7 | [Get a CEDA account]({{< ref "ceda-archive" >}}) | The CEDA Archive provides access to thousands of atmospheric, climate change, and earth observation datasets. This is directly accessible as a file system from the shared science machines on JASMIN. Some datasets on the CEDA Archive require specific agreements, to apply for access to these, you will need a CEDA account.
8 | [Link your JASMIN and CEDA accounts]({{< ref "update-a-jasmin-account" >}}) | The final step is to link your CEDA account to your JASMIN account. This allows you filesystem access to data on CEDA Archive. This is a step that you will be guided through in the JASMIN accounts portal.
{.table .table-striped}
1 | [Generate an SSH key]({{< ref "generate-ssh-key-pair" >}}) | Create this locally, ready to upload it to your JASMIN Account profile
2 | [Get a JASMIN portal account]({{< ref "get-jasmin-portal-account" >}}) | Access to JASMIN services is controlled by the [JASMIN Accounts Portal](https://accounts.jasmin.ac.uk/) \- you must register for an account. Using this portal, you will then need to apply for access to the JASMIN services and privileges you require (as described in the steps below). Some of these services will require manual approval by individuals external to the CEDA/JASMIN team. Creating a JASMIN portal account does not by itself provide you with any access to JASMIN machines or services. You must complete all the steps below to gain full access.
3 | [Check network details]({{< ref "check-network-details" >}}) |Check details of your network connection to JASMIN to ensure you are able to connect. In order to maintain a secure and reliable scientific infrastructure for its users, JASMIN restricts login access by maintaining an "allow list" of network domains.
4 | [Request ssh login access to JASMIN]({{< ref "get-login-account" >}}) | Apply for the `jasmin-login` service, which will allow you to connect to JASMIN machines using ssh.
5 | Apply for access to additional services on JASMIN | JASMIN has a range of additional services, access to which is managed via the Accounts Portal. Search and apply for any services you require in the portal. In most cases, users will "belong" to a particular scientific project which may already have a presence on JASMIN, often in the form of a [Group Workspace]({{< ref "short-term-project-storage" >}}). See here how to [Apply for access to a Group Workspace]({{< ref "apply-for-access-to-a-gws" >}}).
6 | [How to login]({{< ref "login" >}}) | Follow these steps for logging in to JASMIN via ssh, but we also have several other tutorials that may be useful - see [Exercises 1-3 here](https://github.com/cedadev/jasmin-workshop).
7 | [Get a CEDA account]({{< ref "ceda-archive" >}}) | The CEDA Archive provides access to thousands of atmospheric, climate change, and earth observation datasets. The Archive is directly accessible read-only throughout JASMIN. Some datasets on the CEDA Archive require specific agreements, and to apply for access to these, you will need a CEDA account.
8 | [Link your JASMIN and CEDA accounts]({{< ref "update-a-jasmin-account" >}}) | The final step is to link your CEDA account to your JASMIN account. This allows you filesystem access to data on CEDA Archive. This is a step that you will be guided through in the JASMIN accounts portal.
{.table .table-striped}

The table above describes the initial steps to get you started on JASMIN -
however, there are a variety of ways that users can get the most out of
Expand All @@ -53,19 +53,17 @@ areas/services on JASMIN. You can navigate these sections in the menu on the
left-hand side of your screen. A short description of each of these sections
is below:

* [Getting Started]({{< ref "getting-started" >}}) \- this details all the steps needed to get started on JASMIN. Most documents are linked to from the table above, but there may be some other useful information there too.
* [Interactive Computing]({{< ref "interactive-computing" >}}) \- this introduces the resources on JASMIN available for interactive computing. This type of computing is the most common workflow on JASMIN for new users.
* [SLURM Batch Computing on LOTUS]({{< ref "slurm" >}}) \- this introduces the available resources on JASMIN for batch computing.
* [Software on JASMIN]({{< ref "software-overview" >}}) \- Information on running software packages within JASMIN
* [Data Transfer]({{< ref "data-transfer" >}}) \- this category includes guidance on transferring data to and from JASMIN.
* [MASS]({{< ref "mass" >}}) \- JASMIN has Read-only access to the Met Office MASS storage archive. This section explains how to get access.
* [Short-term project storage]({{< ref "short-term-project-storage" >}}) \- this section introduces the concept of shared Group Workspaces and the different storage types on JASMIN. Group Workspaces (GWSs) are portions of disk allocated for particular projects to manage themselves, enabling collaborating scientists to share network accessible storage on JASMIN.
* [Long-term archive storage]({{< ref "long-term-archive-storage" >}}) \- this section describes the long-term CEDA Archive which consists of thousands of atmospheric, climate change, and earth observation datasets. This is directly accessible as a file system from the shared science machines on JASMIN.
* [For Cloud Tenants]({{< ref "for-cloud-tenants" >}}) \- JASMIN also provides a cloud computing service, this section describes this.
* [Workflow management]({{< ref "workflow-management" >}}) \- this category details the various tools available for managing your workflow.
- [Getting Started]({{< ref "getting-started" >}}) \- this details all the steps needed to get started on JASMIN. Most documents are linked to from the table above, but there may be some other useful information there too.
- [Interactive Computing]({{< ref "interactive-computing" >}}) \- this introduces the resources on JASMIN available for interactive computing. This type of computing is the most common workflow on JASMIN for new users.
- [SLURM Batch Computing on LOTUS]({{< ref "slurm" >}}) \- this introduces the available resources on JASMIN for batch computing.
- [Software on JASMIN]({{< ref "software-overview" >}}) \- Information on running software packages within JASMIN
- [Data Transfer]({{< ref "data-transfer" >}}) \- this category includes guidance on transferring data to and from JASMIN.
- [MASS]({{< ref "mass" >}}) \- JASMIN has Read-only access to the Met Office MASS storage archive. This section explains how to get access.
- [Short-term project storage]({{< ref "short-term-project-storage" >}}) \- this section introduces the concept of shared Group Workspaces and the different storage types on JASMIN. Group Workspaces (GWSs) are portions of disk allocated for particular projects to manage themselves, enabling collaborating scientists to share network accessible storage on JASMIN.
- [Long-term archive storage]({{< ref "long-term-archive-storage" >}}) \- this section describes the long-term CEDA Archive which consists of thousands of atmospheric, climate change, and earth observation datasets. This is directly accessible as a file system from the shared science machines on JASMIN.
- [For Cloud Tenants]({{< ref "for-cloud-tenants" >}}) \- JASMIN also provides a cloud computing service, this section describes this.
- [Workflow management]({{< ref "workflow-management" >}}) \- this category details the various tools available for managing your workflow.

The CEDA team also regularly hosts training workshops and events. Details
about past and future events can be found on the [events
section](https://www.ceda.ac.uk/events/) of the CEDA website.


10 changes: 5 additions & 5 deletions content/docs/interactive-computing/tenancy-sci-analysis-vms.md
View file
@@ -1,7 +1,7 @@
---
aliases: /article/4805-tenancy-sci-analysis-vms
description: Tenancy-Sci Analysis VMs
title: Tenancy-Sci Analysis VMs
title: Tenancy Sci Analysis VMs
weight: 70
---

Expand All @@ -18,21 +18,21 @@ service named `Sci Analysis VMs`.

## How to request access

Step 1: Find the Sci Analysis VMs under the Menu 'Discover services' at https://accounts.jasmin.ac.uk/services/
**Step 1:** Find the Sci Analysis VMs under the Menu 'Discover services' at https://accounts.jasmin.ac.uk/services/

Step 2: Check the name of the service and the description that your supervisor
**Step 2:** Check the name of the service and the description that your supervisor
or PI recommended you to choose and click "More information"

{{<image src="img/docs/tenancy-sci-analysis-vms/file-EUW05EGJj3.png" caption="Locate the correct service" >}}

{{<image src="img/docs/tenancy-sci-analysis-vms/file-pyW8yyQboJ.png" caption="Click +Apply" >}}

Step 3: Apply for `USER` role and provide details on your project and a
**Step 3:** Apply for `USER` role and provide details on your project and a
reference then click "Apply"

{{<image src="img/docs/tenancy-sci-analysis-vms/file-QyGyIDjEcM.png" caption="Apply for USER role" >}}

Step 4:
**Step 4:** Notification

{{<image src="img/docs/tenancy-sci-analysis-vms/file-pY8gr70WNK.png" caption="Status PENDING" >}}

Expand Down
3 changes: 2 additions & 1 deletion data/docs.yml
View file
Expand Up @@ -91,6 +91,7 @@
- title: JASMIN external connections
- title: hpxfer access role
- title: Scheduling automating transfers
- title: Transfers from ARCHER2

- title: Short term project storage
pages:
Expand Down Expand Up @@ -132,7 +133,7 @@
- title: cluster as a service pangeo
- title: cluster as a service shared storage
- title: Adding and removing ssh keys from an external cloud vm
- title: Tenancy based sci vm managed cloud
- title: Provisioning tenancy sci vm managed cloud
- title: Sysadmin guidance external cloud
- title: Best practice

Expand Down

0 comments on commit 1148a30

Please sign in to comment.