1- # Neos CMS ElasticSearch indexer based on beanstalkd ( job queue)
1+ # Neos CMS Elasticsearch indexer based on a job queue
22
3- This package can be used to index a huge amount of nodes in ElasticSearch indexes. This
4- package use Beanstalkd and the JobQueue package to handle ES indexing asynchronously.
3+ This package can be used to index a huge amount of nodes in Elasticsearch indexes. This
4+ package use the Flowpack JobQueue packages to handle the indexing asynchronously.
55
66# Breaking change after an upgrade to 3.0
77
8- ## Install and configure your Queue package
8+ Previously the Beanstalk queue package was installed by default, this is no longer
9+ the case.
10+
11+ # Install and configure your Queue package
912
1013You need to install the correct Queue package based on your needs.
1114
1215Available packages:
1316
1417 - [ sqlite] ( https://packagist.org/packages/flownative/jobqueue-sqlite )
15- - [ beanstalkd] ( https://packagist.org/packages/flownative /jobqueue-beanstalkd )
16- - [ doctrine] ( https://packagist.org/packages/flownative /jobqueue-doctrine )
17- - [ redis] ( https://packagist.org/packages/flownative /jobqueue-redis )
18+ - [ beanstalkd] ( https://packagist.org/packages/flowpack /jobqueue-beanstalkd )
19+ - [ doctrine] ( https://packagist.org/packages/flowpack /jobqueue-doctrine )
20+ - [ redis] ( https://packagist.org/packages/flowpack /jobqueue-redis )
1821
1922Please check the package documentation for specific configurations.
2023
21- The default configuration use Beanstalkd, but you need to install it manually:
24+ The default configuration uses Beanstalkd, but you need to install it manually:
2225
2326 composer require flowpack/jobqueue-beanstalkd
24-
27+
2528Check the ``` Settings.yaml ``` to adapt based on the Queue package, you need to adapt the ``` className ``` :
2629
2730 Flowpack:
@@ -30,18 +33,32 @@ Check the ```Settings.yaml``` to adapt based on the Queue package, you need to a
3033 queues:
3134 'Flowpack.ElasticSearch.ContentRepositoryQueueIndexer':
3235 className: 'Flowpack\JobQueue\Beanstalkd\Queue\BeanstalkdQueue'
33-
36+
3437 'Flowpack.ElasticSearch.ContentRepositoryQueueIndexer.Live':
3538 className: 'Flowpack\JobQueue\Beanstalkd\Queue\BeanstalkdQueue'
3639
37-
40+ If you use the [ doctrine] ( https://packagist.org/packages/flownative/jobqueue-doctrine ) package you have to set the ``` tableName ``` manually:
41+
42+ Flowpack:
43+ JobQueue:
44+ Common:
45+ queues:
46+ 'Flowpack.ElasticSearch.ContentRepositoryQueueIndexer':
47+ className: 'Flowpack\JobQueue\Doctrine\Queue\DoctrineQueue'
48+ options:
49+ tableName: 'flowpack_jobqueue_QueueIndexer'
50+
51+ 'Flowpack.ElasticSearch.ContentRepositoryQueueIndexer.Live':
52+ className: 'Flowpack\JobQueue\Doctrine\Queue\DoctrineQueue'
53+ options:
54+ tableName: 'flowpack_jobqueue_QueueIndexerLive'
3855
3956# Batch Indexing
4057
4158## How to build indexing job
4259
4360 flow nodeindexqueue:build --workspace live
44-
61+
4562## How to process indexing job
4663
4764You can use this CLI command to process indexing job:
@@ -56,20 +73,20 @@ You can disable async live indexing by editing ```Settings.yaml```:
5673 ElasticSearch:
5774 ContentRepositoryQueueIndexer:
5875 enableLiveAsyncIndexing: false
59-
76+
6077You can use this CLI command to process indexing job:
6178
62- flow nodeindexqueue:work --queue live
79+ flow nodeindexqueue:work --queue live
6380
6481# Supervisord configuration
6582
6683You can use tools like ``` supervisord ``` to manage long runing process. Bellow you can
6784found a basic configuration:
6885
6986 [supervisord]
70-
87+
7188 [supervisorctl]
72-
89+
7390 [program:elasticsearch_batch_indexing]
7491 command=php flow nodeindexqueue:work --queue batch
7592 stdout_logfile=AUTO
@@ -80,7 +97,7 @@ found a basic configuration:
8097 autostart=true
8198 autorestart=true
8299 stopsignal=QUIT
83-
100+
84101 [program:elasticsearch_live_indexing]
85102 command=php flow nodeindexqueue:work --queue live
86103 stdout_logfile=AUTO
0 commit comments