Direkt zum Hauptinhalt

Update-Schritte

Schilderung typischer to-dos und AbläufeAbläufe fürfür Moodle-Updates

Moodle-Updates gliedern sich in folgende typischen Phasen, wobei auf dieser Wiki-Seite vor allem technische Themen dokumentiert werden sollen:

  1. Sichten neuer Funktionen und UI-ÄnderungenÄnderungen
  2. Installieren und Konfigurieren auf Testsystem (ggf. mehrfach)
  3. Testing auf Testsystem
  4. Dokumentieren der Neuerungen
  5. Update-AnkündigungAnkündigung
  6. Generalprobe auf Testsystem
  7. Update-DurchführungDurchführung Produktiv-System inkl. DB-Backup + Frontend-config
  8. Troubleshooting

1. Sichten neuer Funktionen und UI-ÄnderungenÄnderungen

Es lassen sich drei Kategorien von ÄnderungenÄnderungen benennen: Konfiguration, Funktionen/Features, User Interface/Layout. Als erstes sollte die Moodle-Dokumentation sorgfältigsorgfältig gelesen werden, zuvorderst die Docs-Seite zu Upgrading und dort der Bereich "Possible issues that may affect you in Moodle", z.B. fürfür Moodle 5.1: https://docs.moodle.org/501/en/Upgrading#Possible_issues_that_may_affect_you_in_Moodle_5.1
Die neuen Funktionen werden auf der Release-Seite kurz benannt mit Links zu den entsprechenden Tracker-Einträgen,Einträgen, wo mehr Details und meist Screenshots zu finden sind. Die New Features Seite geht auf die (aus Sicht des Headquaters) wichtigsten ÄnderungenÄnderungen ein. Diese werden meist auch noch in einem Screencast per YouTube vorgestellt (Playlist oben auf New Features Seite verlinkt). ÄnderungenÄnderungen am Layout und der Umgang damit werden im Bereich Moodle Testing nähernäher beschrieben.

Liste aller Neuerungen (Beispiel Moodle 5.1): https://moodledev.io/general/releases/5.1

Neue FunktionalitätenFunktionalitäten / New Features: https://docs.moodle.org/de/Neue_Funktionalit%C3%A4ten / https://docs.moodle.org/en/New_features

YouTube-Videos Moodle: https://www.youtube.com/@moodle/playlists (Videos zu Moodle 5.1)

Dag Klimas macht auch oft Videos zu den neuen Features, z.B. Moodle 5.1 - Was hat sich geändert,geändert, was ist neu? und Moodle 5.2 - Was hat sich geändert, was ist neu?

2. Installieren und Konfigurieren auf Testsystem

Die Installation wird nach bevorzugter Variante der Administration durchgeführt,durchgeführt, z.B. mit Hilfe von Ansible-Playbooks. Dies baut aus verschiedenen Quellen das angepasste Installationspaket. Neben den Moodle core-Dateien sind dies z.B. Moodle Plugins aus github oder modifzierte Plugins aus interner Quelle sowie die config.php Dateien. Das Testsystem (staging) sollte eine möglichstmöglichst mit dem live-System übereinstimmendeübereinstimmende Kopie sein, mit gleichen Server-Einstellungen (inkl. php.ini) und Moodle-Konfiguration. Davon ausgehend wird zur Vorbereitung des live-Updates der komplette Update-Prozess auf staging durchlaufen (siehe 6.), meist auch mehrfach, bis zu einer fehlerfrei laufenden Version.
Praxis-Tipp: Beim installieren auffallende Probleme und nötigenötige Anpassungen wie Konfigurationen sollten gut auffindbar und nachvollziehbar dokumentiert werden. Hier kann auch eine Art Vorlage hilfreich sein. 

3. Testing auf staging

Die Details sind nähernäher beschrieben auf der Seite Moodle Testing. Ziel ist ein fehlerfrei laufendes System, erfahrungsgemäßerfahrungsgemäß treten am ehesten Fehler in nicht-Core Komponenten sowie im Layout auf. Als Nebeneffekt des Testings werden dabei die ÄnderungenÄnderungen der neuen Version kennengelernt. 

4. Dokumentieren der Neuerungen

Als ÜbersichtÜbersicht fürfür alle user sollte fürfür major-Releases ein Neuerungen-Dokument erstellt werden oder auf andere Weise überüber die ÄnderungenÄnderungen informiert werden. Auch angepasste user-Tours könnenkönnen hierbei unterstützen.unterstützen. 

5. Update-AnkündigungAnkündigung

Updates sollten mit ausreichend Vorlauf angekündigtangekündigt werden, sodass die user sich auf die maximale Ausfallzeit einstellen können,können, möglichemögliche Info-Kanäle:Kanäle:
  • Moodle-Startseite, z.B. mit Boost Union via Banner
  • Websites Störungs-Störungs- und Wartungsmeldungen (z.B. Rechenzentrum)
  • Foren / Lehrenden-Foren
  • Info-Chats

6. Generalprobe auf Testsystem

Aufs staging-System wird eine Kopie der live-Datenbank eingespielt und sichergestellt, dass die Versions-Dateien auf den Webservern dazu passen. Dann werdendie neuen Dateien eingespielt und der komplette Update-Prozess simuliert. 

7. Update-DurchführungDurchführung Produktiv-System inkl. DB-Backup + Frontend-config

Zuerst ist ein Datenbank-Backup zu erstellen, z.B. mittels pgadmin. Jetzt wird es ernst: Wartungsmodus per CLI aktivieren: sudo -u www_mdl /usr/bin/php admin/cli/maintenance.php ––enable

Zugriff fürfür Administratoren währendwährend Wartungszeit:

Der Wartungsmodus muss per Frontend gestartet werden (/admin/settings.php?section=maintenancemode) oder via /maintenance.php --enableold, dann könnenkönnen admin-Accounts Moodle weiter nutzen oder sich auch neu einloggen via /login/index.php?username=[Anmeldename]
Wird /cli/maintenance.php aufgerufen, ist die Site auch fürfür admins gesperrt. 

Dann wird das live-System mittels vorbereitetem Job aktualisiert. Upgrade per CLI oder im Frontend, dann ist der AktualisierungsschlüsselAktualisierungsschlüssel einzugeben und der Update-Fortschritt wird verfolgt. Wichtig: auf live dauert es meist deutlich längerlänger als auf den Testsystemen (trotz DB-Kopie), z.B. weil noch mehr Daten im Cache sind. Ist das Update durchgelaufen, sind die vorher definierten Konfigurationsanpassungen im admin-Frontend einzustellen. Zum Abschluss wird der Wartungsmodus wieder deaktiviert (maintenance.php ––disable).

Wenn gepflegt, kann noch ein "to-dos nach dem Update" abgearbeitet werden. Zudem sollten minor- und Major-Updates in einem Changelog dokumentiert werden, dazu auch wenn neue Plugins hinzu kamen.

8. Troubleshooting (bei Bedarf)

Sollte etwas nicht wie geplant und im Vorfeld getestet funktionieren: don´don´t panic! In diesem Fall sind die Debbuging-Methoden anzuwenden. Zudem wie immer auch die debugging- und logging-Meldungen sichten. im Normalfall fallen die Probleme bereits im Testing auf, weshalb ein sorgfältigessorgfältiges Testen mit einer möglichstmöglichst identischen live-System-Kopie wichtig ist. 
Hier ein Beispiel. 

Aktivieren Debug-Modus mittels config.php 

//=========================================================================
// 7. SETTINGS FOR DEVELOPMENT SERVERS - not intended for production use!!!
//=========================================================================
//
// Force a debugging mode regardless the settings in the site administration
@error_reporting(E_ALL | E_STRICT);   // NOT FOR PRODUCTION SERVERS! @ini_set('display_errors', '1');         // NOT FOR PRODUCTION SERVERS! $CFG->debug = (E_ALL | E_STRICT);   // === DEBUG_DEVELOPER - NOT FOR PRODUCTION SERVERS! $CFG->debugdisplay = 1;              // NOT FOR PRODUCTION SERVERS!

Hinweis: E_STRICT ist ab PHP 8.4 deprecated und wird dereinst nicht mehr setzbar sein.

SQL-Abfragen anzeigen:
$CFG->upgradeshowsql = true;

Dadurch werden alle SQL-Befehle währendwährend des Upgrades ausgegeben und wie lange sie geladen haben ("Query took"), das sieht dann in der Konsole z.B. so aus:

-------------------------------- DECLARE crs7 NO SCROLL CURSOR WITH HOLD FOR SELECT * FROM mdl_capabilities [array ( )] -------------------------------- Query took: 0.00043296813964844 seconds. --------------------------------

https://docs.moodle.org/de/Aktualisierung_von_Moodle

Autor: Klaus Steitz, TU Darmstadt