Unversioned Configuration - Manual - Industrial Edge - Industrial Edge - Industrial Edge - Documentation of Industrial Edge APIs - CLI tools - Industrial Edge - References - APIs

Industrial Edge Platform Operation - APIs & References

Product
Industrial Edge
Edition
12/2024
Language
en-US (original)

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 "volumename"  \     # Or relative host volume path, e.g. "./cfg-data"
    --subpath "subdir/"   \         # Will be added behind the volume / bind mount point
    --secure  \                    #  Enabling the secure flag only stores the configuration encrypted on the Industrial Edge Management, but not on the Industrial Edge Device

Info

The hostpath argument can either be the name of a volume specified in the docker compose, or the host path of a bind, so for example "./cfg-data" for the bind "./cfg-data/:/cfg-data/" in the docker compose file.

The subpath is then a directory or chain of subdirectories which will be created in that volume or bind, so for example if host path is set to "./cfg-data" and subpath to "custom/config", the directory "/cfg-data/custom/config" will be available in the container.

The uploaded file will then be placed in the joined host- and subpath with its original filename. In total the final file path for an uploaded file from for example /home/user/Documents/configuration.json would result in the container in /cfg-data/custom/config/configuration.json.