Upgrade Datalore On-Premises (Docker installation)
The instructions below explain how to upgrade Datalore On-Premises (Docker installation). The current latest version is 2025.1.
note
Important
When planning your upgrade to the latest version of Datalore, the upgrade process must be done in a sequential manner. Datalore upgrade mechanism requires you to step through each intermediate version as opposed to skipping straight to the most recent version. This is crucial to ensure the continuity, stability, and integrity of your system and data. We strongly recommend following the correct path from your current version to the desired version, acknowledging each intermediate version in the process. Failure to adhere to this can result in unforeseen compatibility issues, performance inconsistencies or data loss.
If you use a custom agent configuration, update agent images so that agent and server versions match after you upgrade Datalore.
Back up Docker volumes before updating Datalore.
tip
If you use HubMake sure you upgrade Hub before upgrading Datalore.
(Optional) If you're still using secrets and notebook-level SSH keys or Git repositories, make sure to migrate those that you want to keep. Follow this procedure.
Update docker-compose.yaml:
Download and open the docker-compose.yaml file from here.
Edit the file to make sure you have the same configs that you had for the previous version.
Run
docker compose down
and thendocker compose up
to restart the service.
(Optional) Make sure you have migrated from deprecated features.
Update docker-compose.yaml:
Download and open the docker-compose.yaml file from here.
Edit the file to make sure you have the same configs that you had for the previous version.
Run
docker compose down
and thendocker compose up
to restart the service.
(Optional) Make sure you have migrated from deprecated features.
Update docker-compose.yaml:
Download and open the docker-compose.yaml file from here.
Edit the file to make sure you have the same configs that you had for the previous version.
Run
docker compose down
and thendocker compose up
to restart the service.
Update docker-compose.yaml:
Download and open the docker-compose.yaml file from here.
Edit the file to make sure you have the same configs that you had for the previous version.
Run
docker compose down
and thendocker compose up
to restart the service.
warning
This version includes PostgreSQL version migration from Postgres 12 to Postgres 15.
If your Datalore installation uses an external database (not the one shipped with Datalore), we advise to upgrade the database instance using the database provider preferred tooling, or to reach out to your database administrator for further guidance.
Update docker-compose.yaml:
Download and open the docker-compose.yaml file from here.
Edit the file to make sure you have the same configs that you had for the previous version.
Run
docker compose down
and thendocker compose up
to restart the service.
Update docker-compose.yaml:
Download and open the docker-compose.yaml file from here.
Edit the file to make sure you have the same configs that you had for the previous version.
Run
docker compose down
and thendocker compose up
to restart the service.
Update docker-compose.yaml:
Download and open the docker-compose.yaml file from here.
Edit the file to make sure you have the same configs that you had for the previous version.
Run
docker compose down
and thendocker compose up
to restart the service.
Update docker-compose.yaml:
Download and open the docker-compose.yaml file from here.
Edit the file to make sure you have the same configs that you had for the previous version.
Run
docker compose down
and thendocker compose up
to restart the service.
Update docker-compose.yaml:
Download and open the docker-compose.yaml file from here.
Edit the file to make sure you have the same configs that you had for the previous version.
Run
docker compose down
and thendocker compose up
to restart the service.
Update docker-compose.yaml:
Download and open the docker-compose.yaml file from here.
Edit the file to make sure you have the same configs that you had for the previous version.
Run
docker compose down
and thendocker compose up
to restart the service.
Update docker-compose.yaml:
Download and open the docker-compose.yaml file from here.
Edit the file to make sure you have the same configs that you had for the previous version.
Run
docker compose down
and thendocker compose up
to restart the service.
Upgrade to 2024.1 involves an internal output migration. We strongly recommend that you check whether the migration went successfully and report any discovered errors if such occurred in the process. which we strongly recommend checking by performing the following steps.
When running the updated version (2024.1) for the first time, check Datalore server logs. The logs are expected to contain lines similar to the ones in the example below.
note
Timings, thread names and number of files presented in the example will differ from yours.
12:44:03.931 INFO [OutputsMigrationEDT] j.d.o.s.i.migration.OutputsMigrationTool Files to migrate: 313 12:44:04.205 INFO [Thread-3] j.d.o.s.i.m.LoggingOutputMigrationProgressTracker Processed 4/313 (1%) file(s) 12:44:04.261 INFO [Thread-2] j.d.o.s.i.m.LoggingOutputMigrationProgressTracker Processed 7/313 (2%) file(s) ... 12:44:05.324 INFO [Thread-3] j.d.o.s.i.m.LoggingOutputMigrationProgressTracker Processed 313/313 (100%) file(s)
Check if there were any errors that occurred during the migration. Such errors will be listed as a short summary below the
Processed [n] 100% files
line. If no errors are found, no further steps need to be performed.If there are any errors, save the IDs of notebooks together with the error messages. Scroll up the logs and find and save the respective stacktraces for these errors.
Use the saved IDs to try to open the notebooks with the migration errors. If any of these notebooks fail to open, contact Datalore support providing the error message and stacktrace for each such notebook.
Update docker-compose.yaml:
Download and open the docker-compose.yaml file from here.
Edit the file to make sure you have the same configs that you had for the previous version.
Run
docker compose down
and thendocker compose up
to restart the service.
Update docker-compose.yaml:
Download and open the docker-compose.yaml file from here.
Edit the file to make sure you have the same configs that you had for the previous version.
Run
docker compose down
and thendocker compose up
to restart the service.
Update docker-compose.yaml:
Download and open the docker-compose.yaml file from here.
Edit the file to make sure you have the same configs that you had for the previous version.
Run
docker compose down
and thendocker compose up
to restart the service.
Update docker-compose.yaml:
Download and open the docker-compose.yaml file from here.
Edit the file to make sure you have the same configs that you had for the previous version.
Run
docker compose down
and thendocker compose up
to restart the service.
Update docker-compose.yaml:
Download and open the docker-compose.yaml file from here.
Edit the file to make sure you have the same configs that you had for the previous version.
Run
docker compose down
and thendocker compose up
to restart the service.
note
The updating procedure involves checkpoint migration, which will cause the first startup of the new version to take longer than usual.
Update docker-compose.yaml:
Download and open the docker-compose.yaml file from here.
Edit the file to make sure you have the same configs that you had for the previous version.
Run
docker compose down
and thendocker compose up
to restart the service.
note
The updating procedure involves checkpoint migration, which will cause the first startup of the new version to take longer than usual.
Update docker-compose.yaml:
Download and open the docker-compose.yaml file from here.
Edit the file to make sure you have the same configs that you had for the previous version.
Run
docker compose down
and thendocker compose up
to restart the service.
Update docker-compose.yaml:
Download and open the docker-compose.yaml file from here.
Edit the file to make sure you have the same configs that you had for the previous version.
Run
docker compose stop
and thendocker compose start
to restart the service.
Update docker-compose.yaml.
Run
docker compose restart
to restart the service.
Thanks for your feedback!