mirror of
https://github.com/mainflux/mainflux.git
synced 2025-05-11 19:29:16 +08:00
83ff4e12ea
* Change service Default ports Updated ports: - auth http 9000 - auth grpc 7000 - provision http 9001 - things http 9002 - things auth http 9003 - things auth grpc 7001 - twins http 9004 - users http 9005 - bootstrap http 9006 - cassandra-reader http 9007 - cassandra-writer http 9008 - influxdb-reader http 9009 - influxdb-writer http 9010 - lora http 9011 - mongodb reader http 9012 - mongodb writer http 9013 - postgres-reader http 9014 - postgrs-writer http 9015 - smpp-notifier http 9016 - smtp-notifier http 9017 - timescale-reader http 9018 - timescale-writer http 9019 Signed-off-by: SammyOina <sammyoina@gmail.com> * change default service ports on env and sh Signed-off-by: SammyOina <sammyoina@gmail.com> * change things url default port Signed-off-by: SammyOina <sammyoina@gmail.com> * change default ports order by importance - auth http 9000 - auth grpc 7000 - things http 9001 - things auth http 9002 - things auth grpc 7001 - users http 9003 - cassandra-reader http 9004 - cassandra-writer http 9005 - influxdb-reader http 9006 - influxdb-writer http 9007 - mongodb reader http 9008 - mongodb writer http 9009 - postgres-reader http 9010 - postgres-writer http 9011 - timescale-reader http 9012 - timescale-writer http 9013 - bootstrap http 9014 - smpp-notifier http 9015 - smtp-notifier http 9016 - provision http 9017 - lora http 9018 - twins http 9019 Signed-off-by: SammyOina <sammyoina@gmail.com> * lower port number in auth service Signed-off-by: SammyOina <sammyoina@gmail.com> * change things and users port - things 9000 - things auth 9001 - things auth grpc 7000 - users 9002 Signed-off-by: SammyOina <sammyoina@gmail.com> * update documentaton to new port numbers Signed-off-by: SammyOina <sammyoina@gmail.com> * update test and metrics Signed-off-by: SammyOina <sammyoina@gmail.com> * update host on metrics Signed-off-by: SammyOina <sammyoina@gmail.com> * resolving conflics Signed-off-by: SammyOina <sammyoina@gmail.com> * set http adapter port to :80 Signed-off-by: SammyOina <sammyoina@gmail.com> * reassign http port on metrics to :80 Signed-off-by: SammyOina <sammyoina@gmail.com> * reassign http adapter port Signed-off-by: SammyOina <sammyoina@gmail.com> * set http adapter port to 8008 Signed-off-by: SammyOina <sammyoina@gmail.com> * document http adapter default port Signed-off-by: SammyOina <sammyoina@gmail.com> --------- Signed-off-by: SammyOina <sammyoina@gmail.com>
81 lines
3.7 KiB
Markdown
81 lines
3.7 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_PORT | Service HTTP port | 9007 |
|
|
| MF_MONGO_READER_DB | MongoDB database name | messages |
|
|
| MF_MONGO_READER_DB_HOST | MongoDB database host | localhost |
|
|
| MF_MONGO_READER_DB_PORT | MongoDB database port | 27017 |
|
|
| MF_MONGO_READER_CLIENT_TLS | Flag that indicates if TLS should be turned on | false |
|
|
| MF_MONGO_READER_CA_CERTS | Path to trusted CAs in PEM format | |
|
|
| MF_MONGO_SERVER_CERT | Path to server certificate in pem format | |
|
|
| MF_MONGO_SERVER_KEY | Path to server key in pem format | |
|
|
| MF_JAEGER_URL | Jaeger server URL | localhost:6831 |
|
|
| 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_AUTH_GRPC_URL | Auth service gRPC URL | localhost:7001 |
|
|
| MF_AUTH_GRPC_TIMEOUT | Auth service gRPC request timeout in seconds | 1s |
|
|
|
|
|
|
## 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_PORT=[Service HTTP port] \
|
|
MF_MONGO_READER_DB=[MongoDB database name] \
|
|
MF_MONGO_READER_DB_HOST=[MongoDB database host] \
|
|
MF_MONGO_READER_DB_PORT=[MongoDB database port] \
|
|
MF_MONGO_READER_CLIENT_TLS=[Flag that indicates if TLS should be turned on] \
|
|
MF_MONGO_READER_CA_CERTS=[Path to trusted CAs in PEM format] \
|
|
MF_JAEGER_URL=[Jaeger server URL] \
|
|
MF_MONGO_READER_SERVER_CERT=[Path to server pem certificate file] \
|
|
MF_MONGO_READER_SERVER_KEY=[Path to server pem key file] \
|
|
MF_THINGS_AUTH_GRPC_URL=[Things service Auth gRPC URL] \
|
|
MF_THINGS_AUTH_GRPC_TIMEOUT=[Things service Auth gRPC request timeout in seconds] \
|
|
$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.
|
|
|
|
[doc]: https://docs.mainflux.io
|