Update the DataMind Installer

The DataMind Installer updates itself from the pill in the top bar. When a newer build is published, the pill reads Installer update available; this page follows that click through the restart and the outcome. Updating DataMind OS is a separate flow: see Updating.

Before you update

Take the DataMind Installer backup, as in Backup and restore. If the new build rolls back after it has migrated the database, the backup's dump is what you restore.
Wait until no job is running. While a job or another update is in progress, the pill does not open the update, and its tooltip gives the reason.

Run the update

Click the Installer update available pill, in the top bar of the DataMind Installer.
Confirm in the dialog. It asks Update DataMind Installer?, says The Installer restarts; DataMind OS itself is not touched. Expect one to three minutes of no connection., and offers Update Installer. If the published release also changes the Installer's own Compose file, the dialog adds a note.
Watch the restart window. The screen shows Updating DataMind Installer with Updating DataMind Installer… waiting for it to come back. It checks the Installer's health about every 3 seconds and reloads the screen when the Installer answers again.
If the Installer stays away, the screen gives up after about 10 minutes. It reads Installer update did not finish, with The Installer did not come back. The previous version is usually restored by the updater. Try reloading, or check the host. below it and a Reload button. If the Installer stays down, go to Troubleshooting.

What the update does

Stage	What happens
Preparation	Keeps the running build as the rollback copy and pulls the new build. If any of this fails, nothing has changed
Switch	Replaces the Installer's Compose file with the published one and starts the new build, which runs its database migrations. The previous Compose file stays on the host
Health wait	Waits about 300 seconds for the new build to answer healthily. The Installer's actions are paused until the update ends
Rollback	If the new build is not healthy, starts the rollback copy again

The update always moves to the newest published build. Leave VERSION unset. See What lives on the host.

Check the outcome

A toast names how the update ended:

It updated: the toast names the build now running.
It rolled back: a red toast says the update rolled back and which build still runs, with the reason underneath when the Installer recorded one.
Otherwise: a toast names the build that came back.

The pill then reads Installer <tag> again. If the last update failed, the pill keeps a red dot, and its tooltip adds Last update failed: <detail>.

On the host, the .self-update-status file in the Installer's install directory records the last update that reached the switch: ok, rolled-back or failed. See What lives on the host.

Important

If the new build had already migrated the database when it rolled back, the recorded reason begins ROLLED BACK ONTO A CHANGED SCHEMA. Restore the database dump you took before the update, as in Backup and restore.

The outcome toast appears only in the browser you started the update from; the pill and .self-update-status show the result from anywhere. If the update failed, read the update helper's log on the host before you try another update: the next attempt removes it. The recovery steps are on Troubleshooting.

If the update does not start

These messages change nothing: the Installer checked, refused, and left everything as it was. Fix what the detail names, then update again.

Update preparation failed; nothing has changed: … The preparation failed before the switch.
Could not start the updater; nothing has changed: … The update helper could not start.
Self-update was abandoned: the updater helper was not started within the time limit. Nothing changed; update again.
If the Installer already runs the newest published build, there is nothing to do and it does not restart.
An installation that was not started with Docker Compose cannot update itself.

Questions, answered

Does updating the DataMind Installer update DataMind OS?

No. Only the Installer restarts. DataMind OS keeps running and is not touched.

Who can update the DataMind Installer?

Admin accounts. The pill is clickable only for an admin, and only when no job or update is running.

Can I update the Installer while a DataMind OS job is running?

No. The Installer runs one operation at a time. While a job runs, the pill does not open the update, and the dialog cannot confirm until the job finishes.

How long is the DataMind Installer unavailable during its update?

One to three minutes, while it restarts. The screen keeps checking for about 10 minutes; if the Installer is still away, it says Installer update did not finish and offers Reload.

The update dialog mentioned the Installer's Compose file. What does that mean?

That release changes the Installer's own Compose file as well as its image, so the update replaces it. A hand edit to it does not survive; the previous file stays on the host as docker-compose.yml.pre-update. See What lives on the host.

Where do I see how the last update ended, if I missed the toast?

The pill: a red dot and Last update failed: <detail> in its tooltip when the last update failed. On the host, .self-update-status reads ok, rolled-back or failed. The toast itself shows only in the browser you started the update from.

What if the new build is not healthy?

The Installer rolls back on its own: it starts the previous build again and keeps running it, with the reason under the toast. If the rollback fails too, the Installer stays down and the recovery runs on the host, as in Troubleshooting.

Should I take a backup before updating the DataMind Installer?

Yes. Take the DataMind Installer backup first, as in Backup and restore. Its database dump covers the case where the new build migrates the database and then rolls back.