Prathameshwar/repo1

SecureSKYE 's project structure

Table of Contents

• Server components
  • Databases
  • Service Discovery
  • Gateway
  • OAuth
  • User APIs
  • Vechile APIs
  • Front-end UI
• Distributions
  • Trillium docker repository
  • Deployment
• Deferred modules
• Deprecated modules
• Misc

Server components

Databases

ScyllaDB

NoSql

Homepage	http://www.scylladb.com/
Docker	scylladb/scylla:2.0.0
Exposed port	9042

PostgreSQL

RDBMS storing

1. Authentication info

2. Authorization info

3. Vehicle info

Homepage	https://www.postgresql.org/
Docker	postgres:10-alpine
Exposed port	5432

Service Discovery

Consul for service discovery and configuration

Homepage	https://www.consul.io/
Docker	consul:0.9.3
Exposed port	8500

Gateway

Traefik for HTTP reverse proxy and load balancer

Homepage	https://traefik.io/
Docker	/gateway
Exposed ports	80	Gateway using HTTP
	43	Gateway using HTTPS
	8080	Traefik management UI

OAuth

Based on OAuth2 implemented by Spring Security OAuth2. More

oauth-common

Common package for UAA & SAA modules

UAA (User Account & Authentication)

OAuth server for user, provide oauth access token for authorization.

SAA (Service Account & Authentication)

OAuth server for internal services, provide JWT for authorization.

Tip	JWT asymmetric keypair info in \jwt

User APIs

Admin

Provide APIs for user administration.

1. Base path: /api

2. Endpoints

Endpoint	Description
GET /users	List of all managed user.
GET /users/authorities	List of all authorities
GET /users/:userid	Get an user with id.
POST /users	Add an new user.
PUT /users/:userid	Update an user.
DELETE /users/:userid	Delete a registered user.

Vechile APIs

Admin

Provide APIs for vehicle administration.

1. Base path: /vehicle/admin

2. Endpoints

Endpoint	Description
/list	List of all managed vehicles.
/get/:clientid	Get vehicle by client id.

Message

Provide APIs for listening event message of vehicle

1. Base path: /vehicle/message

2. Endpoints

Endpoint	Description
/save	Save a vehicle message on the server.
/events/save	Save a batch of vehicle events on the server.
/events/list	List the recent events of a vehicle.
/events/list.json	List the recent events of a vehicle as json

Front-end UI

UI for monitoring and managing vehicles. More

Distributions

Trillium docker repository

You can connect and pull built images of services from https://10.0.0.7

Add docker\trillium.crt to Trusted Root CA to allow connection to registry server.

Deployment

Deploy via docker-compose with \compose\spring-backend\docker-compose.yml

Deferred modules

Module	Path	Description
Kubernetes	/kubernetes	Unused deploy automation
TCPI Bridge	/tcp-bridge	Bridge between TCP & HTTP
EnOcean	/enocean	Java proxy of native library ENOcean for energy harvesting wireless technology. (?)
Philips Hue	/philipshue	Module based on Philips Hue SDK for interacting with the hue system (?)
IoT Hub	/hub	Integrate with other IoT solution. For now it’s ENOcean & Philips Hue.

Deprecated modules

Module	Path	Description
Zuul	/zuul	API Gateway by Spring Cloud Netflix Zuul
Eureka	/eureka	Service discovery by Spring Cloud Netflix Eureka
Old backend server	/server	Old, unused API for spring backend
Old car API	/api	Old, unused API for car

Misc

• The project is managed by Gradle. All build, run, publish,…​ tasks are already defined by Dominik-san. Should works without problems.

• Other resources in the projects are:

Path	Summary
/gradle	Gradle build tool wrapper
/run-scripts	Script to run application automatically.
/docs	Only draft design, graphs, charts for now.