Erstellen Sie eine Konfiguration für die Vorlagensynchronisierung

Erfahren Sie, wie Sie eine Konfiguration für die Vorlagensynchronisierung mit erstellen AWS Proton.

Bevor du deine erste Konfiguration für die Vorlagensynchronisierung erstellst, übertrage ein Vorlagenpaket in dein Repository, wie im folgenden Verzeichnislayout dargestellt.

 /templates/                                                 # subdirectory (optional)
 /templates/my-env-template/                                 # template name
 /templates/my-env-template/v1/                              # template version
 /templates/my-env-template/v1/infrastructure/               # template bundle
 /templates/my-env-template/v1/schema/

Nachdem du deine erste Konfiguration für die Vorlagensynchronisierung erstellt hast, werden automatisch neue Vorlagenversionen erstellt, wenn du einen Commit veröffentlichst, der ein aktualisiertes Vorlagenpaket unter einer neuen Version (z. B. unter/my-env-template/v2/) hinzufügt.

 /templates/                                                 # subdirectory (optional)
 /templates/my-env-template/                                 # template name
 /templates/my-env-template/v1/                              # template version
 /templates/my-env-template/v1/infrastructure/               # template bundle
 /templates/my-env-template/v1/schema/
 /templates/my-env-template/v2/
 /templates/my-env-template/v2/infrastructure/
 /templates/my-env-template/v2/schema/

Sie können neue Versionen des Vorlagenpakets für eine oder mehrere synchronisierte Vorlagen in einen einzigen Commit aufnehmen. AWS Proton erstellt eine neue Vorlagenversion für jede neue Version des Vorlagenpakets, die im Commit enthalten war.

Nachdem Sie die Konfiguration für die Vorlagensynchronisierung erstellt haben, können Sie immer noch manuell neue Versionen der Vorlage in der Konsole oder mit der erstellen, AWS CLI indem Sie Vorlagenpakete aus einem S3-Bucket hochladen. Die Vorlagensynchronisierung funktioniert nur in eine Richtung: von deinem Repository nach. AWS Proton Manuell erstellte Vorlagenversionen werden nicht synchronisiert.

Nachdem du eine Konfiguration für die Vorlagensynchronisierung eingerichtet hast, AWS Proton wartet es auf Änderungen an deinem Repository. Immer wenn eine Änderung übertragen wird, wird nach einem Verzeichnis gesucht, das denselben Namen wie deine Vorlage hat. Es sucht dann in diesem Verzeichnis nach Verzeichnissen, die wie Hauptversionen aussehen. AWS Proton registriert das Vorlagenpaket für die entsprechende Vorlagen-Hauptversion. Die neuen Versionen sind immer im aktuellen DRAFT Zustand. Sie können die neuen Versionen mit der Konsole oder veröffentlichen AWS CLI.

Nehmen wir zum Beispiel an, Sie haben eine Vorlage, die my-env-template so konfiguriert ist, dass sie von main einem Zweig aus my-repo/templates mit dem folgenden Layout synchronisiert wird.

 /code
 /code/service.go
 README.md
 /templates/
 /templates/my-env-template/
 /templates/my-env-template/v1/
 /templates/my-env-template/v1/infrastructure/
 /templates/my-env-template/v1/schema/
 /templates/my-env-template/v2/
 /templates/my-env-template/v2/infrastructure/
 /templates/my-env-template/v2/schema/

AWS Proton synchronisiert den Inhalt von /templates/my-env-template/v1/ to my-env-template:1 und den Inhalt von /templates/my-env-template/v2/ tomy-env-template:2. Falls sie noch nicht existieren, werden diese Hauptversionen erstellt.

AWS Proton hat das erste Verzeichnis gefunden, das dem Vorlagennamen entsprach. Sie können die AWS Proton Suche nach Verzeichnissen einschränken, indem Sie eine Konfiguration für die Vorlagensynchronisierung angeben, subdirectoryPath wenn Sie eine Konfiguration für die Vorlagensynchronisierung erstellen oder bearbeiten. Sie können beispielsweise angeben /production-templates/ fürsubdirectoryPath.

Sie können eine Konfiguration für die Vorlagensynchronisierung mithilfe der Konsole oder der CLI erstellen.

Servicevorlagen synchronisieren

Die vorangegangenen Beispiele zeigen, wie Sie Umgebungsvorlagen synchronisieren können. Dienstvorlagen sind ähnlich. Um Servicevorlagen zu synchronisieren, fügen Sie jedem Hauptversionsverzeichnis in Ihrem Vorlagenpaket eine zusätzliche Datei hinzu, die benannt .template-registration.yaml ist. Diese Datei enthält zusätzliche Details, die AWS Proton benötigt werden, wenn sie nach einem Commit eine Service-Vorlagenversion für Sie erstellt. Wenn Sie mithilfe der AWS Proton Konsole oder API explizit eine Service-Vorlagenversion erstellen, geben Sie diese Details als Eingaben an, und diese Datei ersetzt diese Eingaben für die Vorlagensynchronisierung.

./templates/                                                 # subdirectory (optional)
 /templates/my-svc-template/                                 # service template name
 /templates/my-svc-template/v1/                              # service template version
 /templates/my-svc-template/v1/.template-registration.yaml   # service template version properties
 /templates/my-svc-template/v1/instance_infrastructure/      # template bundle
 /templates/my-svc-template/v1/schema/

Die .template-registration.yaml Datei enthält die folgenden Details:

Die YAML-Syntax der Datei lautet wie folgt:

compatible_environments:
  - env-templ-name:major-version
  - ...
supported_component_sources:
  - DIRECTLY_DEFINED

Geben Sie eine oder mehrere Kombinationen aus Umgebungsvorlage und Hauptversion an. Die Angabe supported_component_sources ist optional, und der einzige unterstützte Wert istDIRECTLY_DEFINED.

compatible_environments:
  - my-env-template:1
  - my-env-template:2
  - another-env-template:1
  - another-env-template:3