Authentication: Outage manager

auth_outage
Maintained by Picture of Catalyst ITCatalyst IT, Picture of Brendan HeywoodBrendan Heywood, Picture of James VoongJames Voong
A plugin to manage outage periods, such as scheduled maintenance, including CLI tools to embed in your scripting.
175 sites
87 downloads
14 fans
Current versions available: 2

This is a Moodle plugin which makes the student experience of planned outages nicer, and provides extra tools for administrators and testers that help before and after the outage window.

The main idea is that instead of an outage being a very boolean on/off situation, this plugin creates the concept of graduated outages where at predefined times before an outage and after, different levels of warning and access can be provided to students and testers letting them know what is about to happen and why.



If you need support for Moodle 2.x ...

... you can still use this plugin but you will need to manually set up an additional local plugin contained, for more information please refer to: https://github.com/catalyst/moodle-local_outage

Screenshots

Screenshot #0

Contributors

Picture of Catalyst IT
Catalyst IT (Lead maintainer)
Please login to view contributors details and/or to contact them

Comments RSS

Show comments
  • Picture of Daniel Thee Roperto
    Thu, Oct 13, 2016, 7:34 AM
    Hi David, if its not done automatically, can you run again the checks in the version I submitted yesterday? Thanks.
  • Picture of Dan Marsden
    Fri, Oct 14, 2016, 8:11 AM
    Hi Daniel,

    thanks for working on this plugin, I can see it being really useful to manage scheduled outages in a more user-friendly manner. The code is documented nicely and follows Moodle coding guidelines well, also great to see the behat and phpunit tests. My one objection is the inclusion of the local_outage plugin within the code which doesn't seem to be required unless you are running an older version. The version uploaded here in the plugins db for newer versions definitely shouldn't include it, and the version for 2.8 should have it listed as a dependency in the version.php file. Once that is resolved I think it is ready for general release so that others can give further feedback on it.
  • Picture of Daniel Thee Roperto
    Fri, Oct 14, 2016, 10:27 AM
    Hi Dan,

    Thank you for the information, I've just submitted the changes as version 1.0.3.


    Cheers,

    Daniel
  • Picture of David Mudrák
    Tue, Oct 25, 2016, 5:52 AM

    Thanks Daniel for fixing the raised issues promptly, and thanks Dan for the approval review. I just checked and can see that the only remaining blocker with the local_outage presence has been fixed so I am happy to approve this now. You are cleared to land, welcome to the Plugins directory!

  • Picture of Daniel Thee Roperto
    Tue, Oct 25, 2016, 6:38 AM
    I am happy to hear that, thanks David and Dan!
  • Picture of Daniel Thee Roperto
    Tue, Oct 25, 2016, 12:13 PM
    Hi David,

    Can you please transfer the Lead Maintainer to 'Catalyst IT': https://moodle.org/user/profile.php?id=2153863

    Cheers,
    Daniel
  • Picture of Jeff White
    Fri, Oct 28, 2016, 2:42 AM
    Hi there. Great plugin but there seems to be a few small issues. Admins cannot log onto Moodle when maintenance mode starts. This other one may be a configuration problem with my server if my website does 10.0.0.1/moodle and then I am redirected to the manage.php file within the plugin then i am sent to 10.0.0.1/auth/outage/manage.php
  • Picture of Daniel Thee Roperto
    Fri, Oct 28, 2016, 6:39 AM
    Hi Jeff,

    Can you provide a little but more information so I can reproduce the problem?

    I understand that your $CFG->wwwroot is 'http://10.0.0.1/moodle' but the redirection goes to 10.0.0.1/auth/outage/manage.php -- which gives you a NOT FOUND -- is that correct?

    If not, are you using the outage autostart mode? If you are using autostart mode Moodle will not be accessible anymore until you manually finish the maintenance mode.

    If you have a GitHub account you can open an issue in our repository at:
    https://github.com/catalyst/moodle-auth_outage

    Cheers,

    Daniel
  • Picture of Jeff White
    Sat, Oct 29, 2016, 3:03 AM
    Hi Daniel, That is correct I get a not found message.
    I will need to doublecheck the autostart mode part but basically admins could not even log onto the moodle instance. If that is intentional, how does an admin do any work within the GUI while in maintenance mode? I will really need to get back into github as your not the first person that has asked me to open an issue there. I will try to make time this weekend and report the info.
  • Picture of cwadmin 1
    Wed, Nov 9, 2016, 7:04 PM
    Hi,

    I also found that the plugin locks admins out of the site during the outage. This meant there was no way for admins to work in Moodle behind maintenance mode or to disable maintenance mode. I restored access by changing the "auth" database setting in the mdl_config table from "outage" to "manual".

    May only affect our site/theme, but also noticed that during the warning period the top-bar (i.e. with "My Courses", profile menu etc) didn't display. We're running Essential theme & latest version of Moodle.

    The plugin concept is great, but these two issues mean we can't use it yet.

    Happy to provide any details that would be helpful in resolving the two issues, just let me know. I used autostart for the outage.

    Thanks
  • Picture of Brendan Heywood
    Thu, Nov 10, 2016, 6:06 AM
    hi cwadmin,

    The core moodle cli maintenance mode locks everyone out, this isn't something we can, or would, change. However we are working on a new feature to be released soon which lets testers from certain ip ranges in during the shoulder of the outage period but while strict maintenance mode is no longer on. The typical use case being you start the outage, then enter cli maint mode, do the upgrade, turn off maint mode, at which point the testers can do their work while the students still see the outage message, then when the testers are happy the outage is finished and everyone can see moodle again.

    Also re the header of your theme not appearing, there is also a new config setting shortly to be released allowing css tweaks to adapt to any theme. The default css works in the default moodle bootstrap theme.

    cheers
    Brendan
  • Picture of Daniel Thee Roperto
    Mon, Mar 5, 2018, 7:16 AM
    Hi German,

    I created the issue https://github.com/catalyst/moodle-auth_outage/issues/127 so we can perform some testing before marking it compatible with newer Moodles. It seems like our testing goes up to Moodle 3.3 but I need to confirm that.

    Thank you for the information

    Daniel
  • Picture of Blair F.
    Sat, Jun 16, 2018, 1:10 AM
    I just found this and installed it on our 3.2 test sever. The Outage Manager settings page is completely blank. /admin/settings.php?section=authsettingoutage
1 2
Please login to post comments