Note
This page applies to both Atlas Infinite and Atlas Core.
Use the following procedures to configure and delete the maintenance windows, protected hours, and maintenance waves for the projects in your organization. To learn more, see Manage Cluster Maintenance.
To manage maintenance windows, you must have Organization Owner or Project Owner access to the project.
Tip
You can use the Projected Maintenance Calendar Tool to visualize when a maintenance event will roll out to your projects given your configured settings.
Configure Your Maintenance Management Settings
You can configure a project's maintenance window, protected hours, and maintenance waves from your organization's settings or from that project's settings.
To configure maintenance waves for all your projects from your organization's settings using the Atlas UI:
In Atlas, go to the Organization Settings page.
If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.
In the sidebar, click Organization Settings.
The Organization Settings page displays.
Manually Assign Maintenance Waves to your Projects.
To manually assign maintenance waves to your projects, select Manual Assignment.
Use the dropdown next to each project to assign a maintenance wave.
If you have environment project tags set for your projects, you can use the Generate waves based on existing project tags option.
Atlas generates the following assignments based on the environment project tags. You can only use these project tags for maintenance wave assignments.
development/test: Wave 1
staging: Wave 2
production: Last Wave
Atlas does not automatically update these assignments if you update a project's environment tag.
If you have Manual Assignment selected, you can also configure a project's maintenance wave as you configure its maintenance window.
Link Maintenance Waves to your Projects' Environment Tags
Instead of manually assigning maintenance waves to your projects, you can link your projects' maintenance waves to their environment project tags.
Select Use Project Tags to auto-define waves.
Atlas generates the following assignments based on the environment project tags. You can only use these project tags for maintenance wave assignments.
development/test: Wave 1
staging: Wave 2
production: Last Wave
Atlas automatically updates these assignments as you update a project's environment tag.
To configure select projects' maintenance settings using the Atlas UI:
In Atlas, go to the Organization Settings page.
If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.
In the sidebar, click Organization Settings.
The Organization Settings page displays.
Select one or more projects whose maintenance window you want to configure.
To edit the maintenance window of a single project, click the next to the project to open the Edit Maintenance Window page.
To edit the maintenance window of multiple projects, click the checkbox next to the projects you want to select. Then, click Edit maintenance window.
(Optional) Turn on Auto-defer.
If you want Atlas to automatically defer any scheduled maintenance for one week, click Automatically defer maintenance for one week. Enabling this option configures automatic deferral for future maintenance windows. To learn more, see Auto-Defer for Future Maintenance Windows.
To defer currently scheduled maintenance, use the Defer 1 Week button.
Important
Deferring Maintenance when using Maintenance Waves
Auto-deferring maintenance is not available for projects in an organization if any project in the organization has a maintenance wave configured.
You can only manually defer maintenance for projects with a maintenance wave configured if they are assigned to Last Wave. Atlas limits these projects to at most one manual deferral.
Assign a Maintenance Wave.
To set the maintenance waves, use the dropdown under Wave (per project) to assign your project or projects to a maintenance wave.
Note
Using Project Tags to Set Maintenance Waves
If you have Use Project Tags to auto-define waves selected in your organization-level maintenance waves settings, you can't manually configure maintenance waves from a project's settings.
In Atlas, go to the Project Settings page.
If it's not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
In the sidebar, click the icon next to Project Overview.
The Project Settings page displays.
(Optional) Turn on Auto-defer.
If you want Atlas to automatically defer any scheduled maintenance for one week, click Automatically defer maintenance for one week. Enabling this option configures automatic deferral for future maintenance windows. To learn more, see Auto-Defer for Future Maintenance Windows.
To defer currently scheduled maintenance, use the Defer 1 Week button.
Important
Deferring Maintenance when using Maintenance Waves
Auto-deferring maintenance is not available for projects in an organization if any project in the organization has a maintenance wave configured.
You can only manually defer maintenance for projects with a maintenance wave configured if they are assigned to Last Wave. Atlas limits these projects to at most one manual deferral.
Assign a Maintenance Wave.
To set the maintenance wave, use the dropdown under Wave (per project) to assign your project or projects to a maintenance wave.
Note
Using Project Tags to Set Maintenance Waves
If you have Use Project Tags to auto-define waves selected in your organization-level maintenance waves settings, you can't manually configure maintenance waves from a project's settings.
To return the details for the maintenance window using the Atlas CLI, run the following command:
atlas maintenanceWindows describe [options]
To update the maintenance window using the Atlas CLI, run the following command:
atlas maintenanceWindows update [options]
To learn more about the syntax and parameters for the previous commands, see the Atlas CLI documentation for atlas maintenanceWindows describe and atlas maintenanceWindows update.
Atlas provides the Update One Maintenance Window for One Project endpoint and the Get One Maintenance Window for One Project endpoint.
To configure maintenance settings at the organization level, Atlas provides the Update the Maintenance Settings for One Organization endpoint and the Return the Maintenance Settings for One Organization endpoint.
Tip
You can use the Projected Maintenance Calendar Tool to visualize when a maintenance event will roll out to your projects given your configured settings.
Delete Your Maintenance Management Settings
If you have maintenance windows, protected hours, or maintenance waves configured, you can delete these settings. Deleting your maintenance window configuration restores the default maintenance window settings.
You can delete all configured maintenance waves by clicking Delete waves for all projects in the Maintenance Window and Waves section.
To delete specific maintenance settings:
If you have maintenance waves configured, click the tab corresponding to the wave of the project whose maintenance window you want to delete.
Under Actions, click the icon next to the maintenance window you want to delete. This deletes the maintenance window, protected hours, and the assigned wave.
To delete an assigned maintenance waves without deleting the maintenance window:
Select one or more projects whose maintenance waves you want to delete.
To delete the maintenance wave of a single project, click the next to the project to open the Edit Maintenance Window page.
To delete the maintenance waves of multiple projects, click the checkbox next to the projects you want to select. Then, click Edit Maintenance Window.
Select None using the dropdown under Wave (per project).
To delete the configured maintenance settings using the Atlas UI, click the icon in the Maintenance Window and Waves section.
To delete an assigned maintenance wave without deleting the maintenance window:
Click Edit in the Maintenance Window and Waves section.
Select None using the dropdown under Wave (per project).
Click Save to keep your changes or click Cancel to discard them.
To clear the configured maintenance window using the Atlas CLI, run the following command:
atlas maintenanceWindows clear [options]
To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas maintenanceWindows clear.
Atlas provides the Update One Maintenance Window for One Project endpoint.
To delete maintenance settings at the organization level, Atlas provides the Reset the Maintenance Settings for One Organization endpoint.
Tip
You can use the Projected Maintenance Calendar Tool to visualize when a maintenance event will roll out to your projects given your configured settings.