bwCloud-OS - Recent changes [en]

Guide: Instance Action Menu

Admin — Fri, 29 May 2026 11:54:45 GMT

💽 Storage Management

← Older revision		Revision as of 11:54, 29 May 2026
(One intermediate revision by the same user not shown)
Line 16:		Line 16:

	== 💽 Storage Management ==		== 💽 Storage Management ==
	* '''Attach / Detach Volume:''' Connects or disconnects persistent block storage (Cinder Volumes) to your instance. Volumes are ideal for storing data that must persist even if the instance is deleted or rebuilt.		* '''Attach / Detach Volume:''' Connects or disconnects persistent block storage (Cinder Volumes) to your instance. Volumes are ideal for storing data that must persist even if the instance is deleted or rebuilt. For more details see [[Guide:_Volumes_and_Images#Create_and_Attach_a_Volume\|here]].

	== ⚙️ Administration & Diagnostics ==		== ⚙️ Administration & Diagnostics ==
Line 37:		Line 37:
	* '''Soft Reboot Instance:''' Sends a graceful shutdown signal to the guest operating system, allowing it to close processes safely before rebooting (similar to typing <code>sudo reboot</code>).		* '''Soft Reboot Instance:''' Sends a graceful shutdown signal to the guest operating system, allowing it to close processes safely before rebooting (similar to typing <code>sudo reboot</code>).
	* '''Hard Reboot Instance:''' Forces an immediate restart at the hypervisor level (similar to pressing the physical reset button on a server). Use this only if the instance is unresponsive.		* '''Hard Reboot Instance:''' Forces an immediate restart at the hypervisor level (similar to pressing the physical reset button on a server). Use this only if the instance is unresponsive.
	* '''Shut Off Instance:''' Forcibly powers down the instance (virtual power plug pull). ''Please note that a stopped instance still incurs costs. To avoid incurring further costs, it must be deleted. (Applies only to Gen3; see [[Booking_Units\|Booking Units]].)''		* '''Shut Off Instance:''' Forcibly powers down the instance (virtual power plug pull). ⚠️''Please note that a stopped instance still incurs costs. To avoid incurring further costs, it must be deleted. (Applies only to Gen3; see [[Booking_Units\|Booking Units]].)''
	* '''Rebuild Instance:''' Re-installs the operating system from a selected image. '''Warning:''' All data on the local ephemeral root disk will be permanently destroyed. The instance retains its IP address and ID.		* '''Rebuild Instance:''' Re-installs the operating system from a selected image. '''Warning:''' All data on the local ephemeral root disk will be permanently destroyed. The instance retains its IP address and ID.
	* '''Delete Instance:''' Permanently destroys the instance and all ephemeral data. Attached volumes and Floating IPs will be detached but not deleted.		* '''Delete Instance:''' Permanently destroys the instance and all ephemeral data. Attached volumes and Floating IPs will be detached but not deleted.

	----		----

Instances (VMs)

Admin — Fri, 29 May 2026 11:53:05 GMT

What actions can I perform on a running instance?

← Older revision		Revision as of 11:53, 29 May 2026
(2 intermediate revisions by the same user not shown)
Line 126:		Line 126:
	#* <code>sudo resize2fs</code> (for ext4)		#* <code>sudo resize2fs</code> (for ext4)
	#* <code>sudo xfs_growfs</code> (for XFS)		#* <code>sudo xfs_growfs</code> (for XFS)


			= Managing Running Instances =

			== What actions can I perform on a running instance? ==

			Once your instance is running, you can manage its lifecycle, network, and storage directly from the dashboard.
			For a complete breakdown of all available options in the instance dropdown menu (like Snapshots, Resizing, or Shelving), please refer to our dedicated guide:


			➡️ [[Guide: Instance Action Menu\|Instance Action Menu Guide]]

Guide: Instance Action Menu

Admin — Fri, 29 May 2026 11:46:45 GMT

🌐 Network Configuration

← Older revision		Revision as of 11:46, 29 May 2026
(3 intermediate revisions by the same user not shown)
Line 10:		Line 10:
	== 🌐 Network Configuration ==		== 🌐 Network Configuration ==
	These options manage how your instance communicates internally and externally.		These options manage how your instance communicates internally and externally.
	* '''Associate / Disassociate Floating IP:''' Assigns a public IP address to your instance, making it accessible from the internet (e.g., for SSH or web servers). Use ''Disassociate'' to remove the public IP and free it up for other resources.		* '''Associate / Disassociate Floating IP:''' Assigns a public IP address to your instance, making it accessible from the internet (e.g., for SSH or web servers). Use ''Disassociate'' to remove the public IP and free it up for other resources. See [[Guide:_Routers_and_Floating_IPs\|here]] for more details.
	* '''Attach / Detach Interface:''' Adds or removes a virtual Network Interface Card (NIC). This is useful if your instance needs to connect to multiple separate private networks simultaneously.		* '''Attach / Detach Interface:''' Adds or removes a virtual Network Interface Card (NIC). This is useful if your instance needs to connect to multiple separate private networks simultaneously.
	* '''Edit Security Groups:''' Allows you to attach or detach Security Groups (virtual firewalls). These groups define which incoming (ingress) and outgoing (egress) traffic is permitted for the instance.		* '''Edit Security Groups:''' Allows you to attach or detach Security Groups (virtual firewalls). These groups define which incoming (ingress) and outgoing (egress) traffic is permitted for the instance.
Line 32:		Line 32:
	* '''Shelve / Unshelve Instance:''' Shuts down the instance and moves it off the compute node into image storage. This completely frees up your allocated CPU and RAM quota. ''Unshelving'' restores the instance to a new compute node.		* '''Shelve / Unshelve Instance:''' Shuts down the instance and moves it off the compute node into image storage. This completely frees up your allocated CPU and RAM quota. ''Unshelving'' restores the instance to a new compute node.

	== ⚠️ ~~Critical~~ System Actions ==		== ⚠️ System Actions ==
	These actions severely impact the instance lifecycle and are often marked in red in the dashboard to prevent accidental clicks.		These actions severely impact the instance lifecycle and are often marked in red in the dashboard to prevent accidental clicks.
	* '''Resize Instance:''' Changes the instance's flavor (e.g., upgrading from ''m1.small'' to ''m1.medium''). This requires the instance to be restarted and the resize action to be explicitly confirmed afterwards.		* '''Resize Instance:''' Changes the instance's flavor (e.g., upgrading from ''m1.small'' to ''m1.medium''). This requires the instance to be restarted and the resize action to be explicitly confirmed afterwards.
	* '''Soft Reboot Instance:''' Sends a graceful shutdown signal to the guest operating system, allowing it to close processes safely before rebooting (similar to typing <code>sudo reboot</code>).		* '''Soft Reboot Instance:''' Sends a graceful shutdown signal to the guest operating system, allowing it to close processes safely before rebooting (similar to typing <code>sudo reboot</code>).
	* '''Hard Reboot Instance:''' Forces an immediate restart at the hypervisor level (similar to pressing the physical reset button on a server). Use this only if the instance is unresponsive.		* '''Hard Reboot Instance:''' Forces an immediate restart at the hypervisor level (similar to pressing the physical reset button on a server). Use this only if the instance is unresponsive.
	* '''Shut Off Instance:''' Forcibly powers down the instance (virtual power plug pull).		* '''Shut Off Instance:''' Forcibly powers down the instance (virtual power plug pull). ''Please note that a stopped instance still incurs costs. To avoid incurring further costs, it must be deleted. (Applies only to Gen3; see [[Booking_Units\|Booking Units]].)''
	* '''Rebuild Instance:''' Re-installs the operating system from a selected image. '''Warning:''' All data on the local ephemeral root disk will be permanently destroyed. The instance retains its IP address and ID.		* '''Rebuild Instance:''' Re-installs the operating system from a selected image. '''Warning:''' All data on the local ephemeral root disk will be permanently destroyed. The instance retains its IP address and ID.
	* '''Delete Instance:''' Permanently destroys the instance and all ephemeral data. Attached volumes and Floating IPs will be detached but not deleted.		* '''Delete Instance:''' Permanently destroys the instance and all ephemeral data. Attached volumes and Floating IPs will be detached but not deleted.

	----		----

	~~=== Step-by-Step Example: Associating a Floating IP ===~~

	~~If you need your instance to be reachable from the outside world (e.g., for an SSH connection), you must assign it a Floating IP.~~

	~~# Navigate to '''Compute → Instances'''.~~
	~~# Locate your running instance in the list.~~
	~~# Open the dropdown menu on the right side and select '''Associate Floating IP'''.~~
	~~# A new window will appear:~~
	~~#* '''IP Address:''' Select an available IP from the list. If the list is empty, click the '''+ (Plus)''' button to allocate a new IP from the public pool.~~
	~~#* '''Port to be associated:''' Select the network interface of your instance that should receive the IP (usually, there is only one).~~
	~~# Click '''Associate'''. The Floating IP will now be displayed next to your internal IP in the instance list.~~

Guide: Instance Action Menu

Admin — Fri, 29 May 2026 11:40:09 GMT

Created page with "= Instance Action Menu (Dashboard Guide) = Once an instance is running, you can manage it using the dropdown menu located on the far right of the instance list ('''Compute → Instances'''). This menu provides various options for network, storage, power state, and instance lifecycle management. Below is an explanation of all available actions, grouped by their function. == 💾 Core Action: Snapshots == * '''Create Snapshot:''' This is typically the default button nex..."

New page

= Instance Action Menu (Dashboard Guide) =

Once an instance is running, you can manage it using the dropdown menu located on the far right of the instance list ('''Compute → Instances'''). This menu provides various options for network, storage, power state, and instance lifecycle management.

Below is an explanation of all available actions, grouped by their function.

== 💾 Core Action: Snapshots ==
* '''Create Snapshot:''' This is typically the default button next to the dropdown menu. It creates a complete, point-in-time image of the instance's current disk state. This snapshot can be used as a backup or as a template to launch new instances with the exact same configuration.

== 🌐 Network Configuration ==
These options manage how your instance communicates internally and externally.
* '''Associate / Disassociate Floating IP:''' Assigns a public IP address to your instance, making it accessible from the internet (e.g., for SSH or web servers). Use ''Disassociate'' to remove the public IP and free it up for other resources.
* '''Attach / Detach Interface:''' Adds or removes a virtual Network Interface Card (NIC). This is useful if your instance needs to connect to multiple separate private networks simultaneously.
* '''Edit Security Groups:''' Allows you to attach or detach Security Groups (virtual firewalls). These groups define which incoming (ingress) and outgoing (egress) traffic is permitted for the instance.
* '''Edit Port Security Groups:''' Manages security rules directly on the network port level, offering more granular control than instance-level security groups.

== 💽 Storage Management ==
* '''Attach / Detach Volume:''' Connects or disconnects persistent block storage (Cinder Volumes) to your instance. Volumes are ideal for storing data that must persist even if the instance is deleted or rebuilt.

== ⚙️ Administration & Diagnostics ==
* '''Edit Instance:''' Allows you to change basic metadata, such as the instance's display name.
* '''Update Meta''' Add or edit key-value tags associated with the instance. This can be used for organizational purposes or to trigger specific cloud-init scripts during boot.
* '''Console:''' Opens an interactive, web-based terminal directly in your browser (VNC/SPICE). This is crucial for troubleshooting if you lose SSH access due to network misconfiguration or firewall issues.
* '''View Log:''' Displays the console output and boot logs of the instance. This is the first place to look if an instance fails to boot properly.
* '''Rescue Instance:''' Reboots the instance using a temporary, minimal rescue operating system. Your original root disk is attached as a secondary drive, allowing you to fix broken file systems or recover a lost password.
* '''Lock / Unlock Instance:''' Prevents accidental changes, state modifications, or deletion of the instance by other users within the same project.

== ⏸️ Power States & Resource Management ==
These options allow you to temporarily halt an instance.
* '''Pause / Unpause Instance:''' Freezes the instance. The state is kept in RAM, allowing for an immediate resume. However, it still consumes compute resources on the host.
* '''Suspend / Resume Instance:''' Saves the current RAM state to disk and halts the instance. This frees up hypervisor resources, but resuming takes slightly longer than unpausing.
* '''Shelve / Unshelve Instance:''' Shuts down the instance and moves it off the compute node into image storage. This completely frees up your allocated CPU and RAM quota. ''Unshelving'' restores the instance to a new compute node.

== ⚠️ Critical System Actions ==
These actions severely impact the instance lifecycle and are often marked in red in the dashboard to prevent accidental clicks.
* '''Resize Instance:''' Changes the instance's flavor (e.g., upgrading from ''m1.small'' to ''m1.medium''). This requires the instance to be restarted and the resize action to be explicitly confirmed afterwards.
* '''Soft Reboot Instance:''' Sends a graceful shutdown signal to the guest operating system, allowing it to close processes safely before rebooting (similar to typing <code>sudo reboot</code>).
* '''Hard Reboot Instance:''' Forces an immediate restart at the hypervisor level (similar to pressing the physical reset button on a server). Use this only if the instance is unresponsive.
* '''Shut Off Instance:''' Forcibly powers down the instance (virtual power plug pull).
* '''Rebuild Instance:''' Re-installs the operating system from a selected image. '''Warning:''' All data on the local ephemeral root disk will be permanently destroyed. The instance retains its IP address and ID.
* '''Delete Instance:''' Permanently destroys the instance and all ephemeral data. Attached volumes and Floating IPs will be detached but not deleted.

----

=== Step-by-Step Example: Associating a Floating IP ===

If you need your instance to be reachable from the outside world (e.g., for an SSH connection), you must assign it a Floating IP.

# Navigate to '''Compute → Instances'''.
# Locate your running instance in the list.
# Open the dropdown menu on the right side and select '''Associate Floating IP'''.
# A new window will appear:
#* '''IP Address:''' Select an available IP from the list. If the list is empty, click the '''+ (Plus)''' button to allocate a new IP from the public pool.
#* '''Port to be associated:''' Select the network interface of your instance that should receive the IP (usually, there is only one).
# Click '''Associate'''. The Floating IP will now be displayed next to your internal IP in the instance list.

Guide: Project and Quota

Admin — Fri, 29 May 2026 08:18:17 GMT

List of quota flavors

← Older revision		Revision as of 08:18, 29 May 2026
(5 intermediate revisions by the same user not shown)
Line 47:		Line 47:
	!'''ram_gb'''		!'''ram_gb'''
	!'''volumes'''		!'''volumes'''
			! style="border-right: 3px solid #a2a9b1;" \| BEH/day
	!'''volumes_gb'''		!'''volumes_gb'''
	!'''backups'''		!'''backups'''
Line 62:		Line 63:
	\|0		\|0
	\|0		\|0
			\| style="border-right: 3px solid #a2a9b1;" \|
	\|0		\|0
	\|0		\|0
Line 77:		Line 79:
	\|1		\|1
	\|10		\|10
			\| style="border-right: 3px solid #a2a9b1;" \| 4
	\|100		\|100
	\|30		\|30
Line 92:		Line 95:
	\|2		\|2
	\|10		\|10
			\| style="border-right: 3px solid #a2a9b1;" \| 7
	\|100		\|100
	\|30		\|30
Line 107:		Line 111:
	\|4		\|4
	\|20		\|20
			\| style="border-right: 3px solid #a2a9b1;" \| 14
	\|200		\|200
	\|60		\|60
Line 122:		Line 127:
	\|8		\|8
	\|20		\|20
			\| style="border-right: 3px solid #a2a9b1;" \| 26
	\|200		\|200
	\|60		\|60
Line 137:		Line 143:
	\|16		\|16
	\|40		\|40
			\| style="border-right: 3px solid #a2a9b1;" \| 52
	\|400		\|400
	\|120		\|120
Line 152:		Line 159:
	\|32		\|32
	\|40		\|40
			\| style="border-right: 3px solid #a2a9b1;" \| 100
	\|400		\|400
	\|120		\|120
Line 167:		Line 175:
	\|*		\|*
	\|*		\|*
			\| style="border-right: 3px solid #a2a9b1;" \|
	\|*		\|*
	\|*		\|*
Line 176:		Line 185:
	\|*		\|*
	\|*		\|*
			\|}


			Below is the basic translation for calculating Booking Units (BEH). For full details and the complete calculation basis, please refer to the [https://wiki.bwcloud-os.de/index.php/Booking_Units Booking Units page].

			{\| class="wikitable"
			\|+
			! Resource
			! BEH/Day
			\|-
			\| 1 vCPU
			\| 1
			\|-
			\| 1 GB RAM
			\| 2
			\|-
			\| 10 GB Disk
			\| 1
	\|}		\|}

Cloud Migration Guide

Sia — Thu, 28 May 2026 09:52:34 GMT

← Older revision		Revision as of 09:52, 28 May 2026
(One intermediate revision by the same user not shown)
Line 5:		Line 5:
	{\| class="mw-message-box mw-message-box-warning"		{\| class="mw-message-box mw-message-box-warning"
	\| style="vertical-align:middle;" \| '''⚠️ IMPORTANT SHUTDOWN NOTICE:'''		\| style="vertical-align:middle;" \| '''⚠️ IMPORTANT SHUTDOWN NOTICE:'''
	The Gen2 infrastructure will be permanently shut down on '''September ~~15,~~ 2026'''. All projects and data that have not been migrated by this date will be irrevocably deleted. To use Gen3, you must clarify and apply for your entitlements (which are subject to costs) in a timely manner.		The Gen2 infrastructure will be permanently shut down in '''September 2026''' (refer to the [https://bwcloud-os.de/ '''bwCloud-OS website'''] for the exact date). All projects and data that have not been migrated to Gen3 by this date will be irrevocably deleted. To use Gen3, you must clarify and apply for your entitlements (which are subject to costs) in a timely manner.
	\|}		\|}

Guide: Network Configuration by Region

Sia — Thu, 28 May 2026 09:48:56 GMT

← Older revision		Revision as of 09:48, 28 May 2026
(One intermediate revision by the same user not shown)
Line 52:		Line 52:
	This setup allows users to migrate their instances and data from Gen2 to Gen3.		This setup allows users to migrate their instances and data from Gen2 to Gen3.

	* The coexistence period will last until 31. ~~August 2026~~.		* The coexistence period will last until September 2026. Refer to the [https://bwcloud-os.de/ bwCloud-OS website] for the exact date.

	After the transition period:		After the transition period:
Line 107:		Line 107:
	This setup allows users to migrate their instances and data from Gen2 to Gen3.		This setup allows users to migrate their instances and data from Gen2 to Gen3.

	* The coexistence period will last until 31. ~~August 2026~~.		* The coexistence period will last until September 2026. Refer to the [https://bwcloud-os.de/ bwCloud-OS website] for the exact date.
	* During this period, <code>provider_interim_net</code> is used as the flat external network.		* During this period, <code>provider_interim_net</code> is used as the flat external network.

Cloud Migration Guide

Sia — Thu, 28 May 2026 09:42:04 GMT

← Older revision		Revision as of 09:42, 28 May 2026
Line 5:		Line 5:
	{\| class="mw-message-box mw-message-box-warning"		{\| class="mw-message-box mw-message-box-warning"
	\| style="vertical-align:middle;" \| '''⚠️ IMPORTANT SHUTDOWN NOTICE:'''		\| style="vertical-align:middle;" \| '''⚠️ IMPORTANT SHUTDOWN NOTICE:'''
	The Gen2 infrastructure will be permanently shut down on '''~~August 31~~, 2026'''. All projects and data that have not been migrated by this date will be irrevocably deleted. To use Gen3, you must clarify and apply for your entitlements (which are subject to costs) in a timely manner.		The Gen2 infrastructure will be permanently shut down on '''September 15, 2026'''. All projects and data that have not been migrated by this date will be irrevocably deleted. To use Gen3, you must clarify and apply for your entitlements (which are subject to costs) in a timely manner.
	\|}		\|}

Guide: Load Balancers

Sia — Sun, 24 May 2026 13:06:34 GMT

← Older revision		Revision as of 13:06, 24 May 2026
(One intermediate revision by the same user not shown)
Line 60:		Line 60:
	= Load Balancer Setup and Backend Integration =		= Load Balancer Setup and Backend Integration =

			Install the client (preferably in a Python virtual environment):
			<pre>pip3 install python-octaviaclient</pre>
	== Create the load balancer ==		== Create the load balancer ==
	<pre>		<pre>

	openstack loadbalancer create \		openstack loadbalancer create \
	--name myLB \		--name myLB \

Cloud Migration Guide

Admin — Wed, 20 May 2026 12:04:07 GMT

Prerequisites

@@ Line 1: / Line 1: @@
 {| class="mw-message-box mw-message-box-warning"
-| style="vertical-align:middle;" | '''⚠️ Please Note:''' This page is currently being prepared.
+| style="vertical-align:middle;" | '''⚠️ Please Note:''' This guide is still work in progress.
 |}

Guide: ERP-API

As1844 — Tue, 12 May 2026 12:28:46 GMT

← Older revision		Revision as of 12:28, 12 May 2026
Line 23:		Line 23:
	This endpoint can be used for validating syntax and checking the interpretation of eligibility data.		This endpoint can be used for validating syntax and checking the interpretation of eligibility data.

	#Got to the [https://deverp.fr.bwcos.de/docs#/default/check_eligibility_eligibilities_validate_post eligibility validation endpoint]		# Got to the [https://deverp.fr.bwcos.de/docs#/default/check_eligibility_eligibilities_validate_post eligibility validation endpoint]
	# Click on the tryout button.		# Click on the tryout button.
	# Add your eligibility data into the formula.		# Add your eligibility data into the formula. E.g., <code>{ "cost_center": "ufr_netze2", "quota_flavor": "xtiny_1", "first_day_val": null, "last_day_val": null, "max_number_of_booking_units": null }</code>

	# Click on the execute button to send those data to our ERP.		# Click on the execute button to send those data to our ERP.
	# Inspect our results in the output windows below.		# Inspect our results in the output windows below.

Registration

As1844 — Tue, 12 May 2026 12:18:31 GMT

← Older revision		Revision as of 12:18, 12 May 2026
Line 29:		Line 29:
	# A user registers himself*herself.		# A user registers himself*herself.
	# bwIDM requests the creation of a user account by the bwCloud-OS and forwards a set of user data.		# bwIDM requests the creation of a user account by the bwCloud-OS and forwards a set of user data.
	# The bwCloud-OS parses the user data, including given [[Guide: Entitlement & Eligibility\|entitlements]].		# The bwCloud-OS parses the user data, including given [[Guide: Entitlement & Eligibility\|(quota-)entitlements]].
	# Based on these data, a user account and a start [[Projects and Quota\|project]] is created. The [[Guide: Entitlement & Eligibility#Quota flavors\|quota flavor]] given in the entitlement defines the project quota. If more than one [[Guide: Entitlement & Eligibility#Quota Entitlements\|quota eligibilities]] are given, a random one is chosen. [[Projects and Quota#Change-Eligibility\|The eligibility can later on be changed.]]		# Based on these data, a user account and a start [[Projects and Quota\|project]] is created. The [[Guide: Entitlement & Eligibility#Quota flavors\|quota flavor]] given in the entitlement defines the project quota. If more than one [[Guide: Entitlement & Eligibility#Quota Entitlements\|quota eligibilities]] are given, a random one is chosen. [[Projects and Quota#Change-Eligibility\|The eligibility can later on be changed.]]

Line 85:		Line 85:
	== As a customer (institute): Can I roll out the Gen3 entitlement along with the Gen2 entitlements? ==		== As a customer (institute): Can I roll out the Gen3 entitlement along with the Gen2 entitlements? ==
	Yes. The Gen2 environment only respects the Gen2 entitlements and the Gen3 environment only respects the Gen3 entitlements.		Yes. The Gen2 environment only respects the Gen2 entitlements and the Gen3 environment only respects the Gen3 entitlements.

			== As a customer (institute): What happens when I don't roll out quota-entitlements? ==
			This is possible. But then during [[Registration#What happens during the registration for the bwCloud-OS service?\|registration]] no quota is granted for the (start-)projects of the members from your institution. The (start-)project is linked with the [[Guide: Entitlement & Eligibility#Empty-eligibility\|empty-eligibility]]. In general, the users are prohibited from obtaining resources.

	= Regions =		= Regions =

Projects and Quota

As1844 — Tue, 12 May 2026 12:08:50 GMT

← Older revision		Revision as of 12:08, 12 May 2026
Line 175:		Line 175:
	To request additional quota please request the [[Projects and Quota#How can I change the eligibility and ownership of a project?\|change of the eligibility]]. Please note:		To request additional quota please request the [[Projects and Quota#How can I change the eligibility and ownership of a project?\|change of the eligibility]]. Please note:

	* For the [[Guide: Project and Quota\|project quota]] you need a respective [[~~Entitlement & Eligibility#How can I find out which entitlements I am owning?~~\|eligibility]].		* For the [[Guide: Project and Quota\|project quota]] you need a respective [[Registration\|eligibility]].

Entitlement & Eligibility

As1844 — Tue, 12 May 2026 12:08:13 GMT

As1844 deleted page Entitlement & Eligibility content was: "<span id="In-a-Nutshell"></span>{{InANutshell|An entitlement is given to users by its home organization and carries information about the eligibility. An eligibility is the privilege to consume resources within a project and therefore for generating costs.}}'''➡️ More information in the guide about Entitlement & Eligibility.''' = FAQ = =...", and the only contributor was "As1844" (talk)

Registration

As1844 — Tue, 12 May 2026 12:05:11 GMT

← Older revision		Revision as of 12:05, 12 May 2026
Line 59:		Line 59:

	== Is a centralized service planned to manage eligibility directly in the bwCloud-OS? ==		== Is a centralized service planned to manage eligibility directly in the bwCloud-OS? ==
	Not yet. ~~This sounds like~~ a complex service. There are plenty of ~~[[Guide: Entitlement & Eligibility#Central eligibility platform\|~~questions for this central service]] we have to ask in advance.		Not yet. Providing a rule-based assignment of eligibilities is a complex service. There are plenty of questions for this central service we have to ask in advance. E.g. What data can be used to treat user? ..

	== What entitlement do I have to become a member of an existing project? ==		== What entitlement do I have to become a member of an existing project? ==

Guide: Entitlement & Eligibility

As1844 — Tue, 12 May 2026 12:02:01 GMT

← Older revision		Revision as of 12:02, 12 May 2026
(One intermediate revision by the same user not shown)
Line 12:		Line 12:

	* Entitlements are strings assigned to a user carrying information about his/her privileges.		* Entitlements are strings assigned to a user carrying information about his/her privileges.
	* Every [[Guide: Entitlement & Eligibility#Quota Entitlements\|quota entitlements]] (which can be ~~seen as~~ a "package") contains an eligibility. After "unpacking", the bwCloud-OS works only with the eligibility. This is kind of a "protocol" to communicate with the [[Guide: Enterprise Resource Planning\|Enterprise Resource Planning (ERP)]].		* Every [[Guide: Entitlement & Eligibility#Quota Entitlements\|quota entitlements]] (which can be considered a "package") contains an eligibility data. After "unpacking", the bwCloud-OS works only with the eligibility. This is kind of a "protocol" to communicate with the [[Guide: Enterprise Resource Planning\|Enterprise Resource Planning (ERP)]].
	* Every user owns at least the [[Guide: Entitlement & Eligibility#Empty Entitlement\|empty eligibility]].		* Every user owns at least the [[Guide: Entitlement & Eligibility#Empty Entitlement\|empty eligibility]].
	* Every [[Projects and Quota\|project]] needs to be linked with an eligibility.		* Every [[Projects and Quota\|project]] needs to be linked with an eligibility.
Line 27:		Line 27:
	=== Quota Entitlements ===		=== Quota Entitlements ===
	A quota entitlement consists of two parts, the namespace and the identifier (eligibility):		A quota entitlement consists of two parts, the namespace and the identifier (eligibility):
	<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''~~ELIGIBILITY~~'''		<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''ELIGIBILITY_DATA'''
	bzw.		bzw.
	<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''<quota_flavor>:<cost_center>[:<first_day_of_validation\|null>:<last_day_of_validation\|null>:<max_booking_units\|null>]'''		<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''<quota_flavor>:<cost_center>[:<first_day_of_validation\|null>:<last_day_of_validation\|null>:<max_booking_units\|null>]'''
	The ~~syntax~~ for ~~valid eligibilitues~~ is ~~described~~ in the sections ~~below~~.		=== Entitlement structure for eligibilities ===
			The following structure for a eligibiltiy may be used to provide further information and define constraints for the quota flavor:
			'''<quota_flavor>:<cost_center>'''[:CONSTRAINTS]
			respectively
			'''<quota_flavor>:<cost_center>'''[:<first_day_of_validation\|null>:<last_day_of_validation\|null>:<max_booking_units\|null>]
			Further explenation is provided in the next sections.

	=== Access Entitlement ===		=== Access Entitlement ===
Line 44:		Line 49:

	== Eligibility ==		== Eligibility ==
	Every project is associated with an ~~entitlement~~, making sure the project is chargeable.		Every project is associated with an eligibility, making sure the project is chargeable.

	* An eligibility is a unique combination of owner, quota flavor, and cost center.		* An eligibility is a unique combination of owner, quota flavor, and cost center.
	* An eligibility can be assigned to a maximum of one project~~. The eligibility-project association is therefore unique~~. The Eligibility-Project-Mapping is a <code>1:{0..1}</code>-Mapping.		* An eligibility can be assigned to a maximum of one project. The Eligibility-Project-Mapping is a <code>1:{0..1}</code>-Mapping. The eligibility-project association is therefore unique.
	* A limit value for BEH and validation dates may be set to restrict the duration of an eligibility.		* A limit value for BEH and validation dates may be set to restrict the duration of an eligibility.
	* The eligibility owner is dedicated to the home organization named in <code><nowiki>http://bwidm.de/bwidmOrgId</nowiki></code>, not by pattern in the cost center.		* The eligibility owner is dedicated to the home organization named in <code><nowiki>http://bwidm.de/bwidmOrgId</nowiki></code>, not by pattern in the cost center.
	=== ~~Structure~~ ===		=== Owner ===
	~~Optionally~~, the ~~following structure for Eli may be used to provide further information and define constraints for~~ the ~~quota flavor:~~		The user holding the eligibility, e.g., the account carrying the related entitlement, owns the eligibility.
	~~'''<quota_flavor>:<cost_center>'''[:CONSTRAINTS]~~
	~~respectively~~
	~~'''<quota_flavor>:<cost_center>'''[:<first_day_of_validation\|null>:<last_day_of_validation\|null>:<max_booking_units\|null>]~~

	=== Quota flavors ===		=== Quota flavors ===
Line 60:		Line 62:

	* A user can have several quota flavors.		* A user can have several quota flavors.
	* A quota flavor can be specified ~~several~~ times by using different cost centers. Each additional eligibility can be used for another project.		* A quota flavor can be specified many times by using different cost centers. Each additional eligibility can be used for another project.

	The given quota flavor name must be within the [[Guide: Project and Quota#List of quota flavors\|list of support project quota flavors]].		The given quota flavor name must be within the [[Guide: Project and Quota#List of quota flavors\|list of support project quota flavors]].
Line 70:		Line 72:

	==== Custom-eligibility ====		==== Custom-eligibility ====
	The quota flavor associated with this eligibility represents not a fixed set of resources. Further more, the owner of this eligibility is allowed to [[Projects and Quota#How can I request an additional quota?\|request via ticket]] an arbitrarily large and individual combination of resources. The entitlement looks similar to this		The quota flavor associated with this eligibility represents not a fixed set of resources. Further more, the owner of this eligibility is allowed to [[Projects and Quota#How can I request an additional quota?\|request via ticket]] an arbitrarily large and individual combination of resources. The entitlement associated with this eligibility looks similar to this
	<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''custom:'''<cost_center>		<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group</nowiki>:'''custom:'''<cost_center>

Registration

As1844 — Tue, 12 May 2026 11:51:26 GMT

← Older revision		Revision as of 11:51, 12 May 2026
(2 intermediate revisions by the same user not shown)
Line 50:		Line 50:
	* [[Guide: Entitlement & Eligibility#Entitlement URN structure\|Entitlement]] is classified into two types:		* [[Guide: Entitlement & Eligibility#Entitlement URN structure\|Entitlement]] is classified into two types:
	** The [[Guide: Entitlement & Eligibility#Quota Entitlements\|access entitlement]] defines the privilege for using the bwCloud-OS.		** The [[Guide: Entitlement & Eligibility#Quota Entitlements\|access entitlement]] defines the privilege for using the bwCloud-OS.
	** [[Guide: Entitlement & Eligibility#Quota Entitlements\|Quota entitlements]] containing an eligibility.		** [[Guide: Entitlement & Eligibility#Quota Entitlements\|Quota entitlements]] containing the data for the eligibility.

	== As a customer (institute): What do I need to prepare my IDM for the bwCloud-OS Gen3? ==		== As a customer (institute): What do I need to prepare my IDM for the bwCloud-OS Gen3? ==
Line 83:		Line 83:
	We are aware that you wish to budget, control, and manage your expenses. Therefore, we designed these features. However, currently we need to get used to a large set of new processes. If the bwCloud-OS accomplishes this, additional features will be supported.		We are aware that you wish to budget, control, and manage your expenses. Therefore, we designed these features. However, currently we need to get used to a large set of new processes. If the bwCloud-OS accomplishes this, additional features will be supported.

			== As a customer (institute): Can I roll out the Gen3 entitlement along with the Gen2 entitlements? ==
			Yes. The Gen2 environment only respects the Gen2 entitlements and the Gen3 environment only respects the Gen3 entitlements.

	= Regions =		= Regions =

Guide: ERP-API

As1844 — Tue, 12 May 2026 10:27:08 GMT

← Older revision		Revision as of 10:27, 12 May 2026
(2 intermediate revisions by the same user not shown)
Line 1:		Line 1:
	➡️ '''To the [[Guide: Enterprise Resource Planning\|Enterprise Resource Planning]].'''		➡️ '''To the [[Guide: Enterprise Resource Planning\|Enterprise Resource Planning]].'''

	The bwCloud-OS provides an ERP with a RESTful API that allows our customers to overview and manage the accounting data and resources of their members. Mainly, this means to manage entitlements and eligibilities.

	__TOC__		__TOC__

			The bwCloud-OS provides an ERP with a RESTful API that allows our customers to overview and manage the accounting data and resources of their members. Mainly, this means to manage entitlements and eligibilities.

	== Entitlement ==		== Entitlement ==

	=== Entitlement validation ===		=== Entitlement validation ===
	~~{\| class="mw-message-box mw-message-box-warning"~~		This endpoint can be used for validating syntax and checking the interpretation of an entitlement string.
	~~\| style="vertical-align:middle;" \|'''⚠️ Please Note:''' This endpoint is in a late testing phase and will be available soon.~~
	\|}This endpoint can be used for validating syntax and checking the interpretation of an entitlement string.

	~~==== Entitlement~~ validation ~~example 2 ====~~		# Got to the [https://deverp.fr.bwcos.de/docs#/default/check_entitlement_entitlements_validate_post entitlement validation endpoint]
	~~JSON Data:~~ <code>{"~~entitlement~~": "<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group:xtiny_1:~~hfu_netze2~~</nowiki>"}</code>		# Click on the tryout button.
			# Add your entitlement into the formula. E.g. <code>{ "value": "<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group:xtiny_1:ufr_netze2</nowiki>"}</code>
			# Click on the execute button to send those data to our ERP.
			# Inspect our results in the output windows below.

	~~Return~~: ~~<code>{'quota_flavor': 'xtiny_1', 'cost_center_id'~~: ~~'hfu_netze2', 'first_day_of_validation': '2025-12-19', 'last_day_of_validation': 'inf', 'max_number_of_booking_units': 'inf'}</code>~~		[[File:Entitlement validate endpoint.png\|center\|thumb\|761x761px\|[[File:Entitlement validate 2.png\|thumb\|Endpoint section for the entitlement validation with input formula and output fields,]]Endpoint section in the API for the entitlement validation.]]

	~~'''~~Entitlement ~~validation example~~ 2~~'''~~

	~~JSON Data: <code>{"~~entitlement~~": "<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group:xtiny_1:hfu_netze2</nowiki>"}</code>~~

	~~Return: <code>{'quota_flavor': 'xtiny_1', 'cost_center_id': 'hfu_netze2', 'first_day_of_validation': '2026-02-01'~~, ~~'last_day_of_validation': '2027-01-31', 'max_number_of_booking_units': 'inf'}</code>~~

	~~'''Entitlement validation example 3'''~~

	~~JSON Data: <code>{"~~entitlement~~": "<nowiki>urn:geant:dfn.de:bwidm:bwcloud-os:group:xtiny_1:hfu_netze2:null:2027-01-32:null</nowiki>"}</code>~~

	~~Return: <code>Error parsing eligibility. Invalid last day of~~ validation ~~format: 2027-01-32~~.~~</code>~~

	== Eligibility ==		== Eligibility ==

	~~=== Eligibility rules ===~~
	~~{\| class="mw-message-box mw-message-box-warning"~~
	~~\| style="vertical-align:middle;" \|'''⚠️ Please Note:''' Providing this functionalities is optional and still to plan.~~
	\|}
	This endpoint may be extended to allow customers to manage eligibility. By defining rules that can be applied to bwCloud-OS users when matching certain criteria. ''E.g. If the user is a member of the medicine faculty, grant the small quota flavor.'' However, the use cases and requirements for this are yet not cleare.

	* As a customer, I want a service where my local support can define rules for rolling out eligibility, such that new users from my organization gain automatic quotas.
	* As a customer, I want to control who is allowed to manage and see cost centers, user groups, and personal information, such that only privileged people can grant quotas.
	* As a customer, I forward (all?) information of my stuff to this external service, such that I can define precise rules.(?)
	* As a user, I want to see the eligibilities I am owning, such that I can plan how to debit these.

	~~There are plenty of questions the bwCloud-OS needs to address to their customers before it gets clear what kind of centralized service actually is needed and weather it will be accepted.~~

	=== Eligibility validation ===		=== Eligibility validation ===
	~~{\| class="mw-message-box mw-message-box-warning"~~		This endpoint can be used for validating syntax and checking the interpretation of eligibility data.
	~~\| style="vertical-align:middle;" \|'''⚠️ Please Note:''' This endpoint is in a late testing phase and will be available soon.~~
	\|}This endpoint can be used for validating syntax and checking the interpretation of eligibility data.

	~~'''Eligibility validation example 1'''~~

	~~JSON Data: <code>{"quota_flavor": "large_1", "cost_center_id": "student", "first_day": "2026-01-01", "last_day": "2026-12-31", "max_booking_units": 5000}</code>~~

	~~Return: <code>{'quota_flavor': 'large_1', 'cost_center_id': 'student', 'first_day_of_validation': '2026-01-01', 'last_day_of_validation': '2026-12-31', 'max_number_of_booking_units': 5000}</code>~~

	~~'''Eligibility validation example 2'''~~

	~~JSON Data~~: ~~<code>{"quota_flavor": "large_1", "cost_center_id": "student", "first_day": "2026-01-01", "last_day": "2027-12-32", "max_booking_units": 5000}<~~/~~code>~~		#Got to the [https://deverp.fr.bwcos.de/docs#/default/check_eligibility_eligibilities_validate_post eligibility validation endpoint]
			# Click on the tryout button.
			# Add your eligibility data into the formula.

	~~Return: <code>Error parsing eligibility~~. ~~Invalid last day of validation format: 2027-01-32~~.~~</code>~~		# Click on the execute button to send those data to our ERP.
			# Inspect our results in the output windows below.

File:Entitlement validate 2.png

As1844 — Tue, 12 May 2026 10:17:11 GMT

As1844 uploaded File:Entitlement validate 2.png

New page

Endpoint section for the entitlement validaton