Guide: Maintenance Mode and Configurable User Facing Messages

Pause the job queue during updates and set optional user facing messages.

The information in this section applies to CryoSPARC v4.0+.

Maintenance Mode

CryoSPARC’s maintenance mode can be used to pause the job queue so that running jobs complete, but queued jobs are not launched. This allows a busy CryoSPARC instance to be gracefully shut down, re-started, or updated without causing jobs to be terminated or to fail. For example, maintenance mode can be turned on when updating a CryoSPARC instance to prevent new jobs from starting until after the update is rolled out. This can help provide a smooth transition for users during an update by allowing running jobs to complete but prevent new jobs from running until the update is successfully installed and maintenance mode is turned off.

Maintenance mode stops worker nodes from starting new jobs while allowing them to finishing any jobs already in progress. Users can continue to use the application to browse results and to create and queue jobs, but those jobs will only begin processing after maintenance mode is turned off. Users are shown a message in the user interface indicating that maintenance mode is on and what it means for them.

Once an administrator has turned on maintenance mode, the queue will be paused. When existing running jobs are complete, the instance will be idle and the administrator can re-start, update, etc. Once this is complete, the administrator can turn off maintenance mode and previously queued jobs will be launched and processing will continue.

Turning on maintenance mode does not automatically pause running CryoSPARC Live sessions. Please pause any running Live sessions before updating CryoSPARC.

Maintenance mode can be managed using cryosparcm.

To enable maintenance mode:

$ cryosparcm maintenancemode on

Turning maintenance mode ON

To check the status of maintenance mode:

$ cryosparcm maintenancemode status

Maintenance mode is currently ON

To turn maintenance mode off:

$ cryosparcm maintenancemode off

Turning maintenance mode OFF

Message of the Day

In CryoSPARC v4.0+, administrators can set a message that displays as a banner at the top of the dashboard in the UI. This may be useful for announcing scheduled downtimes, planned maintenance, or other information that users should be aware of. The message banner has a customizable title and body, and can be toggled on and off.

he message banner can be managed using cryosparcm.

To set the banner title and message:

$ cryosparcm cli "set_instance_banner(True, 'This is the message title', 'This is the message body')"

{'active': True, 'body': 'This is the message body', 'title': 'This is the message of the day'}

To get the current banner status, title, and message:

$ cryosparcm cli "get_instance_banner()"

{'active': True, 'body': 'This is the message body', 'title': 'This is the message of the day'}

To toggle the banner on:

$ cryosparcm cli "set_instance_banner(True)"

{'active': True, 'body': 'This is the message body', 'title': 'This is the message of the day'}

To toggle the banner off:

$ cryosparcm cli "set_instance_banner(False)"

{'active': False, 'body': 'This is the message body', 'title': 'This is the message of the day'}

Login Message

In v4.0+, CryoSPARC administrators can set a message that displays as modal the first time a user logs into CryoSPARC. This may be useful for announcing important information that users should be aware of when logging in for the first time. The message banner has a customizable title and body, and can be toggled on and off.

The message banner can be managed using cryosparcm.

To set the banner title and message:

$ cryosparcm cli "set_login_message(True, 'This is the login message', 'This is the message body')"

{'active': True, 'body': 'This is the message body', 'title': 'This is the login message'}

To get the current banner status, title, and message:

$ cryosparcm cli "get_login_message()"

{'active': True, 'body': 'This is the message body', 'title': 'This is the login message'}

To toggle the banner on:

$ cryosparcm cli "set_login_message(True)"

{'active': True, 'body': 'This is the message body', 'title': 'This is the login message'}

To toggle the banner off:

$ cryosparcm cli "set_login_message(False)"

{'active': True, 'body': 'This is the message body', 'title': 'This is the login message'}