Erstellen Sie eine benutzerdefinierte Aktion und fügen Sie sie hinzu in CodePipeline

Um eine benutzerdefinierte Aktion zu erstellen, verwenden Sie AWS CLI

1. Öffnen Sie einen Texteditor und erstellen Sie eine JSON-Datei mit der Aktion, dem Aktionsanbieter und allen erforderlichen Einstellungen für Ihre benutzerdefinierte Aktion. Ihre JSON-Datei für eine benutzerdefinierte Aktion mit nur einer Eigenschaft könnte beispielsweise wie folgt aussehen:

   {
       "category": "Build",
       "provider": "My-Build-Provider-Name",
       "version": "1",
       "settings": {
           "entityUrlTemplate": "https://my-build-instance/job/{Config:ProjectName}/",
           "executionUrlTemplate": "https://my-build-instance/job/{Config:ProjectName}/lastSuccessfulBuild/{ExternalExecutionId}/"
       },
       "configurationProperties": [{
           "name": "ProjectName",
           "required": true,
           "key": true,
           "secret": false,
           "queryable": false,
           "description": "The name of the build project must be provided when this action is added to the pipeline.",
           "type": "String"
       }],
       "inputArtifactDetails": {
           "maximumCount": integer,
           "minimumCount": integer
       },
       "outputArtifactDetails": {
           "maximumCount": integer,
           "minimumCount": integer
       },
       "tags": [{
         "key": "Project",
         "value": "ProjectA"
       }]
   }

   In diesem Beispiel wird der benutzerdefinierten Aktion Tagging hinzugefügt, indem der benutzerdefinierten Aktion der Tag-Schlüssel Project und der Wert ProjectA hinzugefügt werden. Weitere Hinweise zum Taggen von Ressourcen in finden Sie CodePipeline unterTaggen von Ressourcen.

   Die JSON-Datei enthält zwei Eigenschaften, entityUrlTemplate und executionUrlTemplate. Solange die Konfigurationseigenschaft erforderlich und nicht geheim ist, können Sie über das Format {Config:name} in den URL-Vorlagen auf einen Namen in den Konfigurationseigenschaften der benutzerdefinierten Aktion verweisen. Im obigen Beispiel bezieht sich der entityUrlTemplate Wert beispielsweise auf die KonfigurationseigenschaftProjectName.

   • entityUrlTemplate: Der statische Link mit Informationen über die Dienstanbieter für die Aktion. Im Beispiel umfasst das Build-System einen statischen Link zu den einzelnen Build-Projekten. Das Linkformat variiert je nach Build-Anbieter oder Dienstanbieter (beispielsweise bei anderen Aktionstypen wie Test). Sie müssen dieses Linkformat so angeben, dass der Benutzer beim Hinzufügen der benutzerdefinierten Aktion mit dem Link eine Webseite im Browser öffnen kann, die die Einzelheiten für das Build-Projekt (oder die Testumgebung) enthält.

   • executionUrlTemplate: Der dynamische Link, der mit Informationen zur aktuellen oder letzten Ausführung der Aktion aktualisiert wird. Wenn Ihr benutzerdefinierter Auftragsworker den Status eines Auftrags aktualisiert (z. B. bei Erfolg, Fehler oder während der Ausführung), stellt er zusätzlich eine externalExecutionId bereit, die zur Vervollständigung des Links verwendet wird. Dieser Link kann verwendet werden, um Details zum Ausführen einer Aktion bereitzustellen.

   Wenn Sie die Aktion beispielsweise in der Pipeline anzeigen, sehen Sie die beiden folgenden Links:

   

   Dieser statische Link wird angezeigt, nachdem Sie Ihre benutzerdefinierte Aktion hinzugefügt haben. Er verweist auf die Adresse in entityUrlTemplate, die Sie bei der Erstellung Ihrer benutzerdefinierten Aktion angegeben haben.

   Dieser dynamische Link wird nach jeder Ausführung der Aktion aktualisiert und verweist auf die Adresse in executionUrlTemplate, die Sie bei der Erstellung Ihrer benutzerdefinierten Aktion angegeben haben.

   Weitere Informationen zu diesen Linktypen sowie zu RevisionURLTemplate und ThirdPartyURL finden Sie unter ActionTypeSettings und CreateCustomActionType in der CodePipeline API-Referenz. Weitere Informationen über die Anforderungen zur Aktionsstruktur und zur Erstellung einer Aktion finden Sie unter CodePipeline Referenz zur Pipeline-Struktur.

2. Speichern Sie die JSON-Datei und geben Sie ihr einen Namen, den Sie sich leicht merken können (z. BMyCustomAction.. json).

3. Öffnen Sie eine Terminalsitzung (Linux, OS X, Unix) oder eine Eingabeaufforderung (Windows) auf einem Computer, auf dem die AWS CLI installiert ist.

4. Verwenden Sie den, AWS CLI um den aws codepipeline create-custom-action-type Befehl auszuführen, und geben Sie dabei den Namen der JSON-Datei an, die Sie gerade erstellt haben.

   Um beispielsweise eine benutzerdefinierte Build-Aktion zu erstellen:

   Wichtig

   Achten Sie darauf, dass file:// vor dem Dateinamen steht. Dies ist bei diesem Befehl erforderlich.

   aws codepipeline create-custom-action-type --cli-input-json file://MyCustomAction.json

5. Dieser Befehl gibt die gesamte Struktur der erstellten, benutzerdefinierten Aktion sowie die für Sie hinzugefügte JobList-Aktionskonfigurationseigenschaft zurück. Wenn Sie die benutzerdefinierte Aktion zu einer Pipeline hinzufügen, können Sie JobList nutzen, um die Projekte vom Anbieter anzugeben, für die Sie Aufträge abfragen können. Ohne entsprechende Konfiguration werden bei der Abfrage von Aufträgen durch Ihren benutzerdefinierten Auftragsworker alle verfügbaren Aufträge zurückgegeben.

   Der vorherige Befehl könnte beispielsweise eine Struktur ähnlich der Folgenden zurückgeben:

   {
       "actionType": {
           "inputArtifactDetails": {               
               "maximumCount": 1,                
               "minimumCount": 1
          },
          "actionConfigurationProperties": [
               {
                   "secret": false,
                   "required": true,
                   "name": "ProjectName",
                   "key": true,
                   "description": "The name of the build project must be provided when this action is added to the pipeline."
               }
           ],
           "outputArtifactDetails": {               
               "maximumCount": 0,                
               "minimumCount": 0
           },
           "id": {
               "category": "Build",
               "owner": "Custom",
               "version": "1",
               "provider": "My-Build-Provider-Name"
           },
           "settings": {
               "entityUrlTemplate": "https://my-build-instance/job/{Config:ProjectName}/",
               "executionUrlTemplate": "https://my-build-instance/job/mybuildjob/lastSuccessfulBuild/{ExternalExecutionId}/"
           }
       }
   }

   Anmerkung

   Als Teil der create-custom-action-type Befehlsausgabe umfasst der id Abschnitt Folgendes"owner": "Custom": CodePipeline weist benutzerdefinierte Aktionstypen automatisch Custom als Eigentümer zu. Dieser Wert kann zugewiesen oder geändert werden, wenn Sie den Befehl create-custom-action-type oder den Befehl update-pipeline verwenden.

Um Amazon EC2-Instances einzurichten

1. Erfahren Sie mehr über Amazon EC2 und finden Sie heraus, ob es die richtige Wahl für Ihre Integration ist. Informationen finden Sie unter Amazon EC2 — Virtual Server Hosting.

2. Beginnen Sie mit der Erstellung Ihrer Amazon EC2-Instances. Weitere Informationen finden Sie unter Erste Schritte mit Amazon EC2 Linux-Instances.

So richten Sie einen Identitätsverbund ein

1. Erfahren Sie mehr über den IAM-Identitätsverbund. Weitere Informationen finden Sie unter Manage Federation.

2. Sehen Sie sich die Beispiele in Scenarios for Granting Temporary Access an, um das Szenario für den temporären Zugriff zu ermitteln, das am besten für Ihre benutzerdefinierte Aktion geeignet ist.

3. Sehen Sie sich die für Ihre Infrastruktur relevanten Codebeispiele zum Identitätsverbund an. Diese sind beispielsweise:

   • Identity Federation Sample Application for an Active Directory Use Case

4. Erste Schritte bei der Konfiguration eines Identitätsverbunds. Weitere Informationen finden Sie im IAM-Benutzerhandbuch unter Identitätsanbieter und Verbund.

1. Öffnen Sie eine Terminalsitzung (Linux, macOS oder Unix) oder eine Befehlszeile (Windows) und führen Sie den get-pipeline Befehl aus, um die Pipeline-Struktur, die Sie bearbeiten möchten, in eine JSON-Datei zu kopieren. Für eine Pipeline mit dem Namen MyFirstPipeline würden Sie beispielsweise den folgenden Befehl verwenden:

   aws codepipeline get-pipeline --name MyFirstPipeline >pipeline.json

   Dieser Befehl gibt nichts zurück. Die erstellte Datei sollte jedoch in dem Verzeichnis auftauchen, in dem Sie den Befehl ausgeführt haben.

2. Öffnen Sie die JSON-Datei in einem Texteditor und bearbeiten Sie die Struktur der Datei, um Ihre benutzerdefinierte Aktion zu einer vorhandenen Stufe hinzuzufügen.

   Anmerkung

   Wenn Sie möchten, dass Ihre Aktion mit einer anderen Aktion in dieser Stufe parallel ausgeführt wird, weisen Sie ihr den gleichen runOrder-Wert wie der anderen Aktion zu.

   Um beispielsweise die Struktur einer Pipeline zu bearbeiten und ihr eine Stufe mit dem Namen Build hinzufügen und gleichzeitig eine benutzerdefinierte Aktion zu dieser Stufe hinzuzufügen, können Sie die JSON-Datei so ändern, dass die Build-Stufe vor einer Bereitstellungsstufe eingefügt ist. Beispiel:

   ,
       {
         "name": "MyBuildStage",
         "actions":  [
                 {
                   "inputArtifacts": [
                   {
                      "name": "MyApp"
                    }
                      ],
                       "name": "MyBuildCustomAction",
                       "actionTypeId": {
                           "category": "Build",
                           "owner": "Custom",
                           "version": "1",
                           "provider": "My-Build-Provider-Name"
                       },
                       "outputArtifacts": [
                           {
                             "name": "MyBuiltApp"
                           }
                       ],
                       "configuration": {
                           "ProjectName": "MyBuildProject"
                       },
                       "runOrder": 1
                   }
               ]
           },      
           {
               "name": "Staging",
               "actions": [
                       {
                           "inputArtifacts": [
                               {
                                   "name": "MyBuiltApp"
                               }
                           ],
                           "name": "Deploy-CodeDeploy-Application",
                           "actionTypeId": {
                               "category": "Deploy",
                               "owner": "AWS",
                               "version": "1",
                               "provider": "CodeDeploy"
                           },
                           "outputArtifacts": [],
                           "configuration": {
                               "ApplicationName": "CodePipelineDemoApplication",
                               "DeploymentGroupName": "CodePipelineDemoFleet"
                           },
                           "runOrder": 1
                       }
                   ]
                }      
       ]
   }

3. Führen Sie den Befehl update-pipeline aus, um die Änderungen zu übernehmen. Geben Sie die Pipeline-JSON-Datei dabei folgendermaßen an:

   Wichtig

   Achten Sie darauf, dass file:// vor dem Dateinamen steht. Dies ist bei diesem Befehl erforderlich.

   aws codepipeline update-pipeline --cli-input-json file://pipeline.json

   Dieser Befehl gibt die gesamte Struktur der bearbeiteten Pipeline zurück.

4. Öffnen Sie die CodePipeline Konsole und wählen Sie den Namen der Pipeline, die Sie gerade bearbeitet haben.

   Die Pipeline zeigt die Änderungen an. Wenn Sie das nächste Mal eine Änderung am Quellspeicherort durchführen, führt die Pipeline die Revision über die überarbeitete Struktur der Pipeline aus.