From 217490d00dd6a2f09ede3392cac792e4615dd66e Mon Sep 17 00:00:00 2001 From: Zandre Engelbrecht Date: Fri, 8 Nov 2024 11:23:52 +0200 Subject: [PATCH 1/2] add changelog documentation --- changelog/0084-add-geospatial-queue.yml | 27 ++++++++++++++ .../changelog/0084-add-geospatial-queue.md | 35 +++++++++++++++++++ docs/source/changelog/index.md | 8 +++++ 3 files changed, 70 insertions(+) create mode 100644 changelog/0084-add-geospatial-queue.yml create mode 100644 docs/source/changelog/0084-add-geospatial-queue.md diff --git a/changelog/0084-add-geospatial-queue.yml b/changelog/0084-add-geospatial-queue.yml new file mode 100644 index 0000000000..9c9bf7345a --- /dev/null +++ b/changelog/0084-add-geospatial-queue.yml @@ -0,0 +1,27 @@ +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. + + To apply this change, run: + + ``` + commcare-cloud update-supervisor-confs + ``` diff --git a/docs/source/changelog/0084-add-geospatial-queue.md b/docs/source/changelog/0084-add-geospatial-queue.md new file mode 100644 index 0000000000..73d07f5041 --- /dev/null +++ b/docs/source/changelog/0084-add-geospatial-queue.md @@ -0,0 +1,35 @@ + + +# 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. + +To apply this change, run: + +``` +commcare-cloud update-supervisor-confs +``` diff --git a/docs/source/changelog/index.md b/docs/source/changelog/index.md index a937d4eb55..13c3038fb1 100644 --- a/docs/source/changelog/index.md +++ b/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. From 0528be517f9a1234208b0c1f8afc8e99b7cb3fb0 Mon Sep 17 00:00:00 2001 From: Zandre Engelbrecht Date: Mon, 11 Nov 2024 09:37:46 +0200 Subject: [PATCH 2/2] small doc changes --- changelog/0084-add-geospatial-queue.yml | 7 +++++-- docs/source/changelog/0084-add-geospatial-queue.md | 7 +++++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/changelog/0084-add-geospatial-queue.yml b/changelog/0084-add-geospatial-queue.yml index 9c9bf7345a..27b9084f61 100644 --- a/changelog/0084-add-geospatial-queue.yml +++ b/changelog/0084-add-geospatial-queue.yml @@ -18,10 +18,13 @@ 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. + following the examples in commcare-cloud commit [a94636b1d](https://github.com/dimagi/commcare-cloud/commit/a94636b1d). - To apply this change, run: + Then, to apply this change: ``` commcare-cloud 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. diff --git a/docs/source/changelog/0084-add-geospatial-queue.md b/docs/source/changelog/0084-add-geospatial-queue.md index 73d07f5041..6002aed59a 100644 --- a/docs/source/changelog/0084-add-geospatial-queue.md +++ b/docs/source/changelog/0084-add-geospatial-queue.md @@ -26,10 +26,13 @@ Microplanning feature. 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. +following the examples in commcare-cloud commit [a94636b1d](https://github.com/dimagi/commcare-cloud/commit/a94636b1d). -To apply this change, run: +Then, to apply this change: ``` commcare-cloud 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.