Merge pull request #6425 from dimagi/gh/backup-retention/changelog

Create changelog entry for #6420

changelog/0083-database_backup_retention_change.yml

@@ -0,0 +1,23 @@
+title: Database Backup Retention Change
+key: database_backup_retention_change
+date: 2024-10-25
+optional_per_env: yes
+min_commcare_version:
+max_commcare_version:
+context: |
+  The logic used to retain database backups has been modified to better respect the settings that specify
+  how many days to keep backups.
+
+details: |
+  No action is needed. This is just to inform you that the logic determining which backups to
+  keep has been modified. This impacts the values set for services like [couchdb](https://github.com/dimagi/commcare-cloud/blob/c3abda48758fb337ca87e8039f1b97e333129351/src/commcare_cloud/ansible/roles/couchdb2/defaults/main.yml#L9-L10),
+  [postgres](https://github.com/dimagi/commcare-cloud/blob/c3abda48758fb337ca87e8039f1b97e333129351/src/commcare_cloud/ansible/roles/pg_backup/defaults/main.yml#L9-L10),
+  and [blob](https://github.com/dimagi/commcare-cloud/blob/c3abda48758fb337ca87e8039f1b97e333129351/src/commcare_cloud/ansible/roles/backups/defaults/main.yml#L5-L6).
+
+  Put simply, if the <service>_backup_days value was set to 2, 4 daily backups would exist on your
+  machine at any given time. This change reduces that value to 3 which is more in line with what
+  it means to keep backups for 2 days.
+
+
+update_steps: |
+  No action needed.

docs/source/changelog/0083-database_backup_retention_change.md

@@ -0,0 +1,29 @@
+<!--THIS FILE IS AUTOGENERATED: DO NOT EDIT-->
+<!--See https://github.com/dimagi/commcare-cloud/blob/master/changelog/README.md for instructions-->
+# 83. Database Backup Retention Change
+
+**Date:** 2024-10-25
+
+**Optional per env:** _only required on some environments_
+
+
+## CommCare Version Dependency
+This change is not known to be dependent on any particular version of CommCare.
+
+
+## Change Context
+The logic used to retain database backups has been modified to better respect the settings that specify
+how many days to keep backups.
+
+## Details
+No action is needed. This is just to inform you that the logic determining which backups to
+keep has been modified. This impacts the values set for services like [couchdb](https://github.com/dimagi/commcare-cloud/blob/c3abda48758fb337ca87e8039f1b97e333129351/src/commcare_cloud/ansible/roles/couchdb2/defaults/main.yml#L9-L10),
+[postgres](https://github.com/dimagi/commcare-cloud/blob/c3abda48758fb337ca87e8039f1b97e333129351/src/commcare_cloud/ansible/roles/pg_backup/defaults/main.yml#L9-L10),
+and [blob](https://github.com/dimagi/commcare-cloud/blob/c3abda48758fb337ca87e8039f1b97e333129351/src/commcare_cloud/ansible/roles/backups/defaults/main.yml#L5-L6).
+
+Put simply, if the <service>_backup_days value was set to 2, 4 daily backups would exist on your
+machine at any given time. This change reduces that value to 3 which is more in line with what
+it means to keep backups for 2 days.
+
+## Steps to update
+No action needed.

docs/source/changelog/index.md

@@ -7,6 +7,12 @@ need to be applied on your environment to keep it up to date.
 
 ### Changelog
 
+#### **2024-10-25** [Database Backup Retention Change](0083-database_backup_retention_change.md)
+The logic used to retain database backups has been modified to better respect the settings that specify
+how many days to keep backups.
+
+
+---
 #### **2024-07-25** [Unicel SMS Gateway Removal](0082-unicel-sms-gateway-removal.md)
 This is a notice specifically for projects with Unicel configured as an SMS gateway, which is no longer functional.
 Projects that are not using the Unicel gateway do not need to take any action.