Tutorial: Erstellen und Verwalten einer serverlosen Projekts in AWS CodeStar

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

   Anmerkung

   Sie müssen sich mit den AWS Management Console Anmeldeinformationen anmelden, die dem IAM-Benutzer zugeordnet sind, den Sie erstellt oder in Einrichten AWS CodeStar dem Sie sich identifiziert haben. Diesem Benutzer muss die verwaltete AWSCodeStarFullAccess-Richtlinie angefügt sein.

2. Wählen Sie die AWS-Region, in der Sie das Projekt und seine Ressourcen erstellen möchten.

   Informationen über die AWS-Regionen, in denen AWS CodeStar verfügbar ist, finden Sie unter Regionen und Endpunkte in der Allgemeinen AWS-Referenz.

3. Wählen Sie Create project (Projekt erstellen) aus.

4. Auf der Seite Choose a project template (Auswählen einer Projektvorlage):

   • Wählen Sie als Anwendungstyp die Option Webdienst aus.

   • Wählen Sie als Programmiersprache Python aus.

   • Wählen Sie für AWSService aus AWS Lambda.

5. Wählen Sie das Feld mit den von Ihnen gewählten Optionen. Wählen Sie Weiter aus.

6. Geben Sie für Project name (Projektname) einen Namen für Ihr Projekt ein (z. B.: My SAM Project). Wenn Sie einen anderen Namen als im Beispiel gezeigt verwenden, müssen Sie diesen durchgehend im ganzen Tutorial verwenden.

   AWS CodeStarWählt als Projekt-ID eine zugehörige Kennung für dieses Projekt aus (z. B. my-sam-project). Wenn Sie eine andere Projekt-ID sehen, müssen Sie diese im gesamten Tutorial verwenden.

   Behalten Sie die Auswahl von AWS CodeCommit bei und ändern Sie den Wert für Repository name (Repository-Name) nicht.

7. Wählen Sie Weiter aus.

8. Überprüfen Sie Ihre Einstellungen und wählen Sie dann Projekt erstellen.

   Wenn Sie es zum ersten Mal AWS CodeStar in dieser AWS Region verwenden, geben Sie für Anzeigename und E-Mail den Anzeigenamen und die E-Mail-Adresse ein, die Sie für Ihren IAM-Benutzer verwenden AWS CodeStar möchten. Wählen Sie Weiter aus.

9. Warten Sie, bis AWS CodeStar das Projekt erstellt hat. Dies kann einige Minuten dauern. Fahren Sie erst fort, wenn Sie beim Aktualisieren das Banner „Projekt bereitgestellt“ sehen.

Um das Quellcode-Repository zu erkunden in CodeCommit

1. Öffnen Sie Ihr Projekt in der AWS CodeStar Konsole und wählen Sie in der Navigationsleiste Repository aus.

2. Wählen Sie in den Repository-Details den Link zu Ihrem CodeCommit Repository (My-SAM-Project) aus.

3. In der CodeCommit Konsole werden auf der Code-Seite die Quellcodedateien für das Projekt angezeigt:

   • buildspec.yml, der die Verwendung während der Erstellungsphase CodePipeline anweist CodeBuild , den Webdienst mithilfe von AWS SAM zu verpacken.

   • index.py, das die Logik für die Lambda-Funktion enthält. Diese Funktion gibt einfach die Zeichenfolge Hello World und den Zeitstempel im ISO-Format aus.

   • README.md, die allgemeine Informationen über das Repository enthält.

   • template-configuration.json, die den Projekt-ARN mit Platzhaltern enthält, die zum Markieren von Ressourcen mit der Projekt-ID verwendet werden

   • template.yml, das AWS SAM verwendet, um den Webservice zu verpacken und die API in API Gateway zu erstellen.

   

   Um den Inhalt einer Datei anzuzeigen, wählen Sie sie in der Liste aus.

   Weitere Informationen zur Verwendung der CodeCommit Konsole finden Sie im AWS CodeCommitBenutzerhandbuch.

Um die Pipeline zu erkunden in CodePipeline

1. Um Informationen über die Pipeline anzuzeigen, öffnen Sie Ihr Projekt in der AWS CodeStar Konsole, wählen Sie in der Navigationsleiste Pipeline aus. Sie sehen, dass die Pipeline Folgendes enthält:

   • Eine Source-Phase, um den Quellcode aus CodeCommit abzurufen.

   • Eine Build-Phase, um den Quellcode mit CodeBuild zu erstellen.

   • Eine Deploy-Phase, um den erstellten Quellcode und die AWS-Ressourcen mit AWS SAM bereitzustellen.

2. Um weitere Informationen zur Pipeline anzuzeigen, wählen Sie unter Pipeline-Details Ihre Pipeline aus, um die Pipeline in der CodePipeline Konsole zu öffnen.

Informationen zu Projektaktivitäten und AWS Serviceressourcen finden Sie auf der Übersichtsseite

1. Öffnen Sie Ihr Projekt in der AWS CodeStar Konsole und wählen Sie in der Navigationsleiste „Übersicht“ aus.

2. Sehen Sie sich die Listen Projektaktivität und Projektressourcen an.

Um die Funktion in Lambda zu erkunden

1. Öffnen Sie Ihr Projekt in der AWS CodeStar Konsole und wählen Sie in der seitlichen Navigationsleiste die Option Übersicht aus.

2. Wählen Sie unter Projektressourcen in der Spalte ARN den Link für die Lambda-Funktion aus.

   Der Code der Funktion wird in der Lambda-Konsole angezeigt.

Um die API in API Gateway zu erkunden

1. Öffnen Sie Ihr Projekt in der AWS CodeStar Konsole und wählen Sie in der seitlichen Navigationsleiste die Option Übersicht aus.

2. Wählen Sie unter Projektressourcen in der Spalte ARN den Link für die Amazon API Gateway API aus.

   Ressourcen für die API werden in der API Gateway Gateway-Konsole angezeigt.

1. Wenn Ihr Projekt aus dem vorherigen Schritt noch geöffnet ist, wählen Sie in der Navigationsleiste Pipeline aus.

2. Stellen Sie sicher, dass für die Phasen Source, Build und Deploy die Option Erfolgreich angezeigt wird, bevor Sie fortfahren. Dies kann einige Minuten dauern.

   Anmerkung

   Wird für eine der Phasen Failed (Fehlgeschlagen) angezeigt, kann Ihnen Folgendes bei der Fehlersuche helfen:

   • Informationen zur Source-Phase finden Sie AWS CodeCommit im AWS CodeCommitBenutzerhandbuch unter Problembehandlung.

   • Informationen zur Build-Phase finden Sie unter Problembehandlung AWS CodeBuild im AWS CodeBuildBenutzerhandbuch.

   • Informationen zur Bereitstellungsphase finden Sie AWS CloudFormation im AWS CloudFormationBenutzerhandbuch unter Problembehandlung.

   • Informationen zu weiteren Problemen finden Sie unter Problembehebung AWS CodeStar.

3. Wählen Sie „Anwendung anzeigen“.

1. Während Ihr Projekt noch aus dem vorherigen Schritt geöffnet ist:

   • Wählen Sie in der Navigationsleiste IDE und erweitern Sie dann Auf Ihren Projektcode zugreifen.

   • Wählen Sie unter der Befehlszeilenschnittstelle die Option Anweisungen anzeigen aus.

     Wenn Sie Visual Studio oder Eclipse installiert haben, wählen Sie stattdessen Anweisungen anzeigen unter Visual Studio oder Eclipse aus, folgen Sie den Anweisungen und fahren Sie dann mit fortSchritt 5: Dem Webservice Logik hinzufügen.

2. Folgen Sie den Anweisungen, um die folgenden Aufgaben auszuführen:

   1. Einrichtung von Git auf Ihrer lokalen Workstation.

   2. Verwenden Sie die IAM-Konsole, um Git-Anmeldeinformationen für Ihren IAM-Benutzer zu generieren.

   3. Klonen Sie das CodeCommit Projekt-Repository auf Ihre lokale Workstation.

3. Wählen Sie in der linken Navigationsleiste Projekt aus, um zu Ihrer Projektübersicht zurückzukehren.

1. Gehen Sie auf Ihrer lokalen Workstation zu dem Verzeichnis, das das geklonte Quellcode-Repository enthält.

2. Erstellen Sie in diesem Verzeichnis eine Datei namens hello.py. Fügen Sie den folgenden Code hinzu und speichern Sie dann die Datei:

   import json
   
   def handler(event, context):
     data = {
       'output': 'Hello ' + event["pathParameters"]["name"]
     }
     return {
       'statusCode': 200,
       'body': json.dumps(data),
       'headers': {'Content-Type': 'application/json'}
     }

   Der oben gezeigte Code gibt einfach die Zeichenfolge Hello und die Zeichenfolge aus, die der Aufrufer an die Funktion sendet.

3. Im selben Verzeichnis öffnen Sie die Datei template.yml. Fügen Sie am Ende der Datei den folgenden Code hinzu und speichern Sie dann die Datei:

     Hello:
       Type: AWS::Serverless::Function
       Properties:
         FunctionName: !Sub 'awscodestar-${ProjectId}-lambda-Hello'
         Handler: hello.handler
         Runtime: python3.7
         Role:
           Fn::GetAtt:
           - LambdaExecutionRole
           - Arn
         Events:
           GetEvent:
             Type: Api
             Properties:
               Path: /hello/{name}
               Method: get

   AWSSAM verwendet diesen Code, um eine Funktion in Lambda zu erstellen, eine neue Methode und einen neuen Pfad zur API in API Gateway hinzuzufügen und dann diese Methode und diesen Pfad mit der neuen Funktion zu verbinden.

   Anmerkung

   Die Einrückung des obigen Codes ist wichtig. Wenn Sie den Code nicht genau so wie gezeigt hinzufügen, wird das Projekt möglicherweise nicht korrekt erstellt.

4. Führen Sie den Befehl git add . aus, um Ihre Dateiänderungen dem Staging-Bereich des geklonten Repositorys hinzuzufügen. Vergessen Sie nicht den Punkt (.), der dafür sorgt, dass alle geänderten Dateien hinzugefügt werden.

   Anmerkung

   Wenn Sie Visual Studio oder Eclipse anstelle der Befehlszeile verwenden, können sich die Anweisungen für die Nutzung von Git unterscheiden. Weitere Informationen finden Sie in der Visual Studio- oder Eclipse-Dokumentation.

5. Führen Sie den Befehl git commit -m "Added hello.py and updated template.yaml." aus, um Ihre bereitgestellten Dateien in das geklonte Repository zu übertragen

6. Führen Sie den Befehl git push aus, um Ihr Commit in das Remote-Repository zu verschieben.

   Anmerkung

   Möglicherweise werden Sie zur Eingabe der zuvor für Sie generierten Anmeldeinformationen aufgefordert. Um zu vermeiden, dass Sie bei jeder Interaktion mit dem Remote-Repository dazu aufgefordert werden, sollten Sie einen Git Credential Manager installieren und konfigurieren. Unter macOS oder Linux beispielsweise können Sie git config credential.helper 'cache --timeout 900' auf dem Terminal ausführen, um höchstens alle 15 Minuten zur Eingabe aufgefordert zu werden. Alternativ können Sie git config credential.helper 'store --file ~/.git-credentials' ausführen, um nie wieder aufgefordert zu werden. GIT speichert Ihre Anmeldeinformationen in einer Klartextdatei in Ihrem Stammverzeichnis. Weitere Informationen finden Sie unter Git Tools - Credential Storage auf der Git-Website.

1. Während Ihr Projekt noch in der AWS CodeStar Konsole geöffnet ist, wählen Sie in der Navigationsleiste Pipeline aus.

2. Vergewissern Sie sich, dass die Pipeline erneut ausgeführt wurde und dass für die Phasen Source, Build und Deploy die Meldung Erfolgreich angezeigt wird, bevor Sie fortfahren. Dies kann einige Minuten dauern.

   Anmerkung

   Wird für eine der Phasen Failed (Fehlgeschlagen) angezeigt, kann Ihnen Folgendes bei der Fehlersuche helfen:

   • Informationen zur Source-Phase finden Sie AWS CodeCommit im AWS CodeCommitBenutzerhandbuch unter Problembehandlung.

   • Informationen zur Build-Phase finden Sie unter Problembehandlung AWS CodeBuild im AWS CodeBuildBenutzerhandbuch.

   • Informationen zur Bereitstellungsphase finden Sie AWS CloudFormation im AWS CloudFormationBenutzerhandbuch unter Problembehandlung.

   • Informationen zu weiteren Problemen finden Sie unter Problembehebung AWS CodeStar.

3. Wählen Sie „Anwendung anzeigen“.

   Auf der neuen Registerkarte, die in Ihrem Webbrowser geöffnet wird, zeigt der Webservice die folgende Ausgabe als Antwort an:

   {"output": "Hello World", "timestamp": "2017-08-30T15:53:42.682839"}

4. Fügen Sie im Adressfeld der Registerkarte den Pfad /hello/ und Ihren Vornamen am Ende der URL ein (z. B. https://API-ID.execute-api.REGIONS-ID.amazonaws.com/Prod/hello/IHR_VORNAME) und drücken Sie dann die Eingabetaste.

1. Gehen Sie auf Ihrer lokalen Workstation zu dem Verzeichnis, das das geklonte Quellcode-Repository enthält.

2. Erstellen Sie in diesem Verzeichnis eine Datei namens hello_test.py. Fügen Sie den folgenden Code hinzu und speichern Sie dann die Datei.

   from hello import handler
   
   def test_hello_handler():
   
     event = {
       'pathParameters': {
         'name': 'testname'
       }
     }
   
     context = {}
   
     expected = {
       'body': '{"output": "Hello testname"}',
       'headers': {
         'Content-Type': 'application/json'
       },
       'statusCode': 200
     }
   
     assert handler(event, context) == expected

   Dieser Test prüft, ob die Ausgabe der Lambda-Funktion das erwartete Format hat. Ist dies der Fall, ist der Test erfolgreich. Andernfalls schlägt der Test fehl.

3. Im selben Verzeichnis öffnen Sie die Datei buildspec.yml. Ersetzen Sie den Dateiinhalt durch den folgenden Code und speichern Sie dann die Datei.

   version: 0.2
   
   phases:
      install:
         runtime-versions:
            python: 3.7
   
         commands:
            - pip install pytest
            # Upgrade AWS CLI to the latest version
            - pip install --upgrade awscli
   
   
      pre_build:
         commands:
            - pytest
   
      build:
         commands:
            # Use AWS SAM to package the application by using AWS CloudFormation
            - aws cloudformation package --template template.yml --s3-bucket $S3_BUCKET --output-template template-export.yml
   
            # Do not remove this statement. This command is required for AWS CodeStar projects.
            # Update the AWS Partition, AWS Region, account ID and project ID in the project ARN on template-configuration.json file so AWS CloudFormation can tag project resources.
            - sed -i.bak 's/\$PARTITION\$/'${PARTITION}'/g;s/\$AWS_REGION\$/'${AWS_REGION}'/g;s/\$ACCOUNT_ID\$/'${ACCOUNT_ID}'/g;s/\$PROJECT_ID\$/'${PROJECT_ID}'/g' template-configuration.json
   
   artifacts:
      type: zip
      files:
         - template-export.yml
         - template-configuration.json

   Diese Build-Spezifikation weist CodeBuild an, Pytest, das Python-Testframework, in seiner Build-Umgebung zu installieren. CodeBuild verwendet Pytest, um den Komponententest auszuführen. Die weiteren Build-Spezifikation bleiben unverändert.

4. Verwenden Sie Git, um diese Änderungen im Remote-Repository zu speichern.

   git add .
   
   git commit -m "Added hello_test.py and updated buildspec.yml."
   
   git push

1. Während Ihr Projekt noch in der AWS CodeStar Konsole geöffnet ist, wählen Sie in der Navigationsleiste Pipeline aus.

2. Stellen Sie sicher, dass die Pipeline erneut ausgeführt wurde, bevor Sie fortfahren. Dies kann einige Minuten dauern.

   Wenn der Einheitentest erfolgreich war, wird Succeeded (Erfolgreich) für die Build-Phase angezeigt.

3. Um die Details der Unit-Test-Ergebnisse anzuzeigen, wählen Sie in der Build-Phase den CodeBuildLink aus.

4. Wählen Sie in der CodeBuild Konsole auf der my-sam-project Seite Build Project: unter Build-Verlauf den Link in der Spalte Build run der Tabelle aus.

5. Wählen Sie auf der Seite my-sam-project: BUILD_ID unter Build-Logs den Link Gesamtes Protokoll anzeigen aus.

6. Suchen Sie in der Amazon CloudWatch Logs-Konsole in der Protokollausgabe nach einem Testergebnis, das dem Folgenden ähnelt. Das folgende Testergebnis zeigt, dass der Test bestanden wurde:

   ...
   ============================= test session starts ==============================
   platform linux2 -- Python 2.7.12, pytest-3.2.1, py-1.4.34, pluggy-0.4.0
   rootdir: /codebuild/output/src123456789/src, inifile:
   collected 1 item
   
   hello_test.py .
   
   =========================== 1 passed in 0.01 seconds ===========================
   ...

   Ist der Test fehlgeschlagen, sollten in der Protokollausgabe detaillierte Informationen enthalten sind, die Ihnen bei der Fehlersuche helfen.

1. Wenn Ihr Projekt noch in der AWS CodeStar Konsole geöffnet ist, wählen Sie in der Navigationsleiste Einstellungen aus.

2. Wählen Sie in den Projektdetails die Option Projekt löschen aus.

3. Geben Sie eindelete, lassen Sie das Feld Ressourcen löschen aktiviert, und wählen Sie dann Löschen aus.

   Wichtig

   Wenn Sie dieses Kontrollkästchen deaktivieren, wird der Projektdatensatz von AWS CodeStar gelöscht, aber viele der AWS-Ressourcen des Projekts bleiben erhalten. Ihr AWS-Konto könnte weiterhin belastet werden.

1. Öffnen Sie die Amazon S3 S3-Konsole unter https://console.aws.amazon.com/s3/.

2. Wählen Sie in der Liste der Buckets das Symbol neben aws-codestar- REGION_ID - ACCOUNT_ID - --pipe aus, wobei: my-sam-project

   • REGION_ID ist die ID der AWS-Region für das Projekt, das Sie gerade gelöscht haben.

   • ACCOUNT_ID ist Ihre AWS-Konto-ID.

   • my-sam-projectist die ID des Projekts, das Sie gerade gelöscht haben.

3. Wählen Sie Empty Bucket (Leerer Bucket). Geben Sie den Namen des Buckets ein und klicken Sie dann auf Confirm (Bestätigen).

4. Wählen Sie Delete Bucket (Bucket löschen). Geben Sie den Namen des Buckets ein und klicken Sie dann auf Confirm (Bestätigen).