Module

maintenanceMode

Provides a possibility to work with maintenance mode. It is used in the case when you want to restart XL Deploy and don't allow to spawn new tasks by users and only drain existed ones.

View Source maintenance-mode/maintenance-mode-actions.js, line 10

Methods

# static changePristineState(pristine)

Changes the pristinity state of maintenance modal dialog. Visually it is represented by asterisk on the title of modal dialog. If pristinity is false and user clicks on "Cancel", first confirmation will be asked before changes be lost.

Parameters:
Name Type Description
pristine boolean

the new pristinity value

Properties:
Name Type Description
type string

CHANGE_PRISTINE_STATE

View Source maintenance-mode/maintenance-mode-actions.js, line 27

# static disable()

Disables the usage of custom text. And disallows the user to change text in the modal dialog.

Properties:
Name Type Description
type string

DISABLE

View Source maintenance-mode/maintenance-mode-actions.js, line 37

# static enable()

Enables the usage of custom text. And allows the user to change text in the modal dialog.

Properties:
Name Type Description
type string

ENABLE

View Source maintenance-mode/maintenance-mode-actions.js, line 44

# static stage(htmlValue)

Stages all user input. It means that it saves in redux store but not persisted to database.

Parameters:
Name Type Description
htmlValue String

provided custom input in html representation.

Properties:
Name Type Description
type string

STAGE

View Source maintenance-mode/maintenance-mode-actions.js, line 53

# static toggle()

Enables/disables the maintenance mode. If its enables users can't anymore to create new deployments. Exception is only for admin user.

Properties:
Name Type Description
type string

TOGGLE

View Source maintenance-mode/maintenance-mode-actions.js, line 65

# static update()

Updates current custom text with new staged one. That means if you want to provide you custom text, first you need to {stage} it and then {update}.

Properties:
Name Type Description
type string

UPDATE

View Source maintenance-mode/maintenance-mode-actions.js, line 73