Moodle Plugin Upgrade 2017 ( )

Transcription

1 Moodle Plugin Upgrade 2017 ( ) Overview Panopto has released a major upgrade as of Panopto Moodle Block ( ). This update improves performance, functionality, and addresses a number of Moodle-related work items within our block. When upgrading from Panopto version or prior to or later, please read this entire article and plan accordingly. Note: This article is for Panopto Moodle Block between version and This article does not apply to the latest version of Panopto Moodle Block anymore. Please see this article instead. 1. Moodle Down-Time This upgrade process requires the reprovisioning of all Panopto folders. This operation will require some temporary downtime and Moodle will become inaccessible during the upgrade duration. We recommend pre-scheduling for this downtime while the work is conducted. Below is an example of the expected duration, which was completed on our Panopto Cloud System. Keep in mind that other factors may impact this performance such as hardware specs and network speed. Please refer to this number as just a rough example. We recommend if at all possible, testing with an internal server first to determine your specific downtime windows. 1,000 Courses, 10,000 Users, each user enrolled within 3 courses Moodle Server using 4 core machines Required Downtime (Example): 50 minutes 2. Supported Version 2.1. Plugin ( ) or later supports the following versions only: Moodle Version 3.1 or Later Panopto Version or Later 2.2. If either of these versions does not meet the criteria, please upgrade first before continuing. Note: The Panopto Cloud system (*.hosted.panopto.com and *.cloud.panopto.eu) already satisfy the Panopto Version. 3. Preparation The upgrade process requires two preparations which were not needed in the typical plugin upgrade process.. Set the Moodle user who will invoke this upgrade as a user. This is required only 3.1 Panopto Admin during the upgrade and you may revert it after the upgrade if you'd like.

2 3.2. Sign into Panopto as an administrator account. This can be a different user from the Moodle user who will be completing the upgrade process Search and find the account who will actually be performing the Moodle upgrade within the Users page Click on the Info tab within their account Check Administrator in the System Roles, and click Update Roles Extend the maximum execution time from PHP and the hosting web server (e.g. Apache) to long enough to complete this upgrade. This Moodle FAQ explains how to achieve it: If this maximum time is reached, the Moodle server may return a 500 error. In this case, you may need to extend the execution time and then rerun the upgrade process. There is no need to rollback, which is explained below In the case that a rollback is needed to a previous version, we recommend rotating the previous block used prior to upgrading To get the current version of the Panopto block go to Site Administration -> Plugins -> Plugin Overview and search for ' block_panopto' Please see below under ' Rollback of upgrade' for more information on how to actually complete this process. 4. Upgrade Operation 4.1. Go to your Panopto site and change the Moodle identity provider setting as ' Plug-in generation 2' (See Figure 1). Figure Go to your Moodle instance and upgrade the Panopto plugin as normal from the Moodle UI. You may

3 also update from the server's command line if you'd like. In this case, you may want to backup the old plugin directory by renaming it At the last step of the upgrade, the migration portion runs and this is where normal access to your Moodle site will be restricted The upgrade process will output the progress to the web server's error log. However, since the process is run in the background, the logs will not be updated until the process finishes in either a success or failure If the upgrade page looks unresponsive this means the upgrade is still working. If the process hits any unexpected issues, the upgrade will fail and the error_log will be updated with all of the progress that was made prior to the failure. For example, you can view the last message by typing the below for Apache2 on CentOS. Other Os/Web servers may use a different location for the logging. tail -f /var/log/httpd/error_log 5. Upgrading via the Command Line Interface (CLI) 5.1. Attempt the upgrade through the CLI. 5.1.a. We expect the upgrade should fail but the error message should indicate which Panopto User the upgrade encountered issues. 5.1.b. Temporarily set this User as an Admin in Panopto. 5.1.c. Repeat the previous steps for each Panopto server configured against your Moodle site Once the upgrade has completed successfully, revoke the admin access temporarily granted above 6. Rollback of the upgrade Note: If the upgrade fails for some reason, for example, a server communication failure, follow these steps Do Not Uninstall the Panopto plug-in from your Moodle UI, as this will cause Moodle to force a database clean of all the plugin data. Follow the below steps for a Panopto rollback Go to Site Administration -> Plugins -> Install Plugins Drag a.zip version of the desired Panopto block you wish to roll back to into the installer via drag & drop This will now prompt a red ' Downgrade' warning/error, which is expected Open the Moodle database and run the following query to revert the plugin state back to the old version, this will skip the ' Cannot Downgrade' error within Moodle. UPDATE `<moodle_db>`.`mdl_config_plugins` SET `value`='<rollback_version>' WHERE `plugin` =

4 '<plugin_name' AND `name` = 'version'; 6.6. Refresh the page to retry the downgrade. The error should now disappear and the upgrade should succeed as desired Once the upgrade completes, if anything is found incorrect or not desirable, you may rollback the plug-in version to an older version (unless you have done the cleanup work explained in the next section). 7. Cleanup of old provisioning information 7.1. This upgrade does not clean up the access permissions given by the older plug-in. That means if a user enrolls in a course prior to the upgrade and that user un-enrolls from the course after the upgrade, the access is not revoked If you want to clean up old permissions and are confident that a plugin rollback is not necessary, please contact Panopto support to request it. 8. Q: Is this upgrade Mandatory? A: No, this is not a mandatory update as of June However, we strongly recommend that you upgrade to the latest version during your next available service window is possible, as our future development and bug fixes will target this latest build. As of this update, previous versions of the Moodle plugin will only receive critical security bug fixes. In June 2018, we also plan to deprecate the API used by older versions of the Moodle plugin. At that time, older versions of the Moodle plugin may not work. 9. Upgrade Process for Mooderooms Customers If your Moodle system is hosted by Moodlerooms, you need a special operation for this upgrade. Moodlerooms will upgrade Panopto block version at one specific time. Mooderooms team will reach out to you about the schedule. Data migration associated with this version update needs to be initiated by the Moodle administrator from its UI. After Moodlerooms notifies you that the version update completes, please follow this instruction. Before this data migration happens, Moodle itself will continue to work and most of Panopto contents will still be accessible. However, newly enrolled users to an existing course will not be able to access their Panopto course folders until this operation is complete Sign in to Moodle as a Moodle Admin user Make sure this user has Panopto's admin user's privilege. You may confirm from the list of user's in Panopto's UI. If it's not clear, contact Panopto support for help Go to Panopto's block admin page. You will see " Upgrade all existing folders and imports" link (Fig.

5 2). Figure You will see a new page. Click the " Begin Upgrading Folders" button (Fig. 3). Figure Please wait as it may take some downtime as explained in section 1 of this document. However, in this Moodlerooms specific step, the Moodle site will continue to work as usual for Moodle users (no downtime).. Progress is reported on UI as seen in the figure below (Fig. 4). 9.6 Note: This UI update happens in batches and it may not be smoothly updated item by item. You may examine the php error log for more precise progress. As far as you see new outputs from the upgrade_all_folders.php in the log, the data migration process is still processing.

6 Figure After all operation completes, you will see a link at the bottom that says " Back to config" (Fig. 5). Figure Panopto, Inc. All rights reserved.