README.md 3.26 KB
Newer Older
Beatriz Sanchez's avatar
Beatriz Sanchez committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# EUDAT B2SAFE

#### Table of Contents

1. [B2SAFE Description - Why B2SAFE](#module-description)
2. [PREREQUISITES - How to install IRODS and B2HANDLE](#prerequisites)
3. [Install - How to install the B2SAFE](#install)
4. [B2SHARE - How to connect B2SHARE with  B2SAFE](#b2share)
4. [Development - Guide for contributing to B2SAFE](#development)
5. [Testing - Instructions to test the code](#testing)


## 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: 
Beatriz Sanchez's avatar
Beatriz Sanchez committed
31
32
33
34
35
36

* [Deployment on Centos 7, see install_centos7.md](install_centos7.md)
* [Deployment on other systems, see install_other.txt](install_other.txt)



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

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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
Information about b2share can be found in https://eudat.eu/services/userdoc/the-b2share-http-rest-api

The following describes the procedure to enable B2SAFE release-4.x.y with the B2SHARE publication option 

Install the python packages listed in /opt/eudat/b2safe/cmd/requirements.txt 

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
```
{
    "configurations": {
        "b2share_http_api": {
            "host_name": "https://trng-b2share.eudat.eu/",
            "access_parameter": "?access_token",
            "list_communities_endpoint": "api/communities/",
            "get_community_schema_endpoint": "/schemas/last",
            "records_endpoint": "api/records/"
        },
        "irods": {
            "zone_name": "tempZone",
            "irods_env": "/home/irods/.irods/irods_environment.json",
            "resources": "",
            "irods_home_dir": "",
            "irods_debug": ""
        },
        "logging": {
            "loglevel": "DEBUG",
            "logfile": "/opt/eudat/b2safe/log/b2share_connection_client.log"
        }
    },
    "record_id": "5f4beef03bf8445a8214fd13bdda3398"

```
The value of record_id correspond with the user access tocken


How to get a access tocken


Beatriz Sanchez's avatar
Beatriz Sanchez committed
84
85


86