iectl publisher standalone-app validate - 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

Validate an .app file for using it within Industrial Edge.

Detailed description

The validation steps check the following by default:

  • validate the .app file according to its scheme

  • validate the integrity of the .app file according to its digests

  • validate the signature, if the app is signed

  • validate the docker-compose according to its scheme

  • validate IE specifics regarding docker-compose (e.g. volume mounts)

  • validate app metadata (e.g. service exposure, dependencies)

  • validate Docker images (e.g. images are importable, tags are correctly set)

These steps are customizable by the user with the --skip option.

Usage

iectl publisher standalone-app validate [OPTIONS]

Options

  -a, --auth-service stringArray    list of services within the application that have a dependency to the auth service [Optional]
  -e, --event-service stringArray   list of services within the application that have a dependency to the event service [Optional]
  -h, --help                        help for standalone-app validate
  -i, --ignore-errors               ignores all errors that may occur during validation. NOTE: this will not return a failing exit code [Optional]
  -n, --networks string             JSON Object which specifies the docker network dependencies of a service within the application. Format: {\\\"my-app\\\":[\\\"one\\\",\\\"two\\\"]} [Optional]
  -p, --path string                 path to the app file to validate
  -k, --public-key string           path to the public key used for validating the signed [Optional] (deprecated)
  -s, --skip stringArray            list of validation steps to skip. available steps to skip: validate_app_file_schema,validate_digest,validate_signature,validate_yaml_schema,validate_ie_rules,validate_meta_files,validate_docker_images [Optional]

Options inherited from parent commands

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

Example

iectl publisher standalone-app validate -p /home/application.app -n {"secureapp1":["proxy"]} -a "secureapp ,secureapp2" -e "secureapp ,secureapp2" -s "validate_meta_files,validate_docker_images" -i