This project is part of FIWARE, being part of the Cosmos Ecosystem.
Cygnus is a connector in charge of persisting certain sources of data in certain configured third-party storages, creating a historical view of such data.
Internally, Cygnus is based on Apache Flume, a technology addressing the design and execution of data collection and persistence agents. An agent is basically composed of a listener or source in charge of receiving the data, a channel where the source puts the data once it has been transformed into a Flume event, and a sink, which takes Flume events from the channel in order to persist the data within its body into a third-party storage.
Cygnus is designed to run a specific Flume agent per source of data.
Current stable release is able to persist the following sources of data in the following third-party storages:
- NGSI-like context data in:
- HDFS, the Hadoop distributed file system.
- MySQL, the well-know relational database manager.
- CKAN, an Open Data platform.
- MongoDB, the NoSQL document-oriented database.
- STH Comet, a Short-Term Historic database built on top of MongoDB.
- Kafka, the publish-subscribe messaging broker.
- DynamoDB, a cloud-based NoSQL database by Amazon Web Services.
- PostgreSQL, the well-know relational database manager.
- Carto, the database specialized in geolocated data.
- Twitter data in:
IMPORTANT NOTE: for the time being, cygnus-ngsi and cygus-twitter agents cannot be installed in the same base path, because of an incompatibility with the required version of the httpclient library. Of course, if you are going to use just one of the agents, there is no problem at all.
Cygnus (more specifically, cygnus-ngsi agent) plays the role of a connector between Orion Context Broker (which is a NGSI source of data) and many FIWARE storages such as CKAN, Cosmos Big Data (Hadoop) and STH Comet. Of course, as previously said, you may add MySQL, Kafka, Carto, etc as other non FIWARE storages to the FIWARE architecture.
The per agent Quick Start Guide found at readthedocs.org provides a good documentation summary (cygnus-ngsi, cygnus-twitter).
Nevertheless, both the Installation and Administration Guide and the User and Programmer Guide for each agent also found at readthedocs.org cover more advanced topics.
The per agent Flume Extensions Catalogue completes the available documentation for Cygnus (cygnus-ngsi, cygnus-twitter).
Other interesting links are:
- Our Apiary Documentation if you want to know how to use our API methods for Cygnus.
- cygnus-ngsi integration examples .
- cygnus-ngsi introductory course in FIWARE Academy.
- The Contributing Guidelines if your aim is to extend Cygnus.
Cygnus is licensed under Affero General Public License (GPL) version 3. You can find a copy of this license in the repository.
Any doubt you may have, please refer to the Cygnus Core Team.