Toolchains erstellen

Toolchain aus einer Vorlage über die Konsole erstellen

Sie können eine Vorlage als Ausgangspunkt verwenden, um eine Toolchain zu erstellen, die einen bestimmten Satz von Toolintegrationen enthält. Abhängig von der verwendeten Vorlage können Sie eine Toolchain erstellen, die eine bestimmte Gruppe von Toolintegrationen enthält, oder eine leere Toolchain, zu der Sie Toolintegrationen hinzufügen können. Weitere Informationen zur Verwendung der Vorlagen finden Sie in IBM Cloud Garage Method.

1. Melden Sie sich bei IBM Cloud an.

2. Klicken Sie in der Konsole IBM Cloud auf das im Menü > Plattformautomatisierung > Toolchains.

3. Klicken Sie auf der Seite 'Toolchains' auf Toolchain erstellen.

4. Klicken Sie auf der Seite Toolchain erstellen auf eine Toolchain-Vorlage.

5. Überprüfen Sie das Diagramm der Toolchain, die Sie gerade erstellen. In dem Diagramm wird jede Toolintegration in ihrer aktuellen Lebenszyklusphase in der Toolchain angezeigt.

   Für einige der Toolchain-Vorlagen sind mehrere Instanzen einer Toolintegration vorhanden. Die Toolchain-Vorlage "Entwickeln und Testen von Microservices mit Kubernetes und Helm " auf IBM Cloud Public enthält zum Beispiel vier Instanzen von GitHub und vier Instanzen von Delivery Pipeline.

   Das Diagramm in der folgenden Abbildung ist ein Beispiel. Wenn Sie eine Toolchain erstellen, zeigt das Diagramm jede Toolintegration an, die Teil der Toolchain ist.

   

6. Überprüfen Sie die Standardinformationen für die Toolchain-Einstellungen:

   • Der Name der Toolchain macht sie in IBM Cloud identifizierbar. Wenn Sie einen anderen Namen verwenden möchten, ändern Sie den Namen der Toolchain.
   • Die Region, in der die Toolchain erstellt wird. Wenn Sie eine andere Region verwenden möchten, wählen Sie eine Region aus der Liste verfügbarer Regionen aus.
   • Die Ressourcengruppe, in der die Toolchain erstellt werden soll. Wenn Sie eine andere Ressourcengruppe verwenden möchten, wählen Sie sie aus der Liste der verfügbaren Ressourcengruppen aus.
   • Der Provider für Ihr Quellenrepository, z. B. GitHub, GitLab oder Bitbucket. Wenn Sie einen anderen Quellenprovider verwenden möchten, wählen Sie ihn aus der Liste verfügbarer Repositorys aus.

7. Wählen Sie im Abschnitt mit den Toolintegrationen jede Toolintegration aus, die Sie für Ihre Toolchain konfigurieren möchten. Einige Toolintegrationen erfordern keine Konfiguration. Weitere Informationen zum Konfigurieren der Toolintegrationen finden Sie unter Toolintegrationen konfigurieren.

   Viele der Toolintegrationen, die eine Toolchain enthalten, erfordern für die Authentifizierung beim Continuous Delivery-Service einen geheimen Schüssel.

   Ein geheimer Schlüssel steht für die Berechtigungsnachweise, die in Form eines Kennworts, eines Authentifizierungstokens, eines API-Schlüssels oder eines Zertifikats bereitgestellt werden können. Wenn Sie beispielsweise die Toolintegration von Delivery Pipeline zu Ihrer Toolchain hinzufügen, müssen Sie einen geheimen Schlüssel in Form eines API-Schlüssels bereitstellen.

   a. Klicken Sie im Abschnitt mit den Toolintegrationen auf Delivery Pipeline.

   b. Klicken Sie auf Neu, um einen IBM Cloud®-API-Schlüssel zu erstellen.

   c. Klicken Sie auf OK, um den neuen API-Schlüssel anzuwenden.

   Jeder Benutzer kann maximal 20 API-Schlüssel haben.

   d. Klicken Sie auf OK, um den API-Schlüssel zu erstellen, ohne eine Sicherheitskopie des Schlüssels zu speichern.

   e. Um den API-Schlüssel sicher zu speichern, damit Sie ihn in anderen Toolchain-Workflows wieder verwenden können:

   • Aktivieren Sie das Kontrollkästchen Diesen Schlüssel in einem Geheimnisspeicher zur Wiederverwendung speichern, um ihn in den Geheimnisspeicher Key Protect oder Secrets Manager zu integrieren.
   • Wenn Sie keine bestehende Instanz von Key Protect oder Secrets Manager haben, geben Sie einen Namen für die Instanz und das Geheimnis an.
   • Klicken Sie auf OK, um den neuen API-Schlüssel anzuwenden.

   Fa. Um zu überprüfen, ob Ihre Key Protect-oder Secrets Manager-Instanz erfolgreich erstellt wurde, rufen Sie Ihre IBM Cloud®-Ressourcenliste auf und erweitern Sie das Pfeilsymbol Services. Um Ihre API-Schlüssel anzuzeigen, klicken Sie in der Menüleiste auf Verwalten > Zugriff (IAM) und wählen Sie IBM Cloud® API-Schlüssel.

   g. Der API-Schlüssel, den Sie erstellt und in Key Protect kopiert haben, steht nun zur Verwendung auf der Seite 'Toolchain erstellen' zur Verfügung. Für jede Toolintegration, die einen geheimen Schüssel benötigt, wird ein Schlüsselsymbol angezeigt. Klicken Sie auf das Schlüsselsymbol, um ein Dialogfeld "Secrets Picker" zu öffnen, um Geheimnisse von einer oder mehreren Key Protect oder Secrets Manager Instanzen abzurufen.

8. Klicken Sie auf Erstellen. Zum Einrichten Ihrer Toolchain werden mehrere verschiedene Schritte automatisch ausgeführt. Welche Toolintegrationen eingerichtet werden, hängt von Ihrer Auswahl der Toolchain-Vorlage ab. Wenn Sie beispielsweise eine Toolchain zum Entwickeln und Testen von Mikroservices mit Kubernetes und Helmin IBM Cloud Public erstellen, werden die folgenden Schritte ausgeführt:

   • Die Toolchain wird erstellt.
   • Wenn Sie Delivery Pipeline konfiguriert haben, werden die Pipelines erstellt und aktiviert.
   • Wenn Sie Event Notifications konfiguriert haben, ist die Toolchain so eingerichtet, dass sie Ereignisbenachrichtigungen an den von Ihnen angegebenen Dienst Event Notifications sendet.
   • Wenn Sie Sauce Labs konfiguriert haben, wird die Toolchain so eingerichtet, dass Sauce Labs-Testjobs zu den Pipelines hinzugefügt werden.
   • Wenn Sie PagerDuty konfiguriert haben, wird die Toolchain so eingerichtet, dass sie Alertbenachrichtigungen an den von Ihnen angegebenen PagerDuty-Service sendet.
   • Wenn Sie Slack konfiguriert haben, wird die Toolchain so konfiguriert, dass sie Benachrichtigungen zum Bereitstellungsstatus an den von Ihnen angegebenen Kanal sendet.
   • Wenn Sie eine Quellcode-Toolintegration wie GitHub konfiguriert haben, wird das GitHub-Beispielrepository in Ihr GitHub-Konto geklont.

   Sie können nun Ereignisbenachrichtigungen mit Hilfe der Event Notifications tool-Integration. IBM Cloud Event Notifications ist die bevorzugte Methode zur Verteilung von Benachrichtigungen an PagerDuty und andere Kommunikationskanäle wie Slack, E-Mail, SMS, Push-Benachrichtigungen, Webhook, Microsoft® Teams, ServiceNow, und IBM Cloud Functions. Weitere Informationen zur Verwendung von Event Notifications finden Sie unter Aktivieren von Ereignisbenachrichtigungen für Toolchains.

Toolchain über die Konsole aus einer App erstellen

Sie können eine Toolchain aus Ihrer App heraus erstellen. Die Toolchain kann u.a. eine kontinuierliche Entwicklung, Bereitstellung oder Überwachung unterstützen und wird Ihrer App zugeordnet. Jede App kann einer Toolchain zugeordnet werden. Wenn Sie Änderungen per Push-Operation an das GitHub-Repository der Toolchain übertragen, erstellt die Pipeline automatisch Builds und stellt die App bereit.

1. Wenn Sie IBM Cloud Public verwendet haben, um Ihre App zu erstellen, wird sie für die kontinuierliche Bereitstellung aus einem neuen GitHub Repo konfiguriert, das mit dem Startcode der App bestückt ist.

2. Überprüfen Sie auf der Seite zum Konfigurieren der Toolchain das Diagramm der Toolchain, die Sie gerade erstellen. In dem Diagramm wird jede Toolintegration in ihrer aktuellen Lebenszyklusphase in der Toolchain angezeigt.

3. Überprüfen Sie die Standardinformationen für die Toolchain-Einstellungen. Der Name der Toolchain macht sie in IBM Cloud identifizierbar. Wenn Sie einen anderen Namen verwenden möchten, ändern Sie den Namen der Toolchain.

4. Wählen Sie im Abschnitt mit den Toolintegrationen jede Toolintegration aus, die Sie für Ihre Toolchain konfigurieren möchten. Einige Toolintegrationen erfordern keine Konfiguration. Weitere Informationen zum Konfigurieren der Toolintegrationen finden Sie unter Toolintegrationen konfigurieren.

5. Klicken Sie auf Erstellen. Zum Einrichten Ihrer Toolchain werden mehrere verschiedene Schritte automatisch ausgeführt. Wenn Sie eine Toolchain aus einer App unter IBM Cloud Public erstellen, werden zum Beispiel die folgenden Schritte ausgeführt:

   • Die Toolchain wird erstellt.
   • Wenn Sie Delivery Pipeline konfiguriert haben, werden die Pipelines erstellt und aktiviert.
   • Wenn Sie GitHub konfiguriert haben, wird das GitHub-Beispielrepository in Ihr GitHub-Konto geklont.

Erstellen einer Toolchain mit der API

1. Rufen Sie ein IAM-Trägertoken ab.. Wenn Sie ein SDK verwenden, rufen Sie einen IAM-API-Schlüssel ab und legen Sie die Clientoptionen mithilfe von Umgebungsvariablen fest.

   export CD_TOOLCHAIN_AUTH_TYPE=iam && \
   export CD_TOOLCHAIN_APIKEY={iam_api_key} && \
   export CD_TOOLCHAIN_URL={base_url}
   

2. Suchen Sie die ID der Ressourcengruppe, in der Sie Ihre Toolchain erstellen wollen.

3. Wählen Sie die Region aus, in der Sie Ihre Toolchain erstellen wollen.

4. Erstellen Sie eine Instanz der Toolchain.

   curl -X POST \
     "{base_url}/toolchains" \
     -H 'Authorization: Bearer {token}' \
     -H 'Content-Type: application/json' \
       -d '{
       "name": "{toolchain_name}",
       "resource_group_id": "{resource_group_id}"
     }'
   

   const CdToolchainV2 = require('@ibm-cloud/continuous-delivery/cd-toolchain/v2');
   const toolchainService = CdToolchainV2.newInstance();
   ...
   (async() => {
      const toolchainPrototypeModel = {
         description: {toolchain_description},
         name: {toolchain_name},
         resourceGroupId: {resource_group_id}
      };
      const response = await toolchainService.createToolchain(toolchainPrototypeModel);
   })();
   

   import (
   	   "github.com/IBM/continuous-delivery-go-sdk/cdtoolchainv2"
   )
   ...
   toolchainClientOptions := &cdtoolchainv2.CdToolchainV2Options{}
   toolchainClient, err := cdtoolchainv2.NewCdToolchainV2UsingExternalConfig(toolchainClientOptions)
   createToolchainOptions := toolchainClient.NewCreateToolchainOptions({toolchain_name}, {resource_group_id})
   createToolchainOptions.SetDescription({toolchain_description})
   toolchain, response, err := toolchainClient.CreateToolchain(createToolchainOptions)
   

   from ibm_continuous_delivery.cd_toolchain_v2 import CdToolchainV2
   ...
   toolchain_service = CdToolchainV2.new_instance()
   toolchain = toolchain_service.create_toolchain(
      description = {toolchain_description},
      name = {toolchain_name},
      resource_group_id = {resource_group_id}
   )
   

   import com.ibm.cloud.continuous_delivery.cd_toolchain.v2.CdToolchain;
   import com.ibm.cloud.continuous_delivery.cd_toolchain.v2.model.*;
   ...
   CdToolchain toolchainService = CdToolchain.newInstance();
   CreateToolchainOptions createToolchainOptions = new CreateToolchainOptions.Builder()
      .description({toolchain_description})
      .name({toolchain_name})
      .resourceGroupId({resource_group_id})
      .build();
   Response<ToolchainPost> response = toolchainService.createToolchain(createToolchainOptions).execute();
   ToolchainPost toolchain = response.getResult();
   

In der folgenden Tabelle werden alle Variablen aufgelistet und beschrieben, die in den vorherigen Schritten verwendet wurden.

Weitere Informationen zum Erstellen von Toolchains mit der API finden Sie unter Toolchain erstellen in der Dokumentation zur IBM Cloud-API.

Toolchain mit Terraform erstellen

1. Um das Terraform CLI zu installieren und das IBM Cloud Provider-Plugin für Terraform zu konfigurieren, folgen Sie dem Lernprogramm für Erste Schritte mit Terraform auf IBM Cloud®.

2. Erstellen Sie eine Terraform-Konfigurationsdatei mit dem Namen main.tf. Fügen Sie in dieser Datei die Konfiguration für die Erstellung einer Toolchain mit Hilfe der HashiCorp Configuration Language hinzu. Weitere Informationen zur Verwendung dieser Konfigurationssprache finden Sie in der Terraform-Dokumentation.

   Im folgenden Beispiel wird eine Toolchain mithilfe der Ressource ibm_cd_toolchain erstellt.

   data "ibm_resource_group" "group" {
     name = "default"
   }
   
   resource "ibm_cd_toolchain" "cd_toolchain" {
     name              = "my toolchain"
     resource_group_id = data.ibm_resource_group.group.id
   }
   

   Weitere Informationen zu ibm_cd_toolchain finden Sie in den Argumentreferenzdetails in der Dokumentation zur Terraform-Registry.

3. Terraform-Befehlszeilenschnittstelle initialisieren.

   terraform init
   

4. Erstellen Sie einen Terraform-Ausführungsplan. Dieser Plan fasst alle Aktionen zusammen, die zum Erstellen einer Toolchain ausgeführt werden müssen.

   terraform plan
   

5. Wenden Sie den Terraform-Ausführungsplan an. Terraform führt alle erforderlichen Aktionen zum Erstellen der Toolchain aus.

   terraform apply