Anwenden von Befehlen über die Manifestdatei - Manual - Industrial Edge - Industrial Edge - Industrial Edge - Documentation of the Industrial Edge Platform - IEM - Hub - Industrial - Device - IED - Edge - IEH

Industrial Edge Platform Operation - APIs & Referenzen

Product
Industrial Edge
Product Version
v25.04
Edition
04/2025
Language
de-DE

Die Manifest-Datei bietet die Möglichkeit, mehrere Befehle gleichzeitig auszuführen, d.h. einen Anwendungsfall zu erfüllen, wie z.B. das Erstellen einer Anwendung, das Erstellen ihrer Version und das Exportieren einer App-Datei.

iectl apply -f downloads.yaml

Manifest YAML-Konfiguration: Die Manifestdatei enthält die folgenden Schlüssel:

  • Befehle: Unter Befehlstaste können Sie eine Liste der Befehlskonfigurationen bereitstellen, die ausgeführt werden müssen

  • Befehl: Platzhalter für Befehlsbeschriftung

  • Ziel: target enthält den Root-Befehl, den Sie aufrufen möchten, d.h.: IEM, Portal, Publisher, Gerät, Onboard usw.

  • Ressource: resource enthalten die Hierarchie des Befehls, den Sie ausführen möchten, verbunden durch Punkt (.), z. B.

    IECTL Publisher App-Projekt Katalog hochladen
    

    Mit diesem Befehl befindet sich publisher in target und publisher.app-project.upload.catalog in Resource

  • Parameter: Parameter enthalten die Flags und deren Werte, die dem Befehl entsprechen, der der Ressource hinzugefügt wurde. Jeder Parameterwert sollte in doppelten Anführungszeichen ("") angegeben werden, mit Ausnahme von JSON-Daten, die in einfachen Anführungszeichen ('') angegeben werden.

!!! info "BEMERKEN" Verwenden Sie den Parameter allowfailure : "true", wenn Sie fortfahren möchten, auch wenn der Befehl mit dem EN-Fehler fehlschlägt

  • Variablen: Definieren Sie Variablen in der Manifest-YAML und verwenden Sie sie in den Befehlsparametern. Zum Beispiel.:
variables :
  username : "myuser@siemens.com"
commands :
  - command
    .
    .
    .
    parameters
      username: "${{username}}"

Beispiel für eine YAML-Datei:

commands:
  - command:
    target: publisher
    resource: workspace.init
    parameters:
      allowfailure: "true"
  - command:
    target: publisher
    resource: standalone-app.create
    parameters:
      appname: "sampleapp"
      reponame: "sampleapp"
      iconpath: "/path/to/siemens.png"
      appdescription: "appDesc"
      allowfailure: "true"
  - command:
    target: publisher
    resource: standalone-app.version.create
    parameters:
      appname: "sampleapp"
      versionnumber: "0.0.1"
      yamlpath: "/path/to/docker-compose.yml"
      redirectsection: "myservice"
      redirecttype: "FromBoxSpecificPort"
      redirecturl: "8080"
      restredirecturl: ""
      allowfailure: "true"
  - command:
    target: publisher
    resource: standalone-app.version.export
    parameters:
      appname: "sampleapp"
      versionnumber: "0.0.1"
      exportpath: "/path/to/Downloads"
      allowfailure: "true"