|
|
# General purpose
|
|
|
To have a possibility to use B2SAFE as storage of objects referenced in B2SHARE a connection between these two systems was evaluated. So the B2SAFE user can trigger a set of iRODS rules that are calling the b2safe_b2share_client python script that connects to the HTTP API of B2SHARE and performs actions requested from the user.
|
|
|
To have a possibility to use B2SAFE as storage of objects referenced in B2SHARE a connection between these two systems was evaluated. So the B2SAFE user can trigger a set of iRODS rules that are calling the b2shareclientCLI python script that connects to the HTTP API of B2SHARE and performs actions requested from the user.
|
|
|
It is not an official part of B2SAFE and can be found in a separate development branch “b2share” of B2SAFE-core package.
|
|
|
|
|
|
# Installation
|
... | ... | @@ -26,9 +26,9 @@ If packages are not within the standards install and use pip to install the miss |
|
|
As described in the “Example Workflow” section, the iRODS rules will trigger these scripts according to the flags user specify in the imeta of the collection.
|
|
|
|
|
|
# Configuration
|
|
|
There are two major scripts for the B2SHARE connection component b2shareclientCLI.py and create_md_file.py that are using the configuration files “b2safe_b2share.conf” and “create_md_file.conf” accordingly. The configurable options are identical. The configurations were only separated as the scripts could be used independently. It consists of 3 parts. The first tow sections `Logging` and `B2SHARE_HTTP_API` are prefilled with default values.
|
|
|
* `Logging` - with 2 values needed to be specified: log level, default is **log_level=DEBUG**, and the file where to safe the logging information, default value is **log_file=log/ b2safe_b2share.log**, so in a file named b2safe_b2share.log in folder log under the installation path.
|
|
|
* `B2SHARE_HTTP_API` - with 1 value needed to be specified: host_name of the B2SHARE instance, default is the address of the training instance of B2SHARE **host_name=https://trng-b2share.eudat.eu/**. Should the HTTP API of B2SHARE be changed in the meantime, than the values for the required endpoints are needed to be adapted.
|
|
|
There are two major scripts for the B2SHARE connection component b2shareclientCLI.py and create_md_file.py that are using the configuration files “b2safe_b2share.conf” and “create_md_file.conf” accordingly. The configurable options are identical. The configurations were only separated as the scripts could be used independently. It consists of 3 parts. The first two sections `Logging` and `B2SHARE_HTTP_API` are prefilled with default values.
|
|
|
* `Logging` - with 2 values needed to be specified: log level, default is **log_level=DEBUG**, and the file where to safe the logging information, default value is **log_file=log/b2safe_b2share.log**, so in a file named b2safe_b2share.log in folder log under the installation path.
|
|
|
* `B2SHARE_HTTP_API` - with 1 value needed to be specified: host_name of the B2SHARE instance, default is the address of the training instance of B2SHARE **host_name=https://trng-b2share.eudat.eu/**.
|
|
|
* `iRODS` - connection information of the iRODS instance: the name of the iRODS zone like **zone_name=Zone1** and the endpoint consisting of the host_name:port information like **zone_ep=localhost:1247** and the information about the iRODS **resources** to be used as well as the logical home directory in iRODS like **irods_home_dir=/Zone1/home**.
|
|
|
|
|
|
# Example Workflow
|
... | ... | |