HoreKa is not available yet
This documentation is preliminary. The HoreKa system will be available for general use in Summer 2021.
Horeka File Systems are not considered stable yet
Please keep in mind that the HoreKa file systems are not considered to be stable before the system becomes generally available in Summer 2021. Data loss might occur during the pilot phase. Please make sure that your important data is backed up or can be reconstructed at all times!
A central aspect in the design of HoreKa has been the enormous amount of data generated by scientific research projects. A multi-level data storage concept guarantees high-throughput processing of data using several different storage systems.
The core of this design are two large-scale, parallel file systems based on IBM Spectrum Scale (also known as GPFS) used for globally visible user data. Individual home and project directories are automatically created for each user on the Spectrum Scale home file system, and the environment variables $HOME and $PROJECT point to these directories. Each user can also create so-called workspaces on the Spectrum Scale work file system.
Other storage locations include a temporary directory called $TMP that is is located on the local solid state disks (SSDs) of a node, and is therefore only visible on an individual node while a job is running. In order to create a temporary directory which is visible on all nodes of a batch job, users can request a temporary BeeGFS On Demand (BeeOND) file system. Access to BeeOND file systems is only possible from the nodes of the batch job and while the job is running.
Users with access to the LSDF can also use the corresponding Spectrum Scale file systems which are mounted on all nodes.
The characteristics of the file systems are shown in the following table.
|Property||$HOME / $PROJECT||workspace||$TMP||BeeOND||LSDF|
|Visibility||global||global||local||job local||LSDF users|
|Lifetime||permanent||limited||job walltime||job walltime||permanent|
|Disk space||2.5 PB||13.5 PB||800 GB||n * 500 GB||13 PB|
|Total read perf||25 GB/s||110 GB/s||750 MB/s||n * 700 MB/s||37 GB/s|
|Total write perf||25 GB/s||110 GB/s||750 MB/s||n * 700 MB/s||37 GB/s|
|Read perf/node||10 GB/s||10 GB/s||750 MB/s||10 GB/s||10 GB/s|
|Write perf/node||10 GB/s||10 GB/s||750 MB/s||10 GB/s||10 GB/s|
global : all nodes see the same file system
local : each node has its own local file system
job local : only available within the currently running job
permanent : data is stored permanently (across job runs and reboots)
limited : data is stored across job runs and reboots, but will be deleted at some time
job walltime : files are removed at end of the batch job.
Migrating data from ForHLR II¶
Users which had previously an account on ForHLR II are responsible to migrate further needed data by themselves. You should keep in mind that ForHLR II file systems will only exist until June 30, 2021. In order to allow an easy migration the ForHLR II file systems for $HOME/$PROJECT, $WORK and workspaces are mounted on all nodes of HoreKa. Note that there is no longer a $WORK file system on HoreKa and workspaces should be used instead.
In order to copy the data you can use copy commands like ''cp'' or ''rsync'' but we recommend ''rsync'' since it has more options. When migrating the data you should be aware that the group names and group IDs are different on ForHLR II and HoreKa. Hence you should use copy command options which do not keep the group of the source files, i.e. you should not use ''cp -p'' or ''rsync -a''. We recommend to use ''rsync -rlptoD''. Other ''rsync'' options might be interesting as well. For example, if you did not modify dotfiles (like ''.bashrc'') on ForHLR II and want to keep the dotfiles on HoreKa which were created during your first login you can use the option ''--ignore-existing''.
In order to find the path name of your ForHLR II data which can be used on HoreKa just go to the path on ForHLR II and execute the command ''/bin/pwd''. This provides the physical path which can also be used on HoreKa. Also note that it is a good idea to add a trailing ''/'' to the source and the target directories of the ''rsync'' command. Hence the command to transfer data of your $PROJECT directory on ForHLR II to your $PROJECT directory on HoreKa could look like this:
rsync -rlptoD --ignore-existing /pfs/data4/project/YOUR_FH2_PROJECT/YOUR_ACCOUNT/ $PROJECT/
In case you have lots of files or a huge amount of data it is recommended to execute the ''rsync'' command inside a batch job. On the login nodes ulimits prohibit long running commands. For this reason the ''rsync'' command might abort on login nodes and has to be started again.
Selecting the appropriate file system¶
In general, you should separate your data and store it on the appropriate file system.
Permanently required data like software or important results should be stored below $HOME or $PROJECT, but capacity limits (so-called "quotas") apply. Permanent data which is not needed for months or exceeds the capacity restrictions should be sent to other large scale (e.g. to the LSDF) or archive (e.g. bwDataArchive) storage systems and deleted from the home file system.
Temporary data which is only needed on a single node and which does not exceed the disk space shown in the table above should be stored below $TMP. Temporary data which is only needed during job runs should be stored on BeeOND. Scratch data which can be easily recomputed or which is the result of one job and input for another job should be stored below so-called workspaces. The lifetime of data in workspaces is limited and depends on the lifetime of the workspace.
If you accidentally deleted data on $HOME/$PROJECT, you can usually copy back an older version from a so-called snapshot path. In addition there is also a the possibility to restore files from a backup. Please see the Backup and Archival section for more information.
$HOME / $PROJECT¶
If your account is member of one project group the environment variables $HOME and $PROJECT point to the same directory.
If your account is member of more than one project group, you will need to select the environment variable $PROJECT. After login $HOME and $PROJECT points to the directory
/home/<your_oldest_project_group>/<your_account>. If you now want to change to another project group, you can do it by executing the commands:
$ newgrp <another_project_group> $ cd $PROJECT
To perform the above mentioned commands does not change the accounting, i.e. changing the project group does not change the project group which a batch job is accounted on. Hint: Accounting can be changed by the option ''-A'' (''--access'') of the command ''sbatch''.
For your project group (i.e. all coworkers of your project) a fixed amount of disk space for the project directories is reserved. The disk space is controlled by so-called quotas. The default quota limit per project group is 10 TB and 20 million inodes.
Workspaces are directory trees which are available for a limited amount of time (few months). The corresponding Spectrum Scale work file system has no backup, i.e. you should use workspaces for data which can be recreated, e.g. by running the same batch jobs once again. This is only needed in the very unlikely case that the file system gets corrupt.
Initially workspaces have a maximum lifetime of 60 days. You can extend the lifetime 3 times for another 60 days but you should do this near the end of the lifetime since the new lifetime starts when you execute the command which requests the extension.
If a workspace has inadvertently expired we can restore the data during a limited time (few weeks). In this case you should create a new workspace and report the name of the new and of the expired workspace in an email to the hotline or by opening a ticket.
For your account (user ID) there is a quota limit for all of your workspaces and for the expired workspaces (as long as they are not yet completely removed). The default quota limit per user is 250 TB and 50 million inodes.
To create a workspace you need to state ''name'' of your workspace and ''lifetime'' in days. Note that maximum integer for ''lifetime'' is 60. Execution of:
$ ws_allocate blah 30
Info: could not read email from users config ~/.ws_user.conf. Info: reminder email will be sent to local user account Info: creating workspace. /hkfs/work/workspace/scratch/USERNAME-blah remaining extensions : 3 remaining time in days: 30
For more information read the program's help, i.e. ''$ man ws_allocate''.
Reminder for workspace deletion¶
By default you will get an email about an expiring workspace 7 days before a workspace expires. You can adapt this time by using the option ''-r
You can also send yourself a calender entry which reminds you when a workspace will be automatically deleted:
$ ws_send_ical <workspace> <email>
List all your workspaces¶
To list all your workspaces, execute:
which will return you:
- Workspace ID
- Workspace location
- creation date, remaining time and expiration date
- available extensions
Find workspace location¶
Workspace location/path can be prompted for any workspace ''ID'' using ws_find, in case of workspace ''blah'':
$ ws_find blah
returns the one-liner:
Extend lifetime of your workspace¶
Any workspace's lifetime can be only extended three times. There two similar commands to extend workspace lifetime:
$ ws_extend blah 40which extends workspace ID ''blah'' by ''40'' days from now,
$ ws_allocate -x blah 40which extends workspace ID ''blah'' by ''40'' days from now.
Delete a workspace¶
$ ws_release blah # Manually erase your workspace blah
The environment variable $TMP contains the name of a directory which is local to each node. This means that different tasks of a parallel application use different directories when they do not utilize the same node. This directory should be used for temporary files being accessed from the local node during job runtime. The $TMP directory is located on an extremely fast 960 GB NVMe SSD disk. This means that performance on small files is much better than on the parallel file systems.
Inside batch jobs $TMP is newly set. $TMP contains the job ID and the job's starting time so that the subdirectory name is unique for each job. At the end of the job the directory $TMP is removed.
On login nodes $TMP also points to a fast directory on a local NVMe SSD disk but this directory is not unique. It is recommended to create your own unique subdirectory on these nodes. This directory should be used for the installation of software packages. This means that the software package to be installed should be unpacked, compiled and linked in a subdirectory of $TMP. The real installation of the package (e.g. make install) should be made in(to) the $HOME or $PROJECT folder.
LSDF Online Storage¶
Users of the LSDF Online Storage can access the storage on HoreKa. Therefore the environment variables $LSDF, $LSDFPROJECTS and $LSDFHOME are set.
The LSDF Online Storage is available on all Login- and Compute Nodes at all points in time. In case of maintenance the jobs will not be started, if the LSDF Constraint batch job parameter is used. For details see here.
BeeOND (BeeGFS On-Demand)¶
Users of the cluster HoreKa can request a private BeeOND (BeeGFS) parallel filesystem for each job. The file system is created during job startup and purged after your job. This means that all data on the private BeeOND filesystem will be deleted after your job. Make sure you have copied your data back within your job to the global filesystem, e.g. $HOME, $PROJECT, any workspace or the LSDF.
BeeOND/BeeGFS can be used like any other parallel file system. Tools like cp or rsync can be used to copy data in and out.
A BeeOND file system is only created if your batch job requests this creation. For details see here.
Snapshots and backup¶
In case you inadvertently deleted some of your data, want to go back to a previous version or compare your data with a previous version you can use so-called snapshot. Snapshots are a point in time copy of your data. For the home file system there will be snapshots of the last 7 days, of the last 4 weeks and of the last 6 months. For the workspaces there will be snapshots of the last 7 days. For the home file system snapshots will be located below
/home/<project_group>/.snapshots. For the work (workspace) file system snapshots will be located below
There are also regular backups of all data of the project directories, whereas ACLs and extended attributes will not be saved by the backup. Please contact the hotline or open a ticket if you need us to restore backup data.