mirror of
https://github.com/mainflux/mainflux.git
synced 2025-05-02 22:17:10 +08:00
58cdf2cddc
* Add mongodb reader service Signed-off-by: Aleksandar Novakovic <aleksandar.novakovic@mainflux.com> * Add tests for mongodb reader service Signed-off-by: Aleksandar Novakovic <aleksandar.novakovic@mainflux.com> * Add documentation for mongodb reader service Signed-off-by: Aleksandar Novakovic <aleksandar.novakovic@mainflux.com> * Fix test function name Signed-off-by: Aleksandar Novakovic <aleksandar.novakovic@mainflux.com> * Update comment in docker-compose for mongodb-reader service Signed-off-by: Aleksandar Novakovic <aleksandar.novakovic@mainflux.com>
63 lines
2.1 KiB
Markdown
63 lines
2.1 KiB
Markdown
# MongoDB writer
|
|
|
|
MongoDB writer 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_NATS_URL | NATS instance URL | nats://localhost:4222 |
|
|
| MF_MONGO_WRITER_PORT | Service HTTP port | 8180 |
|
|
| MF_MONGO_WRITER_DB_NAME | Default MongoDB database name | mainflux |
|
|
| MF_MONGO_WRITER_DB_HOST | Default MongoDB database host | localhost |
|
|
| MF_MONGO_WRITER_DB_PORT | Default MongoDB database port | 27017 |
|
|
|
|
## Deployment
|
|
|
|
```yaml
|
|
mongodb-writer:
|
|
image: mainflux/mongodb-writer:[version]
|
|
container_name: [instance name]
|
|
depends_on:
|
|
- mongodb
|
|
- nats
|
|
expose:
|
|
- [Service HTTP port]
|
|
restart: on-failure
|
|
environment:
|
|
MF_NATS_URL: [NATS instance URL]
|
|
MF_MONGO_WRITER_PORT: [Service HTTP port]
|
|
MF_MONGO_WRITER_DB_NAME: [MongoDB name]
|
|
MF_MONGO_WRITER_DB_HOST: [MongoDB host]
|
|
MF_MONGO_WRITER_DB_PORT: [MongoDB port]
|
|
ports:
|
|
- [host machine port]:[configured HTTP port]
|
|
```
|
|
|
|
To start the service, execute the following shell script:
|
|
|
|
```bash
|
|
# download the latest version of the service
|
|
go get github.com/mainflux/mainflux
|
|
|
|
|
|
cd $GOPATH/src/github.com/mainflux/mainflux
|
|
|
|
# compile the mongodb writer
|
|
make mongodb-writer
|
|
|
|
# copy binary to bin
|
|
make install
|
|
|
|
# Set the environment variables and run the service
|
|
MF_NATS_URL=[NATS instance URL] MF_MONGO_WRITER_PORT=[Service HTTP port] MF_MONGO_WRITER_DB_NAME=[MongoDB database name] MF_MONGO_WRITER_DB_HOST=[MongoDB database host] MF_MONGO_WRITER_DB_PORT=[MongoDB database port] $GOBIN/mainflux-mongodb-writer
|
|
```
|
|
|
|
## Usage
|
|
|
|
Starting service will start consuming normalized messages in SenML format.
|