Skip to content

Latest commit

 

History

History
145 lines (100 loc) · 5.11 KB

CHANGELOG.md

File metadata and controls

145 lines (100 loc) · 5.11 KB
Raw

Version 4.0.0 (2024-10-07)

  • [Enhancement] Drop support for Python 3.8; update the Ubuntu base image to "Ubuntu Jammy" (22.04).

When updating your plugin to this version, you'll need to rebuild the image.

Version 3.3.0 (2024-07-31)

  • [Enhancement] Support Tutor 18 and Open edX Redwood.
  • [Enhancement] Add options to opt-out single-transaction and flush logs in mysql

Version 3.2.0 (2024-04-05)

  • [Enhancement] Support Python 3.12.

Version 3.1.0 (2024-01-12)

  • [Enhancement] Support Tutor 17 and Open edX Quince.

Version 3.0.1 (2023-11-27)

  • [fix] Run mysqladmin flush-logs immediately after a successful MySQL restore.

Version 3.0.0 (2023-10-27)

  • [fix] Switch the MySQL client tools to version 8.0 and the MongoDB client tools to version 4.4.

This version drops compatibility with Open edX Olive and Tutor 15.

Version 2.1.1 (2023-10-12)

  • [fix] Avoid running Kubernetes CronJob instances concurrently by default: add the BACKUP_K8S_CRONJOB_CONCURRENCYPOLICY setting and default it to Forbid (rather than the Kubernetes default, Allow).

Version 2.1.0 (2023-08-22)

  • [Enhancement] Support Tutor 16, Open edX Palm and Python 3.11.

Version 2.0.1 (2023-05-19)

  • [fix] Add the BACKUP_MONGORESTORE_ADDITIONAL_OPTIONS setting to the definition of the Kubernetes restore cron job (in addition to that of the ad-hoc Kubernetes job).

Version 2.0.0 (2023-03-15)

  • [BREAKING CHANGE] Add support for Tutor 15 and Open edX Olive. Tutor version 15.0.0 includes changes to the implementation of custom commands and thus requires changes in this plugin as well that are not backwards compatible. From version 2.0.0 this plugin only supports Tutor versions from 15.0.0 and Open edX Olive release.
  • [feature] Add the BACKUP_MONGORESTORE_ADDITIONAL_OPTIONS setting.

Version 1.2.0 (2022-09-21)

  • [feature] Add the BACKUP_MONGODB_DATABASES setting to select the MongoDB databases to back up. Add BACKUP_MONGODB_AUTHENTICATION_DATABASE to override default authentication database name.
  • [refactor] Remove obsolete scripts.
  • [feature] Use ephemeral volumes in K8s for data volume
  • [fix] When calculating the checksum for large backup tar files, all the file was read into memory. This could cause pods to be killed when backing up large databases. Fix that by reading in the tar file in chunks when calculating the checksum.

Version 1.1.0 (2022-08-31)

  • [feature] Add the BACKUP_MYSQL_DATABASES setting to select the MySQL databases to backup.

Version 1.0.0 (2022-08-04)

  • [BREAKING CHANGE] Support Tutor 14 and Open edX Nutmeg. This entails a configuration format change from JSON to YAML, meaning that from version 1.0.0 this plugin only supports Tutor versions from 14.0.0 (and with that, only Open edX versions from Nutmeg).

Version 0.3.0 (2022-07-28)

  • [feature] From this version forward the backup files contain a date stamp, and are thus named backup.YYYY-MM-DD.tar.xz rather than just backup.tar.xz. Users can now specify a date when using the restore command. In a Kubernetes deployment, if multiple backups are made in one day, users can specify the date and the version ID of the desired backup when restoring. If no date is specified on restore, the restore job looks for a backup from today. This means that when upgrading from an earlier version, attempting a restore operation before any new backup is made will fail because the restore will be looking for a backup named backup.YYYY-MM-DD.tar.xz when no such backup exists yet. In that event, please rename your existing backup.tar.xz file to the backup.YYYY-MM-DD.tar.xz format, reflecting the current date.

Version 0.2.0 (2022-07-26)

  • [feature] Add ability to enable and disable CronJobs by suspending them.
  • [fix] Remove dependencies on mysql and mongodb from the docker-compose configuration if Tutor is configured to run with external MySQL and MongoDB.

Version 0.1.0 (2022-06-29)

  • [refactor] Use Tutor v1 plugin API

Version 0.0.6 (2022-04-19)

  • [feature] List available backup versions using tutor k8s restore --list-versions.

Version 0.0.5 (2022-04-13)

  • [fix] Fix for k8s restore that would fail if no version ID was given.

Version 0.0.4 (2022-04-12)

  • [fix] When checking file integrity after download, compare the checksum to the correct version of the backup file on S3.
  • [feature] Add timestamps to log messages.

Version 0.0.3 (2022-04-11)

  • [fix] Don’t break on existing directories when restoring Caddy data.

Version 0.0.2 (2022-04-07)

  • [refactor] Rewrite backup and restore scripts in Python, improving logging and integrity verification.
  • [feature] Add ability to exclude individual services from restore.

Version 0.0.1 (2022-04-01)

Experimental. Do not use in production.