industrial-edge / iectl-workflow Goto Github PK

Note To finish this task, you need to have IE HUB API access granted. This means you need to have API key from IE HUB.

Maybe a short hint should be give how to enable it.

Additionally you should give a hint how to setup the IEM, you should add a link to the IEM Getting Started if someone is looking for information how to install the OS

Please do not use absolut path or give a hint that this path needs to be modified:

You should also mention somewhere that this example is setting up an IP-Based setup and for DNS-Based some additional steps are needed- Probably somewhere you need to specify the URLs as well as importing the certificates, right?

The following sentence is hard to read, please make it a bit more easy to read.
Additionally you are talking about "executed from a device", I initially thought it is a Edge Device, but for it is not. Maybe better use another word instead of device (engineering station or something similiar).

Same in "installation.md": Note Linux device is used to run shell scripts with IECTL commands.
I would use a different term than "device"

The idea is to provide with several shell scripts which can be executed from a device which has connection to the Industrial Edge componments you want to interact

All componets have a IP adress ==> please change to "an IP address"

did you use the Github template? Why is the issue template missing, which can be used for creating new issues?
==> https://github.com/industrial-edge/how-to-template/tree/main/.github/ISSUE_TEMPLATE

Please update link "here".

Go to your Linux environment and open the script for activating IEM. This script can be found here

That's the right link ==> https://github.com/industrial-edge/iectl-workflow/blob/main/src/activate-iem.sh

I'm trying to build a pipeline that creates a new unpublished version of our application and deploys it onto a testing device.

Following the standalone app example, I tried this:

iectl publisher edgemanagement application uploadunpublishedversion \
    --appid "${APP_ID}" \
    --versionnumber "${version_new}"

iectl portal batches submit-batch \
    --appid "${APP_ID}" \
    --operation "installApplication" \
    --data "$(jq -c --null-input --arg deviceId "${DEVICE_ID}" '
      {
        "infoMap": {
          "devices":[
            $deviceId
          ]
        }
      }')" \
    --verbose

But this causes an error:

Error: request failed with status code 400 and response {"errors":[{"code":"notFound.appVersion","message":"App version not found.","errorCode":400,"field":"VersionVO","logref":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","parentLogref":""}]}

Investigating the network traffic from IEM web ui when I deploy from there, I can see it is making a request to:

https://${IEM_URL}/p.service/api/v4/applications/${APP_ID}/versions/${VERSION_ID}/batch?operation=installApplication&isRetainSecret=false&allow=true

and the infoMap only contains the target deviceIds.

So, how could I pass the versionId when using iectl? If this is currently not possible with iectl, would it be possible to obtain the needed headers from iectl and do the same request for example with curl?

Side note: I think running iectl portal batches submit-batch --help should show what information can/should be passed in infoMap. There is currently no mention of {"devices": [ $deviceIds ]}.

Using iectl version 1.3.1 on linux.

The link to the official docu is broken - see here:

https://github.com/industrial-edge/iectl-workflow/blob/main/README.md

"More information about the tool as well as the official documentation can be found [here]"

Broken link: https://industrial-edge.io/developer/platform/references/iectl/index.html
Correct link: https://docs.eu1.edge.siemens.cloud/apis_and_references/iectl/index.html

Why workspace and onboarding-file folder are not available in the github repo?
If you do not want them to be available please explicitly mention that these two folders need to be created, I was a bit confused that I need to check which of the folders are available and which of the I need to create

please also add a link to the IECTL documentation, that customers can check additional information:

https://industrial-edge.io/developer/platform/references/iectl/index.html