Dear GitLab Users, due to maintance work and updates, the GitLab service will be unavailable for a few minutes between 20:00-20:30 CET on 20.01.2022. We are sorry for any inconvenience.

README.md 2.44 KB
Newer Older
Beatriz Sanchez's avatar
Beatriz Sanchez committed
1
# EUDAT B2SAFE
ccacciari's avatar
ccacciari committed
2

Beatriz Sanchez's avatar
Beatriz Sanchez committed
3
#### Table of Contents
4

Beatriz Sanchez's avatar
Beatriz Sanchez committed
5
6
1. [B2SAFE Description - Why B2SAFE](#module-description)
2. [PREREQUISITES - How to install IRODS and B2HANDLE](#prerequisites)
7
3. [Install/Deployment - How to install the B2SAFE](#install)
Beatriz Sanchez's avatar
Beatriz Sanchez committed
8
4. [B2SHARE - How to connect B2SHARE with  B2SAFE](#b2share)
9
10
5. [Documentation - Documentation](#documentation)
6. [Testing - Instructions to test the code](#testing)
11

Beatriz Sanchez's avatar
Beatriz Sanchez committed
12
13
14

## Module Description

Beatriz Sanchez's avatar
Beatriz Sanchez committed
15
This repository provides the **B2SAFE** service code from the EUDAT project. B2SAFE is released under BSD license.
16

Beatriz Sanchez's avatar
Beatriz Sanchez committed
17
18
19
20
21
22
23
The [EUDAT](http://www.eudat.eu) B2SAFE Service offers functionality to replicate datasets across different data centres in a safe and efficient way while maintaining all information required to easily find and query information about the replica locations. The information about the replica locations and other important information is stored in PID (Persistent IDentifier) records, each managed in separate administrative domains. 
The **B2SAFE** Service is implemented as an [iRODS](http://www.irods.org) module providing a set of iRODS rules or policies to interface with the [EPIC](http://www.pidconsortium.eu) handle API and uses the iRODS middleware to replicate datasets from a source data (or community) centre to a destination data centre.

The documetation can be found in the [B2SAFE-wiki](https://gitlab.eudat.ei/b2safe/B2SAFE-core/-/wikis)

Known issues can be found in [https://github.com/EUDAT-B2SAFE/B2SAFE-core/wiki/Known-issues](https://github.com/EUDAT-B2SAFE/B2SAFE-core/wiki/Known-issues)

Beatriz Sanchez's avatar
Beatriz Sanchez committed
24
## Prerequisites 
Beatriz Sanchez's avatar
Beatriz Sanchez committed
25

Beatriz Sanchez's avatar
Beatriz Sanchez committed
26
IRODS needs to be installed and configured before intalling or upgrading B2SAFE 
Beatriz Sanchez's avatar
Beatriz Sanchez committed
27

Beatriz Sanchez's avatar
Beatriz Sanchez committed
28
## Install
Beatriz Sanchez's avatar
Beatriz Sanchez committed
29

Beatriz Sanchez's avatar
Beatriz Sanchez committed
30
Installtion instruction ca be foun in: 
31
32
33

* [Deployment on Centos 7, see install_centos7.md](install_centos7.md)
* [Deployment on other systems, see install_other.txt](install_other.txt)
ccacciari's avatar
ccacciari committed
34

Beatriz Sanchez's avatar
Beatriz Sanchez committed
35

Beatriz Sanchez's avatar
Beatriz Sanchez committed
36
37
38
39
40
41
1. on your **SAFE** server go to the irods user home directory
2. git clone this repository
```
git clone .git B2SAFE-core
```

Beatriz Sanchez's avatar
Beatriz Sanchez committed
42
## B2share
Beatriz Sanchez's avatar
Beatriz Sanchez committed
43

Beatriz Sanchez's avatar
Beatriz Sanchez committed
44
45
Information about b2share can be found in https://eudat.eu/services/userdoc/the-b2share-http-rest-api

Beatriz Sanchez's avatar
Beatriz Sanchez committed
46
* [Deployment see B2SHARE_install.md](B2SHARE_install.md)
Beatriz Sanchez's avatar
Beatriz Sanchez committed
47

Beatriz Sanchez's avatar
Beatriz Sanchez committed
48
* Install the python packages listed in /opt/eudat/b2safe/cmd/requirements.txt 
Beatriz Sanchez's avatar
Beatriz Sanchez committed
49
50
51
52

Create or update /opt/eudat/b2safe/conf/b2share_client.json with the parameters of your b2safe/irods intallation and with your access parameters for your b2share instance


53
## documentation 
Beatriz Sanchez's avatar
Beatriz Sanchez committed
54

Michele Carpene's avatar
Michele Carpene committed
55
https://gitlab.eudat.eu/b2safe/B2SAFE-core/-/wikis/home
Beatriz Sanchez's avatar
Beatriz Sanchez committed
56

57
## Testing 
58