README

Summary

Web service intended to provide operations on electronic devices (create, edit, fetch device's data, etc.)

Description

Application can be used for creating and editing electronic devices profiles

Compile

For JDK 8

mvnw clean install spring-boot:repackage -Pnon_module_java,test-jar -DskipTests

to build image to Docker daemon:

mvnw clean install -Pnon_module_java,test-jar,jib -DskipTests

For JDK 11

mvnw clean install spring-boot:repackage -Pmodule_java,test-jar,jib -DskipTests

building image to Docker daemon:

mvnw clean package -Pmodule_java,test-jar,jib -DskipTests

buidling and deploying docker image to DockerHub:

mvnw -s settings.xml clean package -Pmodule_java,test-jar,jib -DskipTests -Denv.DOCKERHUB_USERNAME=<username> -Denv.DOCKERHUB_PASSWORD=<password>

Run with containerized PostgreSQL

Run PostgreSQL in docker-container via command:

docker run --name db-postgres -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=password -e POSTGRES_DB=devicedb -p 5432:5432 -d postgres

cd ${project.build.directory}/repackage
java -jar com.sensiblemetrics.api.webgate-mqtt-adapter-0.1.0-SNAPSHOT-exec.jar

where

project.build.directory=modules/webgate-mqtt-adapter/.build/bin/com.sensiblemetrics.api.webgate.mqtt.adapter

or simply run:

scripts/run.bat

Deploy with Kubectl

1. Start the WebGate MQTT Adapter service:

kubectl run spring-boot-jib --image=$IMAGE --port=8080 --restart=Never

2. Wait until pod is up and running:

kubectl port-forward spring-boot-jib 8080

Download Docker image (RegistryHub)

docker pull alexanderr/webgate:0.1.0-SNAPSHOT

Usage

Choose one of the modules and add to your pom.xml

<dependency>
    <groupId>com.sensiblemetrics.api</groupId>
    <artifactId>{module.artifactId}</artifactId>
    <version>{lib.version}</version>
</dependency>

Bundle with all WebGate dependencies:

• WebGate All
  webgate-all - Library to work with WebGate API.

WebGate module dependencies:

• WebGate Actuator
  webgate-actuator - Library to work with Actuator API.

• WebGate Admin
  webgate-admin - Library to work with Admin API.

• WebGate Caching
  webgate-cachin - Library to work with Caching API.

• WebGate Commons
  webgate-commons - Library with utilities for common use cases.

• WebGate Executor
  webgate-executor - Library to work with Executor API.

• WebGate Logger
  webgate-logger - Library to work with Logger API.

• WebGate Metrics
  webgate-metrics - Library to work with Metrics API.

• WebGate MQTT Adapter
  webgate-mqtt-adapter - Library to work with MQTT API.

• WebGate Router
  webgate-router - Library to work with Router API.

• WebGate Security
  webgate-security - Library to work with Security API.

Version Store

./pom.xml

Miscellaneous

You can find more useful libs and examples on wiki

Authors

webgate is maintained by:

• Alexander Rogalskiy

with community support please contact with us if you have some question or proposition.

Team Tools

SensibleMetrics Team would like inform that JetBrains is helping by provided IDE to develop the application. Thanks to its support program for an Open Source projects!

SensibleMetrics webgate project is using SonarCloud for code quality. Thanks to SonarQube Team for free analysis solution for open source projects.

License

SensibleMetrics webgate is distributed under LGPL version 3 or later, see COPYING.LESSER(LGPL) and COPYING(GPL).
LGPLv3 is additional permissions on top of GPLv3.