iectl publisher standalone-app app-config add - 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)

Description

Add configuration of an application.

Detailed description

Following configuration types are being supported:

  • Unversioned

  • Versioned

  • Templated (with an additional flavor of schema based configurations)

Each configuration will be mounted into the container. The mountpoint within the container is specified by the --hostpath and --subpath flags, whereas hostpath is considered as the directory and subpath as the file name relative to the hostpath. The hostpath and subpath will be thus merged together to a complete path. The subpath can also be omitted and the original file name will be used automatically.

Example:

--hostpath /my/data --subpath config.json

This will result in the mountpoint /my/data/config.json within the container.

The unversioned configuration type is the configuration type used by default. This configuration type is mutable and a file should be added during deployment of the app. If a versioned configuration type is provided including template details, such as template name or template description, it will be ignored.

Usage

iectl publisher standalone-app app-config add [OPTIONS]

Options

  -a, --appname string               name of the application for which configuration shall be added
  -d, --configdescription string     description of the configuration to display during deployment
  -n, --configname string            name of the configuration in lower case to display during deployment
  -f, --filepath string              path to the configuration file to be added [Optional]
  -h, --help                         help for standalone-app app-config add
  -p, --hostpath string              host path to be used as mount point within the container
  -j, --jsonschema                   enables the schema-based templated configuration [Optional]
  -x, --secure                       encrypts the configuration on IEM NOTE: configuration will not be encrypted during transmission / on IED [Optional]
  -s, --subpath string               sub path to be used as mount point within the container [Optional]
  -e, --templatedescription string   description for the templated configuration displayed during deployment [Optional]
  -t, --templatename string          name of the templated configuration displayed during deployment [Optional]
  -i, --versiondescription string    description for the versioned configuration displayed during deployment [Optional]
  -v, --versioned                    switches to configuration type versioned [Optional]
  -r, --versionname string           name of the versioned configuration displayed during deployment for selection [Optional]

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

Unversioned configuration

iectl publisher standalone-app app-config add -a "myapp" -d "mydescription" -n "Config1" -p "./data/" -s "myfolder"

Versioned configuration

iectl publisher standalone-app app-config add -a "myapp" -d "mydescription" -n "Config1" "Mysql password" -p "./data/" -s "myfolder" -x -v -r "version1" -i "Version one of mysql configuration" -f "/home/config.txt"

Templated configuration

iectl publisher standalone-app app-config add -a "myapp" -d "mydescription" -n "Config1" "Mysql password" -p "./data/" -s "myfolder" -x -t "ConfigTemplate" -e "My Template Configuration" -f "/home/config.txt"

Templated configuration with JSON schema

iectl publisher standalone-app app-config add -a "myapp" -d "mydescription" -n "Config1" "Mysql password" -p "./data/" -s "myfolder" -x -t "ConfigTemplate" -e "My Template Configuration" -j -f "/home/config.json"