Mainflux.mainflux/readers/postgres/README.md

Postgres reader

Postgres reader provides message repository implementation for Postgres.

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_THINGS_URL	Things service URL	things:8183
MF_POSTGRES_READER_LOG_LEVEL	Service log level	debug
MF_POSTGRES_READER_PORT	Service HTTP port	9204
MF_POSTGRES_READER_CLIENT_TLS	TLS mode flag	false
MF_POSTGRES_READER_CA_CERTS	Path to trusted CAs in PEM format
MF_POSTGRES_READER_DB_HOST	Postgres DB host	postgres
MF_POSTGRES_READER_DB_PORT	Postgres DB port	5432
MF_POSTGRES_READER_DB_USER	Postgres user	mainflux
MF_POSTGRES_READER_DB_PASS	Postgres password	mainflux
MF_POSTGRES_READER_DB_NAME	Postgres database name	messages
MF_POSTGRES_READER_DB_SSL_MODE	Postgres SSL mode	disabled
MF_POSTGRES_READER_DB_SSL_CERT	Postgres SSL certificate path	""
MF_POSTGRES_READER_DB_SSL_KEY	Postgres SSL key	""
MF_POSTGRES_READER_DB_SSL_ROOT_CERT	Postgres SSL root certificate path	""
MF_JAEGER_URL	Jaeger server URL	localhost:6831
MF_POSTGRES_READER_THINGS_TIMEOUT	Things gRPC request timeout in seconds	1

Deployment

  version: "3.7"
  postgres-writer:
    image: mainflux/postgres-writer:[version]
    container_name: [instance name]
    depends_on:
      - postgres
      - nats
    restart: on-failure
    environment:
      MF_NATS_URL: [NATS instance URL]
      MF_POSTGRES_READER_LOG_LEVEL: [Service log level]
      MF_POSTGRES_READER_PORT: [Service HTTP port]
      MF_POSTGRES_READER_DB_HOST: [Postgres host]
      MF_POSTGRES_READER_DB_PORT: [Postgres port]
      MF_POSTGRES_READER_DB_USER: [Postgres user]
      MF_POSTGRES_READER_DB_PASS: [Postgres password]
      MF_POSTGRES_READER_DB_NAME: [Postgres database name]
      MF_POSTGRES_READER_DB_SSL_MODE: [Postgres SSL mode]
      MF_POSTGRES_READER_DB_SSL_CERT: [Postgres SSL cert]
      MF_POSTGRES_READER_DB_SSL_KEY: [Postgres SSL key]
      MF_POSTGRES_READER_DB_SSL_ROOT_CERT: [Postgres SSL Root cert]
      MF_JAEGER_URL: [Jaeger server URL]
      MF_POSTGRES_READER_THINGS_TIMEOUT: [Things gRPC request timeout in seconds]
    ports:
      - 8903:8903
    networks:
      - docker_mainflux-base-net

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 postgres writer
make postgres-writer

# copy binary to bin
make install

# Set the environment variables and run the service
MF_THINGS_URL=[Things service URL] MF_POSTGRES_READER_LOG_LEVEL=[Service log level] MF_POSTGRES_READER_PORT=[Service HTTP port] MF_POSTGRES_READER_CLIENT_TLS =[TLS mode flag] MF_POSTGRES_READER_CA_CERTS=[Path to trusted CAs in PEM format] MF_POSTGRES_READER_DB_HOST=[Postgres host] MF_POSTGRES_READER_DB_PORT=[Postgres port] MF_POSTGRES_READER_DB_USER=[Postgres user] MF_POSTGRES_READER_DB_PASS=[Postgres password] MF_POSTGRES_READER_DB_NAME=[Postgres database name] MF_POSTGRES_READER_DB_SSL_MODE=[Postgres SSL mode] MF_POSTGRES_READER_DB_SSL_CERT=[Postgres SSL cert] MF_POSTGRES_READER_DB_SSL_KEY=[Postgres SSL key] MF_POSTGRES_READER_DB_SSL_ROOT_CERT=[Postgres SSL Root cert] MF_JAEGER_URL=[Jaeger server URL] MF_POSTGRES_READER_THINGS_TIMEOUT=[Things gRPC request timeout in seconds] $GOBIN/mainflux-postgres-reader

Usage

Starting service will start consuming normalized messages in SenML format.