Skip to main content

Teaching vacancies - Maintenance mode

The application has a simple routing-level maintenance mode triggered by the MAINTENANCE_MODE environment variable. This needs the app to be restarted to enable maintenance mode, e.g. via a deploy or a cf restage. This is handy in case of a critical bug being discovered where we need to take the service offline, or in case of maintenance where we want to avoid users interacting with the service.

When enabled, all requests of all types will be routed to the maintenance page (found under app/views/errors/maintenance.html.erb).

Enable Maintenance mode

  • Login to AKS:

    az login --tenant 9c7d9dd3-840c-4b3f-818e-552865082e16

  • Set maintenance mode environment variable:

    kubectl  -n tv-production set env  deployment/teaching-vacancies-production MAINTENANCE_MODE=1

  • The pods will get automatically restarted with the new value.

  • Check that the page is in maintenance mode.

Disable Maintenance mode

  • To disable maintenance mode, set the environment variable value to 0

    kubectl  -n tv-production set env  deployment/teaching-vacancies-production MAINTENANCE_MODE=0

  • The pods will get automatically restarted with the new value.

  • Check that the page is no longer in maintenance mode.

Let users know a for future maintenance

We can let users know in advance about a future maintenance period for the service through the Scheduled Maintenance Banner Component.

Rendering this component above the header layout in the application layout will display the banner on top of the website on production environment.

Remember to remove this component from the layout once the maintenance has been finished.

EG:

= render ScheduledMaintenanceBannerComponent.new(date: "5th October 2023", start_time: "8:00", end_time: "9:30")
= render "layouts/header"