Commit a2eed2b9 authored by Robert Verkerk's avatar Robert Verkerk
Browse files

Update documentation

parent 45c0c834
Pipeline #785 canceled with stages
in 0 seconds
......@@ -19,7 +19,7 @@ The **B2SAFE** Service is implemented as an [iRODS](http://www.irods.org) module
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)
Known issues can be found in [https://gitlab.eudat.eu/b2safe/B2SAFE-core/-/wikis/Known-issues](https://gitlab.eudat.eu/b2safe/B2SAFE-core/-/wikis/Known-issues)
## Prerequisites
......
......@@ -3,12 +3,10 @@ Installation/Upgrade
The following describes the procedure to enable B2SAFE release-4.x.y
*NOTE*: This B2SAFE version makes use of the b2HANDLE library.
<<<<<<< HEAD
It can be found at: https://github.com/EUDAT-B2SAFE/B2HANDLE
=======
It can be found at: https://gitlab.eudat.eu/b2safe/B2HANDLE
>>>>>>> origin/b2share
*NOTE*: This B2SAFE version does NOT make use of the b2HANDLE library. It uses
the msi-persistent-id microservice.
For bulk purposes the B2HANDLE library can be found at: https://gitlab.eudat.eu/b2safe/B2HANDLE
Please use the included instructions in README.md to build and install B2HANDLE.
At the end of this installation the installation of B2HANDLE is described.
......@@ -36,7 +34,7 @@ repo_gpgcheck=1
```
Configure the yum repository for iRODS 4.2.8
Configure the yum repository for iRODS 4.2.10
---------------------------------------------
configure the repo as root:
......@@ -47,20 +45,16 @@ vi /etc/yum.repos.d/eudat.repo
```
[EUDAT]
name=Eudat
baseurl=https://artie.ia.surfsara.nl:443/artifactory/Eudat-RPM-Production-Public/Centos/7/irods-4.2.8/release
baseurl=https://artie.ia.surfsara.nl:443/artifactory/Eudat-RPM-Production-Public/Centos/7/irods-4.2.10/release
enabled=1
gpgkey=https://artie.ia.surfsara.nl/artifactory/Eudat-RPM-Production-Public/Centos/7/irods-4.2.8/release/repodata/repomd.xml.key
gpgkey=https://artie.ia.surfsara.nl/artifactory/Eudat-RPM-Production-Public/Centos/7/irods-4.2.10/release/repodata/repomd.xml.key
repo_gpgcheck=1
```
Install pid-microservices for iRODS and B2SAFE
----------------------------------------------
```bash
<<<<<<< HEAD
sudo yum install msi-persistent-id b2handle irods-eudat-b2safe
=======
sudo yum install msi-persistent-id: irods-eudat-b2safe
>>>>>>> origin/b2share
```
After Installation / upgrade
......@@ -90,7 +84,7 @@ Notice all the warnings and take them in to account.
### update install.json with correct parameters with your favorite editor.
As the user who runs iRODS do following:
```bash
sudo vi /opt/eudat/b2safe/packaging/install.json
vi /opt/eudat/b2safe/packaging/install.json
```
| parameter | comment |
|--------------------------------|---------------------------------------------|
......
......@@ -2,8 +2,10 @@
The following describes the procedure to enable B2SAFE release-4.x.y
NOTE: This B2SAFE version makes use of the b2HANDLE library.
It can be found at: https://github.com/EUDAT-B2SAFE/B2HANDLE
*NOTE*: This B2SAFE version does NOT make use of the b2HANDLE library. It uses
the msi-persistent-id microservice.
For bulk purposes the B2HANDLE library can be found at: https://gitlab.eudat.eu/b2safe/B2HANDLE
Please use the included instructions in README.md to build and install B2HANDLE.
At the end of this installation the installation of B2HANDLE is described.
......@@ -17,14 +19,13 @@ It works as follows:
clone the b2safe project as any user. NOT root
```
$ git clone https://github.com/EUDAT-B2SAFE/B2SAFE-core.git
$ git clone git@gitlab.eudat.eu:b2safe/B2SAFE-core.git
```
go to the directory where the packaging files are and as irods user call create_rpm_package.sh
```
$ cd B2SAFE-core/packaging
$ ./create_rpm_package.sh
```
If upgrading from older version use convert*.py to convert install.conf to install.json
# INSTALLATION
login as root and install package:
......@@ -48,9 +49,17 @@ rpm -Uvh /home/irods/rpmbuild/RPMS/noarch/irods-eudat-b2safe-4.0-0.noarch.rpm
# CONFIGURATION
To configure it in iRODS do following as the user who runs iRODS :
When going from version 4.2.x or lower of B2SAFE to version 4.3 or higher convert the installation configuration.
As the user who runs iRODS do following:
```bash
cd /opt/eudat/b2safe/packaging
./convert_b2safe_conf_to_json.sh
```
Notice all the warnings and take them in to account.
update install.conf with correct parameters with your favorite editor
```
sudo vi /opt/eudat/b2safe/packaging/install.json
vi /opt/eudat/b2safe/packaging/install.json
```
Include the right irods users#zones in the handle_users and handle_groups options in install.json
......@@ -124,7 +133,7 @@ The customers need to install the b2handle library on the b2safe system and
create public/private keypairs and certificates and get the public key binary
uploaded before the upgrades.
This entails following:
- Download the b2handle code from: https://github.com/EUDAT-B2SAFE/B2HANDLE
- Download the b2handle code from: https://gitlab.eudat.eu/b2safe/B2HANDLE
- Create an rpm and install it on the b2safe system. With the necessary
dependencies. See the github page:
a> python setup.py bdist_rpm
......
......@@ -3,7 +3,7 @@
The following describes the procedure to enable B2SAFE release-4.x.y
NOTE: This B2SAFE version makes use of the b2HANDLE library.
It can be found at: https://github.com/EUDAT-B2SAFE/B2HANDLE
It can be found at: https://gitlab.eudat.eu/b2safe/B2HANDLE
Please use the included instructions in README.md to build and install B2HANDLE.
At the end of this installation the installation of B2HANDLE is described.
......@@ -15,7 +15,7 @@ NOTE: iRODS needs to be installed AND configured before installing/upgrading B2S
It works as follows:
- clone the b2safe project as any user. NOT root
$ git clone https://github.com/EUDAT-B2SAFE/B2SAFE-core.git
$ git clone git@gitlab.eudat.eu:b2safe/B2SAFE-core.git
- go to the directory where the packaging files are:
$ cd B2SAFE-core/packaging
......@@ -54,7 +54,7 @@ To install/configure it in iRODS do following as the user who runs iRODS :
# update install.conf with correct parameters with your favorite editor. See
the NOTE below for parameters.
sudo vi /opt/eudat/b2safe/packaging/install.conf
vi /opt/eudat/b2safe/packaging/install.conf
# install/configure it as the user who runs iRODS
source /etc/irods/service_account.config
......@@ -96,7 +96,7 @@ The customers need to install the b2handle library on the b2safe system and
create public/private keypairs and certificates and get the public key binary
uploaded before the upgrades.
This entails following:
- Download the b2handle code from: https://github.com/EUDAT-B2SAFE/B2HANDLE
- Download the b2handle code from: https://gitlab.eudat.eu/b2safe/B2HANDLE
- Create an rpm and install it on the b2safe system. With the necessary
dependencies. See the github page:
a> python setup.py bdist_rpm
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment