README.md 2.64 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
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.

20
The documentation can be found in the [B2SAFE-wiki](https://gitlab.eudat.eu/b2safe/B2SAFE-core/-/wikis)
Beatriz Sanchez's avatar
Beatriz Sanchez committed
21

22
Known issues can be found in [B2SAFE-wiki Known-issues](https://gitlab.eudat.eu/b2safe/B2SAFE-core/-/wikis/Known-issues)
Beatriz Sanchez's avatar
Beatriz Sanchez committed
23

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

26
27
28
IRODS needs to be installed and configured before installing or upgrading B2SAFE.
B2SAFE makes use of the iRODS python rule engine. The iRODS python rule engine will be installed during the installation or upgrade of B2SAFE
B2SAFE makes use of the handle service. This needs to be configured before installing B2SAFE
Beatriz Sanchez's avatar
Beatriz Sanchez committed
29

Beatriz Sanchez's avatar
Beatriz Sanchez committed
30
## Install
Beatriz Sanchez's avatar
Beatriz Sanchez committed
31

32
Installation instruction can be found in: 
33
34

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

Beatriz Sanchez's avatar
Beatriz Sanchez committed
37

Beatriz Sanchez's avatar
Beatriz Sanchez committed
38
39
40
41
42
43
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
44
## B2share
Beatriz Sanchez's avatar
Beatriz Sanchez committed
45

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

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

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

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


55
## documentation 
Beatriz Sanchez's avatar
Beatriz Sanchez committed
56

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

59
## Testing 
60