Merge pull request #752 from dedica-team/develop

Preparing Release 0.4.1
dedica-team · Nov 5, 2021 · 4394bf7 · 4394bf7
2 parents df628fc + 706537d
commit 4394bf7
Show file tree

Hide file tree

Showing 356 changed files with 9,143 additions and 3,541 deletions.
diff --git a/docs/k8s-minikube.md b/docs/k8s-minikube.md
@@ -39,15 +39,22 @@ kubectl create clusterrolebinding dashboard-admin-sa --clusterrole=cluster-admin
 kubectl get secrets
 kubectl describe secret dashboard-admin-sa-token-*****
 ``` 
-* enter the k8s dashboard: go to http://localhost:8001/api/v1/namespaces/kubernetes-dashboard/services/https:kubernetes-dashboard:/proxy/.
 
+* enter the k8s dashboard: go
+  to http://localhost:8001/api/v1/namespaces/kubernetes-dashboard/services/https:kubernetes-dashboard:/proxy/.
+
+## Install example Helm Charts
 
-## Install example Helm Charts 
 * helm repo add bitnami https://charts.bitnami.com/bitnami
 * helm install redis bitnami/redis --set serviceType=NodePort
 * helm install nivio-wordpress bitnami/wordpress
 
+## Change URL in K8s config file
+
+* change URL under sources to K8s API URL
+
 ## Start nivio
+
 ```
 SEED=$(pwd)./src/test/resources/example/example_k8s.yml java -jar target/nivio.jar
 ``` 
diff --git a/docs/source/inc_labels.rst b/docs/source/inc_labels.rst
@@ -1,10 +1,11 @@
 * ``capability`` The capability the service provides for the business or, in case of infrastructure, the technical capability like enabling service discovery, configuration, secrets, or persistence.
-* ``color`` A hex color code to override the inherited group color
+* ``color`` A hex color code (items inherit group colors as default)
 * ``costs`` Running costs of the item.
 * ``fill`` Background image (for displaying purposes).
 * ``frameworks`` A comma-separated list of frameworks as key-value pairs (key is name, value is version).
 * ``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.
@@ -14,6 +15,6 @@
 * ``software`` Software/OS name.
 * ``stability`` Description of the item's stability.
 * ``team`` Name of the responsible team (e.g. technical owner).
-* ``type`` The type (service, database, queue, load balancer, etc.).
 * ``version`` The version (e.g. software version or protocol version).
-* ``visibility`` Visibility to other items.
+* ``visibility`` Visibility to other items.
+* ``weight`` Importance or relations. Used as factor for drawn width if numbers between 0 and 5 are given.
diff --git a/docs/source/model.rst b/docs/source/model.rst
@@ -109,3 +109,4 @@ Service references are required to describe a ``provider`` relation or ``dataflo
           - target: anothergroup/anotherservice
             format: json
             type: dataflow
+            label: Data Sync
diff --git a/docs/source/output.rst b/docs/source/output.rst
@@ -46,19 +46,14 @@ like "account".
       - identifier: bar
         type: account
 
-The following types are translated icons to maintain backward compatibility:
-
-* CACHE -> "flash-circle"
-* CONTAINER -> "inbox"
-* FIREWALL -> "wall"
-* HUMANUSER -> "account"
-* INTERFACE -> "connection"
-* KEYVALUESTORE -> "keyvaluestore"
-* LOADBALANCER -> "loadbalancer"
-* MESSAGEQUEUE -> "tray-full"
-* MOBILECLIENT -> "cellphone"
-* VOLUME -> "harddisk"
-* WEBSERVICE -> "application"
+Alternatively you can use any icon name on the icon field.
+
+.. code-block:: yaml
+   :linenos:
+
+    items:
+      - identifier: bar
+        icon: flash-circle
 
 Vendor Logos
 ^^^^^^^^^^^^^

diff --git a/docs/source/schema/.openapi-generator/VERSION b/docs/source/schema/.openapi-generator/VERSION
@@ -1 +1 @@
-5.1.0
+5.3.0
diff --git a/docs/source/schema/Models/Branding.rst b/docs/source/schema/Models/Branding.rst
@@ -18,9 +18,4 @@ Map branding (tweaks visuals)
      - A resolvable URL pointing to a CSS stylesheet. This stylesheet is included in the generated SVG map. Use is to style the appearance of the map.
      - optional, defaults to null
      - https://acme.com/css/acme.css
-   * - mapLogo
-     - String
-     - A resolvable URL pointing to an image. This image is included (embedded as data-url) in the generated SVG map.
-     - optional, defaults to null
-     - https://acme.com/images/logo.png
 
diff --git a/docs/source/schema/Models/GroupDescription.rst b/docs/source/schema/Models/GroupDescription.rst
@@ -13,43 +13,33 @@ A group of items. Could be used as bounded context, for instance.
      - Remarks
      - Example
 
-   * - labels
-     - Map
-     - Labels related to the group.
-     - optional, defaults to null
-     - null
-   * - identifier
-     - String
-     - A unique identifier for the group (also used as name). Descriptions are merged based on the identifier.
-     - **required**, defaults to null
-     - shipping
-   * - owner
-     - String
-     - The business owner of the group.
-     - optional, defaults to null
-     - null
-   * - description
+   * - color
      - String
-     - A brief description.
+     - The HTML (hexcode only!) color used to draw the group and its items. If no color is given, one is computed.
      - optional, defaults to null
-     - null
+     - 05ffaa
    * - contact
      - String
      - A contact method, preferably email.
      - optional, defaults to null
      - null
-   * - color
-     - String
-     - The HTML (hexcode only!) color used to draw the group and its items. If no color is given, one is computed.
-     - optional, defaults to null
-     - 05ffaa
    * - contains
      - List
      - A list of item identifiers or SQL-like queries to easily assign items to this group.
      - optional, defaults to null
      - identifier LIKE 'DB1'
-   * - name
+   * - description
+     - String
+     - A brief description.
+     - optional, defaults to null
+     - null
+   * - identifier
      - String
+     - A unique identifier for the group (also used as name). Descriptions are merged based on the identifier.
+     - **required**, defaults to null
+     - shipping
+   * - labels
+     - Map
      - 
      - optional, defaults to null
      - null
@@ -58,4 +48,14 @@ A group of items. Could be used as bounded context, for instance.
      - Key-value pairs of related links. Some keys like &#39;github&#39; cause that the endpoint data is parsed and added to to corresponding landscape component.
      - optional, defaults to null
      - github: https://github.com/dedica-team/nivio
+   * - name
+     - String
+     - 
+     - optional, defaults to null
+     - null
+   * - owner
+     - String
+     - The business owner of the group.
+     - optional, defaults to null
+     - null
 
diff --git a/docs/source/schema/Models/InterfaceDescription.rst b/docs/source/schema/Models/InterfaceDescription.rst
@@ -13,6 +13,11 @@ Describes a low-level interface of an item.
      - Remarks
      - Example
 
+   * - deprecated
+     - Boolean
+     - 
+     - optional, defaults to null
+     - null
    * - description
      - String
      - A brief description.
@@ -23,22 +28,17 @@ Describes a low-level interface of an item.
      - The payload format.
      - optional, defaults to null
      - null
-   * - url
+   * - name
      - String
-     - A URL describing the endpoint.
+     - 
      - optional, defaults to null
      - null
-   * - protection
+   * - parameters
      - String
-     - A description of the interface protection method.
-     - optional, defaults to null
-     - null
-   * - deprecated
-     - Boolean
      - 
      - optional, defaults to null
      - null
-   * - name
+   * - path
      - String
      - 
      - optional, defaults to null
@@ -48,19 +48,19 @@ Describes a low-level interface of an item.
      - 
      - optional, defaults to null
      - null
-   * - path
+   * - protection
      - String
-     - 
+     - A description of the interface protection method.
      - optional, defaults to null
      - null
    * - summary
      - String
      - 
      - optional, defaults to null
      - null
-   * - parameters
+   * - url
      - String
-     - 
+     - A URL describing the endpoint.
      - optional, defaults to null
      - null
 
diff --git a/docs/source/schema/Models/ItemDescription.rst b/docs/source/schema/Models/ItemDescription.rst
@@ -13,76 +13,81 @@ List of configuration sources. Handled in the given order, latter extend/overwri
      - Remarks
      - Example
 
-   * - labels
-     - Map
-     - Key-value pair labels for an item.
-     - optional, defaults to null
-     - null
-   * - identifier
+   * - address
      - String
-     - Immutable unique identifier (maybe use an URN). Primary means to identify items in searches.
-     - **required**, defaults to null
+     - The technical address of the item (should be an URI). Taken into account when matching relation endpoints.
+     - optional, defaults to null
      - null
-   * - name
+   * - color
      - String
-     - A human readable name/title. The name is considered when items are searched.
+     - Overrides the group color. Use an HTML hex color code without the leading hash.
      - optional, defaults to null
-     - my beautiful service
-   * - owner
+     - 4400FF
+   * - contact
      - String
-     - The business owner of the item. Preferably use an email address.
+     - The primary way to contact a responsible person or team. Preferably use an email address.
      - optional, defaults to null
      - [email protected]
    * - description
      - String
      - A brief description.
      - optional, defaults to null
      - null
-   * - contact
-     - String
-     - The primary way to contact a responsible person or team. Preferably use an email address.
+   * - frameworks
+     - Map
+     - The parts used to create the item. Usually refers to technical frameworks.
      - optional, defaults to null
-     - [email protected]
+     - java: 8
    * - group
      - String
      - The identifier of the group this item belongs in. Every item requires to be member of a group internally, so if nothing is given, the value is set to common.
      - optional, defaults to null
      - shipping
+   * - icon
+     - String
+     - An icon name or URL to set the displayed map icon. The default icon set is https://materialdesignicons.com/ and all names can be used (aliases do not work).
+     - optional, defaults to null
+     - null
+   * - identifier
+     - String
+     - Immutable unique identifier (maybe use an URN). Primary means to identify items in searches.
+     - **required**, defaults to null
+     - null
    * - interfaces
      - Set<InterfaceDescription>
      - A collection of low level interfaces. Can be used to describe HTTP API endpoints for instance.
      - optional, defaults to null
      - null
-   * - providedBy
-     - List
-     - A collection of identifiers which are providers for this item (i.e. hard dependencies that are required). This is a convenience field to build relations.
+   * - labels
+     - Map
+     - 
      - optional, defaults to null
-     - shipping-mysqldb
-   * - icon
+     - null
+   * - lifecycle
      - String
-     - An icon name or URL to set the displayed map icon. The default icon set is https://materialdesignicons.com/ and all names can be used (aliases do not work).
+     - The lifecycle state of an item.
      - optional, defaults to null
      - null
-   * - color
-     - String
-     - Overrides the group color. Use an HTML hex color code without the leading hash.
+   * - links
+     - Map<Link>
+     - Key-value pairs of related links. Some keys like &#39;github&#39; cause that the endpoint data is parsed and added to to corresponding landscape component.
      - optional, defaults to null
-     - 4400FF
-   * - address
+     - github: https://github.com/dedica-team/nivio
+   * - name
      - String
-     - The technical address of the item (should be an URI). Taken into account when matching relation endpoints.
+     - A human readable name/title. The name is considered when items are searched.
      - optional, defaults to null
-     - null
-   * - type
+     - my beautiful service
+   * - owner
      - String
-     - The type of the item. A string describing its nature. If no icon is set, the type determines the displayed icon.
+     - The business owner of the item. Preferably use an email address.
      - optional, defaults to null
-     - service|database|volume
-   * - lifecycle
-     - String
-     - The lifecycle state of an item.
+     - [email protected]
+   * - providedBy
+     - List
+     - A collection of identifiers which are providers for this item (i.e. hard dependencies that are required). This is a convenience field to build relations.
      - optional, defaults to null
-     - null
+     - shipping-mysqldb
    * - status
      - List<map>
      - A list of statuses that works like hardcoded KPIs.
@@ -93,19 +98,14 @@ List of configuration sources. Handled in the given order, latter extend/overwri
      - A list of statuses that works like hardcoded KPIs.
      - optional, defaults to null
      - null
-   * - frameworks
-     - Map
-     - The parts used to create the item. Usually refers to technical frameworks.
-     - optional, defaults to null
-     - java: 8
    * - tags
      - List
      - 
      - optional, defaults to null
      - null
-   * - links
-     - Map<Link>
-     - Key-value pairs of related links. Some keys like &#39;github&#39; cause that the endpoint data is parsed and added to to corresponding landscape component.
+   * - type
+     - String
+     - The type of the item. A string describing its nature. If no icon is set, the type determines the displayed icon.
      - optional, defaults to null
-     - github: https://github.com/dedica-team/nivio
+     - service|database|volume