Tutorial: Erstellen einer vierstufigen Pipeline

Um das Beispiel zu klonen und in ein GitHub Repository zu pushen

1. Laden Sie den Beispielcode aus dem GitHub Repository herunter oder klonen Sie die Repositorys auf Ihren lokalen Computer. Es gibt zwei Beispielpakete:

   • Wenn Sie Ihr Beispiel auf Amazon Linux- oder Ubuntu Server-Instances bereitstellen möchten, wählen Sie codepipeline-jenkins-aws-codedeploy_linux.zip. RHEL

   • Wenn Sie Ihr Beispiel auf Windows Server-Instances bereitstellen möchten, wählen Sie CodePipeline-Jenkins - _Windows.zip. AWSCodeDeploy

2. Klicken Sie im Repository auf Fork, um das Beispiel-Repository in Ihrem Github-Konto zu klonen. Weitere Informationen finden Sie in der Dokumentation. GitHub

1. Melden Sie sich bei der an AWS Management Console und öffnen Sie die IAM Konsole unter. https://console.aws.amazon.com/iam/

2. Wählen Sie in der IAM Konsole im Navigationsbereich Rollen und dann Rolle erstellen aus.

3. Wählen Sie unter Select type of trusted entity (Typ der vertrauenswürdigen Entität auswählen) die Option AWS-Service Service aus. Wählen Sie unter Wählen Sie den Dienst aus, der diese Rolle verwenden soll die Option aus EC2. Wählen Sie unter Wählen Sie Ihren Anwendungsfall aus EC2.

4. Wählen Sie Weiter: Berechtigungen aus. Wählen Sie auf der Seite Attach permissions policies (Berechtigungsrichtlinien anfügen) die verwaltete AWSCodePipelineCustomActionAccess-Richtlinie und anschließend Next: Tags (Weiter: Tags) aus. Wählen Sie Weiter: Prüfen aus.

5. Geben Sie auf der Seite Überprüfen im Feld Rollenname den Namen der Rolle ein, die speziell für die Jenkins-Integration erstellt werden soll (z. B. JenkinsAccess), und wählen Sie dann Rolle erstellen aus.

Um Jenkins und das Plugin für Jenkins zu installieren CodePipeline

1. Erstellen Sie eine EC2 Instanz, in der Sie Jenkins installieren möchten, und stellen Sie in Schritt 3: Instanzdetails konfigurieren sicher, dass Sie die Instanzrolle auswählen, die Sie erstellt haben (z. B. JenkinsAccess). Weitere Informationen zum Erstellen von EC2 Instances finden Sie unter Starten einer EC2 Amazon-Instance im EC2Amazon-Benutzerhandbuch.

   Anmerkung

   Wenn Sie bereits über Jenkins-Ressourcen verfügen, die Sie verwenden möchten, können Sie dies tun. Sie müssen jedoch einen speziellen IAM Benutzer erstellen, die AWSCodePipelineCustomActionAccess verwaltete Richtlinie auf diesen Benutzer anwenden und dann die Zugangsdaten für diesen Benutzer auf Ihrer Jenkins-Ressource konfigurieren und verwenden. Wenn Sie die Jenkins-Benutzeroberfläche verwenden möchten, um die Anmeldeinformationen bereitzustellen, konfigurieren Sie Jenkins so, dass es nur erlaubt. HTTPS Weitere Informationen finden Sie unter Problembehebung CodePipeline.

2. Installieren Sie Jenkins in der EC2-Instance. Weitere Informationen finden Sie in der Jenkins-Dokumentation unter Installing Jenkins und Starting and accessing Jenkins sowie unter details of integration with Jenkins in Produkt- und Serviceintegrationen mit CodePipeline.

3. Starten Sie Jenkins. Wählen Sie auf der Startseite Manage Jenkins aus.

4. Wählen Sie auf der Seite Manage Jenkins Manage Plugins aus.

5. Wählen Sie die Registerkarte Available (Verfügbar) aus. Geben Sie im Suchfeld Filter „AWS CodePipeline“ ein. Wählen Sie CodePipeline Plugin für Jenkins aus der Liste aus und klicken Sie auf Jetzt herunterladen und nach dem Neustart installieren.

6. Klicken Sie auf der Seite Installing Plugins/Upgrades auf Restart Jenkins when installation is complete and no jobs are running.

7. Wählen Sie Back to Dashboard aus.

8. Klicken Sie auf der Hauptseite auf New Item.

9. Geben Sie im Feld Elementname einen Namen für das Jenkins-Projekt ein (z. B. MyDemoProject). Wählen Sie Freestyle-Projekt und dann OK.

   Anmerkung

   Stellen Sie sicher, dass der Name für Ihr Projekt die Anforderungen für erfüllt. CodePipeline Weitere Informationen finden Sie unter Kontingente in AWS CodePipeline.

10. Wählen Sie auf der Konfigurationsseite des Projekts das Kontrollkästchen Execute concurrent builds if necessary aus. Wählen Sie in Source Code Management (Quellcodeverwaltung) AWS CodePipeline. Wenn Sie Jenkins auf einer EC2 Instanz installiert und diese AWS CLI mit dem Profil für den IAM Benutzer konfiguriert haben, den Sie für die Integration zwischen CodePipeline und Jenkins erstellt haben, lassen Sie alle anderen Felder leer.

11. Wählen Sie Erweitert und geben Sie unter Anbieter einen Namen für den Anbieter der Aktion ein, wie er angezeigt werden soll (zum Beispiel CodePipeline MyJenkinsProviderName). Stellen Sie sicher, dass dieser Name einzigartig und leicht zu merken ist. Sie werden ihn verwenden, wenn Sie zu einem späteren Zeitpunkt in diesem Tutorial eine Build- und -Test-Aktion zu Ihrer Pipeline hinzufügen.

    Anmerkung

    Dieser Aktionsname muss die Benennungsanforderungen für Aktionen in erfüllen CodePipeline. Weitere Informationen finden Sie unter Kontingente in AWS CodePipeline.

12. Deaktivieren Sie unter Trigger erstellen alle Kontrollkästchen und wählen Sie dann Umfrage ausSCM. Geben Sie in Schedule (Zeitplan) fünf durch Leerzeichen getrennte Sternchen ein:

    * * * * *

    Dabei wird CodePipeline jede Minute abgefragt.

13. Wählen Sie in Build Add build step aus. Wählen Sie Shell ausführen (Amazon Linux oder Ubuntu Server) Batch-Befehl ausführen (Windows Server) und geben Sie dann Folgendes ein: RHEL

    rake

    Anmerkung

    Stellen Sie sicher, dass Ihre Umgebung mit den Variablen und Einstellungen konfiguriert ist, die für die Ausführung von Rake erforderlich sind. Andernfalls schlägt der Build fehl.

14. Wählen Sie „Post-Build-Aktion hinzufügen“ und anschließend „AWS CodePipeline Publisher“. Wählen Sie Add aus. Lassen Sie den Speicherort in Build Output Locations leer. Dies ist die Standardkonfiguration. Sie erstellt am Ende des Build-Prozesses eine komprimierte Datei.

15. Wählen Sie Save, um Ihr Jenkins-Projekt zu speichern.

Um einen CodePipeline automatisierten Release-Prozess zu erstellen

1. Melden Sie sich bei der an AWS Management Console und öffnen Sie die CodePipeline Konsole unter http://console.aws.amazon.com/codesuite/codepipeline/home.

2. Falls erforderlich, verwenden Sie die Regionsauswahl, um die Region auf diejenige zu ändern, in der sich Ihre Pipeline-Ressourcen befinden. Wenn Sie beispielsweise Ressourcen für das vorherige Tutorial in erstellt habenus-east-2, stellen Sie sicher, dass die Regionsauswahl auf USA Ost (Ohio) eingestellt ist.

   Weitere Informationen zu den Regionen und Endpunkten, für die verfügbar sind CodePipeline, finden Sie unter AWS CodePipeline Endpunkte und Kontingente.

3. Wählen sie auf der Seite Welcome (Willkommen) die Option Getting started (Erste Schritte) aus, oder auf der Seite Pipelines die Option Create pipeline (Pipeline erstellen).

4. Geben Sie auf der Seite Step 1: Choose pipeline settings (Schritt 1: Pipeline-Einstellungen auswählen) unter Pipeline name (Pipeline-Name) den Namen für Ihre Pipeline ein.

5. Wählen Sie im Feld Pipeline-Typ die Option V1 für die Zwecke dieses Tutorials aus. Sie können auch V2 wählen. Beachten Sie jedoch, dass sich die Pipeline-Typen in ihren Eigenschaften und im Preis unterscheiden. Weitere Informationen finden Sie unter Arten von Pipelines.

6. Wählen Sie unter Servicerolle die Option Neue Servicerolle aus, CodePipeline um das Erstellen einer Servicerolle in zu ermöglichenIAM.

7. Belassen Sie die Advanced settings (Erweiterte Einstellungen) auf den Standardwerten und wählen Sie Next (Weiter) aus.

8. Wählen Sie auf der Seite Schritt 2: Quellstufe hinzufügen im Feld Quellanbieter die Option GitHub.

9. Wählen Sie unter Verbindung eine bestehende Verbindung aus, oder erstellen Sie eine neue. Informationen zum Erstellen oder Verwalten einer Verbindung für Ihre GitHub Quellaktion finden Sie unterGitHub Verbindungen.

10. Wählen Sie in Step 3: Add build stage (Schritt 3: Build-Stufe hinzufügen) die Option Add Jenkins (Jenkins hinzufügen). Geben Sie im Feld Anbietername den Namen der Aktion ein, die Sie im CodePipeline Plugin für Jenkins angegeben haben (z. B. MyJenkinsProviderName). Dieser Name muss exakt mit dem Namen im CodePipeline Plugin für Jenkins übereinstimmen. Geben Sie im Feld Server die EC2 Instanz einURL, auf URL der Jenkins installiert ist. Geben Sie im Feld Projektname den Namen des Projekts ein, das Sie in Jenkins erstellt haben, z. B. MyDemoProject, und wählen Sie dann Weiter.

11. Verwenden Sie in Schritt 4: Bereitstellungsphase hinzufügen die CodeDeploy Anwendung und die Bereitstellungsgruppe, in der Sie sie erstellt haben, erneutTutorial: Erstellen einer einfachen Pipeline (S3-Bucket). Wählen Sie unter Deploy provider (Bereitstellungsanbieter) die Option CodeDeploy aus. Geben Sie unter Application name (Anwendungsname) „CodePipelineDemoApplication“ ein, oder klicken Sie auf die Schaltfläche „Aktualisieren“, und wählen Sie dann den Namen der Anwendung aus der Liste aus. Geben Sie unter Deployment group (Bereitstellungsgruppe) CodePipelineDemoFleet ein oder wählen Sie den Eintrag aus der Liste. Klicken Sie dann auf Next (Weiter).

    Anmerkung

    Sie können Ihre eigenen CodeDeploy Ressourcen verwenden oder neue erstellen, es können jedoch zusätzliche Kosten anfallen.

12. Prüfen Sie in Step 5: Review die Informationen und wählen Sie dann Create pipeline aus.

13. Die Pipeline wird automatisch gestartet und führt das Beispiel über die Pipeline aus. Sie können Fortschritts-, Erfolgs- und Fehlschlagsmeldungen anzeigen, während die Pipeline das Haml-Beispiel erstellt HTML und es auf einer Webseite für jede der EC2 Amazon-Instances in der CodeDeploy Bereitstellung bereitstellt.

So prüfen Sie die IP-Adresse einer Instance, in der Sie Ihren Code bereitgestellt haben

1. Nachdem Succeeded für den Pipelinestatus angezeigt wird, wählen Sie im Statusbereich für die Stufe "Staging" die Option Details aus.

2. Klicken Sie im Abschnitt Deployment Details in Instance ID die Instance-ID einer der erfolgreich bereitgestellten Instances an.

3. Kopieren Sie die IP-Adresse der Instance (zum Beispiel 192.168.0.4). Sie werden diese IP-Adresse in Ihrem Jenkins-Test verwenden.

So erstellen Sie das Jenkins-Projekt

1. Öffnen Sie in der Instance, in der Sie Jenkins installiert haben, Jenkins und wählen Sie auf der Hauptseite New Item aus.

2. Geben Sie im Feld Artikelname einen Namen für das Jenkins-Projekt ein (z. B. MyTestProject). Wählen Sie Freestyle-Projekt und dann OK.

   Anmerkung

   Stellen Sie sicher, dass der Name für Ihr Projekt den CodePipeline Anforderungen entspricht. Weitere Informationen finden Sie unter Kontingente in AWS CodePipeline.

3. Wählen Sie auf der Konfigurationsseite des Projekts das Kontrollkästchen Execute concurrent builds if necessary aus. Wählen Sie in Source Code Management (Quellcodeverwaltung) AWS CodePipeline. Wenn Sie Jenkins auf einer EC2 Instanz installiert und diese AWS CLI mit dem Profil für den IAM Benutzer konfiguriert haben, den Sie für die Integration zwischen CodePipeline und Jenkins erstellt haben, lassen Sie alle anderen Felder leer.

   Wichtig

   Wenn Sie ein Jenkins-Projekt konfigurieren und es nicht auf einer EC2 Amazon-Instance installiert ist, oder wenn es auf einer EC2 Instance installiert ist, auf der ein Windows-Betriebssystem ausgeführt wird, füllen Sie die Felder entsprechend Ihren Proxy-Host- und Port-Einstellungen aus und geben Sie die Anmeldeinformationen des IAM Benutzers oder der Rolle ein, den Sie für die Integration zwischen Jenkins und konfiguriert haben. CodePipeline

4. Wählen Sie Advanced aus und wählen Sie in Category Test aus.

5. Geben Sie im Feld Provider denselben Namen ein, den Sie für das Build-Projekt verwendet haben (z. B. MyJenkinsProviderName). Sie werden diesen Namen verwenden, wenn Sie die Testaktion später in diesem Tutorial zu Ihrer Pipeline hinzufügen.

   Anmerkung

   Dieser Name muss die CodePipeline Benennungsanforderungen für Aktionen erfüllen. Weitere Informationen finden Sie unter Kontingente in AWS CodePipeline.

6. Deaktivieren Sie unter Trigger erstellen alle Kontrollkästchen und wählen Sie dann Umfrage ausSCM. Geben Sie in Schedule (Zeitplan) fünf durch Leerzeichen getrennte Sternchen ein:

   * * * * *

   Dabei wird CodePipeline jede Minute abgefragt.

7. Wählen Sie in Build Add build step aus. Wenn Sie die Bereitstellung auf Amazon Linux- RHEL oder Ubuntu Server-Instances durchführen, wählen Sie Shell ausführen. Geben Sie dann Folgendes ein, wobei die IP-Adresse die Adresse der EC2 Instance ist, die Sie zuvor kopiert haben:

   TEST_IP_ADDRESS=192.168.0.4 rake test

   Wenn Sie die Bereitstellung auf Windows Server-Instanzen durchführen, wählen Sie Batch-Befehl ausführen und geben Sie dann Folgendes ein, wobei die IP-Adresse die Adresse der EC2 Instanz ist, die Sie zuvor kopiert haben:

   set TEST_IP_ADDRESS=192.168.0.4 rake test

   Anmerkung

   Der Test geht davon aus, dass der Standard-Port 80 verwendet wird. Wenn Sie einen anderen Port festlegen, fügen Sie wie folgt eine Test-Port-Anweisung ein:

   TEST_IP_ADDRESS=192.168.0.4 TEST_PORT=8000 rake test

8. Wählen Sie „Post-Build-Aktion hinzufügen“ und anschließend „AWS CodePipeline Publisher“. Wählen Sie nicht Add aus.

9. Wählen Sie Save, um Ihr Jenkins-Projekt zu speichern.

So fügen Sie eine Stufe mit der Jenkins-Testaktion zu der Pipeline hinzu

1. Melden Sie sich bei der an AWS Management Console und öffnen Sie die CodePipeline Konsole unter http://console.aws.amazon.com/codesuite/codepipeline/home.

2. Wählen Sie unter Name den Namen der Pipeline aus, die Sie erstellt haben, MySecondPipeline.

3. Wählen Sie auf der Pipelinedetails-Seite Edit aus.

4. Wählen Sie auf der Seite Edit (Bearbeiten) + Stage (+ Stufe) aus, um eine Stufe direkt nach der Build-Stufe hinzuzufügen.

5. Geben Sie im Namensfeld für die neue Phase einen Namen für die Phase ein (z. B. Testing) und wählen Sie dann Add action group (Aktionsgruppe hinzufügen) aus.

6. Geben Sie im Feld Aktionsname Folgendes ein MyJenkinsTest-Action. Wählen Sie unter Testanbieter den Anbieternamen aus, den Sie in Jenkins angegeben haben (z. B. MyJenkinsProviderName). Geben Sie im Feld Projektname den Namen des Projekts ein, das Sie in Jenkins erstellt haben (z. B. MyTestProject). Wählen Sie unter Eingabeartefakte das Artefakt aus dem Jenkins-Build aus, dessen Standardname lautet BuildArtifact, und wählen Sie dann Fertig.

   Anmerkung

   Da die Jenkins-Testaktion auf der Anwendung ausgeführt wird, die im Jenkins-Build-Schritt erstellt wurde, verwenden Sie das Build-Artefakt als das Eingabeartefakt für die Testaktion.

   Weitere Informationen über die Eingabe- und Ausgabeartefakte und die Struktur von Pipelines finden Sie in CodePipeline Referenz zur Pipeline-Struktur.

7. Wählen Sie auf der Seite Edit Save pipeline changes aus. Klicken Sie im Dialogfeld Save pipeline changes auf Save and continue.

8. Obwohl die neue Stufe der Pipeline hinzugefügt wurde, wird der Status No executions yet für die Stufe angezeigt. Dies liegt daran, dass noch keine Änderungen eine weitere Ausführung der Pipeline ausgelöst haben. Um das Beispiel durch die überarbeitete Pipeline laufen zu lassen, wählen Sie auf der Seite mit den Pipeline-Details die Option Änderung veröffentlichen aus.

   Die Pipelineansicht zeigt die Stufen und Aktionen in Ihrer Pipeline sowie den Status der Revision bei der Ausführung über die vier Stufen an. Die Zeit, die die Pipeline zur Ausführung über alle Stufen benötigt, hängt von der Größe der Artefakte sowie von der Komplexität Ihrer Build- und Testaktionen und von anderen Faktoren ab.

So bereinigen Sie die in diesem Tutorial verwendeten Ressourcen

1. Öffnen Sie eine Terminalsitzung auf Ihrem lokalen Linux-, macOS- oder Unix-Computer oder eine Befehlszeile auf Ihrem lokalen Windows-Computer und führen Sie den delete-pipeline Befehl zum Löschen der von Ihnen erstellten Pipeline aus. Für MySecondPipeline geben Sie beispielsweise den folgenden Befehl ein:

   aws codepipeline delete-pipeline --name "MySecondPipeline"

   Mit diesem Befehl wird kein Inhalt zurückgegeben.

2. Folgen Sie den Anweisungen unter Aufräumen, um Ihre CodeDeploy Ressourcen zu bereinigen.

3. Um Ihre Instance-Ressourcen zu bereinigen, löschen Sie die EC2 Instance, auf der Sie Jenkins installiert haben. Weitere Informationen finden Sie unter Bereinigen Ihrer Instance.

4. Wenn Sie nicht beabsichtigen, weitere Pipelines zu erstellen oder CodePipeline erneut zu verwenden, löschen Sie den Amazon S3 S3-Bucket, der zum Speichern von Artefakten für Ihre Pipeline verwendet wurde. Folgen Sie den Anweisungen in Löschen eines Buckets, um den Bucket zu löschen.

5. Wenn Sie die anderen Ressourcen für diese Pipelines nicht erneut verwenden möchten, können Sie diese mithilfe der Anweisungen für die entsprechende Ressource löschen. Wenn Sie beispielsweise das GitHub Repository löschen möchten, folgen Sie den Anweisungen unter Löschen eines Repositorys auf der GitHub Website.