Manuelle Konfiguration Ihres CI/CD-Workflows für die Ausführung von Auslastungstests

• Eine Azure DevOps Organisation und projekt. Wenn Sie nicht über eine Azure DevOps Organisation verfügen, können Sie eine kostenlos erstellen. Wenn Sie Hilfe bei den ersten Schritten mit Azure Pipelines benötigen, lesen Sie Create your first pipeline.

• Ein GitHub Konto. Wenn Sie kein GitHub Konto haben, können Sie kostenlos erstellen.
• Ein GitHub Repository zum Speichern der Ladetesteingabedateien und Erstellen eines GitHub Actions Workflows. Informationen zum Erstellen eines Repositorys finden Sie unter Erstellen eines neuen Repositorys.

• Berechtigung zum Erstellen oder Ändern einer CI-Pipeline.
• Ein Quellcode-Repository zum Speichern der Auslastungstest-Eingabedateien.

Erstellen einer Dienstverbindung in Azure Pipelines

In Azure Pipelines erstellen Sie eine serviceverbindung in Ihrem Azure DevOps Projekt, um auf Ressourcen in Ihrem Azure-Abonnement zuzugreifen. Wenn Sie die Dienstverbindung erstellen, erstellt Azure DevOps ein Microsoft Entra Dienstprinzipalobjekt.

1. Melden Sie sich bei Ihrer Azure DevOps Organisation (https://dev.azure.com/<your-organization>) an, und wählen Sie Ihr Projekt aus.

   Ersetzen Sie den Textplatzhalter <your-organization> durch Ihren Projektbezeichner.

2. Wählen Sie Project Einstellungen>Service connections>+ Neue Dienstverbindung aus.

3. Wählen Sie im Bereich Neue Dienstverbindung den Azure Resource Manager aus, und wählen Sie dann Nächst aus.

4. Wählen Sie die Authentifizierungsmethode Dienstprinzipal (automatisch) und anschließend Weiter aus.

5. Geben Sie die Details zur Dienstverbindung ein, und wählen Sie dann Speichern aus, um die Dienstverbindung zu erstellen.

   Feld	Wert
   Bereichsebene	Abonnement.
   Abonnement	Wählen Sie das Azure-Abonnement aus, das Ihre Ressourcen zum Ladentest hostet.
   Ressourcengruppe	Wählen Sie die Ressourcengruppe aus, die die Ressource für den Auslastungstest enthält.
   Name der Dienstverbindung	Geben Sie für die Dienstverbindung einen eindeutigen Namen ein.
   Zugriffserlaubnis für alle Pipelines gewähren	Aktiviert.

6. Wählen Sie in der Liste der Dienstverbindungen die zuvor erstellte Dienstverbindung aus, und wählen Sie dann Dienstprinzipal verwalten aus.

   

   Das Azure Portal wird auf einer separaten Browserregisterkarte geöffnet und zeigt die Dienstprinzipaldetails an.

7. Kopieren Sie im Azure Portal den Wert Displayname.

   Sie verwenden diesen Wert im nächsten Schritt, um dem Dienstprinzipal Berechtigungen zum Ausführen von Auslastungstests zu erteilen.

Gewähren des Zugriffs auf Azure Load Testing

Azure Load Testing verwendet Azure RBAC, um Berechtigungen zum Ausführen bestimmter Aktivitäten für Ihre Auslastungstestressource zu erteilen. Um einen Auslastungstest über Ihre CI/CD-Pipeline auszuführen, weisen Sie dem Dienstprinzipal die Rolle „Mitwirkender für Auslastungstest“ zu.

1. Wechseln Sie im Azure-Portal zu Ihrer Azure Load Testing Ressource.

2. Klicken Sie auf Zugriffssteuerung (IAM)>Hinzufügen>Rollenzuweisung hinzufügen.

3. Wählen Sie auf der Registerkarte Rolle in der Liste der Auftragsfunktionsrollen die Option Mitwirkender für Auslastungstest aus.

   

4. Wählen Sie auf der Registerkarte Mitglieder die Option Mitglieder auswählen aus, und verwenden Sie dann den Anzeigenamen, den Sie zuvor kopiert haben, um den Dienstprinzipal zu suchen.

5. Wählen Sie den Dienstprinzipal und dann Auswählen aus.

6. Wählen Sie auf der Registerkarte Überprüfen + zuweisen die Option Überprüfen + zuweisen aus, um die Rollenzuweisung hinzuzufügen.

Sie können jetzt die Dienstverbindung in Ihrer Azure Pipelines Workflowdefinition verwenden, um auf Ihre Azure Auslastungstestressource zuzugreifen.

Um über den GitHub Actions-Workflow auf Ihre Azure Load Testing-Ressource zuzugreifen, erstellen Sie zuerst einen Microsoft Entra Service principal. Dieser Dienstprinzipal stellt Ihren GitHub Actions Workflow in Microsoft Entra ID dar.

Als Nächstes erteilen Sie dem Dienstprinzipal Berechtigungen zum Erstellen und Ausführen eines Auslastungstests mit Ihrer Azure Load Testing Ressource.

Erstellen eines Dienstprinzipals

Erstellen Sie einen Dienstprinzipal im Azure-Abonnement, und weisen Sie die Rolle "Load Test Contributor" zu, damit Ihr GitHub Actions Workflow Zugriff auf Ihre Azure Load Testing-Ressource hat, um Auslastungstests auszuführen.

1. Erstellen Sie einen Dienstprinzipal und weisen Sie die Rolle Load Test Contributor zu:

   # Get the resource ID for the load testing resource - replace the text place holders.
   loadtest=$(az resource show -g <resource-group-name> -n <load-testing-resource-name> --resource-type "Microsoft.LoadTestService/loadtests" --query "id" -o tsv)
   echo $loadtest
   
   # Create a service principal and assign the Load Test Contributor role - the scope is limited to the load testing resource.
   az ad sp create-for-rbac --name "my-load-test-cicd" --role "Load Test Contributor" \
                            --scopes $loadtest \
                            --json-auth
   

   Die Ausgabe ist ein JSON-Objekt, das den Dienstprinzipal darstellt. Sie verwenden diese Informationen, um sich bei Azure im GitHub Actions-Workflow zu authentifizieren.

   Creating 'Load Test Contributor' role assignment under scope
   {
     "clientId": "00000000-0000-0000-0000-000000000000",
     "clientSecret": "00000000-0000-0000-0000-000000000000",
     "subscriptionId": "00000000-0000-0000-0000-000000000000",
     "tenantId": "00000000-0000-0000-0000-000000000000",
     "activeDirectoryEndpointUrl": "https://login.microsoftonline.com",
     "resourceManagerEndpointUrl": "https://management.azure.com/",
     "activeDirectoryGraphResourceId": "https://graph.windows.net/",
     "sqlManagementEndpointUrl": "https://management.core.windows.net:8443/",
     "galleryEndpointUrl": "https://gallery.azure.com/",
     "managementEndpointUrl": "https://management.core.windows.net/"    
   }
   

   Hinweis

   Wenn Sie diesen Befehl ausführen, erhalten Sie möglicherweise eine --sdk-auth-Außerbetriebnahmewarnung. Alternativ können Sie OpenID Connect (OIDC)-basierte Authentifizierung für die Authentifizierung von GitHub bei Azure verwenden. Erfahren Sie, wie Sie die Azure-Anmeldeaktion mit OpenID Connect nutzen.

2. Kopieren Sie das JSON-Ausgabeobjekt in die Zwischenablage.

   Im nächsten Schritt speichern Sie die Dienstprinzipalinformationen als GitHub Actions Geheimnis.

Speichern von Azure-Anmeldeinformationen in GitHub Actions Secrets

Erstellen Sie einen GitHub Actions geheimen Schlüssel, um die Dienstprinzipalinformationen sicher zu speichern. Sie verwenden dieses Geheimnis in Ihrer Workflowdefinition, um eine Verbindung mit Azure herzustellen, sich zu authentifizieren und auf Ihre Azure-Ressource für Lasttests zuzugreifen.

So erstellen Sie einen GitHub Actions geheimen Schlüssel:

1. Navigieren Sie in GitHub zu Ihrem Repository.

2. Wählen Sie Einstellungen>Geheimnisse & Variablen>Aktionen aus.

3. Wählen Sie Neues Repositorygeheimnis aus, geben Sie die neuen Geheimnisinformationen ein, und wählen Sie dann Geheimnis hinzufügen aus, um ein neues Geheimnis zu erstellen.

   Feld	Wert
   Name	AZURE_CREDENTIALS
   Geheimnis	Fügen Sie die JSON-Ausgabe aus dem Dienstprinzipalerstellungsbefehl ein, die Sie zuvor kopiert haben.

Sie können jetzt über Ihren GitHub Actions Workflow über die gespeicherten Anmeldeinformationen auf Ihr Azure-Abonnement zugreifen und die Testressource laden.

Wenn Sie ein anderes CI/CD-Tool verwenden, verwenden Sie die Azure CLI, um mit Ihren Azure-Ressourcen zu interagieren. Führen Sie die folgenden Schritte aus, um den CI-Toolzugriff auf Ihre Load Testing-Ressource zu autorisieren:

1. Erstellen Sie einen Microsoft Entra Serviceprinzipal, um eine Verbindung mit Ihrem Azure-Abonnement herzustellen und auf Ihre Azure-Lasttest-Ressource zuzugreifen.
2. Erteilen Sie dem Dienstprinzipal Berechtigungen, um einen Auslastungstest zu erstellen und auszuführen, indem Sie die Rolle „Auslastungstestteilnehmer“ zuweisen.
3. Speichern Sie die Azure Anmeldeinformationen sicher im CI-Tool.

Führen Sie die folgenden Schritte aus, um die Dienstautorisierung für Ihr CI-Tool zu konfigurieren:

1. Erstellen eines Dienstprinzipals und Zuweisen der Rolle „Auslastungstestteilnehmer“:

   Ersetzen Sie die Textplatzhalter <resource-group-name> und <load-testing-resource-name>.

   # Get the resource ID for the load testing resource - replace the text place holders.
   loadtest=$(az resource show -g <resource-group-name> -n <load-testing-resource-name> --resource-type "Microsoft.LoadTestService/loadtests" --query "id" -o tsv)
   echo $loadtest
   
   # Create a service principal and assign the Load Test Contributor role - the scope is limited to the load testing resource.
   az ad sp create-for-rbac --name "my-load-test-cicd" --role "Load Test Contributor" \
                            --scopes $loadtest \
                            --json-auth
   

   Die Ausgabe ist ein JSON-Objekt, das den Dienstprinzipal darstellt.

   Creating 'Load Test Contributor' role assignment under scope
   {
     "clientId": "00000000-0000-0000-0000-000000000000",
     "clientSecret": "00000000-0000-0000-0000-000000000000",
     "subscriptionId": "00000000-0000-0000-0000-000000000000",
     "tenantId": "00000000-0000-0000-0000-000000000000",
     "activeDirectoryEndpointUrl": "https://login.microsoftonline.com",
     "resourceManagerEndpointUrl": "https://management.azure.com/",
     "activeDirectoryGraphResourceId": "https://graph.windows.net/",
     "sqlManagementEndpointUrl": "https://management.core.windows.net:8443/",
     "galleryEndpointUrl": "https://gallery.azure.com/",
     "managementEndpointUrl": "https://management.core.windows.net/"    
   }
   

2. Kopieren Sie die Werte clientId, clientSecretund tenantId, und speichern Sie sie sicher als Geheimnisse in Ihrem CI-Tool.

   Sie verwenden diese Werte, um sich mit dem Befehl Azure CLI az login bei Ihrem Azure-Abonnement anzumelden.

Installieren der Azure Load Testing-Erweiterung für Azure DevOps

Zum Erstellen und Ausführen eines Auslastungstests verwendet die Azure Pipelines Workflowdefinition die Azure Load Testing-Aufgabeerweiterung aus dem Azure DevOps Marketplace.

1. Öffnen Sie die Aufgabenerweiterung Azure Load Testing im Azure DevOps Marketplace, und wählen Sie Get it free aus.

2. Wählen Sie Ihre Azure DevOps Organisation und dann Install aus, um die Erweiterung zu installieren.

   Wenn Sie nicht über Administratorrechte für die ausgewählte Azure DevOps Organisation verfügen, wählen Sie Request aus, um einen Administrator zur Installation der Erweiterung anzufordern.

Aktualisieren des Azure Pipelines-Workflows

Aktualisieren Sie ihren Azure Pipelines Workflow so, dass ein Auslastungstest für Ihre Azure Load Testing-Ressource ausgeführt wird.

1. Melden Sie sich bei Ihrer Azure DevOps Organisation (https://dev.azure.com/<your-organization>) an, und wählen Sie Ihr Projekt aus.

2. Wählen Sie im linken Navigationsbereich Pipelines aus, wählen Sie Ihre Pipeline und dann Bearbeiten aus, um Ihre Workflowdefinition zu bearbeiten.

   Wählen Sie alternativ Pipeline erstellen aus, um eine neue Pipeline in Azure Pipelines zu erstellen.

3. Verwenden Sie die AzureLoadTest-Aufgabe, um den Auslastungstest auszuführen.

   Geben Sie in der loadTestConfigFile-Eigenschaft die Konfigurationsdatei für den Auslastungstest an, die Sie zuvor exportiert haben.

   Ersetzen Sie die Platzhalter für <load-testing-resource> und <load-testing-resource-group> text durch den Namen ihrer Azure Lasttestressource und der Ressourcengruppe.

       - task: AzureLoadTest@1
         inputs:
           azureSubscription: $(serviceConnection)
           loadTestConfigFile: 'config.yaml'
           loadTestResource: <load-testing-resource>
           resourceGroup: <load-testing-resource-group>
   

   Optional können Sie Parameter oder Geheimnisse mithilfe der env-Eigenschaft oder der secrets-Eigenschaft an den Auslastungstest übergeben. Legen Sie fest waitForCompletion: false , ob Sie fortfahren möchten, ohne auf den Abschluss des Ladetestlaufs zu warten.

4. Verwenden Sie die Aufgabe publish, um die Testergebnisse als Artefakte in Ihrer Azure Pipelines Workflowausführung zu veröffentlichen.

       - publish: $(System.DefaultWorkingDirectory)/loadTest
         artifact: loadTestResults
   

Aktualisieren des GitHub Actions-Workflows

Aktualisieren Sie Ihren GitHub Actions-Workflow, um einen Auslastungstest für Ihre Azure Auslastungstestressource auszuführen.

1. Navigieren Sie in GitHub zu Ihrem Repository.

2. Bearbeiten Sie Ihren GitHub Actions Workflow oder erstellen Sie einen neuen Workflow in Ihrem GitHub Repository.

3. Verwenden Sie die Aktion actions/checkout, um das Repository mit den Auslastungstest-Eingabedateien auszuchecken.

       - name: Checkout
         uses: actions/checkout@v3
   

4. Verwenden Sie die Aktion azure/login, um sich mit Azure mithilfe der gespeicherten Anmeldeinformationen zu authentifizieren.

   Fügen Sie die folgenden YAML-Inhalte in Ihre Workflowdefinition ein:

       - name: Login to Azure
         uses: azure/login@v1
         continue-on-error: false
         with:
           creds: ${{ secrets.AZURE_CREDENTIALS }}
   

5. Verwenden Sie die azure/load-testing-Aktion, um den Auslastungstest auszuführen.

   Geben Sie in der loadTestConfigFile-Eigenschaft die Konfigurationsdatei für den Auslastungstest an, die Sie zuvor exportiert haben.

   Ersetzen Sie die Platzhalter für <load-testing-resource> und <load-testing-resource-group> text durch den Namen ihrer Azure Lasttestressource und der Ressourcengruppe.

       - name: 'Azure Load Testing'
         uses: azure/load-testing@v1
         with:
           loadTestConfigFile: 'config.yaml'
           loadTestResource: <load-testing-resource>
           resourceGroup: <load-testing-resource-group>
   

   Optional können Sie Parameter oder Geheimnisse mithilfe der env-Eigenschaft oder der secrets-Eigenschaft an den Auslastungstest übergeben. Legen Sie fest waitForCompletion: false , ob Sie fortfahren möchten, ohne auf den Abschluss des Ladetestlaufs zu warten.

6. Verwenden Sie die Aktion actions/upload-artifact, um die Testergebnisse als Artefakte in Ihrer GitHub Actions Workflowausführung zu veröffentlichen.

       - uses: actions/upload-artifact@v2
         with:
           name: loadTestResults
           path: ${{ github.workspace }}/loadTest
   

Aktualisieren Sie Ihren CI-Workflow, um einen Auslastungstest für Ihre Azure Auslastungstestressource mithilfe der Azure CLI auszuführen. Verwenden Sie die Besonderheiten Ihres CI-Tools, um ihrem CI-Workflow die folgenden Befehle hinzuzufügen:

1. Melden Sie sich mit dem Dienstprinzipal beim Azure-Abonnement an.

   Verwenden Sie die zuvor gespeicherten Werte clientId, clientSecretund tenantId.

   az login --service-principal -u $AZURE_CLIENT_ID -p $AZURE_CLIENT_SECRET -t $AZURE_TENANT_ID
   az account set -s $AZURE_SUBSCRIPTION_ID
   

2. Erstellen Sie einen Auslastungstest mithilfe der YAML-Datei für die Auslastungstestkonfiguration.

   Ersetzen Sie die Textplatzhalter <load-testing-resource>, <load-testing-resource-group>und <load-test-config-yaml> durch den Namen der Load Testing-Ressource, den Namen der Ressourcengruppe und den Dateinamen der YAML-Datei für die Auslastungstestkonfiguration, die Sie zuvor dem Repository hinzugefügt haben.

   az load test create --load-test-resource <load-testing-resource> --resource-group <load-testing-resource-group> --test-id sample-test-id --load-test-config-file <load-test-config-yaml>
   

3. Führen Sie den Ladetest aus.

   testRunId="run_"`date +"%Y%m%d%_H%M%S"`
   displayName="Run"`date +"%Y/%m/%d_%H:%M:%S"`
   
   az load test-run create --load-test-resource <load-testing-resource> --test-id sample-test-id --test-run-id $testRunId --display-name $displayName --description "Test run from CLI"
   

4. Rufen Sie die clientseitigen Metriken für die Auslastungstestausführung ab, und zeigen Sie sie an.

   az load test-run metrics list --load-test-resource <load-testing-resource> --test-run-id $testRunId --metric-namespace LoadTestRunMetrics
   

1. Entfernen Sie die Änderungen an Azure Pipelines:

   1. Melden Sie sich bei Ihrer Azure DevOps Organisation (https://dev.azure.com/<your-organization>) an, und wählen Sie Ihr Projekt aus.

      Ersetzen Sie den Textplatzhalter <your-organization> durch Ihren Projektbezeichner.

   2. Wenn Sie eine neue Pipeline erstellt haben:

      1. Wählen Sie "Pipelines" und dann Ihre Pipeline aus.

      2. Wählen Sie die Auslassungspunkte und anschließend Löschen aus.

         

      3. Geben Sie den Pipelinenamen ein, und wählen Sie dann Löschen aus, um die Pipeline zu löschen.

   3. Wenn Sie eine vorhandene Workflowdefinition geändert haben, machen Sie die Änderungen für das Ausführen des Auslastungstests rückgängig, und speichern Sie den Workflow.

2. Entfernen der Dienstverbindung:

   1. Wählen Sie Project Settings>Service connections und dann Ihre Dienstverbindung aus.
   2. Wählen Sie Bearbeiten>Löschen aus, um die Dienstverbindung zu entfernen.

1. Entfernen GitHub Actions Änderungen:

   1. Navigieren Sie in GitHub zu Ihrem Repository.
   2. Wenn Sie eine neue Workflowdefinition erstellt haben, löschen Sie die YAML-Workflowdatei im Ordner .github/workflows.
   3. Wenn Sie eine vorhandene Workflowdefinition geändert haben, machen Sie die Änderungen für das Ausführen des Auslastungstests rückgängig, und speichern Sie den Workflow.

2. Entfernen des Dienstprinzipals:

   az ad sp delete --id $(az ad sp show --display-name "my-load-test-cicd" -o tsv)
   

1. Machen Sie Änderungen in Ihrem CI-Workflow rückgängig.

2. Entfernen des Dienstprinzipals:

   az ad sp delete --id $(az ad sp show --display-name "my-load-test-cicd" -o tsv)