Create App Version - 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)

The App Version consists of all information related to the Docker image as well as the Docker-compose file of your app. Also, it defines the app version.

You create an app version with the following command:

$ iectl publisher standalone-app version create \
            --appname "my cool app" \                                   #  You have to select a previously created application available within your workspace
            --changelogs "initial release" \
            --yamlpath "/path/to/folder/with/docker-compose.yaml" \     #  path to your docker compose yaml file
            --versionnumber "1.0.0" \                                   #  This version must be conformant to the semantic versioning specification
            --redirectsection "my service" \                            #  This requires the service name within docker-compose which contains the container that shall be exposed
            --redirecttype "FromBoxSpecificPort" \                      # redirecttype: Either FromBoxSpecificPort for direct port exposure or FromBoxReverseProxy for reverse proxy exposure
            --redirecturl "8080" \                                      # redirecturl: The port which shall be exposed from your container
            --restredirecturl "" \                                      # restredirecturl: This path will be used upon redirect to your application

With the provided settings, port 8080 of the "my service" service will be exposed. The port will be exposed directly, either with HTTP or HTTPS depending on your app.

This will lead to the following exposed URL: http or https://{industrial-edge-device-ip}:{random port}

NOTICE

If your application does not have any interface then use these redirect type.

    --redirectsection "" \
    --redirecttype "ExternalLink" \
    --redirecturl "" \