Bug 37787 - Undocument koha-worker --queue elastic_index
Summary: Undocument koha-worker --queue elastic_index
Status: Pushed to stable
Alias: None
Product: Koha
Classification: Unclassified
Component: Command-line Utilities (show other bugs)
Version: Main
Hardware: All All
: P5 - low minor
Assignee: Magnus Enger
QA Contact: Testopia
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2024-08-30 06:30 UTC by Magnus Enger
Modified: 2024-11-20 18:36 UTC (History)
4 users (show)

See Also:
Change sponsored?: ---
Patch complexity: String patch
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:
24.11.00,24.05.06
Circulation function:


Attachments
Bug 37787; Undocument koha-worker --queue elastic_index (2.59 KB, patch)
2024-08-30 08:04 UTC, Magnus Enger
Details | Diff | Splinter Review
Bug 37787: Remove mention of elastic_index from POD (1.06 KB, patch)
2024-09-05 06:42 UTC, Magnus Enger
Details | Diff | Splinter Review
Bug 37787: Remove mention of elastic_index from POD (1.13 KB, patch)
2024-09-10 19:25 UTC, Sukhmandeep
Details | Diff | Splinter Review
Bug 37787; Undocument koha-worker --queue elastic_index (2.66 KB, patch)
2024-09-10 19:28 UTC, Sukhmandeep
Details | Diff | Splinter Review
Bug 37787: Remove mention of elastic_index from POD (1.13 KB, patch)
2024-09-10 19:28 UTC, Sukhmandeep
Details | Diff | Splinter Review
Bug 37787: Undocument koha-worker --queue elastic_index (2.71 KB, patch)
2024-10-22 14:35 UTC, Tomás Cohen Arazi (tcohen)
Details | Diff | Splinter Review
Bug 37787: Remove mention of elastic_index from POD (1.19 KB, patch)
2024-10-22 14:35 UTC, Tomás Cohen Arazi (tcohen)
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Magnus Enger 2024-08-30 06:30:54 UTC
Documentation for koha-worker --queue elastic_index was added in Bug 36009, and as far as I can tell, that was the right thing to do at the time. 

Then koha-es-indexer was added in Bug 33108, and after that running both koha-es-indexer and "koha-worker --queue elastic_index" at the same time leads to problems, like only every other elastic_index job getting processed. 

We should remove the mention of "--queue elastic_index" from the koha-worker docs. (And maybe add a note that only koha-es-indexer should be run.)

koha-es-indexer has been introduced to 23.05.00 and 22.11.06, so a fix should not be backported to older versions than that.
Comment 1 Magnus Enger 2024-08-30 08:04:31 UTC Comment hidden (obsolete)
Comment 2 Magnus Enger 2024-09-05 06:36:47 UTC
The POD for https://git.koha-community.org/Koha-community/Koha/src/branch/main/misc/workers/background_jobs_worker.pl still mentions elastic_index: 

=item B<--queue>

Repeatable. Give the job queues this worker will process.

The different values available are:

    default
    long_tasks
    elastic_index
Comment 3 Magnus Enger 2024-09-05 06:42:37 UTC Comment hidden (obsolete)
Comment 4 Sukhmandeep 2024-09-10 19:25:02 UTC Comment hidden (obsolete)
Comment 5 Sukhmandeep 2024-09-10 19:28:13 UTC
Created attachment 171281 [details] [review]
Bug 37787; Undocument koha-worker --queue elastic_index

To test:
- Copy the koha-worker script to the standard location:
  $ sudo cp debian/scripts/koha-worker /usr/sbin/koha-worker
- Check "sudo koha-worker --help" and verify elastic_index is
  not mentioned in the list of "current queues"
- See https://wiki.koha-community.org/wiki/Testing_man_pages for
  how to check the "man" page. elastic_index should not be
  mentioned in the list of "Current queues".
- Both places aboce should have a note about elastic_index not
  being active when koha-es-indexer is running.

Signed-off-by: Sukhmandeep Benipal <sukhmandeep.benipal@inLibro.com>
Comment 6 Sukhmandeep 2024-09-10 19:28:15 UTC
Created attachment 171282 [details] [review]
Bug 37787: Remove mention of elastic_index from POD

After the introduction of misc/workers/es_indexer_daemon.pl,
misc/workers/background_jobs_worker.pl should not handle the
elastic_index queue. But the latter script still mentions this
queue in the POD. This patch removes that mention.

To test:
- Run perldoc misc/workers/background_jobs_worker.pl
- Verify "elastic_index" is mentioned under --queue
- Apply this patch
- Run perldoc again and verify the mention of "elastic_index"
  is gone

Signed-off-by: Sukhmandeep Benipal <sukhmandeep.benipal@inLibro.com>
Comment 7 Tomás Cohen Arazi (tcohen) 2024-10-22 14:35:24 UTC
Created attachment 173164 [details] [review]
Bug 37787: Undocument koha-worker --queue elastic_index

To test:
- Copy the koha-worker script to the standard location:
  $ sudo cp debian/scripts/koha-worker /usr/sbin/koha-worker
- Check "sudo koha-worker --help" and verify elastic_index is
  not mentioned in the list of "current queues"
- See https://wiki.koha-community.org/wiki/Testing_man_pages for
  how to check the "man" page. elastic_index should not be
  mentioned in the list of "Current queues".
- Both places aboce should have a note about elastic_index not
  being active when koha-es-indexer is running.

Signed-off-by: Sukhmandeep Benipal <sukhmandeep.benipal@inLibro.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Comment 8 Tomás Cohen Arazi (tcohen) 2024-10-22 14:35:26 UTC
Created attachment 173165 [details] [review]
Bug 37787: Remove mention of elastic_index from POD

After the introduction of misc/workers/es_indexer_daemon.pl,
misc/workers/background_jobs_worker.pl should not handle the
elastic_index queue. But the latter script still mentions this
queue in the POD. This patch removes that mention.

To test:
- Run perldoc misc/workers/background_jobs_worker.pl
- Verify "elastic_index" is mentioned under --queue
- Apply this patch
- Run perldoc again and verify the mention of "elastic_index"
  is gone

Signed-off-by: Sukhmandeep Benipal <sukhmandeep.benipal@inLibro.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Comment 9 Katrin Fischer 2024-10-23 17:18:44 UTC
Pushed for 24.11!

Well done everyone, thank you!
Comment 10 Lucas Gass (lukeg) 2024-11-20 18:36:55 UTC
Backported to 24.05.x for upcoming 24.05.06