AWS IoT Greengrass Befehlszeilenschnittstelle des Development Kit - AWS IoT Greengrass

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

AWS IoT Greengrass Befehlszeilenschnittstelle des Development Kit

Das AWS IoT Greengrass Development Kit Command-Line Interface (GDK CLI) bietet Funktionen, mit denen Sie benutzerdefinierte Greengrass-Komponenten entwickeln können. Sie können die GDK-CLI verwenden, um benutzerdefinierte Komponenten zu erstellen, zu erstellen und zu veröffentlichen. Wenn Sie ein Komponenten-Repository mit der GDK-CLI erstellen, können Sie mit einer Vorlage oder einer Community-Komponente aus dem Greengrass Software Catalog beginnen. Anschließend können Sie ein Build-System auswählen, das Dateien als ZIP-Archive verpackt, ein Maven- oder Gradle-Build-Skript verwendet oder einen benutzerdefinierten Build-Befehl ausführt. Nachdem Sie eine Komponente erstellt haben, können Sie die GDK-CLI verwenden, um sie im AWS IoT Greengrass Service zu veröffentlichen, sodass Sie die AWS IoT Greengrass Konsole oder API verwenden können, um die Komponente auf Ihren Greengrass-Core-Geräten bereitzustellen.

Wenn Sie Greengrass-Komponenten ohne die GDK-CLI entwickeln, müssen Sie die Versions- und Artefakt-URIs in der Komponentenrezeptdatei jedes Mal aktualisieren, wenn Sie eine neue Version der Komponente erstellen. Wenn Sie die GDK-CLI verwenden, können die Versions- und Artefakt-URIs jedes Mal, wenn Sie eine neue Version der Komponente veröffentlichen, automatisch aktualisiert werden.

Die GDK-CLI ist Open Source und auf verfügbar GitHub. Sie können die GDK-CLI an Ihre Anforderungen an die Komponentenentwicklung anpassen und erweitern. Wir laden Sie ein, Probleme zu öffnen und Anfragen im GitHub Repository abzurufen. Die GDK-CLI-Quelle finden Sie unter folgendem Link: https://github.com/aws-greengrass/aws-greengrass-gdk-cli.

Voraussetzungen

Um die Greengrass Development Kit CLI zu installieren und zu verwenden, benötigen Sie Folgendes:

  • Ein(e) AWS-Konto. Falls Sie noch keines haben, beachten Sie die Informationen unter Einrichten eines AWS-Konto.

  • Ein Windows-, macOS- oder Unix-ähnlicher Entwicklungscomputer mit einer Internetverbindung.

  • Für GDK-CLI-Version 1.1.0 oder höher ist Python 3.6 oder höher auf Ihrem Entwicklungscomputer installiert.

    Für GDK-CLI-Version 1.0.0 ist Python 3.8 oder höher auf Ihrem Entwicklungscomputer installiert.

  • Git ist auf Ihrem Entwicklungscomputer installiert.

  • AWS Command Line Interface (AWS CLI) installiert und mit Anmeldeinformationen auf Ihrem Entwicklungscomputer konfiguriert. Weitere Informationen finden Sie unter Installieren, Aktualisieren und Deinstallieren der AWS CLI und Konfigurieren der AWS CLI im AWS Command Line Interface -Benutzerhandbuch.

    Anmerkung

    Wenn Sie einen Raspberry Pi oder ein anderes 32-Bit-ARM-Gerät verwenden, installieren Sie AWS CLI V1. AWS CLI V2 ist für 32-Bit-ARM-Geräte nicht verfügbar. Weitere Informationen finden Sie unter Installieren, Aktualisieren und Deinstallieren der AWS CLI Version 1.

  • Um die GDK-CLI zum Veröffentlichen von Komponenten im AWS IoT Greengrass Service zu verwenden, benötigen Sie die folgenden Berechtigungen:

    • s3:CreateBucket

    • s3:GetBucketLocation

    • s3:PutObject

    • greengrass:CreateComponentVersion

    • greengrass:ListComponentVersions

  • Um die GDK-CLI zum Erstellen einer Komponente zu verwenden, deren Artefakte in einem S3-Bucket und nicht im lokalen Dateisystem vorhanden sind, müssen Sie über die folgenden Berechtigungen verfügen:

    • s3:ListBucket

    Diese Funktion ist für GDK CLI v1.1.0 und höher verfügbar.

Änderungsprotokoll

In der folgenden Tabelle werden die Änderungen in jeder Version der GDK-CLI beschrieben. Weitere Informationen finden Sie auf der Seite GDK-CLI-Versionen auf GitHub.

Version

Änderungen

1.6.2

Fehlerbehebungen und Verbesserungen
  • Behebt ein Problem, bei dem Windows gradlew.bat aufgrund des relativen Pfads nicht funktioniert.

  • Kleinere Verbesserungen an Protokollierung, Tests und Paketierung.

1.6.1

Fehlerbehebungen und Verbesserungen
  • Fügt einen Sicherheitsfix für das Analysieren von CLI-Argumenten hinzu.

  • Ermöglicht dem GDK, den neuesten Greengrass Testing Framework (GTF)-Versionsnamen als Standard-GTF-Version abzurufen.

  • Ermöglicht GDK, Kunden, die eine ältere Version von GTF verwenden, zu empfehlen, dass sie auf die neueste Version aktualisieren.

1.6.0

Neue Features
  • Fügt während der component publish Befehle component build und eine Überprüfung der Rezeptvalidierung anhand des Greengrass-Rezeptschemas hinzu. Dieses Update hilft Entwicklern, verwertbare Probleme innerhalb ihrer Komponentenrezepte zu einem früheren Zeitpunkt im Prozess der Komponentenerstellung zu identifizieren.

  • Fügt der Vorlage eine Konfidenztestsuite hinzu, die mit dem test-e2e init Befehl nach unten abgerufen werden kann. Diese Konfidenztestsuite umfasst acht generische Tests, die verwendet und erweitert werden können, um grundlegende Anforderungen an Komponententests zu erfüllen.

Fehlerbehebungen und Verbesserungen
  • Aktualisiert die vom test-e2e Befehl verwendete Standardversion des Greengrass Testing Framework (GTF) auf Version 1.2.0.

1.5.0

Fehlerbehebungen und Verbesserungen

Aktualisiert die Muster, die von der excludes Build-Option erkannt werden, wenn build_system istzip. Diese Version erkennt jetzt globalen Muster, die Pfadnamen basierend auf ihren Platzhalterzeichen abgleichen. Dies ermöglicht eine benutzerdefinierte Angabe, aus welchen Verzeichnissen ausgeschlossen werden sollen.

1.4.0
Neue Features
  • Fügt einen neuen config Befehl hinzu, der eine interaktive Aufforderung zum Ändern von Feldern innerhalb einer vorhandenen GDK-Konfigurationsdatei startet.

  • Ändert die gdk component publish Befehle gdk component build und , um zu überprüfen, ob die Rezeptgröße den Greengrass-Anforderungen (<=16 000 Bytes) entspricht, bevor fortgefahren wird.

Fehlerbehebungen und Verbesserungen
  • Fügt zusätzliche Protokollierung in der Ausgabe des gdk component build Befehls hinzu, wenn ein Rezeptsyntaxfehler verhindert, dass der Build aus Gründen der Kenntnis abgeschlossen wird.

  • Benennt otf-options und otf-version in gtf-options gtf-version bzw. um, da Open Test Framework in Greengrass Testing Framework umbenannt wurde.

1.3.0
Neue Features
  • Fügt einen neuen test-e2e Befehl hinzu, um das end-to-end Testen von Komponenten mit Open Test Framework zu unterstützen.

  • Fügt eine neue Konfigurationsoption hinzu, zip_nameum konfigurierbare ZIP-Dateinamen mit dem ZIP-Build-System zu unterstützen.

  • Legt die region Eigenschaft in der GDK-Konfigurationsdatei als optional fest.

Fehlerbehebungen und Verbesserungen
  • Behebt ein Problem, bei dem ein neues Verzeichnis erstellt wird, auch wenn die angegebene Vorlage oder das angegebene Repository nicht vorhanden ist, wenn ein GDK-Projekt mit dem --name Argument initialisiert wird.

1.2.3
Fehlerbehebungen und Verbesserungen
  • Behebt ein Problem, bei dem die Bucket-Erstellung aufgrund einer falschen Fehlerbehandlung fehlschlägt.

  • Behebt ein Problem, bei dem Listenstrukturen im Komponentenrezept entfernt werden.

1.2.2
Fehlerbehebungen und Verbesserungen
  • Bei Rezeptschlüsseln wird die Groß- und Kleinschreibung nicht mehr beachtet.

  • Fügt eine Prüfung hinzu, um festzustellen, ob ein Bucket in einem vorhanden ist AWS-Region und für den Benutzer zugänglich ist, bevor ein neuer Bucket erstellt wird. Erfordert, dass der Benutzer über die -GetBucketLocationBerechtigung verfügt.

  • Behebt ein Problem mit dem excludes Schlüsselwort in der GDK-CLI-Konfigurationsdatei.

1.2.1
Fehlerbehebungen und Verbesserungen
  • Akzeptiert das Kanada (Zentral) (ca-central-1) AWS-Region im Konfigurationseintrag der Region in der -gdk-config.jsonDatei.

  • Behebt Probleme mit dem --region GDK-CLI-Argument für den -publishBefehl.

1.2.0
Neue Features
  • Fügt der build Konfiguration in der GDK-CLI-Konfigurationsdatei den options Eintrag hinzu. Unterstützt excludes unter options, um bestimmte Dateien aus dem ZIP-Artefakt auszuschließen, wenn das zip Build-System verwendet wird.

  • Fügt das gradlew Build-System hinzu, um Gradle Wrapper zum Erstellen von Komponenten zu verwenden.

  • Fügt Unterstützung für Kotlin-DSL-Build-Dateien für die gradle Build-Option hinzu.

  • Fügt der publish Konfiguration in der GDK-CLI-Konfigurationsdatei einen options Eintrag hinzu. Unterstützt das file_upload_args unter , options um zusätzliche Argumente beim Hochladen von Dateien in Amazon S3 bereitzustellen.

Fehlerbehebungen und Verbesserungen
  • Behebt ein Problem, bei dem Gradle-Builds nicht bereinigt wurden, bevor ein Build-Befehl ausgeführt wurde.

  • Behebt ein Problem, bei dem der Build nicht beendet wurde, wenn der Build-Befehl fehlschlägt.

  • Verbessert das Ausgabeformat des gdk component list Befehls.

1.1.0

Neue Features
  • Fügt Unterstützung für das Gradle-Build-System hinzu.

  • Fügt Unterstützung für das Maven-Build-System auf Windows-Geräten hinzu.

  • Fügt das --bucket Argument dem Befehl zum Veröffentlichen von Komponenten hinzu. Sie können dieses Argument verwenden, um den genauen Bucket anzugeben, in den die GDK-CLI Komponentenartefakte hochlädt.

  • Fügt das Argument dem init--name-Befehl der Komponente hinzu. init Sie können diese Option verwenden, um den Ordner anzugeben, in dem die GDK-CLI die Komponente initialisiert.

  • Fügt Unterstützung für Komponentenartefakte hinzu, die in einem S3-Bucket vorhanden sind, aber nicht im Build-Ordner der lokalen Komponente. Sie können diese Funktion verwenden, um die Bandbreitenkosten für große Komponentenartefakte wie Machine-Learning-Modelle zu senken.

Fehlerbehebungen und Verbesserungen
  • Aktualisiert den Befehl zum Veröffentlichen von Komponenten, um zu überprüfen, ob die Komponente erstellt wurde, bevor sie die Komponente veröffentlicht. Wenn die Komponente nicht erstellt wird, erstellt dieser Befehl die Komponente jetzt für Sie.

  • Behebt ein Problem, bei dem das ZIP-Build-System nicht auf Windows-Geräten erstellt werden kann, wenn der ZIP-Dateiname Großbuchstaben enthält.

  • Verbessert das Protokollnachrichtenformat und ändert die Standardprotokollebene auf Geräten, INFO auf denen Python-Versionen vor 3.8 ausgeführt werden.

  • Ändert die Mindestanforderung für Python-Versionen in Python 3.6.

1.0.0

Erste Version