mirror of
https://github.com/mainflux/mainflux.git
synced 2025-04-27 13:48:49 +08:00
3e7bac493c
* Initial Commit: Sync Env Veriables With Docker Deployment Signed-off-by: rodneyosodo <blackd0t@protonmail.com> * Sync Env Vars With Master Signed-off-by: rodneyosodo <blackd0t@protonmail.com> * Remove Altprefix Signed-off-by: rodneyosodo <blackd0t@protonmail.com> * Rename HttpPort to HTTPPort Signed-off-by: rodneyosodo <blackd0t@protonmail.com> * Fix envPrefixDB After Rebase Signed-off-by: rodneyosodo <blackd0t@protonmail.com> * Remove Server Parse Signed-off-by: rodneyosodo <blackd0t@protonmail.com> * Add Provision For TLS on CoAP Signed-off-by: rodneyosodo <blackd0t@protonmail.com> * Fix Exit After Defer Signed-off-by: rodneyosodo <blackd0t@protonmail.com> * Remove Unused Function Signed-off-by: rodneyosodo <blackd0t@protonmail.com> * Document Undocumentated Env Variables Signed-off-by: rodneyosodo <blackd0t@protonmail.com> --------- Signed-off-by: rodneyosodo <blackd0t@protonmail.com> Co-authored-by: Drasko DRASKOVIC <drasko.draskovic@gmail.com>
97 lines
5.2 KiB
Markdown
97 lines
5.2 KiB
Markdown
# MongoDB reader
|
|
|
|
MongoDB reader provides message repository implementation for MongoDB.
|
|
|
|
## Configuration
|
|
|
|
The service is configured using the environment variables presented in the
|
|
following table. Note that any unset variables will be replaced with their
|
|
default values.
|
|
|
|
| Variable | Description | Default |
|
|
| -------------------------------- | --------------------------------------------------- | ------------------------------ |
|
|
| MF_MONGO_READER_LOG_LEVEL | Service log level | info |
|
|
| MF_MONGO_READER_HTTP_HOST | Service HTTP host | localhost |
|
|
| MF_MONGO_READER_HTTP_PORT | Service HTTP port | 9007 |
|
|
| MF_MONGO_READER_HTTP_SERVER_CERT | Service HTTP server cert | "" |
|
|
| MF_MONGO_READER_HTTP_SERVER_KEY | Service HTTP server key | "" |
|
|
| MF_MONGO_NAME | MongoDB database name | messages |
|
|
| MF_MONGO_HOST | MongoDB database host | localhost |
|
|
| MF_MONGO_PORT | MongoDB database port | 27017 |
|
|
| MF_THINGS_AUTH_GRPC_URL | Things service Auth gRPC URL | localhost:7000 |
|
|
| MF_THINGS_AUTH_GRPC_TIMEOUT | Things service Auth gRPC request timeout in seconds | 1s |
|
|
| MF_THINGS_AUTH_GRPC_CLIENT_TLS | Flag that indicates if TLS should be turned on | false |
|
|
| MF_THINGS_AUTH_GRPC_CA_CERTS | Path to trusted CAs in PEM format | "" |
|
|
| MF_AUTH_GRPC_URL | Users service gRPC URL | localhost:7001 |
|
|
| MF_AUTH_GRPC_TIMEOUT | Users service gRPC request timeout in seconds | 1s |
|
|
| MF_AUTH_GRPC_CLIENT_TLS | Flag that indicates if TLS should be turned on | false |
|
|
| MF_AUTH_GRPC_CA_CERT | Path to trusted CAs in PEM format | "" |
|
|
| MF_JAEGER_URL | Jaeger server URL | http://jaeger:14268/api/traces |
|
|
| MF_SEND_TELEMETRY | Send telemetry to mainflux call home server | true |
|
|
| MF_MONGO_READER_INSTANCE_ID | Service instance ID | "" |
|
|
|
|
## Deployment
|
|
|
|
The service itself is distributed as Docker container. Check the [`mongodb-reader`](https://github.com/mainflux/mainflux/blob/master/docker/addons/mongodb-reader/docker-compose.yml#L16-L37) service section in
|
|
docker-compose to see how service is deployed.
|
|
|
|
To start the service, execute the following shell script:
|
|
|
|
```bash
|
|
# download the latest version of the service
|
|
git clone https://github.com/mainflux/mainflux
|
|
|
|
cd mainflux
|
|
|
|
# compile the mongodb reader
|
|
make mongodb-reader
|
|
|
|
# copy binary to bin
|
|
make install
|
|
|
|
# Set the environment variables and run the service
|
|
MF_MONGO_READER_LOG_LEVEL=[Service log level] \
|
|
MF_MONGO_READER_HTTP_HOST=[Service HTTP host] \
|
|
MF_MONGO_READER_HTTP_PORT=[Service HTTP port] \
|
|
MF_MONGO_READER_HTTP_SERVER_CERT=[Path to server pem certificate file] \
|
|
MF_MONGO_READER_HTTP_SERVER_KEY=[Path to server pem key file] \
|
|
MF_MONGO_NAME=[MongoDB database name] \
|
|
MF_MONGO_HOST=[MongoDB database host] \
|
|
MF_MONGO_PORT=[MongoDB database port] \
|
|
MF_THINGS_AUTH_GRPC_URL=[Things service Auth gRPC URL] \
|
|
MF_THINGS_AUTH_GRPC_TIMEOUT=[Things service Auth gRPC request timeout in seconds] \
|
|
MF_THINGS_AUTH_GRPC_CLIENT_TLS=[Flag that indicates if TLS should be turned on] \
|
|
MF_THINGS_AUTH_GRPC_CA_CERTS=[Path to trusted CAs in PEM format] \
|
|
MF_AUTH_GRPC_URL=[Users service gRPC URL] \
|
|
MF_AUTH_GRPC_TIMEOUT=[Users service gRPC request timeout in seconds] \
|
|
MF_AUTH_GRPC_CLIENT_TLS=[Flag that indicates if TLS should be turned on] \
|
|
MF_AUTH_GRPC_CA_CERT=[Path to trusted CAs in PEM format] \
|
|
MF_JAEGER_URL=[Jaeger server URL] \
|
|
MF_SEND_TELEMETRY=[Send telemetry to mainflux call home server] \
|
|
MF_MONGO_READER_INSTANCE_ID=[Service instance ID] \
|
|
$GOBIN/mainflux-mongodb-reader
|
|
|
|
```
|
|
|
|
### Using docker-compose
|
|
|
|
This service can be deployed using docker containers. Docker compose file is
|
|
available in `<project_root>/docker/addons/mongodb-reader/docker-compose.yml`.
|
|
In order to run all Mainflux core services, as well as mentioned optional ones,
|
|
execute following command:
|
|
|
|
```bash
|
|
docker-compose -f docker/docker-compose.yml up -d
|
|
docker-compose -f docker/addons/mongodb-reader/docker-compose.yml up -d
|
|
```
|
|
|
|
## Usage
|
|
|
|
Service exposes [HTTP API](https://api.mainflux.io/?urls.primaryName=readers-openapi.yml) for fetching messages.
|
|
|
|
```
|
|
Note: MongoDB Reader doesn't support searching substrings from string_value, due to inefficient searching as the current data model is not suitable for this type of queries.
|
|
```
|
|
|
|
[doc]: https://docs.mainflux.io
|