Template-based Configuration - Text based - Manual - Industrial Edge Platform - Industrial Edge - Industrial Edge - Documentation of the Industrial Edge Platform - IEM - Hub - Industrial - Device - IED - Edge - IEH

Industrial Edge Platform Operation - APIs & References

Portfolio
Industrial Edge
Product
Industrial Edge Platform
Edition
02/2025
Language
en-US (original)

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 "./bind/path/on/host" \                                      # volume name or relative bind path
    --subpath "config/templated/" \
    --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

Info

Similar to versioned configuration is the filename taken from the template file specified in filepath. For the example above the resulting file path inside the container is /bindmount/config/tamplated/sample.json, asuming the bind "./bind/path/to/host:/bindmount" is specified in the docker compose file.