Merge pull request #840 from dedica-team/develop

Merge develop into master #838
dedica-team · Jan 5, 2022 · 5dc0e5e · 5dc0e5e
2 parents f4d9299 + 34d7a01
commit 5dc0e5e
Show file tree

Hide file tree

Showing 389 changed files with 13,413 additions and 8,721 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -31,11 +31,11 @@ jobs:
     strategy:
       matrix:
         os: [macos-latest, ubuntu-latest, windows-latest]
-        jdk: [11.0.8, 13.0.2]
+        jdk: [11.0, 17.0]
 
     steps:
       - uses: actions/checkout@v2
-      - name: Set up JDK 11/13
+      - name: Set up JDK 11/17
         uses: actions/setup-java@v1
         with:
           java-version: ${{matrix.jdk}}

diff --git a/.gitignore b/.gitignore
@@ -10,3 +10,4 @@ src/test/resources/example/*_debug.json
 src/test/resources/example/*_debug.svg
 src/main/resources/static/icons/svg/*.svg
 /src/main/app/debug.log
+/src/test/dump/
diff --git a/Dockerfile b/Dockerfile
@@ -1,5 +1,5 @@
 # use not slim base image, because libfontmanager needs libfreetype (mfbieber)
-FROM adoptopenjdk/openjdk11:x86_64-alpine-jre-11.0.8_10
+FROM openjdk:17-ea-22
 
 ENV JAVA_TOOL_OPTIONS="-Xms100m -Xmx400m"
 VOLUME /tmp

diff --git a/development.md b/development.md
@@ -4,9 +4,9 @@
 **Requirements**
 
 To run nivio you need the following software installed:
-- [nodejs v12.6.2 or higher](https://nodejs.org/en/), [How to update node?](https://www.hostingadvice.com/how-to/update-node-js-latest-version/)
+- [nodejs v16 LTS](https://nodejs.org/en/), [How to update node?](https://www.hostingadvice.com/how-to/update-node-js-latest-version/)
 - [Maven](https://maven.apache.org/install.html)
-- Java 11
+- Java 17
 
 ---
 

diff --git a/docs/source/assessment.rst b/docs/source/assessment.rst
@@ -39,7 +39,7 @@ Other
 * health (examines the health label on items)
 * condition (K8s condition true/false evaluation)
 
-By default all shipped `KPIs (Key Performance Indicators)` are enabled. Set ``enabled`` to false in the config to disable them.
+By default all shipped `KPIs (Key Performance Indicators)` are disabled. Set ``enabled`` to true in the config to disable them.
 
 .. code-block:: yaml
    :linenos:
@@ -49,7 +49,7 @@ By default all shipped `KPIs (Key Performance Indicators)` are enabled. Set ``en
     config:
       kpis:
         scaling:
-          enabled: false
+          enabled: true
 
 
 Custom KPIs
@@ -87,3 +87,7 @@ label ``foo``.
             RED: "BAD;err.*"
         health:
           description: can be overridden
+
+The pet clinic demo uses a custom KPI which evaluates radiation levels. In this simulation a sensor item (see xray group)
+collects a made up radiation (in mrem) in a label also named ``radiation``. This label is then examined by the custom KPI.
+See https://github.com/dedica-team/nivio/blob/develop/src/test/resources/example/pet_clinic.yml
diff --git a/docs/source/first.png b/docs/source/first.png
diff --git a/docs/source/groups.png b/docs/source/groups.png
diff --git a/docs/source/icons.png b/docs/source/icons.png
diff --git a/docs/source/inc_env_config.rst b/docs/source/inc_env_config.rst
@@ -62,6 +62,10 @@ A welcome message on the front page.
 
 Accent color used for active elements (hexadecimal only).
 
+.. envvar:: NIVIO_ICON_FOLDER
+
+A folder containing icons named similar to material design icons
+
 .. envvar:: NIVIO_MAIL_HOST
 
 SMTP mail host.

diff --git a/docs/source/inc_labels.rst b/docs/source/inc_labels.rst
@@ -6,7 +6,6 @@
 * ``health`` Description of the item's health status.
 * ``icon`` Icon/image (for displaying purposes).
 * ``label`` A custom label (like a note, but very short).
-* ``layer`` A technical layer.
 * ``lifecycle`` A lifecycle phase (``PLANNED|plan``, ``INTEGRATION|int``, ``PRODUCTION|prod``, ``END_OF_LIFE|eol|end``).
 * ``note`` A custom note.
 * ``scale`` Number of instances.

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -18,9 +18,8 @@ sources, like files and web APIs (e.g. monitoring items) or allows pushing infor
 * **It is easy to install and to maintain.** Runs dockerized on a single server with moderate to low hardware requirements. It stores the items, so it can be discarded at any time and be refilled with the next start.
 * **No-op usage** Besides its initial configuration, it is designed to gather the application landscape information from configurable items, preferably code repositories.
 * **Renders the landscapes as a graph** See above.
-* **Multiple configuration sources** While Nivio has its proprietary format, you can also use docker-compose files, or use them as basis and enrich them using further files
-* **PULL: Single seed** Basic indexing of landscapes driven by a configuration file.
-* **PUSH: incremental data aggregation** Send configuration files and other formats to build a landscape.
+* **Multiple configuration sources** While Nivio has its proprietary YAML format, you can also use docker-compose files, or use them as basis and enrich them using further files
+* **PULL and PUSH** Basic indexing of landscapes driven by observed configuration files, or send data to the API.
 * **Aggregation of item state** Using sources, like Prometheus, and marking items accordingly.
 
 
@@ -34,5 +33,6 @@ sources, like files and web APIs (e.g. monitoring items) or allows pushing infor
    assessment
    magic
    output
+   troubleshooting
    references
 
diff --git a/docs/source/input.rst b/docs/source/input.rst
@@ -71,6 +71,37 @@ skip (usually 1 for the header row) can be set.
        skipLines: 1
 
 
+Reading and Mapping from JSON
+-----------------------------
+
+Any JSON file or URL can be parsed and mapped into a landscape description. Existing structures are mapped to landscape
+components using JSONPath, a query language to traverse JSON objects and select specific properties.
+
+.. code-block:: yaml
+   :linenos:
+
+   identifier: example:customjson
+   name: Custom JSON example
+   sources:
+     - format: customJSON
+       url: /mnt/items.json
+       mapping:
+         items: "$.items"
+         item:
+           identifier: "$.id"
+           endOfLife: "$.end_of_life.date"
+           name: '$.moreThanAName|find "([\\w\\s]*),"'
+           nivio.link.homepage: "$.a_named_link"
+           nivio.relations.inbound: "$.@dependencies.@upstream|fetch|$.items[*].id"
+           nivio.relations.providers: "$.infra|fetch|$.items[*].id"
+
+The folling mapping steps are supported:
+
+* **JsonPath**. Simply add the path expression. Note that the root for items is the root of the assigned JSON subnode. For more info on JsonPath, see https://support.smartbear.com/alertsite/docs/monitors/api/endpoint/jsonpath.html.
+* **fetch** an URL, starting with the keyword _fetch_
+* **find** a subtext using regular expressions. starting with the keyword _find_. Make sure to put lines containing regexes in **single quotes** and surround the pattern with **double quotes** (a CSV parser is used in combination with a YAML parser, so this is the combination that works).
+
+
 Reading from GraphViz dot files
 -------------------------------