OrgGo/Mainflux.mainflux
1
0
Fork 0
mirror of https://github.com/mainflux/mainflux.git synced 2025-05-09 19:29:29 +08:00
Code Issues Projects Releases Wiki Activity
Mainflux.mainflux/readers/cassandra
History
Dušan Borovčanin 8be2516321 MF-780 - Use Normalizer as a lib (#915) 
* Use Normalizer as a lib

To normalize messages on the consumer side, Normalizer is moved
to the internal pkgs. Writers being message consumers are modified to
do message normalization instead of subscribing to normalized messages
subject.

Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>

* Fix logging middleware for readers and writers

Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>

* Remove normalizer interface

Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>

* Use Normalizer in writers

As we agreed on #919, we'll use normalizer as an interface and provide
the default SenML implementation. Because of that, Normalizer is removed
from `internal` and we'll use the project structure proposed in the
aforementioned issue.

Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>

* Fix tests

Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>

* Remove unused batch settings from influxDB reader

Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>

* Update docs

Move Normalizer service to `addons`.

Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>

* Rename channels input topic

Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>

* Update Noramlizer docs

Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>

* Remove commented code

Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>

* Update readers logging

Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>

* Update addons docker-compose files

Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>

* Update topcis explanations

Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>
2019-10-31 14:04:47 +01:00
..
doc.go
MF-788 - Remove date and minimize copyright comments (#876)
2019-10-07 16:14:47 +02:00
init.go
MF-788 - Remove date and minimize copyright comments (#876)
2019-10-07 16:14:47 +02:00
messages_test.go
MF-780 - Use Normalizer as a lib (#915)
2019-10-31 14:04:47 +01:00
messages.go
MF-788 - Remove date and minimize copyright comments (#876)
2019-10-07 16:14:47 +02:00
README.md
MF-780 - Use Normalizer as a lib (#915)
2019-10-31 14:04:47 +01:00
setup_test.go
MF-788 - Remove date and minimize copyright comments (#876)
2019-10-07 16:14:47 +02:00

README.md

Cassandra reader

Cassandra reader provides message repository implementation for Cassandra.

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_CASSANDRA_READER_PORT Service HTTP port 8180
MF_CASSANDRA_READER_DB_CLUSTER Cassandra cluster comma separated addresses 127.0.0.1
MF_CASSANDRA_READER_DB_KEYSPACE Cassandra keyspace name mainflux
MF_CASSANDRA_READER_DB_USERNAME Cassandra DB username
MF_CASSANDRA_READER_DB_PASSWORD Cassandra DB password
MF_CASSANDRA_READER_DB_PORT Cassandra DB port 9042
MF_THINGS_URL Things service URL localhost:8181
MF_CASSANDRA_READER_CLIENT_TLS Flag that indicates if TLS should be turned on false
MF_CASSANDRA_READER_CA_CERTS Path to trusted CAs in PEM format
MF_JAEGER_URL Jaeger server URL localhost:6831
MF_CASSANDRA_READER_THINGS_TIMEOUT Things gRPC request timeout in seconds 1

Deployment

  version: "3.7"
  cassandra-reader:
    image: mainflux/cassandra-reader:[version]
    container_name: [instance name]
    expose:
      - [Service HTTP port]
    restart: on-failure
    environment:
      MF_THINGS_URL: [Things service URL]
      MF_CASSANDRA_READER_PORT: [Service HTTP port]
      MF_CASSANDRA_READER_DB_CLUSTER: [Cassandra cluster comma separated addresses]
      MF_CASSANDRA_READER_DB_KEYSPACE: [Cassandra keyspace name]
      MF_CASSANDRA_READER_DB_USERNAME: [Cassandra DB username]
      MF_CASSANDRA_READER_DB_PASSWORD: [Cassandra DB password]
      MF_CASSANDRA_READER_DB_PORT: [Cassandra DB port]
      MF_CASSANDRA_READER_CLIENT_TLS: [Flag that indicates if TLS should be turned on]
      MF_CASSANDRA_READER_CA_CERTS: [Path to trusted CAs in PEM format]
      MF_JAEGER_URL: [Jaeger server URL]
      MF_CASSANDRA_READER_THINGS_TIMEOUT: [Things gRPC request timeout in seconds]
    ports:
      - [host machine port]:[configured HTTP port]

To start the service, execute the following shell script:

# download the latest version of the service
go get github.com/mainflux/mainflux


cd $GOPATH/src/github.com/mainflux/mainflux

# compile the cassandra
make cassandra-reader

# copy binary to bin
make install

# Set the environment variables and run the service
MF_THINGS_URL=[Things service URL] MF_CASSANDRA_READER_PORT=[Service HTTP port] MF_CASSANDRA_READER_DB_CLUSTER=[Cassandra cluster comma separated addresses] MF_CASSANDRA_READER_DB_KEYSPACE=[Cassandra keyspace name] MF_CASSANDRA_READER_DB_USERNAME=[Cassandra DB username] MF_CASSANDRA_READER_DB_PASSWORD=[Cassandra DB password] MF_CASSANDRA_READER_DB_PORT=[Cassandra DB port] MF_CASSANDRA_READER_CLIENT_TLS=[Flag that indicates if TLS should be turned on] MF_CASSANDRA_READER_CA_CERTS=[Path to trusted CAs in PEM format] MF_JAEGER_URL=[Jaeger server URL] MF_CASSANDRA_READER_THINGS_TIMEOUT=[Things gRPC request timeout in seconds] $GOBIN/mainflux-cassandra-reader

Using docker-compose

This service can be deployed using docker containers. Docker compose file is available in <project_root>/docker/addons/cassandra-reader/docker-compose.yml. In order to run all Mainflux core services, as well as mentioned optional ones, execute following command:

docker-compose -f docker/docker-compose.yml up -d
./docker/addons/cassandra-writer/init.sh
docker-compose -f docker/addons/casandra-reader/docker-compose.yml up -d

Usage

Service exposes HTTP API for fetching messages.