OrgGo
/
Mainflux.mainflux
mirror of https://github.com/mainflux/mainflux.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Mainflux.mainflux/readers/cassandra
History
Aleksandar Novaković 5202d734c9 MF-574 - Add missing environment variables to Cassandra writer (#745) 
* Add username, password and port env var

Signed-off-by: Aleksandar Novakovic <anovakovic01@gmail.com>

* Update existing readme files with new env vars

Signed-off-by: Aleksandar Novakovic <anovakovic01@gmail.com>
 		2019-05-15 23:31:40 +02:00
..
README.md MF-574 - Add missing environment variables to Cassandra writer (#745) 2019-05-15 23:31:40 +02:00
doc.go MF-325 - Add SPDX license and copyright headers (#362) 2018-08-26 13:15:48 +02:00
init.go MF-574 - Add missing environment variables to Cassandra writer (#745) 2019-05-15 23:31:40 +02:00
messages.go NOISSUE - Fix Readers logs (#735) 2019-05-07 15:59:18 +02:00
messages_test.go MF-574 - Add missing environment variables to Cassandra writer (#745) 2019-05-15 23:31:40 +02:00
setup_test.go MF-574 - Add missing environment variables to Cassandra writer (#745) 2019-05-15 23:31:40 +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

Deployment

  version: "2"
  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]
    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] $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.