Merge pull request #6435 from dimagi/ze/geospatial-queue-changelog

Geospatial Queue Changelog

changelog/0084-add-geospatial-queue.yml

@@ -0,0 +1,30 @@
+title: New Geospatial Celery Queue
+key: add-geospatial-queue
+date: 2024-11-06
+optional_per_env: no
+min_commcare_version:
+max_commcare_version: 513700958cf443a85f0480ff681979d207f22db0
+context: |
+  The Microplanning feature requires the location properties on cases to be indexed correctly so
+  that they can be used correctly in this feature. A separate queue is added to handle this indexing
+  process when the Microplanning feature is enabled for a domain. This can potentially be a long-running
+  task, and so having a separate queue ensures that other queues do not get clogged up by this indexing task.
+
+details: |
+  This creates a geospatial_queue in Celery, which will be used for indexing cases when enabling the
+  Microplanning feature.
+
+update_steps: |
+  This update should be performed before updating CommCare to a version more recent than that specified above.
+
+  First, add a queue called `geospatial_queue` to your app_processes.yml,
+  following the examples in commcare-cloud commit [a94636b1d](https://github.com/dimagi/commcare-cloud/commit/a94636b1d).
+
+  Then, to apply this change:
+
+  ```
+  commcare-cloud <env> update-supervisor-confs
+  ```
+
+  Please note that a restart is required for the change to take effect and can be done as part of the above command
+  or with a separately done deploy.

docs/source/changelog/0084-add-geospatial-queue.md

@@ -0,0 +1,38 @@
+<!--THIS FILE IS AUTOGENERATED: DO NOT EDIT-->
+<!--See https://github.com/dimagi/commcare-cloud/blob/master/changelog/README.md for instructions-->
+# 84. New Geospatial Celery Queue
+
+**Date:** 2024-11-06
+
+**Optional per env:** _required on all environments_
+
+
+## CommCare Version Dependency
+CommCare versions beyond the following commit require this change to function correctly:
+[51370095](https://github.com/dimagi/commcare-hq/commit/513700958cf443a85f0480ff681979d207f22db0)
+
+
+## Change Context
+The Microplanning feature requires the location properties on cases to be indexed correctly so
+that they can be used correctly in this feature. A separate queue is added to handle this indexing
+process when the Microplanning feature is enabled for a domain. This can potentially be a long-running
+task, and so having a separate queue ensures that other queues do not get clogged up by this indexing task.
+
+## Details
+This creates a geospatial_queue in Celery, which will be used for indexing cases when enabling the
+Microplanning feature.
+
+## Steps to update
+This update should be performed before updating CommCare to a version more recent than that specified above.
+
+First, add a queue called `geospatial_queue` to your app_processes.yml,
+following the examples in commcare-cloud commit [a94636b1d](https://github.com/dimagi/commcare-cloud/commit/a94636b1d).
+
+Then, to apply this change:
+
+```
+commcare-cloud <env> update-supervisor-confs
+```
+
+Please note that a restart is required for the change to take effect and can be done as part of the above command
+or with a separately done deploy.

docs/source/changelog/index.md

@@ -7,6 +7,14 @@ need to be applied on your environment to keep it up to date.
 
 ### Changelog
 
+#### **2024-11-06** [New Geospatial Celery Queue](0084-add-geospatial-queue.md)
+The Microplanning feature requires the location properties on cases to be indexed correctly so
+that they can be used correctly in this feature. A separate queue is added to handle this indexing
+process when the Microplanning feature is enabled for a domain. This can potentially be a long-running
+task, and so having a separate queue ensures that other queues do not get clogged up by this indexing task.
+
+
+---
 #### **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.