ASynchronous Backup and Restore Specification - Revision history

Sarjona: This page will not be migrated to new devdocs

2025-02-07T15:35:00Z

This page will not be migrated to new devdocs

← Older revision		Revision as of 15:35, 7 February 2025
Line 1:		Line 1:
			{{Template:WillNotMigrate}}

	{{DISPLAYTITLE:Asynchronous Backup and Restore Specification}}		{{DISPLAYTITLE:Asynchronous Backup and Restore Specification}}
	{{Infobox Project		{{Infobox Project

Jprovasnik: Title was "ASynchronous" and I made the "S" lower case to be "Asynchronous"

2024-04-11T14:45:40Z

Title was "ASynchronous" and I made the "S" lower case to be "Asynchronous"

← Older revision		Revision as of 14:45, 11 April 2024
Line 1:		Line 1:
			{{DISPLAYTITLE:Asynchronous Backup and Restore Specification}}
	{{Infobox Project		{{Infobox Project
	\|name = Asynchronous Backup and Restore		\|name = Asynchronous Backup and Restore
Line 81:		Line 82:

	''' Notes and things to discuss '''		''' Notes and things to discuss '''

			{{DEFAULTSORT:Asynchronous_Backup_and_Restore_Specification}}

Mudrd8mz: Text replacement - "class="nicetable"" to "class="wikitable""

2021-07-14T13:22:42Z

Text replacement - "class="nicetable"" to "class="wikitable""

← Older revision		Revision as of 13:22, 14 July 2021
Line 55:		Line 55:

	=== List of backup/restore types that should happen asynchronously ===		=== List of backup/restore types that should happen asynchronously ===
	{\| class="~~nicetable~~"		{\| class="wikitable"
	\|-		\|-
	! Operation		! Operation

Damyon at 14:30, 28 October 2012

2012-10-28T14:30:39Z

← Older revision		Revision as of 14:30, 28 October 2012
Line 28:		Line 28:
	* Sending notifications that a backup/restore is complete		* Sending notifications that a backup/restore is complete
	* Preventing a user from queuing multiple identical backup restores		* Preventing a user from queuing multiple identical backup restores
			* Allow cancelling a backup/restore

	== Relevant tracker issues ==		== Relevant tracker issues ==

Damyon at 14:29, 28 October 2012

2012-10-28T14:29:38Z

← Older revision		Revision as of 14:29, 28 October 2012
Line 4:		Line 4:
	\|tracker = MDL-28505		\|tracker = MDL-28505
	\|discussion = -		\|discussion = -
	~~\|contributors = -~~
	}}		}}

Damyon at 14:27, 28 October 2012

2012-10-28T14:27:44Z

← Older revision		Revision as of 14:27, 28 October 2012
Line 33:		Line 33:

	* MDL-28505 - Asynchronous course backup / restore		* MDL-28505 - Asynchronous course backup / restore

			== Notes from Hackfest 2012 ==

			https://docs.google.com/document/d/1EUuZIukG56EnU-gjmvxjmD9biJZX3b5SSdjTnhL1mG4/edit?pli=1

	== Implementation plan ==		== Implementation plan ==

Damyon at 16:00, 27 October 2012

2012-10-27T16:00:38Z

@@ Line 20: / Line 20: @@
 This project aims to:
-* For all backup and restore operations in core Moodle to happen asynchronously in order to
+* Make user course/activity backup and restore operations in core Moodle to happen asynchronously in order to:
 ** Allow backup and restores through the UI of courses that would normally fail with a timeout
 ** Allow backup and restore operations to be carried out on dedicated nodes in a cluster (to prevent session locks and load on the app serving nodes)
@@ Line 48: / Line 48: @@
 * Reuses existing backup/restore ui classes to generate the interface
 * Instead of executing the operation saves the backup/restore controller to a queue
 * Provide a cli script for pulling N backups off the queue and executing them
 === Database schema ===

Damyon at 15:54, 27 October 2012

2012-10-27T15:54:46Z

← Older revision		Revision as of 15:54, 27 October 2012
Line 6:		Line 6:
	\|contributors = -		\|contributors = -
	}}		}}
	~~{{Moodle 2.5}}~~

	== Project goals ==		== Project goals ==

Damyon: Created page with "{{Infobox Project |name = Asynchronous Backup and Restore |state = Proposed |tracker = MDL-28505 |discussion = - |contributors = - }} {{Moodle 2.5}} == Project goals == * Long-..."

2012-10-27T15:54:10Z

Created page with "{{Infobox Project |name = Asynchronous Backup and Restore |state = Proposed |tracker = MDL-28505 |discussion = - |contributors = - }} {{Moodle 2.5}} == Project goals == * Long-..."

New page

{{Infobox Project
|name = Asynchronous Backup and Restore
|state = Proposed
|tracker = MDL-28505
|discussion = -
|contributors = -
}}
{{Moodle 2.5}}

== Project goals ==

* Long-term goal: For all backup and restore operations in core Moodle to happen asynchronously
* Short-term goal: To allow a plugin to change the default Moodle operation so backup and restore operations happen asynchronously
* To prevent timeouts from long running backup/restore operations
* To allow backups and restores to happen on dedicated node(s) in a clustered environment

== Project scope ==

This project does NOT change the UI of backup and restore except as required in order for users to monitor the backup and restore queue.

This project aims to:

* For all backup and restore operations in core Moodle to happen asynchronously in order to
** Allow backup and restores through the UI of courses that would normally fail with a timeout
** Allow backup and restore operations to be carried out on dedicated nodes in a cluster (to prevent session locks and load on the app serving nodes)

Things that must be decided and designed carefully:

* Reporting errors to the user from a backup and restore operation
* Sending notifications that a backup/restore is complete
* Preventing a user from queuing multiple identical backup restores

== Relevant tracker issues ==

* MDL-28505 - Asynchronous course backup / restore

== Implementation plan ==

=== Immediately (2.5?) ===
* New admin tool plugin for contrib called asyncbackup

=== Later (2.X) ===
* Move the code into core but perform the backup and restores in cron by default (to cater for small sites/default installs)

== Design for plugin ==
* Should be a new admin tool plugin in contrib (asyncbackup)
* Removes default backup/restore links from the settings block for courses and activities
* Adds equivalent links which call it's own backup/restore pages
* Reuses existing backup/restore ui classes to generate the interface
* Instead of executing the operation saves the backup/restore controller to a queue
* Provide a cli script for pulling N backups off the queue and executing them

=== Database schema ===

''' Notes and things to discuss '''