Mainflux.mainflux/readers/cassandra
beres 61b2d6b87b MF-596 - Add subtopic to RawMessage (#642)
* Commit for mainflux-596
Modified and tested:
- cli
- http
- mqtt
- normalizer
- all readers
- sdk messages
- all writers
- ws
Missing:
- coap
- lora

Signed-off-by: ale <ale@metaverso.org>

* - fix subtopic name in, when starting with dot, http/ws/mqtt
- add some test on readers

Signed-off-by: ale <ale@metaverso.org>

* - fix string concatenation
- update http/transport regexp to match subtopic names with only \w-
- update ws/transport regexp like http ones with also the wildcard * and >

Signed-off-by: ale <ale@metaverso.org>

* added subtopic support to coap adapter

Signed-off-by: ale <ale@metaverso.org>

* - update replace functions with replaceall when needed
- renamed getDestChannel to fmtSubject
- update api/transport and ws/transport route to be more readable
- fix mqtt syntax
- renamed func andQuery to query as suggested by @anovakovic01
- have a nice we :)

Signed-off-by: ale <ale@metaverso.org>

* - fix error declaration on ws/nat/publisher
- fix regexp added missing allowed chars - and _ on coap/api/transport
- fix subtopic clean suffix / if present on coap/api/transport
- improve regexp on http and ws /api/transport, now does not accept url that do not strictly match
- add some ws subtopic tests

Signed-off-by: ale <ale@metaverso.org>

* - enabled wildcard chars on coap/api/transport
- allow use special chars on http and ws api/transport

Signed-off-by: ale <ale@metaverso.org>

* - use strings.Replace() insted ReplaceAll()

Signed-off-by: ale <ale@metaverso.org>

* - allow every chars on subtopics
- fix replace error on mqtt

Signed-off-by: ale <ale@metaverso.org>

* fix cassandra test

Signed-off-by: ale <ale@metaverso.org>

* fix ws test with invalid subtopic

Signed-off-by: ale <ale@metaverso.org>

* fix invalid GOCACHE in go1.12, replaced by -count 1, see https://golang.org/doc/go1.10#test

Signed-off-by: ale <ale@metaverso.org>

* - improve regexp on http/ws api/transport
- minor changes

Signed-off-by: ale <ale@metaverso.org>

* - add generic function parseSubtopic on ws/http adapters

Signed-off-by: ale <ale@metaverso.org>

* - add generic function fmtSubtopic on coap adapter

Signed-off-by: ale <ale@metaverso.org>
2019-03-15 18:38:07 +01:00
..
README.md Add TLS support to CoAP adapter and all readers (#459) 2018-11-20 12:52:28 +01: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.go MF-596 - Add subtopic to RawMessage (#642) 2019-03-15 18:38:07 +01:00
messages_test.go MF-596 - Add subtopic to RawMessage (#642) 2019-03-15 18:38:07 +01:00
setup_test.go MF-443 Update project dependencies (#444) 2018-11-07 10:18:57 +01: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
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_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_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.