Open Source Lightweight Microservices Architecture for the Internet of Things. For developers.
Switch branches/tags
Nothing to show
Clone or download
FedeG and andreareginato Add types-dashboard, devices-dashboard and dev-center to lelylan in d…
…evelopment mode and update documentation (#151)

* add docker-compose files for all lelylan services
* #144 - Docker-compose documentation
* #144 - Add docker-compose for develoment
* #144 - Add docker-compose for production
* #144 - Add dependencies for docker compose containers
* add nginx-proxy container https://github.com/jwilder/nginx-proxy
* add VIRTUAL_HOST and VIRTUAL_PORT environments https://github.com/jwilder/nginx-proxy/blob/master/README.md#usage
* change default PORT to 80 or 8000 for new proxy
* fixbug - Error in docker image name
* add expose configuration to database containers
* update docker-compose for development mode
* close #150 - Add dev-center to docker compose
* close #149 - Add devices-dashboard to docker compose
* close #148 - Add types-dashboard to docker compose
* #147 - Add documentation for LELYLAN_DEV_URL and LELYLAN_DEV_PORT
* fix #147 - Add LELYLAN_DEV_URL and LELYLAN_DEV_PORT in docker compose
* close #147 - Documentation for #147, #148, #149 and #150
* fixed some details (ports and host in docker-compose)
* update environment variables
* update documentation
* update environment variables
* update documentation for custom host
* fix #152 - Update environment variables documentation
* #152 - Update environment variables
* #152 - Update environment variables
* #152 - Update environment variables documentation
* update environment variables and use mongo with smallfiles
* update environment variables
* add environment variable for log debug in physicals
Latest commit 4582a92 Mar 12, 2017

README.md

Lelylan. Open Source Internet of Things

Lelylan is an IoT cloud platform based on a lightweight microservices architecture.

The Lelylan platform is both hardware-agnostic and platform-agnostic. This means that you can connect any hardware, from the ESP8266 to the most professional embedded hardware solution and everything in between - and it can run on any public cloud, your own private datacenter, or even in a hybrid environment, whether virtualized or bare metal.

Lelylan Logo

Notes

This repository defines the architecture documentation. Check out the microservices list for the code implementation.

Why Lelylan

Research in the Internet of Things is global and growing fast, but lacks the standard tools. Many companies are building their own solutions. By sharing what we have learned during the years, we want to create a shared code base with a clear focus on developers. To see Lelylan in action checkout the tutorials in the dev center.

Resources

Getting Started

Requirements

Lelylan is tested against

  • Ruby MRI ~1.9.3
  • Node ~0.8.8
  • MongoDB ~2.6
  • Redis ~2.6

(remember to run the mongod and redis-server)

Setup

Installation

Development

Lelylan is composed by different microservices. Follow the installation guidelines for each of them.

Microservice Description
API Proxy Proxy API
Devices API Device monitoring and control
Types API Device type structure
Subscriptions API Realtime subscription
Profiles API Profile information
OAuth 2.0 User authentication and authorization
Physical Proxy Forward requests to the physical world
MQTT Node Forward and receive MQTT requests
MQTT Server MQTT server/broker
Webhooks Realtime HTTP notification
Websockets Full-duplex communication over TCP
Dev Center Lelylan Dev Center
Devices Dashboard Lelylan Devices Dashboard
Types Dashboard Lelylan Types Dashboard

You can now access the APIs from http://0.0.0.0:8200 (API proxy URL).

Development Environment Variable

During deployment, every microservice needs to be set to the following environment variables (remember to change them with your own microservices, mongodb, redis and cache URLs).

Environment Variable Description
RACK_ENV=development Development rack environment
RAILS_ENV=development Development rails environment
NODE_ENV=development Development node environment
LELYLAN_API_URL Api Proxy microservice URL
LELYLAN_API_HOST Api Proxy microservice URL
LELYLAN_DEV_URL=dev.lelylan.com Dev Center microservice URL
LELYLAN_PEOPLE_URL=people.lelylan.com OAuth 2.0 microservice URL
LELYLAN_DEVICES_URL=devices.lelylan.com Devices API microservice URL
LELYLAN_TYPES_URL=types.lelylan.com Types API microservice URL
LELYLAN_SUBSCRIPTIONS_URL=subscriptions.lelylan.com Subs. API microservice URL
LELYLAN_PROFILES_URL=profiles.lelylan.com Profiles API microservice URL
MONGOLAB_PEOPLE_URL=mongodb://<user>:<pass>@<host>:<port>/<name> OAuth 2.0 MongoDB URL
MONGOLAB_DEVICES_URL=mongodb://<user>:<pass>@<host>:<port>/<name> Devices API MongoDB URL
MONGOLAB_TYPES_URL=mongodb://<user>:<pass>@<host>:<port>/<name> Types API MongoDB URL
MONGOLAB_JOBS_URL=mongodb://<user>:<pass>@<host>:<port>/<name> Event Bus MongoDB URL
MONGOLAB_SUBSCRIPTIONS_URL=mongodb://<user>:<pass>@<host>:<port>/<name> Subs. MongoDB URL
MEMCACHIER_SERVERS=<host>:<port> Cache server
MEMCACHIER_USERNAME=<username> Cache server username
MEMCACHIER_PASSWORD=<password> Cache server password
REDIS_URL=redis://<user>:<pass>@<host>:<port>/ Background Job Redis URL
REDIS_RATE_LIMIT_URL=redis://<user>:<pass>@<host>:<port>/ Late Limit Redis URL

We are studying solutions such as Docker, Mesos, and Ansible to simplify the installation process. If you are experimenting in the same area get in touch with lelylan team.

Docker Development Installation

  • Configure environment variables in docker-compose-dev.yml
  • Run docker compose
docker-compose -f docker-compose-dev.yml up -d
Use subdomains for all microservices
Sed to replace domains
sed -i '/VIRTUAL_HOST/ s/$/.lelylan.com/' docker-compose-dev.yml
sed -i '/DEFAULT_HOST/ s/$/.lelylan.com/' docker-compose-dev.yml
sed -i '/PUBLIC_URL/ s/$/.lelylan.com/' docker-compose-dev.yml
sed -i '/LELYLAN_DEV_URL/ s/$/.lelylan.com/' docker-compose-dev.yml
sed -i '/PUBLIC_HOST/ s/$/.lelylan.com/' docker-compose-dev.yml
sed -i '/LELYLAN_PROXY_URL/ s/$/.lelylan.com/' docker-compose-dev.yml
sed -i '/LELYLAN_API_HOST/ s/$/.lelylan.com/' docker-compose-dev.yml
Microservice Default Domian Domian after sed commands
api-proxy api-proxy api-proxy.lelylan.com
devices devices devices.lelylan.com
types types types.lelylan.com
subscriptions subscriptions subscriptions.lelylan.com
profiles profiles profiles.lelylan.com
people people people.lelylan.com
physicals physicals physicals.lelylan.com
nodes nodes nodes.lelylan.com
mqtt mqtt mqtt.lelylan.com
webhooks webhooks webhooks.lelylan.com
websockets websockets websockets.lelylan.com
dev dev-center dev-center.lelylan.com
devices-dashboard-ng devices-dashboard-ng devices-dashboard-ng.lelylan.com
types-dashboard-ng types-dashboard-ng types-dashboard-ng.lelylan.com

Production

Lelylan is composed by different microservices. Follow the installation guidelines for each of them.

Microservice Description
API Proxy Proxy API
Devices API Device monitoring and control
Types API Device type structure
Subscriptions API Realtime subscription
Profiles API Profile information
OAuth 2.0 User authentication and authorization
Physical Proxy Forward requests to the physical world
MQTT Node Forward and receive MQTT requests
MQTT Server MQTT server/broker
Webhooks Realtime HTTP notification
Websockets Full-duplex communication over TCP

You can now access the APIs from http://0.0.0.0:8200 (API proxy URL).

Production Environment Variable

During deployment, every microservice needs to be set to the following environment variables (remember to change them with your own microservices, mongodb, redis and cache URLs).

Environment Variable Description
RACK_ENV=production Production rack environment
RAILS_ENV=production Production rails environment
NODE_ENV=production Production node environment
LELYLAN_API_URL Api Proxy microservice URL
LELYLAN_API_HOST Api Proxy microservice URL
LELYLAN_PEOPLE_URL=people.lelylan.com OAuth 2.0 microservice URL
LELYLAN_DEVICES_URL=devices.lelylan.com Devices API microservice URL
LELYLAN_TYPES_URL=types.lelylan.com Types API microservice URL
LELYLAN_SUBSCRIPTIONS_URL=subscriptions.lelylan.com Subs. API microservice URL
LELYLAN_PROFILES_URL=profiles.lelylan.com Profiles API microservice URL
MONGOLAB_PEOPLE_URL=mongodb://<user>:<pass>@<host>:<port>/<name> OAuth 2.0 MongoDB URL
MONGOLAB_DEVICES_URL=mongodb://<user>:<pass>@<host>:<port>/<name> Devices API MongoDB URL
MONGOLAB_TYPES_URL=mongodb://<user>:<pass>@<host>:<port>/<name> Types API MongoDB URL
MONGOLAB_JOBS_URL=mongodb://<user>:<pass>@<host>:<port>/<name> Event Bus MongoDB URL
MONGOLAB_SUBSCRIPTIONS_URL=mongodb://<user>:<pass>@<host>:<port>/<name> Subs. MongoDB URL
MEMCACHIER_SERVERS=<host>:<port> Cache server
MEMCACHIER_USERNAME=<username> Cache server username
MEMCACHIER_PASSWORD=<password> Cache server password
REDIS_URL=redis://<user>:<pass>@<host>:<port>/ Background Job Redis URL
REDIS_RATE_LIMIT_URL=redis://<user>:<pass>@<host>:<port>/ Late Limit Redis URL

We are studying solutions such as Docker, Mesos, and Ansible to simplify the installation process. If you are experimenting in the same area get in touch with lelylan team.

Docker Production Installation

  • Configure environment variables in docker-compose.yml
  • Run docker compose
docker-compose up -d
Use subdomains for all microservices
Sed to replace domains
sed -i '/VIRTUAL_HOST/ s/$/.lelylan.com/' docker-compose-dev.yml
sed -i '/DEFAULT_HOST/ s/$/.lelylan.com/' docker-compose-dev.yml
sed -i '/PUBLIC_URL/ s/$/.lelylan.com/' docker-compose-dev.yml
sed -i '/LELYLAN_PROXY_URL/ s/$/.lelylan.com/' docker-compose-dev.yml
sed -i '/LELYLAN_API_HOST/ s/$/.lelylan.com/' docker-compose-dev.yml
Microservice Default Domian Domian after sed commands
api-proxy api-proxy api-proxy.lelylan.com
devices devices devices.lelylan.com
types types types.lelylan.com
subscriptions subscriptions subscriptions.lelylan.com
profiles profiles profiles.lelylan.com
people people people.lelylan.com
physicals physicals physicals.lelylan.com
nodes nodes nodes.lelylan.com
mqtt mqtt mqtt.lelylan.com
webhooks webhooks webhooks.lelylan.com
websockets websockets websockets.lelylan.com

Roadmap

The Roadmap provides the description of the items that the project has decided to concentrate on. It should serve as a reference point for Lelylan contributors to understand where the project is going, and helps to determine whether a contribution could be conflicting considering the future goals.

The fact that a feature isn't listed here doesn't mean that a patch for it will automatically be refused (we also miss important things). We are always happy to receive patches for new cool features that we haven't thought about, or didn't consider as a priority. Nevertheless understand that such patches might take longer for us to review.

Checkout the roadmap to see our near future goals.

Contributing to Lelylan

This Contributing document tries to define a contributor's guide explaining how to contribute to one or more Lelylan Microservice. It contains information about reporting issues as well as some useful tips and guidelines for experienced open source contributors.

Checkout the contributing to help us with Lelylan.

Support

Use the available communication channels to communicate your ideas, problems or suggestions.

License

Lelylan is licensed under the Apache License, Version 2.0.