Tapeworm - Revision history

Prins0891 at 09:26, 19 March 2026

2026-03-19T09:26:45Z

← Older revision		Revision as of 11:26, 19 March 2026
Line 1:		Line 1:
	= Tapeworm: Automated tape-archival of old datasets =		= Tapeworm: Automated tape-archival of old datasets =

	~~<div style="border:2px solid #d32f2f; background:#ffebee; padding:12px; margin:12px 0;">~~
	~~<b>Under construction:</b>~~
	~~<ul style="margin:8px 0 0 18px;">~~
	~~<li>This documentation page is under construction and may still contain some gaps.</li>~~
	~~<li>The Tapeworm application will be "In Production" from March 19.</li>~~
	~~</ul>~~
	~~</div>~~

	=== https://tapeworm.anunna.wur.nl/ ===		=== https://tapeworm.anunna.wur.nl/ ===

Prins0891: images updated to new GUI

2026-03-17T14:25:07Z

images updated to new GUI

← Older revision		Revision as of 16:25, 17 March 2026
Line 45:		Line 45:
	=== 1) Overview ===		=== 1) Overview ===
	This is your action page. It shows items that currently need your decision.		This is your action page. It shows items that currently need your decision.
	[[File:~~Tapeworm screen1~~.png\|~~frame~~\|~~left~~]]		[[File:Screenshot from 2026-03-17 15-19-46.png\|none\|thumb\|1400x1400px]]
	For each candidate, you can:		For each candidate, you can:
	* <b>Approve</b>: proceed with the tape move. It will schedule for the next day		* <b>Approve</b>: proceed with the tape move. It will schedule for the next day
Line 56:		Line 56:
	=== 2) Datasets ===		=== 2) Datasets ===
	This page shows your discovered datasets, their sizes, and last activity times. The application has no concept of what data belongs together and should be considered a 'dataset'. If the selections on this page are wrong, you can change how Tapeworm should handle these datasets instead.		This page shows your discovered datasets, their sizes, and last activity times. The application has no concept of what data belongs together and should be considered a 'dataset'. If the selections on this page are wrong, you can change how Tapeworm should handle these datasets instead.
			[[File:Screenshot from 2026-03-17 15-20-23.png\|none\|thumb\|1400x1400px]]
	[[File:~~User datasets~~.png\|~~frame~~\|~~none~~]]

	Important:		Important:
	* If a dataset already has an active move candidate, scheduling controls are disabled.		* If a dataset already has an active move candidate, scheduling controls are disabled.
Line 65:		Line 63:
	=== 3) Schedule ===		=== 3) Schedule ===
	This page shows move candidates and their status over time.		This page shows move candidates and their status over time.
			[[File:Screenshot from 2026-03-17 15-20-58.png\|none\|thumb\|1400x1400px]]
	[[File:~~User schedule~~.png\|~~frame~~\|~~none~~]]

	Common statuses:		Common statuses:
	* <b>Planned</b>: under review		* <b>Planned</b>: under review
Line 78:		Line 74:
	=== 4) Overrides ===		=== 4) Overrides ===
	Overrides tell Tapeworm to ignore specific paths in future planning.		Overrides tell Tapeworm to ignore specific paths in future planning.
			[[File:Screenshot from 2026-03-17 15-21-49.png\|none\|thumb\|1400x1400px]]
	[[File:~~User override~~.png\|~~frame~~\|~~none~~]]

	Use overrides when:		Use overrides when:
	* a project is still active and needs to remain on /archive		* a project is still active and needs to remain on /archive
Line 92:		Line 86:
	This page shows completed archival moves.		This page shows completed archival moves.
	When a dataset has been successfully archived and finalized, it is removed from active scheduling pages and moved into history.		When a dataset has been successfully archived and finalized, it is removed from active scheduling pages and moved into history.
			[[File:Screenshot from 2026-03-17 15-24-40.png\|none\|thumb\|1400x1400px]]
	[[File:~~User history~~.png\|~~frame~~\|~~none~~]]

	== Group pages ==		== Group pages ==

Prins0891 at 14:05, 17 March 2026

2026-03-17T14:05:42Z

← Older revision		Revision as of 16:05, 17 March 2026
Line 45:		Line 45:
	=== 1) Overview ===		=== 1) Overview ===
	This is your action page. It shows items that currently need your decision.		This is your action page. It shows items that currently need your decision.
	[[File:Tapeworm screen1.png\|~~none~~\|~~frame~~]]		[[File:Tapeworm screen1.png\|frame\|left]]
	For each candidate, you can:		For each candidate, you can:
	* <b>Approve</b>: proceed with the tape move. It will schedule for the next day		* <b>Approve</b>: proceed with the tape move. It will schedule for the next day

Prins0891 at 14:04, 17 March 2026

2026-03-17T14:04:56Z

← Older revision		Revision as of 16:04, 17 March 2026
Line 45:		Line 45:
	=== 1) Overview ===		=== 1) Overview ===
	This is your action page. It shows items that currently need your decision.		This is your action page. It shows items that currently need your decision.
			[[File:Tapeworm screen1.png\|none\|frame]]
	[[File:~~User overview 3~~.png\|frame~~\|none~~]]

	For each candidate, you can:		For each candidate, you can:
	* <b>Approve</b>: proceed with the tape move. It will schedule for the next day		* <b>Approve</b>: proceed with the tape move. It will schedule for the next day

Prins0891 at 13:58, 17 March 2026

2026-03-17T13:58:21Z

← Older revision		Revision as of 15:58, 17 March 2026
Line 29:		Line 29:
	# Tapeworm scans <code>/archive</code> and builds an index of paths and filesystem metadata.		# Tapeworm scans <code>/archive</code> and builds an index of paths and filesystem metadata.
	# A dataset discovery step groups those paths into datasets, determines size, owner, and last active use, and makes them available in the GUI. Very small datasets are filtered out and will not be shown.		# A dataset discovery step groups those paths into datasets, determines size, owner, and last active use, and makes them available in the GUI. Very small datasets are filtered out and will not be shown.
	# A policy engine checks which discovered datasets look stale (for example: 30+ days old and larger than 1GB).		# A policy engine checks which discovered datasets look stale (for example: 60+ days old and larger than 1GB).
	# Matching datasets are marked as <b>planned</b> and shown in your overview.		# Matching datasets are marked as <b>planned</b> and shown in your overview.
	# You will be notified by email that Tapeworm plans to move data you own		# You will be notified by email that Tapeworm plans to move data you own

Prins0891 at 14:55, 13 March 2026

2026-03-13T14:55:50Z

← Older revision		Revision as of 16:55, 13 March 2026
Line 22:		Line 22:
	If you do nothing, Tapeworm will continue with the planned move after the review period.		If you do nothing, Tapeworm will continue with the planned move after the review period.
	That is why we recommend checking your pending actions regularly. You will also receive notification emails about pending actions.		That is why we recommend checking your pending actions regularly. You will also receive notification emails about pending actions.

			From time to time, the user pages may temporarily be unavailable during maintenance. In that case, Tapeworm will show a short maintenance page instead of the normal interface.

	== How Tapeworm works ==		== How Tapeworm works ==

	# Tapeworm scans <code>/archive</code> and builds an index of datasets, size, owner, and last active use.		# Tapeworm scans <code>/archive</code> and builds an index of paths and filesystem metadata.
	# A policy engine checks which datasets look stale (for example: 30+ days old and larger than 1GB).		# A dataset discovery step groups those paths into datasets, determines size, owner, and last active use, and makes them available in the GUI. Very small datasets are filtered out and will not be shown.
			# A policy engine checks which discovered datasets look stale (for example: 30+ days old and larger than 1GB).
	# Matching datasets are marked as <b>planned</b> and shown in your overview.		# Matching datasets are marked as <b>planned</b> and shown in your overview.
	# You will be notified by email that Tapeworm plans to move data you own		# You will be notified by email that Tapeworm plans to move data you own
Line 68:		Line 71:

	Common statuses:		Common statuses:
	* <b>Planned</b> ~~(or <b>planned + notified</b>)~~: under review		* <b>Planned</b>: under review
	* <b>Scheduled</b>: move is planned for a specific date		* <b>Scheduled</b>: move is planned for a specific date
	* <b>Executing / Tape staged / On tape</b>: move is in progress or completed		* <b>Executing / Tape staged / On tape</b>: move is in progress or completed
Line 148:		Line 151:
	Usually because the move has already progressed (executing/staged/on tape/error), so schedule edits are no longer valid.		Usually because the move has already progressed (executing/staged/on tape/error), so schedule edits are no longer valid.

	=== Why do ~~I see “planned + notified”~~? ===		=== Why do some paths on /archive/ not appear as datasets in Tapeworm? ===
	~~That means the dataset move is planned~~ and a ~~notification has already been sent~~.		Tapeworm only shows paths that are discovered as datasets and pass a minimum-size threshold. Very small paths, single text files, and other tiny items are intentionally filtered out.

	== Need help? ==		== Need help? ==
	If anything is unclear, or you think a move is incorrect but you cannot alter it in the provided GUI, please open an HPC support ticket.		If anything is unclear, or you think a move is incorrect but you cannot alter it in the provided GUI, please open an HPC support ticket.

Itter003 at 11:57, 12 March 2026

2026-03-12T11:57:43Z

← Older revision		Revision as of 13:57, 12 March 2026
Line 2:		Line 2:

	<div style="border:2px solid #d32f2f; background:#ffebee; padding:12px; margin:12px 0;">		<div style="border:2px solid #d32f2f; background:#ffebee; padding:12px; margin:12px 0;">
	<b>~~Warning~~:</b>		<b>Under construction:</b>
	<ul style="margin:8px 0 0 18px;">		<ul style="margin:8px 0 0 18px;">
	<li>This documentation page is under construction and may contain ~~errors~~.</li>		<li>This documentation page is under construction and may still contain some gaps.</li>
	<li>The Tapeworm application ~~is in beta and may contain errors~~.</li>		<li>The Tapeworm application will be "In Production" from March 19.</li>
	</ul>		</ul>
	</div>		</div>

Haars0011: Don't flow text around images

2026-03-03T17:31:45Z

Don't flow text around images

← Older revision		Revision as of 19:31, 3 March 2026
Line 43:		Line 43:
	This is your action page. It shows items that currently need your decision.		This is your action page. It shows items that currently need your decision.

	[[File:User overview 3.png\|~~left~~\|~~frame~~]]		[[File:User overview 3.png\|frame\|none]]

	For each candidate, you can:		For each candidate, you can:
Line 56:		Line 56:
	This page shows your discovered datasets, their sizes, and last activity times. The application has no concept of what data belongs together and should be considered a 'dataset'. If the selections on this page are wrong, you can change how Tapeworm should handle these datasets instead.		This page shows your discovered datasets, their sizes, and last activity times. The application has no concept of what data belongs together and should be considered a 'dataset'. If the selections on this page are wrong, you can change how Tapeworm should handle these datasets instead.

	[[File:User datasets.png\|~~left~~\|~~frame~~]]		[[File:User datasets.png\|frame\|none]]

	Important:		Important:
Line 65:		Line 65:
	This page shows move candidates and their status over time.		This page shows move candidates and their status over time.

	[[File:User schedule.png\|~~left~~\|~~frame~~]]		[[File:User schedule.png\|frame\|none]]

	Common statuses:		Common statuses:
Line 78:		Line 78:
	Overrides tell Tapeworm to ignore specific paths in future planning.		Overrides tell Tapeworm to ignore specific paths in future planning.

	[[File:User override.png\|~~left~~\|~~frame~~]]		[[File:User override.png\|frame\|none]]

	Use overrides when:		Use overrides when:
Line 92:		Line 92:
	When a dataset has been successfully archived and finalized, it is removed from active scheduling pages and moved into history.		When a dataset has been successfully archived and finalized, it is removed from active scheduling pages and moved into history.

	[[File:User history.png\|~~left~~\|~~frame~~]]		[[File:User history.png\|frame\|none]]

	== Group pages ==		== Group pages ==

Prins0891 at 15:39, 3 March 2026

2026-03-03T15:39:52Z

← Older revision		Revision as of 17:39, 3 March 2026
Line 15:		Line 15:

	With Tapeworm, you can:		With Tapeworm, you can:
	* See which of your datasets are being considered for tape archival.		* See which of your datasets are being considered for tape archival
	* Review planned moves before they happen.		* Review planned moves before they happen
	* Approve, snooze, or block moves when needed.		* Approve, snooze, or block moves when needed
	* Add metadata to help describe archived datasets. The metadata is included on tape and can be used to view/retrieve from tape, should you need to do so in the future.		* Add metadata to help describe archived datasets. The metadata is included on tape and can be used to view/retrieve from tape, should you need to do so in the future

	If you do nothing, Tapeworm will continue with the planned move after the review period.		If you do nothing, Tapeworm will continue with the planned move after the review period.
Line 46:		Line 46:

	For each candidate, you can:		For each candidate, you can:
	* <b>Approve</b>: proceed with the tape move. It will schedule for the next day.		* <b>Approve</b>: proceed with the tape move. It will schedule for the next day
	* <b>Deny</b>: stop this move, configure an override for this path. Tapeworm will not try to move this dataset/path again, until you choose to remove the override.		* <b>Deny</b>: stop this move, configure an override for this path. Tapeworm will not try to move this dataset/path again, until you choose to remove the override
	* <b>Snooze</b>: postpone the decision to a future date.		* <b>Snooze</b>: postpone the decision to a future date
	* <b>Edit metadata</b>: add key/value notes for archived data. These values are included on tape and can be used to view/retrieve datasets on tape.		* <b>Edit metadata</b>: add key/value notes for archived data. These values are included on tape and can be used to view/retrieve datasets on tape

	You can also select multiple rows and apply actions in bulk.		You can also select multiple rows and apply actions in bulk.
Line 68:		Line 68:

	Common statuses:		Common statuses:
	* <b>Planned</b> (or <b>planned + notified</b>): under review.		* <b>Planned</b> (or <b>planned + notified</b>): under review
	* <b>Scheduled</b>: move is planned for a specific date.		* <b>Scheduled</b>: move is planned for a specific date
	* <b>Executing / Tape staged / On tape</b>: move is in progress or completed.		* <b>Executing / Tape staged / On tape</b>: move is in progress or completed
	* <b>Error</b>: move needs admin attention. You may be contacted, maybe we resolve it ourselves :).		* <b>Error</b>: move needs admin attention. You may be contacted, maybe we resolve it ourselves :)

	Once a move is already executing or completed, schedule-changing actions are locked.		Once a move is already executing or completed, schedule-changing actions are locked.
Line 93:		Line 93:

	[[File:User history.png\|left\|frame]]		[[File:User history.png\|left\|frame]]

	~~History helps you answer:~~
	* what was moved,
	* when it moved,
	* where it went on tape.

	== Group pages ==		== Group pages ==
Line 115:		Line 110:

	Emails typically include:		Emails typically include:
	* ~~dataset~~ path,		* Dataset path
	* ~~size and last~~ activity,		* Size
	* ~~current~~ status,		* Last activity
	* ~~review~~/scheduled date.		* Current status
			* Review/scheduled date

	Notification types you may receive:		Notification types you may receive:
	* <b>Action required</b>: please approve, snooze, or deny.		* <b>Action required</b>: please approve, snooze, or deny
	* <b>Reminder</b>: review date is approaching.		* <b>Reminder</b>: review date is approaching
	* <b>Informational</b>: move status changed (for example scheduled, staging, or completed).		* <b>Informational</b>: move status changed (for example scheduled, staging, or completed)
	* <b>Escalation</b>: sent to group contacts when no user response is received.		* <b>Escalation</b>: sent to group contacts when no user response is received

	Please read these emails carefully — they are your chance to adjust decisions before execution.		Please read these emails carefully — they are your chance to adjust decisions before execution.
Line 130:		Line 126:
	== Best practices for users ==		== Best practices for users ==

	* Check your <b>Overview</b> page regularly.		* Check your <b>Overview</b> page regularly
	* Use <b>Snooze</b> if you need time to validate impact.		* Use <b>Snooze</b> if you need time to validate impact
	* Add <b>metadata</b> when approving important datasets.		* Add <b>metadata</b> when approving important datasets
	* Use <b>Overrides</b> for known exceptions.		* Use <b>Overrides</b> for known and persisting exceptions
	* If unsure, contact HPC support before a scheduled move date.		* If unsure, contact HPC support before a scheduled move date

	== FAQ ==		== FAQ ==

	=== What happens if I do nothing? ===		=== What happens if I do nothing? ===
	Planned items can move forward automatically after the review window (~~typically~~ 4 weeks).		Planned items can move forward automatically after the review window (4 weeks)

	=== Can I undo after tape staging? ===		=== Can I undo after tape staging? ===

Prins0891 at 15:25, 3 March 2026

2026-03-03T15:25:46Z

← Older revision		Revision as of 17:25, 3 March 2026
Line 25:		Line 25:
	== How Tapeworm works ==		== How Tapeworm works ==

	# Tapeworm scans <code>/archive</code> and builds an index of datasets, size, owner, and last ~~activite~~ use.		# Tapeworm scans <code>/archive</code> and builds an index of datasets, size, owner, and last active use.
	# A policy engine checks which datasets look stale (for example: 30+ days old and larger than 1GB).		# A policy engine checks which datasets look stale (for example: 30+ days old and larger than 1GB).
	# Matching datasets are marked as <b>planned</b> and shown in your overview.		# Matching datasets are marked as <b>planned</b> and shown in your overview.
Line 42:		Line 42:
	=== 1) Overview ===		=== 1) Overview ===
	This is your action page. It shows items that currently need your decision.		This is your action page. It shows items that currently need your decision.
	[[File:User overview 3.png\|frame~~\|center~~]]
			[[File:User overview 3.png\|left\|frame]]

	For each candidate, you can:		For each candidate, you can:
Line 55:		Line 56:
	This page shows your discovered datasets, their sizes, and last activity times. The application has no concept of what data belongs together and should be considered a 'dataset'. If the selections on this page are wrong, you can change how Tapeworm should handle these datasets instead.		This page shows your discovered datasets, their sizes, and last activity times. The application has no concept of what data belongs together and should be considered a 'dataset'. If the selections on this page are wrong, you can change how Tapeworm should handle these datasets instead.

	[[File:User datasets.png\|frame~~\|center~~]]		[[File:User datasets.png\|left\|frame]]

	Important:		Important:
Line 64:		Line 65:
	This page shows move candidates and their status over time.		This page shows move candidates and their status over time.

	[[File:User schedule.png\|frame~~\|center~~]]		[[File:User schedule.png\|left\|frame]]

	Common statuses:		Common statuses:
Line 77:		Line 78:
	Overrides tell Tapeworm to ignore specific paths in future planning.		Overrides tell Tapeworm to ignore specific paths in future planning.

	[[File:User override.png\|frame~~\|center~~]]		[[File:User override.png\|left\|frame]]

	Use overrides when:		Use overrides when:
Line 86:		Line 87:

	Overrides apply to the selected path and everything below it.		Overrides apply to the selected path and everything below it.

			=== 5) History ===
			This page shows completed archival moves.
			When a dataset has been successfully archived and finalized, it is removed from active scheduling pages and moved into history.

			[[File:User history.png\|left\|frame]]

			History helps you answer:
			* what was moved,
			* when it moved,
			* where it went on tape.

			== Group pages ==

			Group admins have a separate set of pages for their group scope:
			* <b>Group overview</b>
			* <b>Group datasets</b>
			* <b>Group schedule</b>
			* <b>Group overrides</b>
			* <b>Group history</b>

			If you manage more than one group, you can switch group scope in the selector at the top of the group pages.

	== Notifications (email) ==		== Notifications (email) ==

	Tapeworm sends email updates when actions are pending or dates are approaching.		Tapeworm sends email updates when actions are pending, dates are approaching, or move state changes happen.

	Emails typically include:		Emails typically include:
Line 96:		Line 119:
	* current status,		* current status,
	* review/scheduled date.		* review/scheduled date.

			Notification types you may receive:
			* <b>Action required</b>: please approve, snooze, or deny.
			* <b>Reminder</b>: review date is approaching.
			* <b>Informational</b>: move status changed (for example scheduled, staging, or completed).
			* <b>Escalation</b>: sent to group contacts when no user response is received.

	Please read these emails carefully — they are your chance to adjust decisions before execution.		Please read these emails carefully — they are your chance to adjust decisions before execution.
Line 110:		Line 139:

	=== What happens if I do nothing? ===		=== What happens if I do nothing? ===
	Planned items can move forward automatically after the review window.		Planned items can move forward automatically after the review window (typically 4 weeks).

	=== Can I undo after tape staging? ===		=== Can I undo after tape staging? ===
	Not directly in Tapeworm. Retrieval is done via the tape/iRODS workflow.		Not directly in Tapeworm. Retrieval is done via the tape/iRODS workflow.
	See: https://irods.wur.nl/userguide/tape_retrieval/		See: https://irods.wur.nl/userguide/tape_retrieval/

			=== What does “completed” mean? ===
			Completed means Tapeworm saw the tape workflow finish and finalized the move.
			Before finalization, the system verifies the archive in iRODS and only then removes the staged source copy.

	=== Why is an action button disabled? ===		=== Why is an action button disabled? ===