This training module provides hands-on material for iRODS4, EUDAT B2SAFE, B2STAGE and persistent identifiers, more specifically handles (handle version 8).
Please consult the user documentation on the services for a general introduction, if needed, before following the contents of this git repository. This training material foresees two types of trainees: those who want to learn how to use the EUDAT B2SAFE and B2STAGE services; and those who prefer to deploy and integrate these services. Following the full, in-depth tutorial will allow you to understand how the components of a service are combined and thus enables you to also extend the integration of services at the low-level (technology-level rather than API level). Following just the "use" part of the training will familiarise you with the APIs of the services, but not with the underlying technology and its wiring.
The order of the markdown files proposes the curriculum of the training. Each component takes about 1 hour.
| File | Target audience | Status |
|---|---|---|
| 00-install-iRODS4.md | site admins | |
| 01-iRODS-handson-user.md | researchers | |
| 02-iRODS-handson-admin.md | site admins and interested researchers | |
| 03-install-B2SAFE.md | site admins | |
| 04-iRODS_federations_configuration.md | site admins and interested researchers | |
| 05-iRODS-advanced-users.md | site admins and researchers | |
| 06-B2SAFE-handson.md | site admins and data managers | |
| 07a-Working-with-PIDs_CURL.md 07b-Working-with-PIDs_epicclient.md 07c-Working-with-PIDs_B2HANDLE.md 07d-Working-with-PIDs_EPIC.md |
site admins and interested researchers | [Legacy material] Module 07b and Module 07d * |
| 08-install-gridFTP-server.md | site admins | |
| 09-install-B2STAGE.md | site admins | |
| 10-using-B2STAGE.md | researchers, last exercise is a joint effort between researchers and site admins | |
| 11a-Setup-HTTP-API.md | site admins, scientific programmers | |
| 11b-HTTP-API-handson-user.md | researchers, scientific programmers |
To get access to the training environment, please use the EUDAT contact pages; and provide some details on which community you are from and in which context you would like to follow the tutorial.
During the tutorial site admins learn how to set up an infrastructure like indicated in the picture below. Users can make use of a pre-deployed instance of this infratructure on the EUDAT Training Sandbox.
We provide a detailed tutorial for iRODS 4.1.10 on Ubuntu 14 in the main modules. However, since Ubuntu 14 is out of support but there are no official packages for Ubuntu 16 yet, we provide details on the setup below for CentOS 7.X and iRODS 4.2.1 in TrainingInstances-iRODS4.2.1. In that case please replace all modules for installations with the instructions provided there.
Users can get access to a setup of virtual machines (VMs) like above. The tutorial will show them the functionality of single components and how to combine them in order to arrive at proper data management. Users can either choose to set up their personal computer to resemble the user interface machine or they can receive a login on a user interface VM on the training sandbox operated by the EUDAT User Documentation and Training Material team. Via the user interface machine they can access the first VM which contains an iRODS server, a gridFTP server, and the B2SAFE module. Another VM holds another iRODS server. Both iRODS grids are federtated and users can transfer data from one grid to the other. The user interface VM also provides the necessary python libraries to work with the epicclient and with B2HANDLE.
The appropriate parts of the tutorial you can follow in the training environment are labeled with "researchers", "interested researchers" and "data managers" in the table above.
Site admins will be guided through all steps to set up the environment, covering iRODS installation and federation, setting up B2SAFE, deploying a gridFTP endpoint and pointing it to the iRODS server via the data staging interface.
To build the setup you will need to prepare or have access to three distinct (potentially virtualised) computational resources; each with e.g. 2 vCPU, 8GB memory, 100GB disk; running a Linux operating system (Ubuntu preferred); in which you have sudo rights.
You will also need extra credentials for the persistent identifiers part; see below.
In the tutorial we explain how to create, update and delete PIDs. The infrastructure to manage PIDs is provided by SURFsara. Note that all instances (B2SAFE, user modules) will make use of the same PID prefix.
To follow this part of the tutorial you need extra credentials. We will provide you with these credentials via EUDAT contact pages; please provide some details on which community you are from and in which context you would like to follow the tutorial.
* To get back to the old versions do:
git clone https://github.com/EUDAT-Training/B2SAFE-B2STAGE-Training.git
git checkout 7b22697f13efce29465d97dfb3177be5db2e33dc 07d-Working-with-PIDs_EPIC.md
git checkout 7b22697f13efce29465d97dfb3177be5db2e33dc 07b-Working-with-PIDs_epicclient.md