PlatformManager stores IntegrationManager (IM) instance code and configuration in GitLab. This page describes the GitLab maintenance window: where an administrator defines it, which IntegrationManager actions PlatformManager disables while the window is active, and which notices users see.
Navigation: Administration > GitLab Maintenance
Purpose of the Maintenance Window
IntegrationManager actions such as starting an instance, deploying a connection, or updating an instance write to GitLab. While GitLab is unavailable, these actions fail with upstream errors.
A GitLab maintenance window lets an administrator declare the maintenance period in advance. During the window, PlatformManager disables the affected actions and explains why they are unavailable, instead of letting users start actions that cannot succeed. The IntegrationManager instances themselves keep running for the whole window. Only the actions that write to GitLab are unavailable.
Permission Required
Defining, editing, and clearing a maintenance window requires the global permission GitLab Maintenance Management. For the full list of global permissions, see Permissions.
Users without this permission do not see the Administration > GitLab Maintenance section. They do see the maintenance notices and the disabled actions, because the window is readable by every signed-in user.
Current Status
The GitLab Maintenance Window screen opens with a Current status box. It shows one of the following:
|
Status |
Meaning |
|---|---|
|
No maintenance window configured. |
No window is defined. No action is disabled. |
|
Maintenance scheduled from {from} to {to} |
A window is defined and starts in the future. |
|
Maintenance active until {time} |
The window is in effect. The affected actions are disabled. |
|
Last maintenance window ended {time} |
The window has passed. The actions are available again. The definition is kept until you clear or overwrite it. |
Maintenance Window Settings
Only one maintenance window exists at a time. Saving a window replaces the previous definition.
If no window is defined, the screen shows No window configured. Click Configure maintenance window to define one.
|
Field |
Description |
|---|---|
|
Start date & time |
Date and time at which the window begins, in the format |
|
End date & time |
Date and time at which the window ends, in the format |
All dates and times are displayed in your local time.
The form offers the following actions:
-
Save – Stores the window. It takes effect immediately, including for a window that has already started.
-
Cancel – Discards the changes and restores the stored values.
-
Clear window – Deletes the window after confirmation. The IntegrationManager actions become available again immediately.
Note: No restart and no page reload are needed. PlatformManager enables and disables the actions at the exact start and end of the window, and the notices appear and disappear at the same moments.
Disabled Actions
While the window is active, the actions below are greyed out and show the tooltip "Unavailable during GitLab maintenance." PlatformManager also rejects the corresponding requests on the server, so an action cannot be started outside the user interface either.
|
Area |
Disabled Actions |
|---|---|
|
Integrations table |
New IntegrationManager, Start Integration, Stop Integration, Restart Integration, Settings, Update, Transport to, Resolve merge request, Delete IntegrationManager |
|
Instance settings |
Save on all tabs of the instance form, and setting the instance password |
|
Routes |
Start, Stop |
|
Connections, Certificates, Classes, Filters, Mappers, Properties |
Deploy |
|
IM Update |
Analyze, Re-Analyze, code modification, direct update, and finishing the upgrade |
|
Custom image |
Building a custom image and reverting to the default image |
Actions that do not write to GitLab stay available for the whole window. These include viewing the Integrations table and instance detail pages, Version History, Export CSV, and editing an entity without deploying it.
For the full list of actions on the Integrations table, see Integrations Table Options.
Maintenance Notices
PlatformManager shows a notice at the top of the Integrations section, on the Integrations list and on the instance pages. The notice is not shown in other parts of the application.
|
Notice |
When It Appears |
Text |
|---|---|---|
|
GitLab maintenance |
From 24 hours before the window starts until it starts |
Planned GitLab maintenance will take place between <from> and <to>. Although some actions of the IntegrationManager instance will be unavailable, the instance itself will continue to work without interruption. |
|
GitLab maintenance in progress |
For the duration of the window |
GitLab is undergoing maintenance until <to>. Some Integration Manager actions are unavailable, but the instance is still operational. |
The two notices never appear together. Both state the window times, so users know when the disabled actions become available again.
Scheduled Jobs during Maintenance
PlatformManager jobs that depend on GitLab skip their run while a maintenance window is active, instead of failing. The merge request checks, the requested instances check, and the IntegrationManager connection scan behave this way. Each skipped run is recorded in the log. The jobs resume on their normal schedule after the window ends.
IntegrationManager Instances without Routes Report
Note: The details of this report are pending confirmation with the development team.
PlatformManager sends a report listing all IntegrationManager instances that have no routes. An instance without routes does no integration work, so the report gives the platform team a standing view of instances that need attention.
The report contains the following columns:
|
Column |
Description |
|---|---|
|
Instance name |
Name of the IntegrationManager instance. |
|
Account |
Account the instance belongs to. |
|
Created at |
Date on which the instance was created. |
|
Created by |
User who created the instance. |
|
Last changed |
Date of the last change to the instance. |
The report is sent to platform.manager@pricefx.com.