ravaga/context.orion-ld

Context Broker and CEF building block for context data management which supports both the NGSI-LD and the NGSI-v2 APIs

Orion Context Broker (with Linked Data Extensions)

This project is part of FIWARE. For more information check the FIWARE Catalogue entry for FIWARE Core Context Management.

Issues on this projects can be reported as github issues, while questions are preferred on Stack Overflow, using the tag fiware-orion.

The latest release of Orion-LD is 1.6.0 from July 2024

Orion-LD is a Context Broker and CEF building block for context data management, implementting both the NGSI-LD API and the NGSIv2 API. It is currently a fork of the original Orion Context Broker extending support to add NGSI-LD and linked data concepts. Orion-LD follows the ETSI specification for NGSI-LD and has been tested to be a stable and fast NGSI-LD broker with near compliance to the version 1.6.1 of the NGSI-LD API specification (and some features from newer releases).

License

Orion-LD is licensed under Affero General Public License (GPL) version 3.

Further information on the use of the AGPL open source license

Are there any legal issues with AGPL 3.0? Is it safe for me to use?

There is absolutely no problem in using a product licensed under AGPL 3.0. Issues with GPL (or AGPL) licenses are mostly related with the fact that different people assign different interpretations on the meaning of the term “derivate work” used in these licenses. Due to this, some people believe that there is a risk in just using software under GPL or AGPL licenses (even without modifying it).

For the avoidance of doubt, the owners of this software licensed under an AGPL-3.0 license wish to make a clarifying public statement as follows:

Please note that software derived as a result of modifying the source code of the software in order to fix a bug or incorporate enhancements IS considered a derivative work of the product. Software that merely uses or aggregates (i.e. links to) an otherwise unmodified version of existing software IS NOT considered a derivative work.

Contribution to Orion-LD

Anyone wishing to contribute to Orion-LD, be it fixing/adding documentation, tests, source code, all types of contributions are welcome. For source code contributions, please see the Contribution guidelines.

General Information on NGSI-LD

NGSI-LD is an an extended subset of JSON-LD for use with context management systems. Its payloads are encoded as linked data using JSON.

The NGSI-LD Specification is regularly updated and published by ETSI. The latest specification is version 1.8.1, published in March 2024. The next release, version 1.9.1, is expected for September/October 2024·

A few presentations on NGSI-LD:

• NGSI-LD Overview
• NGSI-LD in 30 min
• NGSI-LD in a Nutshell

Examples of NGSI-LD payloads can be found in ETSI. See also the OpenAPI Specification of NGSI-LD.
That is for version 1.7.1 of the NGSI-LD API specification.
We're currently working on updating this to v1.8.1, ETA: Dec 2024.

If you are not sharing your data across systems and have no need for linked data concepts, then the current stable version of NGSI (NGSI-v2) is more than sufficient. If so, please use the original Orion instead of Orion-LD (note that Orion-LD is not up-to-date with Orion in terms of NGSI v2).

📚 Documentation	🎓 Academy	quay.io

NGSI-LD Context Broker Feature Comparison

An Excel file detailing the current compatibility of the development version of the Orion-LD Context Broker against the features (up to v1.8.1) of the API specification can be downloaded here.

Test and Deployment of Orion-LD

If you want to start testing Orion-LD, the most common option is to use Docker. There are a number of docker images to choose from.

If you (at your own risk) want to evaluate the bleeding edge development changes, you can use the latest image: docker run fiware/orion-ld:latest or better: use docker compose to run it.

The use of the "latest" tag is NOT RECOMMENDED, as it keeps changing. Please don't use it. It's solely meant for internal testing. The recommendation is to use the newest fixed tag you find and stick to it until you have need for some newer feature/fix and then change to that newer fixed tag. Every merged pull request results in a new fixed tag in dockerhub/quay.io.

Please note that for production and/or performance implementations, there is a thorough guide for that right here

If you want to use a more stable image, the latest release (as of July 2024) is 1.6.0

docker run quay.io/fiware/orion-ld:1.6.0

Please check quay.io or dockerhub for other releases.

Documentation:

• Guide to NGSI-LD entities and attributes
• Guide to the JSON-LD @context
• Installation Guide
• Quick Start Guide
• External Libraries
• Temporal Representation
• The Broker as Context Server
• Roadmap

A Test Suite for NGSI-LD compliant brokers can be found here. This test suite is deprecated in favor of the newer ETSI NGSI-LD API Conformance Test Suite. (Orion-LD passes about 95% of the test cases of this older deprecated test suite.)

About the ETSI funded conformance test suite, a third TTF (Testing Task force) is currently in progress, to improve on overall coverage and to aggregate conformance tests for distributed operations. This third TTF is expected to finish in February 2025 and by then, the ETSI NGSI-LD conformance test suite should be fully operational, and thus test results for Orion-LD can and will be published.