Changelog

v2.30.0 - 2025-09-17

Features and Enhancements

  • Added support for setting the S3 Checksum Algorithm when uploading files to S3 compatible storage providers.

v2.29.0 - 2025-08-22

Features and Enhancements

  • Updated the service to build from Synapse v2.219.0.

v2.28.0 - 2025-08-01

Documentation

  • Updated the documentation for the AWS S3 permissions section of the DevOps guide.

  • Updated the service to build from Synapse v2.218.1.

v2.27.0 - 2025-06-12

Features and Enhancements

  • Updated the service to build from Synapse v2.213.0.

v2.26.0 - 2025-04-10

Features and Enhancements

  • Tuned the usage of the Azure SDK for better upload performance to Azure Storage resulting in an order of magnitude (in minutes) better backup times.

    • Reduced Azure Storage block size from 4000MiB to 16MiB.

    • Increased concurrency on Azure Storage API.

v2.25.1 - 2025-04-08

Bugfixes

  • Reduced Azure Storage block size from 4 GiB to supported maximum of 4000 MiB.

v2.25.0 - 2025-04-04

Features and Enhancements

  • Increased Azure Storage block size from default of 4MB to maximum of 4GB.

v2.24.0 - 2025-03-07

Features and Enhancements

  • Updated the SDKs for interacting with the S3 storage backend.

v2.23.0 - 2025-02-13

Features and Enhancements

  • Update the service to build from Synapse v2.197.0.

v2.22.0 - 2025-01-09

Features and Enhancements

  • Update SDKs for interacting with the Azure storage backend.

v2.21.0 - 2024-12-13

Features and Enhancements

  • Update the service to build from Synapse v2.192.0.

v2.20.0 - 2024-12-02

Features and Enhancements

  • Update the service to build from Synapse v2.190.0.

v2.19.0 - 2024-08-20

Features and Enhancements

  • Update the service to build from Synapse v2.178.0.

v2.18.0 - 2024-07-11

Features and Enhancements

  • Update the Synapse-Backup service to use the getCellInfo() API when checking the Synapse version of the target service being backed up.

v2.17.0 - 2024-06-14

Features and Enhancements

  • Update the service to build from Synapse v2.171.0.

v2.16.0 - 2024-03-26

Features and Enhancements

  • Update the service to build from Synapse v2.165.0.

v2.15.0 - 2024-03-14

Features and Enhancements

  • Update the gcloud-aio-auth library used for handling auth to GCS backup targets.

v2.14.0 - 2024-03-01

Features and Enhancements

  • Update the service to build from Synapse v2.164.0.

  • Update the service to manage S3 related logging using the s3:log:level configuration value. This defaults to the INFO level. This can be used to display DEBUG related information if needed. DEBUG related information may contain secret key material depending on the deployment configuration.

v2.13.0 - 2023-11-15

Features and Enhancements

  • Update the service to build from Synapse v2.154.1.

v2.12.0 - 2023-10-13

Features and Enhancements

  • Update the service to build from Synapse v2.151.0.

v2.11.0 - 2023-08-21

Features and Enhancements

  • Update the service to build from Synapse v2.144.0.

v2.10.0 - 2023-07-28

Features and Enhancements

  • Update the service to build from Synapse v2.143.0.

Bugfixes

  • Update the tool synmods.backup.tools.backupsvc to use the Synapse-Backup local AHA configuration when connecting to the backup service.

v2.9.0 - 2023-07-07

Features and Enhancements

  • Update the service to build from Synapse v2.141.0.

v2.8.0 - 2023-05-19

Features and Enhancements

  • Update the service to build from Synapse v2.134.0.

Bugfixes

  • Fix an issue where the service attempted to delete backups that were never created in the remote services.

v2.7.0 - 2023-05-15

Features and Enhancements

  • Added support for backups to Azure Blob Storage.

v2.6.0 - 2023-05-09

Features and Enhancements

  • Update the service to build from Synapse v2.133.0.

v2.5.2 - 2023-04-29

Bugfixes

  • Fix an issue where GCS could timeout backups which took too long to begin streaming data.

v2.5.1 - 2023-04-20

Bugfixes

  • Remove incomplete backup files from S3 when errors are encountered during an S3 backup.

  • Fix an issue where uploads to GCS could incorrectly timeout before completing.

Documentation

  • Add note that the backup service cannot be backed up.

v2.5.0 - 2023-03-17

Features and Enhancements

  • Add a --name argument to the backup.service command to specify the filename when saving a backup.

  • Log full exception traceback for errors encountered during backups.

Bugfixes

  • Disable the total timeout for operations when saving backups to GCS to avoid potentially timing out when dealing with large backups.

v2.4.0 - 2023-02-02

Features and Enhancements

  • Update the service to build from Synapse v2.122.0.

v2.3.1 - 2022-12-05

Bugfixes

  • Fix a packaging issue.

v2.3.0 - 2022-12-05

Features and Enhancements

  • Add boot hooks to the container entrypoint. Move the entrypoint script to /vertex/synapse/entrypoint.sh.

Documentation

  • Update user guide and the Storm backup.service help to show the use of full Telepath URLs and AHA urls as backup targets.

  • Update documentation related to Google Cloud Storage.

v2.2.0 - 2022-10-09

Features and Enhancements

  • Added support for backups to Google Cloud Storage.

  • Update the service to build from Synapse v2.110.0.

Bugfixes

  • Rename _execBackupTask to avoid overriding it in the Cell.

v2.1.0 - 2022-08-31

Bugfixes

  • Fix a minor issue with the backup.privsep Storm module.

Documentation

  • Update documentation for S3 configurations.

  • Add a note to the user guide to about storage requirements when taking the backup of a service.

v2.0.0 - 2022-06-22

Features and Enhancements

  • Update permissions to use power-ups.backup.user rule.

  • The command line tool synmods.backup.backupcell has been renamed to synmods.backup.backupsvc.

Bugfixes

  • When backing up a service by name, the service now makes a backup of the first instance of the service it found by name. Previously the backup service used the last service found by name.

v1.9.0 - 2022-06-01

Bugfixes

  • Fix an incorrect log message when deleting a non-existent backup from S3.

Documentation

  • Add documentation for AHA provisioning.

v1.8.0 - 2022-05-17

Features and Enhancements

  • Update to the newest Synapse v2.93.0 to support AHA provisioning.

Bugfixes

  • Load storm package readonly to allow containers to run as non-root user.

v1.7.1 - 2022-04-06

Bugfixes

  • Fix an issue which could have caused the Backup service to close the Telepath connection to a service after the backup stream was done being consumed, but prior to the service having the opportunity to clean up a local back up. This would have resulted in a misleading log message on the remote service which has just been backed up.

v1.7.0 - 2022-03-28

Features and Enhancements

  • Embed some of the Backup documentation into the Storm Package delivered by the Backup Storm Service so it is available in the Synapse UI.

  • Add a --keep-on-fail argument to the backup.service command to keep local backups in the event that a backup failed to be copied to the destination.

v1.6.1 - 2021-11-02

Bugfixes

  • Fix a Python packaging issue with the synmods.backup.tools.backupcell CLI tool.

v1.6.0 - 2021-10-29

Features and Enhancements

  • Add a synmods.backup.tools.backupcell CLI tool. This can be used to connect to the Synapse Backup service via Telepath and perform a backup. (#16)

v1.5.0 - 2021-10-18

Features and Enhancements

  • The behavior of the backup.service Storm command has been changed. If an error occurs during the backup, this will cause the Storm runtime to be torn down. For users which use the Cortex cron system to run backups, this will appears as an error has occurred with the cron job.

v1.4.2 - 2021-10-12

Bugfixes

  • Fix an issue where a Telepath URL was not sanitized in the log output.

v1.4.1 - 2021-10-08

Features and Enhancements

  • Update the Synapse-Backup to be built on Synapse 2.64.1.

v1.4.0 - 2021-07-20

Features and Enhancements

  • Update the service to use tini as a container entrypoint.

  • If the s3:transfer:upload configuration option is not configured, it now defaults to populating the multipart_chunksize option to 100MB, to allow uploading backups up to 1TB in size to S3. User provided configurations are not affected by this default behavior.

v1.3.0 - 2021-06-21

Features and Enhancements

  • Update the service to build from Synapse v2.43.0.

  • Add additional debug logging for S3.

v1.2.1 - 2021-06-14

Bugfixes

  • Sanitize passwords from Telepath URLs in logs.

v1.2.0 - 2021-05-17

Features and Enhancements

  • Update the service to build from Synapse v2.38.0.

v1.1.0 - 2021-04-26

Features and Enhancements

  • Update the service to include information for the getCellInfo() API.

v1.0.1 - 2021-03-29

Fix a CI related issue.

v1.0.0 - 2021-03-09

Features and Enhancements

  • Initial release of Synapse Backup.