Enable Deploy maintenance mode
This topic describes how to use maintenance mode in Deploy to safely restart the server and temporarily prevent new deployments and tasks from starting.
When the system is in maintenance mode:
- Deployments that have already started will be allowed to finish. You can use the Monitoring section to view deployments that are in progress.
- The
admin
user can continue to start new tasks. - Scheduled tasks are not prevented from starting.
Enable maintenance mode
Note: In a cluster setup, you must enable maintenance mode for each master node separately.
To enable maintenance mode:
- Click on gear icon and select Maintenance mode.
- Select the Enable maintenance mode checkbox.
- Optionally modify the user message with details about the outage and any relevant links. While maintenance mode is enabled, this message will display at the top of Deploy.
- Click Save.
Disable maintenance mode
To disable maintenance mode and allow users to start new deployments:
-
Click on gear icon and select Maintenance mode.
-
Uncheck Enable maintenance mode.
-
Click Save.
Note: If you had configured a notification message, it will no longer display.