VRE Backend API and Scheduler
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 

6.6 KiB

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> </head>

Storages

Here you can read which storage engines are supported. And how they can be used. Per storage engine there is a short description how to setup.

Per storage engine the following options needs to be specified

  • location: Full path of the storage engine or API
  • username: The username that is able to connect to the storage
  • password: The password that is needed to connect to the storage

When we connect a storage to a study, the options to set a storage path and encryption will become available. So you are able to reuse the same storage configuration for multiple studies, but per combination storage/study you can specify storage paths, encryption, notification etc

Gitea

In order to use Gitea as a storage, you need to create an 'Application' in Gitea. This will create a new token that is used for authenticating with the API.

Creating access token

Login into the Gitea server with a webrowser and go to your 'Applications' in your 'Settings'.

Gitea API Token generating
  1. Click on you profile menu
  2. Click on 'Settings'
  3. Click on 'Applications'
  4. Enter a name for this Application.

Then press the 'Generate token' button and a new token will be generated with the new Application.

Gitea API Token generating done
  1. Store the token somewhere save
  2. Here is your newly created Application with the latest activity. This will show you the last time this Application is used.
  3. Here you can delete the Application. This will revoke the token, and will block new API calls and uploads.

Research Workspaces Storage values

Now we have created an Gitea API Application we can use this in the Research Workspaces Dropoff Storage settings.

Github

In order to use Gitea as a storage, you need to create an 'Application' in Gitea. This will create a new token that is used for authenticating with the API.

Creating access token

Login into the Github with a webrowser and follow the steps below to make an API token.

Github API Token generating
  1. Click on you profile menu
  2. Click on 'Settings'
  3. Click on 'Developer settings'
Github API Token generating done
  1. Click on 'Personal access tokens'
Github API Token generating done
  1. Click on 'Generate new token'
Github API Token generating done
  1. Enter a name
  2. Select the Repo checkbox.
Github API Token generating done
  1. Store the token somewhere save
  2. Here is your newly created Application with the latest activity. This will show you the last time this Application is used.
  3. Here you can delete the Application. This will revoke the token, and will block new API calls and uploads.

Research Workspaces Storage values

Now we have created an Github.com API Application we can use this in the Research Workspaces Dropoff Storage settings.

WebDAV

In order to use a WebDAV server as a storage there are different ways of creating API tokens and/or authentication. So for WebDAV we have steps per working known WebDAV servers.

Owncloud/Nexcloud/Unishare

Creating access token

Login into the Owncloud/Nexcloud/Unishare server with a webrowser and go to your 'Security' in your 'Settings'.

Owncloud/Nexcloud/Unishare API Token generating
  1. Click on you profile menu
  2. Click on 'Settings'
  3. Click on 'Security'
  4. Enter a name for this Application.
  5. Press the 'Generate token' button and a new token will be generated with the new Application.
Owncloud/Nexcloud/Unishare API Token generating done
  1. Store the token somewhere save
  2. Here is your newly created Application with the latest activity. This will show you the last time this Application is used.
  3. Here you can delete the Application. This will revoke the token, and will block new API calls and uploads.

Research Workspaces Storage values

System Message: WARNING/2 (<stdin>, line 151)

Title underline too short.

Research Workspaces Storage values
------------------
Owncloud/Nexcloud/Unishare WebDAV url

Now we have created an Owncloud/Nexcloud/Unishare API Application we can use this in the Research Workspaces Dropoff Storage settings. For Owncloud/Nexcloud/Unishare there are some extra steps to get the right WebDAV settings.

  1. Go to the Files Application
  2. Click on the Settings icon
  3. Copy the url value at the field WebDAV. Make sure you copy the full path

iRODS

In order to use iRODS as a storage, you need to enter some credential values in the the data storage form.

Creating access token

There is no need for creating separate access tokens. As iRODS does not support multiple login tokens per user, we need to use the same credentials as the user is using when reading data from the iRODS server.

Keep in mind, that when you change the iRODS credentials (due to missing password), you need to update the credentials here as well.

As iRODS works with federation, you need to know your iRODS zone. This will be added to the address location when entering iRODS credentials.

Research Workspaces Storage values

  • location: hostname or ip of the iRODS server with '#[iRODS ZONE NAME]' appended
  • username: Your own username
  • password: Your own password
</html>