File Render with multiple inventories

Prerequisites

Modules

• osp-web

git checkout origin/osp-web-configuration .

Vscode extension

• osp-composer

Example configuration

git checkout origin/template-playbooks-filerender-multiple-inventory .

Description

This example demonstrate usage of a template-playbook to automatically generate a configuration file that take multiple Inventory as data input:

This will simulate multiple devices that are present in different sites.

This example integrate a list of sites that may contains some lights. Playbook will generate a single dashboard that contains a widget for every light. Every widgets will have a background color corresponding to the site where it is located.

Example

1. Create inventories

This example integrate a list of sites that may contains some lights. First create two inventories.

One for the list of sites that contains site name and corresponding color:

templates/inventory/sites.csv

source;destination;rule;variable-siteLocation;variable-backgroundColor
templates.sources.site;root.fribourg;;fribourg;A1A1A1
templates.sources.site;root.lausanne;;lausanne;FFD835
templates.sources.site;root.berne;;berne;1DAA54

And a second one that describe every lights and where their sites.

templates/inventory/devices.csv

source;destination;rule;variable-deviceName;variable-siteLocation
templates.sources;root.fribourg;;light01;fribourg
templates.sources;root.lausanne;;light02;lausanne
templates.sources;root.berne;;light03;berne
templates.sources;root.lausanne;;light04;lausanne

2. Create a playbook

Note

In this example we have a second target of type ItemsRender to automatically add a dummy value for every widget subscription. This is not necessary.

templates/playbooks/example.playbook

[
    {
        "type": "FileRender",
        "generation": [
            {
                "destination": "root.devices.light.monitoring",
                "source": "templates/sources/dashboard.view.nunjucks"
            }
        ],
        "import": {
            "lights": "templates/inventory/devices.csv",
            "sites": "templates/inventory/sites.csv"
        }
    },
    {
        "type": "FileRender",
        "generation": [
            {
                "destination": "root.devices.light.monitoring",
                "source": "templates/sources/dashboard.web.nunjucks"
            }
        ],
        "import": {}
    },
    {
        "type": "ItemsRender",
        "source": "templates/inventory/sites.csv",
        "fileRenderContext": {}
    }
]

Target FileRender import both two inventories defines in previous step as lights and sites.

3. Create dashboard template

templates/sources/dashboard.view.nunjucks

{% set comma = joiner(',') %}
{
    "configuration": [
      {% for light in lights -%}{{ comma() }}
      {
        "type": "BasicInputOutputValue",
        "id": "{{ light.deviceName }}",
        "title": "{{ light.deviceName }}",
        "valueSubscriptions": {
            "values": [
                {
                    "id": "{{ light.destination }}.light",
                    "type": "BOOLEAN",
                    "right": "READ_WRITE"
                }
            ]
        },
        "basicWidgetSettings": {
            "label": "{{ light.deviceName }}",
            "showLabel": true,
            "showTooltip": true,
            "showIcon": true,
            "showValue": false,
            "onValue": false,
            "offValue": true,
            "onIcon": "logout",
            "offIcon": "warning_amber",
            "onBackgroundColor": "#{{ sites | innerJoin(light, "siteLocation", "backgroundColor") | first }}",
            "offBackgroundColor": "#{{ sites | innerJoin(light, "siteLocation", "backgroundColor") | first }}"
        }
    }
    {%- endfor %}
    ],
    "layout": {
        "lg": []
    }
}

This template create a widget for every lights inside light’s inventory. But on top of that (on line 28-29), target will access to sites inventory to lookup for a match entry between variable siteLocation. When an entry is found, it will replace be the value in backgroundColor.

Note

Remember sites inventory header:

templates/inventory/sites.csv

source;destination;rule;variable-siteLocation;variable-backgroundColor

4. Execute the playbook

Generate the playbook template with one of the given command :

• Playbook template [execute-all]

• Playbook template [execute a unique target] and select the example.playbook then press enter.

5. Check files generated

Finally you can verify the file generated. It contains one widget for every lights and background colors correspond to the one defines in site inventory:

root/devices/light/monitoring/dashboard.view

{
  "type": "BasicInputOutputValue",
  "id": "light01",
  "title": "light01",
  "valueSubscriptions": {
    "values": [
      {
        "id": "root.fribourg.light",
        "type": "BOOLEAN",
        "right": "READ_WRITE"
      }
    ]
  },
  "basicWidgetSettings": {
    "label": "light01",
    "showLabel": true,
    "showTooltip": true,
    "showIcon": true,
    "showValue": false,
    "onValue": false,
    "offValue": true,
    "onIcon": "logout",
    "offIcon": "warning_amber",
    "onBackgroundColor": "#A1A1A1",
    "offBackgroundColor": "#A1A1A1"
  }
}