OrgGo/Mainflux.mainflux
1
0
Fork 0
mirror of https://github.com/mainflux/mainflux.git synced 2025-04-26 13:48:53 +08:00
Code Issues Projects Releases Wiki Activity
Mainflux.mainflux/readers/cassandra
History
Ivan Milošević 8e9d7b4fdb MF-389 - Add documentation for Writers and Readers (#398) 
* MF-389 - Add documentation for Writers and Readers

Signed-off-by: Ivan Milošević <iva@blokovi.com>

* MF-389 - Update readme files for readers and writers

Signed-off-by: Ivan Milošević <iva@blokovi.com>

* MF-389 - Update mongodb-reader docker-compose.yml

Signed-off-by: Ivan Milošević <iva@blokovi.com>

* Fix links formatting in docs

Signed-off-by: Ivan Milošević <iva@blokovi.com>

* Updated reader and writer docs

Signed-off-by: Ivan Milošević <iva@blokovi.com>

* Fix formatting

Signed-off-by: Ivan Milošević <iva@blokovi.com>

* Update Grafana access

Signed-off-by: Ivan Milošević <iva@blokovi.com>
2018-09-20 15:32:50 +02:00
..
doc.go
MF-325 - Add SPDX license and copyright headers (#362)
2018-08-26 13:15:48 +02:00
init.go
MF-325 - Add SPDX license and copyright headers (#362)
2018-08-26 13:15:48 +02:00
messages_test.go
MF-325 - Add SPDX license and copyright headers (#362)
2018-08-26 13:15:48 +02:00
messages.go
MF-325 - Add SPDX license and copyright headers (#362)
2018-08-26 13:15:48 +02:00
README.md
MF-389 - Add documentation for Writers and Readers (#398)
2018-09-20 15:32:50 +02:00
setup_test.go
MF-325 - Add SPDX license and copyright headers (#362)
2018-08-26 13:15:48 +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_THINGS_URL Things service URL localhost:8181

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]
    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] $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.