Skip to content

Quick Start Guide

Add App Configuration

Industrial Edge supports specific app configuration types. For an in-depth documentation about the different configuration types and their use cases, refer to the Industrial Edge Management - Operation manual.

Following app configuration types are available:

Each of these types can be added to your app via the IECTL respectively via the IE App Publisher.

Unversioned Configuration

Unversioned configurations are user provided inputs of any content type (i.e. text files, binary files, etc.).

You add unversioned configurations with the following command:

$ iectl publisher standalone-app app-config add \
    --appname "my cool app" \
    --configname "Displayed to the end-user during deployment"  \
    --configdescription "displayed to the end-user during deployment"   \
    --hostpath "/my/data/folder/within/container"  \            # Provide the folder path internal to your container where you expect the configuration to be stored into
    --subpath "config.json"   \
    --secure  \                                                 #  Enabling the secure flag only stores the configuration encrypted on the Industrial Edge Management, but not on the Industrial Edge Device

Versioned Configuration

Versioned configurations provide the option of predefined configurations of any content type (i.e. text files, binary files, etc.).

You add versioned configurations with the following command:

$ iectl publisher standalone-app app-config add \
    --appname "my cool app" \
    --configname "my_version_config1" \
    --configdescription "displayed to the end-user during deployment" \
    --hostpath "/my/data/folder" \                                          # Provide the folder path internal to your container where you expect the configuration to be stored into
    --subpath "./" \
    --secure \                                                              # Enabling the secure flag only stores the configuration encrypted on the Industrial Edge Management, but not on the Industrial Edge Device
    --versioned \
    --versionname "displayed to the end-user as selection option" \
    --versiondescription "displayed to the end-user as selection option" \
    --filepath /path/to/configuration/file                                  # filepath: File that shall finally be used as input

Template-based Configuration - Text based

Text based configurations provide the option to adapt text based configurations (from templates) as required during the deployment.

You can add them with the following command:

$ iectl publisher standalone-app app-config add \
    --appname "my cool app" \
    --configname "text_based_config1" \
    --configdescription "displayed to the end-user during deployment" \
    --hostpath "/my/data/folder" \                                      # Provide the folder path internal to your container where you expect the configuration to be stored into
    --subpath config.json \
    --secure \                                                          # Enabling the secure flag only stores the configuration encrypted on the Industrial Edge Management, but not on the Industrial Edge Device
    --templatename "test_based_config_template1" \                      # displayed to the end-user during deployment
    --templatedescription "displayed to the end-user during deployment" \
    --filepath "/path/to/configuration/sample.json" \                   # File that shall be used as initial configuration, expected to be changed

Template-based Configuration - Schema based

Schema based configurations give the user the option to provide configurations in a wizard, supporting complex types to create JSON based configurations.

You can add them with the following command:

$ iectl publisher standalone-app app-config add \
    --appname "my cool app" \
    --configname "schema_based_config1" \
    --configdescription "displayed to the end-user during deployment" \
    --hostpath "/my/data/folder" \                                          # Provide the folder path internal to your container where you expect the configuration to be stored into
    --subpath "config.json" \
    --secure \                                                              # Enabling the secure flag only stores the configuration encrypted on the Industrial Edge Management, but not on the Industrial Edge Device
    --templatename "schema_based_config_template1" \                        # displayed to the end-user during deployment
    --templatedescription "displayed to the end-user during deployment" \
    --jsonschema \
    --filepath /path/to/configuration/sample.json                           # filepath: File that shall be used as initial configuration, expected to be changed