This release is a pre-release and may not be stable for production use.
udata-search-service
A search service for udata. The idea is to have search service separated from the udata MongoDB. The indexation update is made using real-time messages with Kafka.
See the following architecture schema:
Getting started
You can follow this recommended architecture for your code:
$WORKSPACE
├── fs
├── udata
│ ├── ...
│ └── setup.py
│ └── udata.cfg
├── udata-front
│ ├── ...
│ └── setup.py
└── udata-search-service
├── ...
└── pyproject.toml
Clone the repository:
cd $WORKSPACE
git clone git@github.com:opendatateam/udata-search-service.git
Start the different services using docker-compose:
cd udata-search-service
docker-compose up
This will start:
- an elasticsearch
- a kafka broker
- a zookeper
- a kafka consumer
- a search app
Initialize the elasticsearch indices on setup.
# Locally
udata-search-service init-es
# In the docker context
docker-compose run --entrypoint /bin/bash web -c 'udata-search-service init-es'
This will create the following indices:
- {UDATA_INSTANCE_NAME}-dataset-{yyyy}-{mm}-{dd}-{HH}-{MM}
- {UDATA_INSTANCE_NAME}-reuse-{yyyy}-{mm}-{dd}-{HH}-{MM}
- {UDATA_INSTANCE_NAME}-organization-{yyyy}-{mm}-{dd}-{HH}-{MM}
Configure your udata to use the search service, by updating the following variables in your udata.cfg. Ex in local:
SEARCH_SERVICE_API_URL = 'http://127.0.0.1:5000/api/1/'
KAFKA_URI = 'localhost:9092'
You can feed the elasticsearch by publishing messages to Kafka. Using udata, when you modify objects, indexation messages will be sent and will be consumed by the kafka consumer. If you want to reindex your local mongo base in udata, you can run:
cd $WORKSPACE/udata/
source ./venv/bin/activate
udata search index
Make sure to have the corresponding UDATA_INSTANCE_NAME specified in your udata settings.
After a reindexation, you'll need to change the alias by using the following command:
# Locally
udata-search-service set-alias <index-suffix>
# In the docker context
docker-compose run --entrypoint /bin/bash web -c 'udata-search-service set-alias <index-suffix>'
You can query the search service with the search service api, ex: http://localhost:5000/api/1/datasets/?q=toilettes%20à%20rennes
Development
You can create a virtualenv, activate it and install the requirements with the following commands.
python3 -m venv venv
source venv/bin/activate
make deps
make install
You can start the Elasticsearch and Kafak broker and zookeper using the docker compose. You can start the consumer locally with the following command:
udata-search-service consume-kafka
You can start the web search service with the following command:
udata-search-service run
Deployment
The project depends on Kafka and ElasticSearch 7.16.
Elasticsearch requires the Analysis ICU plugin for your specific version. On Debian, you can take a look at these instructions for installation.
You will need a Kafka broker and zookeeper. You can follow the quick-start instructions to start all services in correct order.
You will need to start a search service app a kafka consumer. You can start these using uWSGI.
Troubleshooting
- If the elasticsearch service exits with an error 137, it is killed due to out of memory error. You should read the following points.
- If you are short on RAM, you can limit heap memory by setting
ES_JAVA_OPTS=-Xms750m -Xmx750mas environment variable when starting the elasticsearch service. - If you are on MAC and still encounter RAM memory issues, you should increase Docker limit memory to 4GB instead of default 2GB.
- If you are on Linux, you may need to double the vm.max_map_count. You can set it with the following command:
sysctl -w vm.max_map_count=262144. - If you are on Linux, you may encounter permissions issues. You can either create the volume or change the user to the current user using
chown.
2 maintainers
Metadata
2 maintainers
Release files for udata-search-service 1.0.3.dev191
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| udata-search-service-1.0.3.dev191.tar.gz | 40.5 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| udata_search_service-1.0.3.dev191-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 59.1 kB
Release files / udata-search-service-1.0.3.dev191.tar.gz
| Download URL | udata-search-service-1.0.3.dev191.tar.gz |
|---|---|
| Size | 40.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1169b18ec6e6c3af5fbc887e6b0ef380f6197163504097790a8bb4b377b47086
|
|
BLAKE2b-256 checksum How to use checksums |
3011e9fb6637eb64280aafea3dd51181fb505869e0792a45f82e67f545a6efab
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.27.1
|
Release files / udata_search_service-1.0.3.dev191-py2.py3-none-any.whl
| Download URL | udata_search_service-1.0.3.dev191-py2.py3-none-any.whl |
|---|---|
| Size | 18.7 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
fb5e082d043d4d5cce6a74acbea62492e21bf6dee236411d45a5fe1d08845cc6
|
|
BLAKE2b-256 checksum How to use checksums |
7a33c2ea215ac8232c1321c9a9cc065ab5a334371914cc8fa206fdf3b30fe731
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.27.1
|
Security for udata-search-service 1.0.3.dev191
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
