Skip to content

coraine 0.6.1

Choose a tag to compare

@github-actions github-actions released this 28 Oct 16:42
· 185 commits to main since this release
47d2a17

A lightweight NGSI-LD Context Broker written in C, fully implementing
ETSI GS CIM 009 v1.9.1 and passing the official ETSI NGSI-LD conformance test
suite with a 100% success rate.*

What makes it worth a look:

  • Small. 4.8 MiB of files a machine did not already have — the broker
    with its in-memory store, and two libraries, both GEOS. One process, no runtime, no
    JVM, and no database server to install beside it.
  • Fast. 12 577 requests/s per core at limit=20 — 251 540 entities/s per
    core
    — and answering 9 ms after exec. Writes, the store on disk: 54 707 creates/s
    per core one at a time, 117 460 in batches of twenty.
  • Persistent, still without a database server. --database corDB --dbDir <dir> --troe corDB: the store and its temporal history on disk, in the same process.
  • Plugin-driven. Storage backend, temporal history and extra API surfaces are
    shared libraries loaded at startup. The core speaks NGSI-LD; the plugins decide
    where data lives and how the broker talks to the world.

Getting started

The image runs on amd64 and arm64 under the same tag. An in-memory store, no external
services — the broker answers NGSI-LD on 1026:

docker run --rm -p 1026:1026 \
    quay.io/seamware/coraine:0.6.1 --database corDB

Or as a Debian package (Ubuntu 26.04, 24.04, Debian 13), from the signed repository:

curl -fsSL https://seamware.github.io/apt/coraine.gpg | sudo tee /usr/share/keyrings/coraine.gpg > /dev/null
echo "deb [signed-by=/usr/share/keyrings/coraine.gpg] https://seamware.github.io/apt $(. /etc/os-release; echo $VERSION_CODENAME) main" \
  | sudo tee /etc/apt/sources.list.d/coraine.list
sudo apt update && sudo apt install coraine

Then:

curl -X POST localhost:1026/ngsi-ld/v1/entities \
     -H 'Content-Type: application/json' \
     -d '{ "id": "urn:ngsi-ld:Sensor:1", "type": "Sensor",
           "temperature": { "type": "Property", "value": 21.4 } }'

curl localhost:1026/ngsi-ld/v1/entities/urn:ngsi-ld:Sensor:1

To keep the data, add --dbDir <dir> (corDB on disk), or use MongoDB with
--database mongoc. The README walks
through the rest.

Where to look next

  • Documentation — installation
    and administration, the API walkthrough, the plugin architecture, building from
    source, and the roadmap.
  • Container images —
    every published tag. 0.6.1 is this release; every merge to main also
    publishes an immutable <version>-<date>-<commit>.
  • Issues — questions, bugs and
    feature requests all belong here; that is where the maintainers are.
  • README — footprint and
    throughput numbers, the plugin catalogue, and how the test suites are run.

What is in 0.6.1

The same day as 0.6.0: 0.6.0 was built with an NGSI-LD library that accepts a Subscription's
expandValues, jsonKeys and langProperties as an array, which its broker did not read. 0.6.1 is
the broker that does, the lists as an array throughout, and main's version between releases.

New

  • expandValues, jsonKeys and langProperties in a POST Query body and a Subscription, and aggrMethods
    in a temporal Query's temporalQ: a string, comma separated, or an array of strings with one name per
    item - an item holding a comma, an empty item or a non-string is a 400. A name is short or already
    expanded. A Subscription keeps the form it was sent in. The URL parameters stay comma separated lists.
    (API walkthrough)

Changed behaviour

  • Between releases, main reports the last release with +dev (0.6.0+dev), not the next one with
    -dev: the next release's number is decided when it is cut. Its Debian packages are
    0.6.0+git<date>.<sha> (after 0.6.0) and its images 0.6.0-post-<date>-<commit>
    (Installation, Kubernetes).

Fixed

  • 0.6.0: a Subscription's expandValues, jsonKeys or langProperties sent as an array of strings was
    accepted and then ignored - 0.6.0's NGSI-LD library took the array, the broker read only a string. 0.6.1
    reads both forms.
    (API walkthrough)


* The conformance runs use a corrected fork of the ETSI test suite. The changes
are test-side fixes — the suite has bugs of its own and parts of it do not run as
published — never relaxations of what the broker must do. The fixes are filed
upstream with ETSI.

Built by @kzangeli, with @claude.

Licensed under the Apache License 2.0.