Enabling Maintenance Mode

Use Application Maintenace Mode to put up a notification page for your users when your app is in maintenance (see example). You'll use maintenance mode whenver you need to:

  • Make a code deployment that requires downtime.
  • Make a change to an underlying service which is going to required downtime for an app.
  1. Introducing Maintenance Mode
  2. How Maintenance Mode Works
  3. Enabling Maintenance Mode
    1. Login to Droppanel
    2. Turn on Maintenance
    3. Wait for The Maintenance Page to Boot
    4. Check that Maintenance is Enabled
    5. Disable Maintenance Mode
  4. Additional Options
    1. Keep Alive
    2. Configuration

Introducing Maintenance Mode

Often times when deploying applications, its not always possible to do a live deployment, and thus downtime may be necessary. Sometimes this happens if for example major changes need to be made to a database before the new version can be deployed, or if you are migrating to a completely new installation. Droppanel will help you easily enable and disable maintenance mode in these situations.

How Maintenance Mode Works

Droppanel enables maintenance mode by dynamically routing your public IP endpoint to a specific maintenance server and bypassing your application instances. This makes it very easy to toggle maintenance mode on and off without impacting your production servers. It also allows you to easily customize your maintenance page without impacting the application.

Enabling Maintenance Mode

  • Login to Droppanel and go to the App that will be put into maintenance.

  • Turn on Maintenance

    From the App screen, there is a section called "Maintenance" under the Application Endpoint. This section controls maintenance mode for the application. Enable maintenance mode by clicking the button

    .
    Droppanel Maintenance
    some description about the image
  • Wait for The Maintenance Page to Boot

    Droppanel will spin up a new droplet to host the maintenance page before switching the public IP to this droplet. While it is booting you will see this:

    Deploying Droppanel Maintenance Server
    What an app looks like while waiting for the maintenance server to deploy
  • Check that Maintenance is Enabled

    Once Droppanel finishes installing the maintenance droplet, it will put the application into maintenance mode by switching the Public IP from your application instances to the maintenance server. It will look like this:

    Deploying Droppanel Maintenance Server
    What an app looks like when it is in maintenance

    Click on the Public IP to ensure that the maintenance page is properly serving.

  • Disable Maintenance Mode

    When you are done performing maintenace on your application, click the or to disable maintenance mode any put the App back into production.

Additional Options

There are a few additional options available in the maintenance section to manage your maintenance activities:

Keep Alive

By default, Droppanel only creates a maintenance server when needed. This saves money at digital ocean because the maintenance server will be a droplet in your DigitalOcean account and costs money. However, it takes about 60 seconds to spin up the maintenance server. If you want to go into maintenance mode a lot, consider turning Keep Alive to on. Droppanel will keep the maintenance server active between maintenances, thereby speeding up going into maintenance mode.

Configuration

The image for the maintenance can be customized to your particular use case. Edit the configuration where you'll be able to change a few settings:

Maintenance Output

Edit the HTML that will be served by the maintenance server. Any valid markup can be allowed here. No additional files can be saved, so include all of your Javascript and CSS in this page. Embed any images at base64 encoded.

Image Size

You can change the image/droplet size used for the maintenance server. This may be necessary for very heavy traffic situations. For most applications the default size of 512mb & 1 vCPU should be enough.