M Janczyk: M Janczyk moved page Workspaces/Advanced Features/ws restore to NEMO2/Workspaces/Advanced Features/ws restore

2026-03-02T19:39:30Z

M Janczyk moved page Workspaces/Advanced Features/ws restore to NEMO2/Workspaces/Advanced Features/ws restore

← Older revision	Revision as of 21:39, 2 March 2026
(No difference)

M Janczyk: /* Cluster-Specific Information */

2025-12-02T15:01:41Z

Cluster-Specific Information

← Older revision		Revision as of 17:01, 2 December 2025
Line 60:		Line 60:
	== Cluster-Specific Information ==		== Cluster-Specific Information ==

	Grace periods for expired/released workspaces vary by cluster ~~and are configured via the <tt>keeptime</tt> parameter in <tt>/etc/ws.conf</tt>~~:		Grace periods for expired/released workspaces vary by cluster:

	{\| class="wikitable"		{\| class="wikitable"
Line 90:		Line 90:

	'''Note:'''		'''Note:'''
	* '''Expired workspaces''' (reached end of lifetime) are kept for <tt>keeptime~~</tt> days configured in <tt>/etc/ws.conf~~</tt>		* '''Expired workspaces''' (reached end of lifetime) are kept for <tt>keeptime</tt>
	* '''Released workspaces''' (via <tt>ws_release</tt>) are kept until the next automated cleanup cycle		* '''Released workspaces''' (via <tt>ws_release</tt>) are kept until the next automated cleanup cycle
	* '''Actual deletion''' happens during automated cleanup runs, typically during nighttime		* '''Actual deletion''' happens during automated cleanup runs, typically during nighttime

M Janczyk at 14:48, 2 December 2025

2025-12-02T14:48:54Z

← Older revision		Revision as of 16:48, 2 December 2025
Line 1:		Line 1:
	= ws_restore - Restore Expired Workspace =		= ws_restore - Restore Expired Workspace =

	{\| class="wikitable"
	\|-
	!style="width:40%" \| Works on cluster
	!style="width:10%" \| bwUC 3.0
	!style="width:10%" \| BinAC2
	!style="width:10%" \| Helix
	!style="width:10%" \| JUSTUS 2
	!style="width:10%" \| NEMO2
	\|-
	\|<tt>ws_restore</tt>
	\|style="background-color:#90EE90; text-align:center;" \| ✓
	\|style="background-color:#90EE90; text-align:center;" \| ✓
	\|style="background-color:#90EE90; text-align:center;" \| ✓
	\|style="background-color:#90EE90; text-align:center;" \| ✓
	\|style="background-color:#90EE90; text-align:center;" \| ✓
	\|}

	For a certain (system-specific) grace time following workspace expiration, a workspace can be restored.		For a certain (system-specific) grace time following workspace expiration, a workspace can be restored.

M Janczyk: Created page with "= ws_restore - Restore Expired Workspace = {| class="wikitable" |- !style="width:40%" | Works on cluster !style="width:10%" | bwUC 3.0 !style="width:10%" | BinAC2 !style="width:10%" | Helix !style="width:10%" | JUSTUS 2 !style="width:10%" | NEMO2 |- |`ws_restore` |style="background-color:#90EE90; text-align:center;" | ✓ |style="background-color:#90EE90; text-align:center;" | ✓ |style="background-color:#90EE90; text-align:center;" | ✓ |style="background-col..."

2025-12-02T13:59:17Z

Created page with "= ws_restore - Restore Expired Workspace = {| class="wikitable" |- !style="width:40%" | Works on cluster !style="width:10%" | bwUC 3.0 !style="width:10%" | BinAC2 !style="width:10%" | Helix !style="width:10%" | JUSTUS 2 !style="width:10%" | NEMO2 |- |<tt>ws_restore</tt> |style="background-color:#90EE90; text-align:center;" | ✓ |style="background-color:#90EE90; text-align:center;" | ✓ |style="background-color:#90EE90; text-align:center;" | ✓ |style="background-col..."

New page

= ws_restore - Restore Expired Workspace =

{| class="wikitable"
|-
!style="width:40%" | Works on cluster
!style="width:10%" | bwUC 3.0
!style="width:10%" | BinAC2
!style="width:10%" | Helix
!style="width:10%" | JUSTUS 2
!style="width:10%" | NEMO2
|-
|<tt>ws_restore</tt>
|style="background-color:#90EE90; text-align:center;" | ✓
|style="background-color:#90EE90; text-align:center;" | ✓
|style="background-color:#90EE90; text-align:center;" | ✓
|style="background-color:#90EE90; text-align:center;" | ✓
|style="background-color:#90EE90; text-align:center;" | ✓
|}

For a certain (system-specific) grace time following workspace expiration, a workspace can be restored.

== Syntax ==

<tt>ws_restore [options] workspace_name target_name | -l</tt>

== Restore Procedure ==

'''(1) Display restorable workspaces:'''

$ ws_restore -l

This will list all workspaces that can still be recovered. You can use <tt>-b</tt> or <tt>--brief</tt> to hide the unavailability date in the list.

'''(2) Create a new workspace as the target for the restore:'''

$ ws_allocate restored 60

'''(3) Restore the expired workspace:'''

$ ws_restore <full_name_of_expired_workspace> restored

'''Important:'''
* The expired workspace must be specified using the '''full name''' as printed by <tt>ws_restore -l</tt> (not as printed by <tt>ws_list</tt>!), including username prefix and timestamp suffix (otherwise it cannot be uniquely identified)
* The target workspace must be given with just its '''short name''' as listed by <tt>ws_list</tt>, without the username prefix
* '''<tt>ws_restore</tt> can only work on the same filesystem.''' Ensure the new workspace is on the same filesystem as the expired workspace. Use <tt>-F <filesystem></tt> flag if needed

Example:

$ ws_restore username-myWs-0 restored

== Options ==

{| class="wikitable"
|-
!style="width:30%" | Option
!style="width:70%" | Description
|-
|<tt>-l</tt>, <tt>--list</tt>
|List restorable workspaces. '''Use this first''' to see what can be recovered
|-
|<tt>-b</tt>, <tt>--brief</tt>
|Do not show unavailability date in list (used with <tt>-l</tt>)
|-
|<tt>-n <name></tt>
|Workspace name (alternative to positional argument)
|-
|<tt>-t <target></tt>
|Existing target workspace name (alternative to positional argument)
|-
|<tt>-F <filesystem></tt>
|Specify filesystem where the workspace is located
|-
|<tt>-u <username></tt>
|Username (for restoring other users' workspaces if permitted)
|}

== Cluster-Specific Information ==

Grace periods for expired/released workspaces vary by cluster and are configured via the <tt>keeptime</tt> parameter in <tt>/etc/ws.conf</tt>:

{| class="wikitable"
|-
!style="width:30%" | Cluster
!style="width:35%" | Expired Workspace Retention (<tt>keeptime</tt>)
!style="width:35%" | Released Workspace Grace Period
|-
|bwUniCluster 3.0
|30 days
|Until next cleanup cycle
|-
|Helix
|System-specific (check with support)
|Until next cleanup cycle
|-
|JUSTUS 2
|System-specific (check with support)
|Until next cleanup cycle
|-
|BinAC2
|System-specific (check with support)
|Until next cleanup cycle
|-
|NEMO2
|30 days
|Until next cleanup cycle
|}

'''Note:'''
* '''Expired workspaces''' (reached end of lifetime) are kept for <tt>keeptime</tt> days configured in <tt>/etc/ws.conf</tt>
* '''Released workspaces''' (via <tt>ws_release</tt>) are kept until the next automated cleanup cycle
* '''Actual deletion''' happens during automated cleanup runs, typically during nighttime
* This allows users to recover accidentally released workspaces quickly, while giving more time for expired workspaces

For more information: <tt>$ ws_restore -h</tt> or <tt>man ws_restore</tt>

== If Workspace Cannot Be Restored ==

If the workspace is not visible/restorable, it has been '''permanently deleted''' and cannot be restored, not even by system administrators.

=== Helix-specific - Workspace Snapshots ===

On Helix, if the workspace can't be restored anymore using <tt>ws_restore</tt>, you can check the snapshots under:

/work/.snapshots/<timepoint>/ws/

'''Important notes about snapshots:'''
* Snapshots are point-in-time copies of the workspace filesystem
* Changes that happened since the last snapshot was created are lost
* Browse available snapshot timepoints in <tt>/work/.snapshots/</tt>
* '''Caution:''' The Helix team tries to keep the latest snapshots, but they cannot guarantee that snapshots will be available at all times
* Snapshots are a last resort when <tt>ws_restore</tt> no longer works

'''How to use snapshots:'''

$ ls /work/.snapshots/ # List available snapshot timepoints
$ cd /work/.snapshots/2025-11-15_00.00.00/ws/
$ ls # Find your old workspace directory
$ cp -r username-myWs-0 /path/to/active/workspace/ # Copy data to active workspace

Contact Helix support if you need assistance with snapshot recovery.

'''Please remember:''' Workspaces are intended solely for temporary work data, and there is '''no backup''' of data in the workspaces.

'''Recommendation:''' Email reminders are sent automatically. You can optionally customize reminder timing with <tt>-r</tt> option to be notified earlier, giving you time to extend the workspace or backup important data to appropriate permanent storage. See [[Workspaces/Advanced_Features/Reminders|Reminders & Configuration]].

NEMO2/Workspaces/Advanced Features/ws restore - Revision history

M Janczyk: M Janczyk moved page Workspaces/Advanced Features/ws restore to NEMO2/Workspaces/Advanced Features/ws restore

M Janczyk: /* Cluster-Specific Information */

M Janczyk at 14:48, 2 December 2025