View a markdown version of this page

Bootstrap für dieselbe Pipeline - AWS Serverless Application Model

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.

Bootstrap für dieselbe Pipeline

Diese Seite enthält Referenzinformationen für AWS Serverless Application Model Befehlszeilenschnittstelle (AWS SAM CLI) sam local pipeline bootstrap Unterbefehl.

Für eine Einführung in die AWS SAM CLI, siehe Was ist der AWS SAM CLI?

Das sam pipeline bootstrap Unterbefehl generiert das erforderliche AWS Infrastrukturressourcen für die Verbindung zu Ihrem CI/CD System. Dieser Schritt muss für jede Bereitstellungsphase in Ihrer Pipeline ausgeführt werden, bevor der ausgeführt wird sam pipeline init Befehl.

Dieser Unterbefehl richtet Folgendes ein AWS Infrastrukturressourcen:

  • Option zur Konfiguration von Pipeline-Berechtigungen über:

  • Ein CloudFormation IAM-Rolle für die Ausführung, übernommen von CloudFormation um das bereitzustellen AWS SAM Anwendung.

  • Ein Amazon S3-Bucket zur Aufbewahrung der AWS SAM Artefakte.

  • Optional ein Amazon ECR-Image-Repository für Lambda-Bereitstellungspakete für Container-Images (falls Sie über eine Ressource des Pakettyps verfügen) Image).

Wichtig

Lauf nicht sam pipeline bootstrap mit einer nicht vertrauenswürdigen Konfigurationsdatei. Der OIDC-Anbieter und die Berechtigungseinstellungen der Datei bestimmen, wer die IAM-Rollen übernehmen kann, die dieser Befehl erstellt.

Usage

$ sam pipeline bootstrap <options>

Optionen

--bitbucket-repo-uuid TEXT

Die UUID des Bitbucket-Repositorys. Diese Option ist spezifisch für die Verwendung von Bitbucket OIDC für Berechtigungen.

Anmerkung

Dieser Wert ist unter zu finden https://bitbucket.org/workspace/repository/admin/addon/admin/pipelines/openid-verbinden

--bucket TEXT

Der ARN des Amazon S3-Buckets, der den enthält AWS SAM Artefakte.

--cicd-provider TEXT

Die CI/CD Plattform für die AWS SAM Pipeline.

--cloudformation-execution-role TEXT

Der ARN der IAM-Rolle, die übernommen werden soll von CloudFormation bei der Bereitstellung des Stacks der Anwendung. Geben Sie dies nur an, wenn Sie Ihre eigene Rolle verwenden möchten. Andernfalls erstellt der Befehl eine neue Rolle.

--config-env TEXT

Der Umgebungsname, der die zu verwendenden Standardparameterwerte in der Konfigurationsdatei angibt. Der Standardwert ist default. Weitere Informationen zu Konfigurationsdateien finden Sie unter AWS SAMCLIKonfigurationsdatei.

--config-file PATH

Der Pfad und der Dateiname der Konfigurationsdatei, die die zu verwendenden Standardparameterwerte enthält. Der Standardwert ist samconfig.toml im Stammverzeichnis des Projektverzeichnisses. Weitere Informationen zu Konfigurationsdateien finden Sie unter AWS SAMCLIKonfigurationsdatei.

--confirm-changeset | --no-confirm-changeset

Aufforderung zur Bestätigung der Bereitstellung Ihrer Ressourcen.

--create-image-repository | --no-create-image-repository

Geben Sie an, ob ein Amazon ECR-Image-Repository erstellt werden soll, falls keines angegeben ist. Das Amazon ECR-Repository enthält die Container-Images von Lambda Event Functions oder Ebenen mit dem Pakettyp Image. Der Standardwert ist --no-create-image-repository.

--debug

Schaltet die Debug-Protokollierung ein und druckt Debug-Meldungen aus, die AWS SAM CLI generiert und um Zeitstempel anzuzeigen.

--deployment-branch TEXT

Name des Zweigs, von dem aus die Bereitstellungen erfolgen. Diese Option ist spezifisch für die Verwendung GitHub Aktionen OIDC für Berechtigungen.

--github-org TEXT

Das GitHub Organisation, zu der das Repositorium gehört. Wenn keine Organisation existiert, geben Sie den Benutzernamen des Repository-Besitzers ein. Diese Option ist spezifisch für die Verwendung GitHub Aktionen OIDC für Berechtigungen.

--github-repo TEXT

Name des GitHub Repository, von dem aus die Bereitstellungen erfolgen. Diese Option ist spezifisch für die Verwendung GitHub Aktionen OIDC für Berechtigungen.

--gitlab-group TEXT

Das GitLab Gruppe, zu der das Repository gehört. Diese Option ist spezifisch für die Verwendung GitLab OIDC für Berechtigungen.

--gitlab-project TEXT

Das GitLab Name des Projekts. Diese Option ist spezifisch für die Verwendung GitLab OIDC für Berechtigungen.

--help, -h

Zeigt diese Meldung an und beendet das Programm.

--image-repository TEXT

Der ARN eines Amazon ECR-Image-Repositorys, das die Container-Images von Lambda-Funktionen enthält, oder Ebenen mit dem Pakettyp Image. Falls angegeben, die --create-image-repository Optionen werden ignoriert. Wenn nicht angegeben und --create-image-repository angegeben ist, erstellt der Befehl einen.

--interactive | --no-interactive

Deaktiviert die interaktive Aufforderung zur Eingabe von Bootstrap-Parametern und schlägt fehl, wenn erforderliche Parameter fehlen. Der Standardwert ist --interactive. Für diesen Befehl gilt: --stage ist der einzige erforderliche Parameter.

Anmerkung

Wenn --no-interactive wird zusammen mit angegeben --use-oidc-provider, alle erforderlichen Parameter für Ihren OIDC-Anbieter müssen enthalten sein.

--oidc-client-id TEXT

Die Client-ID, die für die Verwendung mit Ihrem OIDC-Anbieter konfiguriert ist.

--oidc-provider [github-actions | gitlab | bitbucket-pipelines]

Name des CI/CD Anbieter, der für OIDC-Berechtigungen verwendet wird. GitLab, GitHub, und Bitbucket werden unterstützt.

--oidc-provider-url TEXT

Die URL für den OIDC-Anbieter. Der Wert muss beginnen mit https://.

--permissions-provider [oidc | iam]

Wählen Sie einen Berechtigungsanbieter aus, der die Pipeline-Ausführungsrolle übernimmt. Der Standardwert ist iam.

--pipeline-execution-role TEXT

Der ARN der IAM-Rolle, die der Pipeline-Benutzer übernehmen muss, um in dieser Phase zu arbeiten. Geben Sie dies nur an, wenn Sie Ihre eigene Rolle verwenden möchten. Wenn nicht angegeben, erstellt dieser Befehl eine neue Rolle.

--pipeline-user TEXT

Der Amazon-Ressourcenname (ARN) des IAM-Benutzers, dessen Zugriffsschlüssel-ID und sein geheimer Zugriffsschlüssel gemeinsam mit dem CI/CD System. Es wird verwendet, um diesem IAM-Benutzer die Erlaubnis zu erteilen, auf das entsprechende zuzugreifen AWS Konto. Wenn nicht angegeben, erstellt der Befehl einen IAM-Benutzer zusammen mit der Zugriffsschlüssel-ID und den Anmeldeinformationen für den geheimen Zugriffsschlüssel.

--profile TEXT

Das spezifische Profil aus Ihrer Anmeldeinformationsdatei, das abgerufen wird AWS Anmeldeinformationen.

--region TEXT

Die AWS Region, in der bereitgestellt werden soll. Beispiel, us-east-1.

--save-params

Speichern Sie die Parameter, die Sie in der Befehlszeile angeben, im AWS SAM Konfigurationsdatei.

--stage TEXT

Der Name der entsprechenden Bereitstellungsphase. Es wird als Suffix für das erstellte verwendet AWS Infrastrukturressourcen.

Fehlerbehebung

Fehler: Fehlender erforderlicher Parameter

Wann --no-interactive wird zusammen mit angegeben --use-oidc-provider Wenn keiner der erforderlichen Parameter angegeben ist, wird diese Fehlermeldung zusammen mit einer Beschreibung der fehlenden Parameter angezeigt.

Beispiel

Das folgende Beispiel erstellt die AWS Ressourcen, die für die Erstellung Ihrer erforderlich sind CI/CD System, und es aktiviert die Debug-Protokollierung und druckt Debug-Meldungen aus, die vom AWS SAM CLI: verwendet ein generiertes Ereignis für lokale Tests mithilfe eines s3.json Ereignis, um eine Lambda-Funktion lokal aufzurufen

$ sam pipeline bootstrap --debug