[CrateDB] Add documentation across the board

Author: amotl

CHANGES.rst

@@ -25,6 +25,7 @@ in progress
   a single TTN Application. Thanks, @thiasB, @einsiedlerkrebs, and @ClemensGruber.
 - [core] Fix error when connecting to MQTT broker without authentication credentials
 - [docs] Refactor "decoders" section to "integrations", and improve index/overview page
+- [CrateDB] Add support for data acquisition and data export
 
 
 .. _kotori-0.27.0:

README.rst

@@ -76,6 +76,10 @@ Kotori
         :target: https://github.com/grafana/grafana
         :alt: Supported Grafana versions
 
+  .. image:: https://img.shields.io/badge/CrateDB-4.2%20--%205.x-blue.svg
+        :target: https://github.com/crate/crate
+        :alt: Supported CrateDB versions
+
   .. image:: https://img.shields.io/badge/InfluxDB-1.6%2C%201.7%2C%201.8-blue.svg
         :target: https://github.com/influxdata/influxdb
         :alt: Supported InfluxDB versions
@@ -105,7 +109,7 @@ Details
 
 Kotori takes the role of the `data historian`_ component within a `SCADA`_ / `MDE`_
 system, exclusively built upon industry-grade `free and open-source software`_
-like Grafana_, Mosquitto_, or InfluxDB_. It is written in Python_,
+like Grafana_, Mosquitto_, CrateDB_, or InfluxDB_. It is written in Python_,
 and uses the Twisted_ networking library.
 
 The best way to find out what you can do with Kotori, is by looking at
@@ -222,6 +226,7 @@ The project is licensed under the terms of the GNU AGPL license, see `LICENSE`_.
 
 .. _Autobahn: https://crossbar.io/autobahn/
 .. _contributors: https://getkotori.org/docs/project/contributors.html
+.. _CrateDB: https://github.com/crate/crate
 .. _Create an issue: https://github.com/daq-tools/kotori/issues/new
 .. _data historian: https://en.wikipedia.org/wiki/Operational_historian
 .. _development sandbox: https://getkotori.org/docs/setup/sandbox.html

doc/source/_meta.rst

@@ -16,5 +16,5 @@
     :keywords lang=es: adquisición de datos, gráficas, conjunto de herramientas, telemetría
     :keywords lang=fr: acquisition de données, graphiques, boîte à outils, télémétrie
     :keywords:         m2m, iot, mqtt, wamp, http, rest, udp, binary struct,
-                       Kotori, Grafana, InfluxDB, Mosquitto, MongoDB, XMPP, SMTP
+                       Kotori, Grafana, CrateDB, InfluxDB, Mosquitto, MongoDB, XMPP, SMTP
 

doc/source/_resources.rst

@@ -170,6 +170,7 @@
 .. _Raumfahrtagentur: http://www.raumfahrtagentur.org/
 
 .. NEW
+.. _CrateDB: https://github.com/crate/crate
 .. _curl: https://en.wikipedia.org/wiki/CURL
 .. _Flux data scripting language: https://docs.influxdata.com/flux/
 .. _Funky v3: https://harizanov.com/product/funky-v3/
@@ -183,6 +184,7 @@
 .. _OpenXC: https://openxcplatform.com/
 .. _OpenXC for Python: http://python.openxcplatform.com/
 .. _multi-tenant: https://en.wikipedia.org/wiki/Multitenancy
+.. _near real-time: https://en.wikipedia.org/wiki/Near_real-time#Near_real-time
 .. _NodeUSB: https://web.archive.org/web/20210621192219/http://www.nodeusb.com/
 .. _trunking: https://en.wikipedia.org/wiki/Trunking
 .. _webhook: https://en.wikipedia.org/wiki/Webhook

doc/source/about/scenarios.rst

@@ -85,8 +85,8 @@ We are standing on the shoulders of giants:
 - Leverage the open infrastructure based on Twisted_ - an event-driven networking engine -
   to implement custom software components.
 - Listen and talk M2M_ using the *MQ Telemetry Transport* connectivity protocol and software bus (MQTT_).
-- Store data points into InfluxDB_, a leading open source time series database suitable
-  for realtime analytics and sensor data storage.
+- Store data points into CrateDB_, InfluxDB_, or other open source time series databases
+  suitable for realtime analytics and sensor data storage.
 - Automate dashboard management in the context of data arriving on different data channels
   using Grafana_, an open source, feature rich metrics dashboard and graph editor.
 - Make Browser clients first-class citizens of the underpinning software bus framework

doc/source/about/technologies.rst

@@ -26,14 +26,16 @@ Infrastructure components
 
 - Kotori_, a data acquisition, graphing and telemetry toolkit
 - Grafana_, a graph and dashboard builder for visualizing time series metrics
-- InfluxDB_, a time-series database
+- CrateDB_, a time-series database ¹
+- InfluxDB_, a time-series database ¹
 - Mosquitto_, an MQTT message broker
-- MongoDB_, a document store (optional) ¹²
+- MongoDB_, a document store (optional) ²³
 
-| ¹ MongoDB is only required when doing CSV data acquisition, so it is completely
+| ¹ Kotori can either use CrateDB or InfluxDB as timeseries database.
+| ² MongoDB is only required when doing CSV data acquisition, so it is completely
 | optional for regular operations of Kotori.
-| ² As MongoDB - strictly speaking - stopped being free software recently (2018/2019),
-| it will probably be phased out gradually and replaced by PostgreSQL_.
+| ³ As MongoDB - strictly speaking - stopped being free software recently (2018/2019),
+| it will probably be phased out gradually and replaced by PostgreSQL_ or CrateDB_.
 
 
 Supported protocols

doc/source/database/cratedb.rst

@@ -0,0 +1,18 @@
+.. include:: ../_resources.rst
+
+.. _database-cratedb:
+
+#######
+CrateDB
+#######
+
+.. admonition::
+
+    .. todo:: Content on this page may need an update.
+
+*****
+About
+*****
+
+`CrateDB`_ is a distributed and scalable SQL database for storing and analyzing massive
+amounts of data in `near real-time`_. It is PostgreSQL-compatible, and based on Lucene.

doc/source/database/index.md

@@ -14,6 +14,7 @@ with Kotori. Adding more adapters is possible.
 :maxdepth: 1
 :hidden:
 
+cratedb
 influxdb
 mongodb
 ```
@@ -24,6 +25,34 @@ mongodb
 :padding: 0
 
 
+:::::{grid-item-card}
+::::{grid} 2
+:margin: 0
+:padding: 0
+
+:::{grid-item}
+:columns: 8
+#### [](#database-cratedb)
+
+CrateDB is a distributed and scalable SQL database for storing and analyzing massive
+amounts of data in near real-time. It is PostgreSQL-compatible, and based on Lucene.
+
+<small>
+<strong>Categories:</strong> timeseries-database, multi-modal database
+</small>
+:::
+:::{grid-item}
+:columns: 4
+{bdg-primary-line}`eth` {bdg-primary-line}`wifi` {bdg-primary-line}`http` {bdg-primary-line}`postgresql`
+
+{bdg-success-line}`sql` {bdg-success-line}`blob`
+
+{bdg-secondary-line}`amd64` {bdg-secondary-line}`arm64`
+:::
+::::
+:::::
+
+
 :::::{grid-item-card}
 ::::{grid} 2
 :margin: 0

doc/source/development/releasing/foundation.rst

@@ -34,6 +34,24 @@ Download packages
     scp mosquitto*.deb [email protected]:/srv/packages/organizations/elmyra/foss/aptly/public/incoming
 
 
+*******
+CrateDB
+*******
+- https://github.com/crate/crate
+- https://crate.io/docs/crate/tutorials/
+
+Download packages
+=================
+::
+
+    # Download amd64 packages
+    wget https://cdn.crate.io/downloads/apt/stable/pool/main/c/crate/crate_5.3.2-1~buster_amd64.deb
+    wget https://cdn.crate.io/downloads/apt/stable/pool/main/c/crate/crate_5.3.2-1~bullseye_amd64.deb
+
+    # Upload to "incoming" directory
+    scp crate_*.deb [email protected]:/srv/packages/organizations/elmyra/foss/aptly/public/incoming
+
+
 ********
 InfluxDB
 ********
@@ -100,7 +118,7 @@ Publish packages
 
     # Add packages to repository
     aptly repo add -config=$APTLY_CONFIG -remove-files=true $APTLY_REPOSITORY \
-        $PACKAGES_INCOMING/influxdb*.deb $PACKAGES_INCOMING/grafana*.deb $PACKAGES_INCOMING/*mosquitto*.deb
+        $PACKAGES_INCOMING/crate*.deb $PACKAGES_INCOMING/influxdb*.deb $PACKAGES_INCOMING/grafana*.deb $PACKAGES_INCOMING/*mosquitto*.deb
 
     # Publish repository
     aptly publish update -config=$APTLY_CONFIG -gpg-key=2543A838 -passphrase=esp $APTLY_DISTRIBUTION

doc/source/development/releasing/index.rst

@@ -4,7 +4,7 @@ Releasing and packaging
 
 This section describes how to cut a new release, how to build
 and publish Kotori packages and how to add foundation packages
-like InfluxDB and Grafana to the same package repositories.
+like CrateDB, InfluxDB, and Grafana to the same package repositories.
 
 .. toctree::
     :maxdepth: 1