Skip to content

Commit

Permalink
integrate documentation about T1-Cloud from user docs of HPC-UGent
Browse files Browse the repository at this point in the history
  • Loading branch information
lexming committed Jul 29, 2023
1 parent 2c8c1c0 commit 9032433
Show file tree
Hide file tree
Showing 29 changed files with 2,349 additions and 0 deletions.
96 changes: 96 additions & 0 deletions source/cloud/access.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
# Access to the VSC Cloud

Access to the VSC Cloud is linked to the central VSC account system
([account.vscentrum.be](https://account.vscentrum.be)), so you do not
need a separate login or password. In order to use the cloud services,

- you need an active VSC account and

- your account must be a member of one or more OpenStack projects.

New users can obtain an account by following [the procedure described
here](/access/vsc_account.rst).
Once you have an account, contact if you want to start a new OpenStack
project, or join an existing one.

You can interact with the VSC Cloud using the OpenStack Dashboard, a web
interface, or the OpenStack command line interface, which you can use
from any system, and which is installed for you on the UGent login node
**login.hpc.ugent.be**. You can log in to the Dashboard using the VSC
accountpage, as illustrated in the next section. To get access from the
command line interface, you'll need to obtain an application credential,
as explained in section [application credentials](#application-credentials).

These restrictions do not apply to someone who simply wishes to access
an existing VM running in the cloud. VSC Cloud projects can decide
themselves who gets access to their VM's, and how.

## Dashboard Login

You can access the OpenStack web interface, or Dashboard, via
[cloud.vscentrum.be](https://cloud.vscentrum.be).

To log in, choose the (default) authentication method **VSC Accountpage**
and click .


![image](img/cloud_login_1.png)


From here on, follow the standard procedure to log in to your VSC
account, using your home institution's single sign-on system.
The following chapters explain how to accomplish basic tasks using the
Dashboard.

## Application Credentials

If you want to use the OpenStack command line interface --- or, for
advanced users, use the OpenStack APIs directly --- you need to identify
yourself using an application credential. An application credential
contains a secret piece of information which grants access to an
OpenStack project on your behalf.

You can create an application credential using the dashboard:

1. Log in to the dashboard, and, if you are a member of more than one
project, select the project for which you want to create an
application credential.

2. Open the **Identity** tab, and click **Application Credentials**.

3. You can now see an overview of your application credentials
(initially none). Click **Create Application Credential**.

4. Fill out the **Create Application Credential** dialog:

1. **Name, Description**
: Choose a name (mandatory) and description that remind you of the
purpose of this credential.

2. **Secret**
: We recommend to leave this empty, in which case OpenStack will
generate a random secret for you.

3. **Expiration Date, Expiration Time**
: It is good practice make the token expire. An expiration date
limits the impact if the secret is accidentally exposed, and you
can always create a new credential when an old one is expired.

4. **Roles**
: A role defines a set of access rights. By selecting a subset of
roles for this credential, you can limit the access rights
granted by this credential. It is a good idea to select only the
minimal set of roles required for the task you want to
accomplish.

Click **Create Application Credential**.

5. A summary dialog with the credential's id, name, and secret is
displayed. If you close the window, you can't retrieve the secret
anymore, so you should save it now. A convenient solution is to
download the openrc file, a shell script that sets the appropriate
environment variables for the command line interface.

The newly created credential is now shown in the overview. If you
accidentally expose a credential somewhere, you should delete it here to
prevent unauthorized access to the system.
36 changes: 36 additions & 0 deletions source/cloud/appendix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Appendix

## VSC Tier-1 Cloud flavors list

```console
$ openstack flavor list
+----+-----------------+--------+------+-----------+-------+-----------+
| ID | Name | RAM | Disk | Ephemeral | VCPUs | Is Public |
+----+-----------------+--------+------+-----------+-------+-----------+
| 0 | CPUv1.nano | 64 | 1 | 0 | 1 | True |
| 1 | CPUv1.tiny | 512 | 10 | 0 | 1 | True |
| 10 | UPSv1.medium | 4096 | 30 | 0 | 2 | True |
| 11 | UPSv1.large | 8192 | 40 | 0 | 4 | True |
| 12 | UPSv1.2xlarge | 61440 | 40 | 0 | 16 | True |
| 13 | GPUv2.small | 2048 | 20 | 0 | 1 | True |
| 14 | GPUv2.medium | 4096 | 30 | 0 | 2 | True |
| 15 | GPUv2.large | 8192 | 40 | 0 | 4 | True |
| 16 | GPUv2.2xlarge | 61440 | 40 | 0 | 16 | True |
| 17 | UPSv1.3xlarge | 122880 | 80 | 0 | 16 | True |
| 18 | CPUv1.1_3xlarge | 184320 | 80 | 0 | 14 | True |
| 19 | CPUv1.4xlarge | 368640 | 80 | 0 | 20 | True |
| 2 | CPUv1.small | 2048 | 20 | 0 | 1 | True |
| 20 | GPUv3.small | 2048 | 20 | 0 | 1 | True |
| 21 | GPUv3.medium | 4096 | 30 | 0 | 2 | True |
| 22 | GPUv3.large | 8192 | 40 | 0 | 4 | True |
| 23 | GPUv3.2xlarge | 61440 | 40 | 0 | 16 | True |
| 3 | CPUv1.medium | 4096 | 30 | 0 | 2 | True |
| 4 | CPUv1.large | 8192 | 40 | 0 | 4 | True |
| 5 | CPUv1.xlarge | 16384 | 40 | 0 | 8 | True |
| 6 | CPUv1.2xlarge | 61440 | 40 | 0 | 16 | True |
| 7 | CPUv1.3xlarge | 122880 | 80 | 0 | 16 | True |
| 8 | CPUv1.1_2xlarge | 61440 | 40 | 0 | 8 | True |
| 9 | UPSv1.small | 2048 | 20 | 0 | 1 | True |
+----+-----------------+--------+------+-----------+-------+-----------+

```
Loading

0 comments on commit 9032433

Please sign in to comment.