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

Create a new app version within workspace.

Usage

iectl publisher standalone-app version create [OPTIONS]

Options

  -x, --accesswithoutlogin                   Allow application access without login
  -a, --appname string                       name of the application for which a new version should be created
  -o, --authservice string                   Auth service enables an application to use IED auth service api's(Make sure the application is created by enabling checkmark - Use Edge Device Auth Service). eg: --authservice "{"servicename":"/opt/appsecrets.json"}" [Optional]
  -c, --changelogs string                    Release Notes
  -m, --defaultmountpath                     To add default mount path (./publish/ and ./cfg-data/)
  -e, --eventservice string                  Event Service is a feature provided by edge runtime for applications to receive and publish events. The communication is based on Unix Domain Socket(UDS). eg: --eventservice "{"servicename":"/opt/event.sock"}" [Optional]

  -h, --help                                 help for standalone-app version create
  -j, --imagetarjson string                  List of services with the reference to their exported docker images
  -n, --nginxjson string                     JSON map of nginx configuration
  -s, --redirectsection string               Redirect Section
  -t, --redirecttype string                  Redirect Type ("FromBoxReverseProxy","FromBoxSpecificPort","ExternalLink")
  -u, --redirecturl string                   Redirect URL
  -r, --restredirecturl string               Rest Redirect URL
  -v, --versionnumber string                 version number associated with the new version
  -y, --yamlpath string                      Path of docker compose yaml or folder path in case of kubernetes application
      --arch string                          Architecture supported by the application version , value can be 'x86-64' or 'arm64'.
                                             Default value is 'x86-64' [Optional]
  -b  --adddiscoveryinfo string              Add service metadata (discovery information). [Optional]
  -d, --devicefeatures <devicefeatures>      The Applications will be allowed to trigger a Shutdown Operation, on the supporting device. The Device will gracefully shutdown in case triggered, by releasing the resources to avoid damaging integrity of the system. Especially useful for electric outage detection applications to trigger a shutdown in case of an outage. [Optional]

Options inherited from parent commands

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

Example

# examples are based on given yaml
version: "2.4" 
services: 
  nginx: 
    image: nginx:alpine 
    restart: always 
    mem_limit: 200m
# Create application version with nginx reverse proxy 
iectl publisher standalone-app version create -a "my_app" -v "0.0.2" -y "/home/user/Desktop/docker-compose.yaml" -c "changelogs" -n '{"nginx":[{"name":"nginxservice","protocol":"HTTP","port":"80","headers":{"proxy_cache_revalidate":"on","proxy_cache_valid":"5m"},"rewriteTarget":"/nginx", "subPath":"app/", "isSecureRedirection":false}]}' -s "nginx" -t "FromBoxReverseProxy" -u "nginxservice/app/" -r "" -e '{"nginx":"/.publish/"}' -o '{"nginx":"/.publish/"}' --arch "x86-64"

# Create application version without docker engine connection 
iectl publisher standalone-app version create -a "my_app" -v "0.0.1" -y "/yaml/docker-compose.yaml" -c "changelogs" -s "nginx" -t "FromBoxSpecificPort" -u "80" --arch "x86-64" -j '{"nginx":"/data/nginx.tar"}'

# Create application version which does not have any redirection
iectl publisher standalone-app version create -a "my_app" -v "0.0.1" -y "/yaml/docker-compose.yaml" -c "changelogs" -s "" -t "ExternalLink" -u "" --arch "x86-64"