Registration: Difference between revisions

From bwCloud-OS
Jump to navigation Jump to search
Admin (talk | contribs)
No edit summary
 
(82 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<span id="In-a-Nutshell"></span>
{{InANutshell|
{{InANutshell|
<li>Access to '''bwCloud-OS''' requires an active account from a bwIDM-participating institution (university, HAW, PH, etc.).</li>
<li>Access to bwCloud-OS requires an active account from a '''bwIDM'''-participating institution.</li>
<li>Log in once at [https://dashboard.bw-cloud.org https://dashboard.bw-cloud.org] to activate your user profile — setup is automatic via bwIDM.</li>
<li>Your account must include a valid '''entitlement''', assigned by your '''home institution'''. This is usually automatic. If it is missing (see [[Registration#How_can_I_find_out_which_entitlements_my_account_contains?|here]]), contact your institution’s IT support. The bwCloud-OS team cannot assign entitlements.</li>
<li>If you cannot log in, contact your institution’s '''IT service center''' and request the required entitlement.</li>
<li>Log in once to the [https://portal.bw-cloud.org/ '''Dashboard'''] to activate your profile. Setup is automated via bwIDM.</li>
<li>After successful login, select your '''home region''' and start using bwCloud-OS resources.</li>
<li>After login, select your '''region''' as described [[Registration#Region-Selection|here]] to begin using bwCloud-OS.</li>}}
}}




__TOC__
__TOC__
= Entitlements =
= Entitlements =
This page explains the '''bwIDM entitlements'''(bwCloud Basic, bwCloud Extended) required to use bwCloud-OS and their impact on access, resources, and operating rules. <span id="was-sind-entitlements"></span>


== What are "Entitlements" or "bwIDM Entitlements"? ==
== What are "bwIDM" and "entitlements"? ==
<span id="Entitlements"></span>


Every member of an institution (university, college, PH, HAW, etc.) in Baden-Württemberg has a personal account to log in to and use the IT services provided by the institution. If the institution is a member of the [https://www.bwidm.de/ federated identity management of Baden-Württemberg universities bwIDM], then associates of this institution can apply for further use of IT services offered by other locations.
Every member of a higher education institution in Baden-Württemberg  (university, college, PH, HAW, etc.) has a personal account for accessing the IT services provided by their institution. If the institution participates in the federated identity management system  [https://www.bwidm.de/ '''bwIDM'''], its members can also apply for additional IT services offered by other participating institutions.


In order that these "external" IT services "know" who the user is, the following information is provided during registration and/or usage of the external IT service and some data of the user(s) is transmitted to the IT service. The federated Identity management also ensures through the mutual trust model that the external IT service knows that the user really exists at the respective institution (validation of the account).
To allow external IT services to identify users, certain personal data is transmitted during registration and/or use of the service. Federated identity management ensures, through a model of mutual trust, that the external service can verify the user’s affiliation with their institution — confirming that the account is valid and the user is officially recognized. Within the bwIDM Federation, participating institutions have agreed on a minimum set of personal data that is transmitted to external IT services. This includes standard attributes such as <code>eduPersonPrincipalName</code>, <code>mail</code>, and <code>givenName</code>.


Within the context of the bwIDM Federation, the participating institutions have agreed on a minimum data set, which is transmitted to the external IT service. This data record includes, for example Attribute like eduPersonalPrincipalName, mail or givenName. These are so-called "standard attributes".
Some services, however, require additional information — for example, whether a user’s home institution is authorized to access a particular external service. This is handled through the assignment of special attributes, such as <code>eduPersonEntitlement</code>, to the user's account.


However, some IT services require specific information, such as whether a home institution is permitted to use a foreign IT service at all. This specific information can be added to the personal account of the user(s) through the assignment of an additional special attribute (eduPersonEntitlement).
== Which entitlements are required to use bwCloud-OS? ==
<span id="Entitlements-bwCloud-OS"></span>


<span id="welche-entitlements-notwendig"></span>
To access and use bwCloud-OS, you need a valid bwCloud(-OS) entitlement. A detailed overview of current regulations can be found on the page [[Entitlements in bwCloud-OS]].


== Which Entitlements do I need to use bwCloud-OS? ==
'''📌 Note:''' The bwCloud(-OS) entitlement model is currently being restructured and subject to change.
To use the bwCloud-OS you need at least one of the two entitlements:
* bwCloud-Basic
* bwCloud-Extended


Accounts can also include both entitlement elements - in this case the "higher ranking" entitlement element ('''bwCloud-Extended''') is evaluated and applied.
== How can I find out which entitlements my account contains?==
<span id="My-Entitlements"></span>


== What is regulated with the Entitlements? Why do I need these Entitlements? ==
To view information about bwIDM services linked to your account, log in to the "[https://login.bwidm.de/welcome/index.xhtml RegApp]".
The entitlements serve several purposes. The most important points in overview:


# Entitlements answer the question of ''who is allowed access to bwCloud-OS and who is not'' based on decisions made by the users’ home institutions.  The users' home institiution independently decide on the allocation of entitlements to their members - and thus ultimately who and how the bwCloud-OS should be used.  On our side applies from 01.10.2019: No release by the home institution via Entitlement = No access to bwCloud-OS
For detailed information on the entitlements associated with your account (including those for services not yet registered), navigate to:
# Entitlements define how many resources a user is allowed to use. The following applies: the flavor table is the basis for differentiation:
## Users who only have the bwCloud-Basic entitlement can start an instance of either "nano" or "tiny". This is a kind of "trial access" and is mainly targeted at students. Instances of this flavor are free of charge.
## Users who have the "bwCloud-Extended" entitlement will be given significantly more quotas and can therefore use all the flavors offered. The use of the bwCloud-OS will incur costs in the future.
# With the Entitlements we regulate how we handle the instances  The Entitlement bwCloud-Basic is mainly addressed to students who want to use the bwCloud-OS for various purposes such as theses or as a software repository. Since there is a large number of students in Baden-Württemberg, we expect a correspondingly large number of small VMs to accumulate over time. At the same time, we assume that these VMs will most likely be forgotten and stay online even after their original purpose is no longer applicable". The bwIDM Entitlement bwCloud-Basic is not intended to run a (system) service permanently. We will therefore regularly delete all VMs started by users with entitlement ''bwCloud-Basic'' to "clean up" our systems and to give other users the chance to start an instance. The bwIDM Entitlement bwCloud-Basic is not intended for permanently running VMs. With bwCloud-Extended these restrictions do not exist. Here the following applies: the VMs run until they are independently deleted by the users.
# With the entitlements we know who can potentially pay for the virtual machines  To ensure the sustainable operation of the bwCloud-OS and a regular exchange of hardware and software In order to be able to ensure this, it is necessary to charge for the services used. We therefore would like to establish a cost allocation model. With the income generated in this way, we intend to renew our hardware infrastructure regularly and adapt it to requirements. In order to be able to avoid individual invoices with the users, we are going to generate so-called collective overviews and invoices", because only the home region know their users and know who has the appropriate resources to operate VMs. With the award of the Entitlements bwCloud Extended for a user, the respective home region signals two things:
## the user has access to an account with appropriate means and that
## the home site can therefore pay the total bill for the resource consumption of all users of the site.  How the costs are then allocated internally at the home site is again a matter for the respective site and can be organised individually and according to their local guidelines. Resources operated with the bwIDM Entitlement bwCloud-Basic remain free of charge: this flavor is supported by the Ministry of Science, Research and the Arts (MWK).
# We accelerate the registration process  Through the automated evaluation of the bwIDM Entitlements in the course of the registration for the service, users receive immediate feedback when the account has been set up in the bwCloud. No manual intervention from our side is required anymore - and so everybody wins: Users enter the bwCloud-OS within minutes and we don't have to activate anyone manually anymore.


== How can I find out which entitlements my account contains? ==
'''Index → Personal Data → Shibboleth'''
To find out which Entitlements are linked to an account, you can for example log into the "[https://login.bwidm.de/welcome/index.xhtml RegApp]" or the [https://bw-support.scc.kit.edu bwSupportPortal].
When logging into a RegApp or into the bwSupportPortal an overview of the data to be transmitted is displayed. This overview also includes the supplied Entitlements (see screenshot).


<div style="text-align:center;">
In the '''Value''' column, you should see entries such as <code>bwCloud-Basic</code> or <code>bwCloud-Extended</code>. If such an entry containing <code>bwCloud</code> exists, you are entitled to register for and use bwCloud-OS. Which specific entitlement you have is determined by your home institution and cannot be changed by you or the bwCloud-OS team.
[[File:Screenshot login bwSupportPortal.png|450x450px|border]]
</div>


<br><br><br><br><br>
== What should I do if my account has no bwCloud-OS entitlement assigned? ==
<span id="No-Entitlements"></span>


== What do I do if my account has no bwCloud entitlement assigned to it? ==
The assignment of entitlements is exclusively managed by your home institution. The bwCloud-OS team does '''not''' have the authority to add or remove entitlements on user accounts.
The assignment of the entitlement is the sole responsibility of the respective home institiution. The bwCloud-OS team ''cannot add or remove entitlements'' to user accounts! In this case, please contact the central IT service department (computer center, IT service center, service center, ...) and request the assignment of the desired entitlement.


= Region =
If your account lacks the necessary entitlement, please contact your institution’s central IT service department or service desk.


= Regions =


== What does "region" mean in bwCloud-OS? ==
== What does "region" mean in bwCloud-OS? ==
bwCloud-OS currently consists of '''four different operating sites = regions''', which can be selected and administered via a common interface (dashboard or portal). Each of the four operating sites acts as an independent region. This means: running instances in the Mannheim region receive an IP address according to the configuration of the Mannheim region. The IP address is specific to Mannheim and cannot move to another region.
<span id="Regions"></span>


== What is a "home region"? ==
In bwCloud-OS, a '''region''' refers to one of the four operating sites: '''Freiburg''', '''Karlsruhe''', '''Mannheim''', and '''Ulm'''. Each region runs its own infrastructure but is accessible through a shared interface ([https://portal.bw-cloud.org/ Dashboard]).
Each user in the bwCloud-OS is initially assigned a home region during the setup. For users from the four operating locations this assignment is of course trivial. For users from other locations we have oriented ourselves to the network topology of the BelWü. The goal of the current assignment is the shortest possible connection of the respective location to one of our operating sites.


The following table gives a rough overview of the current distribution of users:
Resources such as virtual machines (VMs, instances), networks, and storage are bound to the region in which they are created. For example, an instance launched in the Mannheim region will receive an IP address from Mannheim’s specific IP range(s) — this address cannot be transferred to another region.


You can switch between regions in the Dashboard interface as described [[Registration#Region-Selection|here]].


{| class="wikitable"
== What is my "home region"? ==
! User location
<span id="Home-Region"></span>
! bwCloud-OS region = home region
|-
| Baden-Baden
| rowspan="5" | Karlsruhe
|-
| Karlsruhe
|-
| KIT
|-
| Pforzheim
|-
| Rastatt
|-
| Offenburg
| rowspan="3" | Freiburg
|-
| Freiburg
|-
| Furtwangen
|-
| Aalen
| rowspan="8" | Ulm
|-
| Albsing
|-
| Bieberach
|-
| Esslingen
|-
| Heidenheim
|-
| Hohenheim
|-
| Ulm
|-
| Weingarten
|-
| Gmünd
| rowspan="13" | Mannheim
|-
| Heidelberg
|-
| Heilbronn
|-
| Ludwigsburg
|-
| Mannheim
|-
| Rottenburg
|-
| Stuttgart
|-
| BSZ-BW
|-
| DHBW-VS
|-
| Konstanz
|-
| Reutlingen
|-
| Tübingen
|-
| Every other location
|}
<div style="font-size:smaller; text-align:left;">Status: July 2018</div>


In bwCloud-OS, each user is initially assigned a '''home region''' during account setup. For users from one of the four operating sites (Freiburg, Karlsruhe, Mannheim, Ulm), this assignment is straightforward. For users from other institutions, the assignment is based on the network topology of [https://www.belwue.de/ BelWue] — aiming to route each user to the nearest operating site for optimal connectivity. However, you can [[Projects and Quota#Group-Project-Application|apply for a project]] with resources (also) in other regions.


A table showing the current home region assignments can be found [[Regions|here]].


== Where do I select the region in the Dashboard? ==
<span id="Region-Selection"></span>


 
You can select a region from the drop-down menu located on the left side of the top navigation bar in the [https://portal.bw-cloud.org/ Dashboard]. The currently active region is marked with a checkmark. Simply click on a different region in the list to switch to it.
In order to determine the home region, we evaluate the "affiliation" of the users during registration. If a user comes from a location that is not explicitly listed in the table, the Freiburg region is used as the default home region.
[[File:Region selection.png|center|thumb|722x722px]]
 
== Where do I select the region in the dashboard? ==
In the left half of the top navigation bar in the dashboard you can click on a drop-down menu to display the regions. The currently selected region is marked with a tick. A click on the respective region switches there.
 
[[File:Select region dashboard.png|border|center|thumb|722x722px]]

Latest revision as of 18:07, 10 November 2025

In a Nutshell
  • Access to bwCloud-OS requires an active account from a bwIDM-participating institution.
  • Your account must include a valid entitlement, assigned by your home institution. This is usually automatic. If it is missing (see here), contact your institution’s IT support. The bwCloud-OS team cannot assign entitlements.
  • Log in once to the Dashboard to activate your profile. Setup is automated via bwIDM.
  • After login, select your region as described here to begin using bwCloud-OS.


Entitlements

What are "bwIDM" and "entitlements"?

Every member of a higher education institution in Baden-Württemberg (university, college, PH, HAW, etc.) has a personal account for accessing the IT services provided by their institution. If the institution participates in the federated identity management system bwIDM, its members can also apply for additional IT services offered by other participating institutions.

To allow external IT services to identify users, certain personal data is transmitted during registration and/or use of the service. Federated identity management ensures, through a model of mutual trust, that the external service can verify the user’s affiliation with their institution — confirming that the account is valid and the user is officially recognized. Within the bwIDM Federation, participating institutions have agreed on a minimum set of personal data that is transmitted to external IT services. This includes standard attributes such as eduPersonPrincipalName, mail, and givenName.

Some services, however, require additional information — for example, whether a user’s home institution is authorized to access a particular external service. This is handled through the assignment of special attributes, such as eduPersonEntitlement, to the user's account.

Which entitlements are required to use bwCloud-OS?

To access and use bwCloud-OS, you need a valid bwCloud(-OS) entitlement. A detailed overview of current regulations can be found on the page Entitlements in bwCloud-OS.

📌 Note: The bwCloud(-OS) entitlement model is currently being restructured and subject to change.

How can I find out which entitlements my account contains?

To view information about bwIDM services linked to your account, log in to the "RegApp".

For detailed information on the entitlements associated with your account (including those for services not yet registered), navigate to:

Index → Personal Data → Shibboleth

In the Value column, you should see entries such as bwCloud-Basic or bwCloud-Extended. If such an entry containing bwCloud exists, you are entitled to register for and use bwCloud-OS. Which specific entitlement you have is determined by your home institution and cannot be changed by you or the bwCloud-OS team.

What should I do if my account has no bwCloud-OS entitlement assigned?

The assignment of entitlements is exclusively managed by your home institution. The bwCloud-OS team does not have the authority to add or remove entitlements on user accounts.

If your account lacks the necessary entitlement, please contact your institution’s central IT service department or service desk.

Regions

What does "region" mean in bwCloud-OS?

In bwCloud-OS, a region refers to one of the four operating sites: Freiburg, Karlsruhe, Mannheim, and Ulm. Each region runs its own infrastructure but is accessible through a shared interface (Dashboard).

Resources such as virtual machines (VMs, instances), networks, and storage are bound to the region in which they are created. For example, an instance launched in the Mannheim region will receive an IP address from Mannheim’s specific IP range(s) — this address cannot be transferred to another region.

You can switch between regions in the Dashboard interface as described here.

What is my "home region"?

In bwCloud-OS, each user is initially assigned a home region during account setup. For users from one of the four operating sites (Freiburg, Karlsruhe, Mannheim, Ulm), this assignment is straightforward. For users from other institutions, the assignment is based on the network topology of BelWue — aiming to route each user to the nearest operating site for optimal connectivity. However, you can apply for a project with resources (also) in other regions.

A table showing the current home region assignments can be found here.

Where do I select the region in the Dashboard?

You can select a region from the drop-down menu located on the left side of the top navigation bar in the Dashboard. The currently active region is marked with a checkmark. Simply click on a different region in the list to switch to it.