SDS@hd/Registration: Difference between revisions

From bwHPC Wiki
Jump to navigation Jump to search
m (changed link from responsible to manager section)
(update to bwServices-Management)
Line 1: Line 1:
== Prerequisites ==

* Only scientific data is stored. Don't place administrative data on SDS@hd.
* Only hot data is stored which means only data that is actively used is allowed. We expect you to remove data from finished projects. It is advised to use an archiving service for this. Temporary data should also be removed on a regular basis.
* The storage of personal data or data capable of being linked to an individual is not permitted.
* SDS@hd mustn't be used as an archive or a backup. To find solutions in this regard, please have a look at the [https://wiki.bwhpc.de/e/Main_Page Main Page] and your institutional services.
* The use of SDS@hd must be adequately documented:
** All publications that were created with the involvement of the storage service SDS@hd should acknowledge its use. For an example text see [[SDS@hd/Acknowledgement | here]].
** These publications, scientific posters, theses and third-party funded projects for which the service was used need to be reported to us via [https://management.bwservices.uni-heidelberg.de/ bwServices-Management] or via [mailto:sds-hd-support@urz.uni-heidelberg.de email].

== Registration Steps ==
== Registration Steps ==


The registration consists of two steps:
The registration consists of two steps:


* '''Step A:''' Membership in Storage Project (Speichervorhaben/'''SV'''). There are two options:
* '''Step A:''' Membership in Storage Project (Speichervorhaben/'''SV''', same as SDS@hd allocation). There are two options:
*: '''a)''' →[[SDS@hd/Registration#a)_Join_existing_SV | Join existing SV]]
*: '''a)''' →[[SDS@hd/Registration_New#a)_Get_invited_to_existing_SV | Get invited to existing SV]]
*: '''b)''' →[[SDS@hd/Registration#b)_Apply_for_new_SV | Apply for new SV]] (only possible for [https://www.bwidm.de/hochschulen.php bwIDM members])
*: '''b)''' →[[SDS@hd/Registration_New#b)_Apply_for_new_SV | Apply for new SV]]
* '''Step B:''' →[[SDS@hd/Registration#Step_B:_Registration_for_SDS@hd_Service |Registration for SDS@hd Service]]
* '''Step B:''' →[[SDS@hd/Registration_New#Step_B:_Registration_for_SDS@hd_Service |Registration for SDS@hd Service]]


After finishing the registration, the <span id="sds_registration_nextSteps">'''next steps'''</span> are:
After finishing the registration, the <span id="sds_registration_nextSteps">'''next steps'''</span> are:
* Check which management options there are for your respective role in the SV &rarr; [[SDS@hd/SV_Management |SV Management]]
* Check which management options there are for your respective role in the SV &rarr; [[SDS@hd/SV_Management_New |SV Management]]
* See how to access and use your storage space &rarr; [[SDS@hd/Access | Access]]
* See how to access and use your storage space &rarr; [[SDS@hd/Access | Access]]




[[File:SDS@hd_Registration.png|center|x500px|upright|SDS@hd Registration Process]]
[[File:Sds-hd-registration_new.png|center|x500px|upright|SDS@hd Registration Process]]


=== Step A: SV Membership ===
=== Step A: SV Membership ===
[[File:BwServices_Management_project_sv_structure.png|600px|thumb|right|A Project consists of multiple elements like a description, users and allocations/SVs. Every user in the project can be added to one or multiple of the available SVs.]]
You can either join an existing SV or start a new one. SVs are always part of a Project at the [https://management.bwservices.uni-heidelberg.de/ bwServices-Management] page. In the image on the right you can see how the general setup of a Project looks like. The person who created the Project is called PI (Principal Investigator). The PI and the PMs (Project Managers), defined by the PI, can invite new users to the project and add them to SVs.


You can either join an existing SV or start a new one.
==== a) Get invited to existing SV ====


To join an existing SV as a coworker, ask the PI or a PM to add you to the project and afterwards to the SV.
==== a) Join existing SV ====
* They can add you directly if you've already logged in to [https://management.bwservices.uni-heidelberg.de/ bwServices-Management] once.
To join an existing SV as a coworker:
* They can invite you by sending an email invite. You have to accept the invite to be a project member first, before you can be added to the SV.
# Get the following information from the SV responsible:
Whenever a manager adds you to a project or SV, you get an information via email.
#:* SV acronym

#:* SV password
&rarr; As soon as you're a member of an SV, you can [[SDS@hd/Registration_New#Step_B:_Registration_for_SDS@hd_Service | go on with Step B]] if you are using SDS@hd for the first time.
# Fill in and submit the [https://sds-hd.urz.uni-heidelberg.de/management/shib/sds_collaboration.php SV collaboration form] after logging in to the SDS@hd Managementtool.
#: You are now a member of the SV. The SV owner (and SV managers) will be notified automatically.
&rarr; [[SDS@hd/Registration#Step_B:_Registration_for_SDS@hd_Service | Go on with Step B]] if you are using SDS@hd for the first time.


==== b) Apply for new SV ====
==== b) Apply for new SV ====


This is typically done only by the leader of a scientific work group or the senior scientist of a research group/collaboration.
This is typically done only by the leader of a scientific work group or the senior scientist of a research group/collaboration.
You can add any amount of co-workers to your SV.
Any amount of co-workers can join your SV without having to register another project. You just need to provide them with the SV acronym and SV password. You'll receive this information via e-mail as soon as the SV application was successful.


# '''Check prerequisites:''' Your institution must be a [https://www.bwidm.de/hochschulen.php bwIDM member] and you have to be an employee of your institution.
There are two steps:
# '''Create a Project''' at [https://management.bwservices.uni-heidelberg.de/ bwServices-Management] (alternatively use an already existing project):
# '''Get the permission / entitlement:'''. Your institution has to grant you the permission to start an SDS@hd storage project ("SDS@hd SV entitlement"). Please follow the procedure specific to your institution:
## Go to the bwServices-Management Tool. At the start page click the title "Projects" and then "Add a project".
#: &rarr; see [[SDS@hd/Registration/Entitlement | Entitlement]].
## Fill in and submit the form.
# '''Apply for a new SV:'''
##* Keep in mind that this Project can stand for a scientific research project but alternatively, it can for example represent all acitivities of a research group as well. The title and description can be changed later.
#: &rarr; Fill in the form at the [https://sds-hd.urz.uni-heidelberg.de/management SDS@hd Managementtool].
##* The information to fill in is as follows: <syntaxhighlight>
&rarr; [[SDS@hd/Registration#Step_B:_Registration_for_SDS@hd_Service | Go on with Step B]] if you are using SDS@hd for the first time.
Please provide a detailed description of your work and select your field of science. In case that this Project corresponds to one dedicated scientific project, please describe your scientific project and indicate the expected project duration. Please mention additional infrastructure that is used by the project (cluster, cloud, storage, archiving services). Thank you!
</syntaxhighlight>
#: &rarr; Your project is directly active.
# '''Apply for SV'''. This is the same as adding allocations to a project:
## In the Allocations section of the Project's page is a button "Request Resource Allocation". Currently, the only allocation that can be chosen is an allocation for the resource SDS@hd. An SDS@hd allocation is called SV (Speichervorhaben / storage project).
## Fill in the form:
##* Justification questions (this field is the only one that can't be changed later on): <syntaxhighlight>
Q1: If not already provided in the bwServices-Management-Project description: Describe the intended usage of the storage space and indicate the expected duration that the allocation is needed.
Q2: How are data generated and processed? Please distinguish primary vs. secondary data and mention relevant equipment or software.
Q3: What is the expected data growth? Which file formats are used? Please describe any notable characteristics of your data, such as exceptionally large file size or very large number of small files.
Q4: Describe at which timepoints data can be archived or deleted. Describe the data and the data volume that can be archived at the end of the project.
Q5: How are your project data structured, and how is access managed? Are there special needs for the access rights within the SV (e.g. users or guest folder)?
</syntaxhighlight>
##* Title of the SV: The title is for you to recognize the SV in the allocations table if you have multiple SVs. It can be short.
## After filling in the form and agreeing to the terms, the allocation is shown on the project page with the status 'New'. A 'New' allocation is not approved, yet, and therefore not usable.
## The allocation application gets reviewed and approved. In the approval state no new users can be added. As soon as the storage space was set up, an email informs about the activation of the allocation.


&rarr; [[SDS@hd/Registration_New#Step_B:_Registration_for_SDS@hd_Service | Go on with Step B]] if you are using SDS@hd for the first time.
If you register your own SV, you will be:

* ...responsible for providing new members with the necessary information to join the SV. SV managers can do the same.
If you're a PI in a project with SDS@hd allocations, you will be:
*: &rarr; see [[SDS@hd/SV_Management#SV_Manager | SV Manager]]
* ...held accountable for the co-workers in the SV
* ...held accountable for the co-workers in the SV
* ...responsible for all data stored in this SV, as well as for any costs incurred as a result.
* ...asked to provide information for the two reports required by the DFG for their funding of SDS@hd
* ...asked to provide information for the two reports required by the DFG for their funding of SDS@hd
* ...likely asked for a contribution to a future DFG grant proposal for an extension of the storage system in your area of research ("wissenschaftliches Beiblatt")
* ...likely asked for a contribution to a future DFG grant proposal for an extension of the storage system in your area of research ("wissenschaftliches Beiblatt")
Line 67: Line 94:


&rarr; '''[[Registration/bwForCluster/Helix#Setting_a_New_Service_Password | Setting a New Service Password]]'''
&rarr; '''[[Registration/bwForCluster/Helix#Setting_a_New_Service_Password | Setting a New Service Password]]'''

== FAQ ==
* Is there a Test-SV to do technical tests?
*: Yes, there is a Test-SV for this purpose. You can write to the support to get invited. Please keep in mind that data gets regularly deleted and users may be removed after some time.
* I can login with different institutions/IDs (edugain, ORCID, university ID, university clinics ID,...). Which one shall I choose?
*: If you want to be able to start your own SVs, use the ID were you can get the entitlement most conveniently. Otherwise it doesn't matter. But ORCID is the most unspecific option and therefore should only be chosen if the other options don't work.
* I own a SV with my ID at institution A. Can I connect my account from institution B to it?
*: You can't connect different accounts. But you can join the SV with both accounts if necessary.
* What is my userID when I register via ORCID?
*: You'll be informed about the ID along the process. It'll start with "orcid_".
* How do I set up ORCID?
*: Login with your ORCID account (instead of an institutional account) and set it up so that your email address is shared with us.
* How do I register with foreign institutions (outside of [https://www.belwue.de/ueberuns/teilnehmer.html BelWü])
*: We might need to enable the IP range first.
*: After we've added the ip addresses, you might need to wait for an hour before it works.

Revision as of 17:14, 1 September 2026

Prerequisites

  • Only scientific data is stored. Don't place administrative data on SDS@hd.
  • Only hot data is stored which means only data that is actively used is allowed. We expect you to remove data from finished projects. It is advised to use an archiving service for this. Temporary data should also be removed on a regular basis.
  • The storage of personal data or data capable of being linked to an individual is not permitted.
  • SDS@hd mustn't be used as an archive or a backup. To find solutions in this regard, please have a look at the Main Page and your institutional services.
  • The use of SDS@hd must be adequately documented:
    • All publications that were created with the involvement of the storage service SDS@hd should acknowledge its use. For an example text see here.
    • These publications, scientific posters, theses and third-party funded projects for which the service was used need to be reported to us via bwServices-Management or via email.

Registration Steps

The registration consists of two steps:

After finishing the registration, the next steps are:

  • Check which management options there are for your respective role in the SV → SV Management
  • See how to access and use your storage space → Access


SDS@hd Registration Process

Step A: SV Membership

A Project consists of multiple elements like a description, users and allocations/SVs. Every user in the project can be added to one or multiple of the available SVs.

You can either join an existing SV or start a new one. SVs are always part of a Project at the bwServices-Management page. In the image on the right you can see how the general setup of a Project looks like. The person who created the Project is called PI (Principal Investigator). The PI and the PMs (Project Managers), defined by the PI, can invite new users to the project and add them to SVs.

a) Get invited to existing SV

To join an existing SV as a coworker, ask the PI or a PM to add you to the project and afterwards to the SV.

  • They can add you directly if you've already logged in to bwServices-Management once.
  • They can invite you by sending an email invite. You have to accept the invite to be a project member first, before you can be added to the SV.

Whenever a manager adds you to a project or SV, you get an information via email.

→ As soon as you're a member of an SV, you can go on with Step B if you are using SDS@hd for the first time.

b) Apply for new SV

This is typically done only by the leader of a scientific work group or the senior scientist of a research group/collaboration. You can add any amount of co-workers to your SV.

  1. Check prerequisites: Your institution must be a bwIDM member and you have to be an employee of your institution.
  2. Create a Project at bwServices-Management (alternatively use an already existing project):
    1. Go to the bwServices-Management Tool. At the start page click the title "Projects" and then "Add a project".
    2. Fill in and submit the form.
      • Keep in mind that this Project can stand for a scientific research project but alternatively, it can for example represent all acitivities of a research group as well. The title and description can be changed later.
      • The information to fill in is as follows:
        Please provide a detailed description of your work and select your field of science. In case that this Project corresponds to one dedicated scientific project, please describe your scientific project and indicate the expected project duration. Please mention additional infrastructure that is used by the project (cluster, cloud, storage, archiving services). Thank you!
    → Your project is directly active.
  3. Apply for SV. This is the same as adding allocations to a project:
    1. In the Allocations section of the Project's page is a button "Request Resource Allocation". Currently, the only allocation that can be chosen is an allocation for the resource SDS@hd. An SDS@hd allocation is called SV (Speichervorhaben / storage project).
    2. Fill in the form:
      • Justification questions (this field is the only one that can't be changed later on):
        Q1: If not already provided in the bwServices-Management-Project description: Describe the intended usage of the storage space and indicate the expected duration that the allocation is needed.
        Q2: How are data generated and processed? Please distinguish primary vs. secondary data and mention relevant equipment or software.
        Q3: What is the expected data growth? Which file formats are used? Please describe any notable characteristics of your data, such as exceptionally large file size or very large number of small files.
        Q4: Describe at which timepoints data can be archived or deleted. Describe the data and the data volume that can be archived at the end of the project.
        Q5: How are your project data structured, and how is access managed? Are there special needs for the access rights within the SV (e.g. users or guest folder)?
      • Title of the SV: The title is for you to recognize the SV in the allocations table if you have multiple SVs. It can be short.
    3. After filling in the form and agreeing to the terms, the allocation is shown on the project page with the status 'New'. A 'New' allocation is not approved, yet, and therefore not usable.
    4. The allocation application gets reviewed and approved. In the approval state no new users can be added. As soon as the storage space was set up, an email informs about the activation of the allocation.

Go on with Step B if you are using SDS@hd for the first time.

If you're a PI in a project with SDS@hd allocations, you will be:

  • ...held accountable for the co-workers in the SV
  • ...responsible for all data stored in this SV, as well as for any costs incurred as a result.
  • ...asked to provide information for the two reports required by the DFG for their funding of SDS@hd
  • ...likely asked for a contribution to a future DFG grant proposal for an extension of the storage system in your area of research ("wissenschaftliches Beiblatt")

Step B: Registration for SDS@hd Service

Select your home organization

After step A you have to register your personal account on the storage system and set a service password.

  • Visit the registration website bwServices: https://bwservices.uni-heidelberg.de
    1. Select your home organization from the list and click Proceed
      You will be directed to the Identity Provider of your home organisation
    2. Enter your home-organisational user ID / username and your home-organisational password and click Login button
      You will be redirected back to bwServices
  • Register for the SDS@hd service:
    1. Under The following services are available select the service SDS@hd - Scientific Data Storage.
    2. Click Register
  • Set your personal service password for SDS@hd. This is used for accessing SVs.
  • The registration is finished.
    next steps

Change Service Password at bwServices

Setting a New Service Password

FAQ

  • Is there a Test-SV to do technical tests?
    Yes, there is a Test-SV for this purpose. You can write to the support to get invited. Please keep in mind that data gets regularly deleted and users may be removed after some time.
  • I can login with different institutions/IDs (edugain, ORCID, university ID, university clinics ID,...). Which one shall I choose?
    If you want to be able to start your own SVs, use the ID were you can get the entitlement most conveniently. Otherwise it doesn't matter. But ORCID is the most unspecific option and therefore should only be chosen if the other options don't work.
  • I own a SV with my ID at institution A. Can I connect my account from institution B to it?
    You can't connect different accounts. But you can join the SV with both accounts if necessary.
  • What is my userID when I register via ORCID?
    You'll be informed about the ID along the process. It'll start with "orcid_".
  • How do I set up ORCID?
    Login with your ORCID account (instead of an institutional account) and set it up so that your email address is shared with us.
  • How do I register with foreign institutions (outside of BelWü)
    We might need to enable the IP range first.
    After we've added the ip addresses, you might need to wait for an hour before it works.