Verbindung zu Event Notifications in der Konsole herstellen

Konfigurieren Sie Event Notifications, um kritische Ereignisse von Toolchains und Toolintegrationsinstanzen zu senden:

1. Wenn Sie über eine Toolchain verfügen und diese Tool-Integration hinzufügen möchten, klicken Sie in der IBM Cloud-Konsole auf das Menü-Symbol ( ) > Platform Automation > Toolchains. Klicken Sie auf der Seite 'Toolchains' auf die Toolchain, um die zugehörige Übersichtsseite zu öffnen.

   a. Klicken Sie auf Tool hinzufügen.

   b. Klicken Sie im Abschnitt mit den Toolintegrationen auf Event Notifications.

2. Geben Sie den Namen ein, den Sie für diese Tool-Integration auf der Event Notifications-Karte in Ihrer Toolchain anzeigen möchten. Dieser Name wird verwendet, um die Werkzeugintegration in Ihrer Toolchain zu identifizieren.

3. Wählen Sie die Instanz Event Notifications aus, mit der die Toolchain verbunden werden soll.

4. Klicken Sie auf Integration erstellen, um die Event Notifications-Tool-Integration zu Ihrer Toolchain hinzuzufügen.

5. Klicken Sie auf der Übersichtsseite Ihrer Toolchain auf der Karte IBM Cloud auf Event Notifications.

Verbindung zu Event Notifications über die API herstellen

Sie können die Event Notifications-Toolintegration mithilfe der API zu Ihrer Toolchain hinzufügen.

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 nach der ID der Toolchain, in der Sie Ihre Toolintegration erstellen wollen.

3. Geben Sie eventnotifications als tool_type_id an.

4. Geben Sie die folgenden tool_parameters an, die für die Toolintegration erforderlich sind:

   • name: Der Name, mit dem die Event Notifications-Toolintegration identifiziert wird.
   • instance-crn: Der Cloudressourcenname (CRN) der Event Notifications-Serviceinstanz.

5. Fügen Sie die Tool-Integration in die jeweilige Toolchain hinzu.

   curl -X POST --location --header "Authorization: Bearer {iam_token}" \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --data '{ "name": "{tool_name}", "tool_type_id": "eventnotifications", "parameters": { "name": {event_notifications_tool_integration_name}, "instance-crn": {event_notifications_service_crn} } }' \
     "{base_url}/toolchains/{toolchain_id}/tools"
   

   const CdToolchainV2 = require('@ibm-cloud/continuous-delivery/cd-toolchain/v2');
   const toolchainService = CdToolchainV2.newInstance();
   ...
   (async() => {
      const toolParameters = {
         "name": {event_notifications_tool_integration_name},
         "instance-crn": {event_notifications_service_crn}
      }
      const toolPrototypeModel = {
         toolchainId: {toolchain_id},
         toolTypeId: "eventnotifications",
         name: {tool_name},
         parameters: toolParameters
      };
      const response = await toolchainService.createTool(toolPrototypeModel);
   })();
   

   import (
   	   "github.com/IBM/continuous-delivery-go-sdk/cdtoolchainv2"
   )
   ...
   toolchainClientOptions := &cdtoolchainv2.CdToolchainV2Options{}
   toolchainClient, err := cdtoolchainv2.NewCdToolchainV2UsingExternalConfig(toolchainClientOptions)
   toolParameters := map[string]interface{}{
      "name": {event_notifications_tool_integration_name},
      "instance-crn": {event_notifications_service_crn},
   }
   createToolOptions := toolchainClient.NewCreateToolOptions({toolchain_id}, "eventnotifications")
   createToolOptions.SetName({tool_name})
   createToolOptions.SetParameters(toolParameters)
   tool, response, err := toolchainClient.CreateTool(createToolOptions)
   

   from ibm_continuous_delivery.cd_toolchain_v2 import CdToolchainV2
   ...
   toolchain_service = CdToolchainV2.new_instance()
   tool_parameters = {}
   tool_parameters["name"] = {event_notifications_tool_integration_name}
   tool_parameters["instance-crn"] = {event_notifications_service_crn}
   tool = toolchain_service.create_tool(
      name = {tool_name},
      toolchain_id = {toolchain_id},
      tool_type_id = "eventnotifications",
      parameters = tool_parameters
   )
   

   import com.ibm.cloud.continuous_delivery.cd_toolchain.v2.CdToolchain;
   import com.ibm.cloud.continuous_delivery.cd_toolchain.v2.model.*;
   ...
   CdToolchain toolchainService = CdToolchain.newInstance();
   HashMap<String, Object> toolParameters = new HashMap<>();
   toolParameters.put("name", {event_notifications_tool_integration_name});
   toolParameters.put("instance-crn", {event_notifications_service_crn});
   CreateToolOptions createToolOptions = new CreateToolOptions.Builder()
      .name({tool_name})
      .parameters(toolParameters)
      .toolchainId({toolchain_id})
      .toolTypeId("eventnotifications")
      .build();
   Response<ToolchainToolPost> response = toolchainService.createTool(createToolOptions).execute();
   ToolchainToolPost tool = response.getResult();
   

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

Toolintegration mit Terraform hinzufügen

Sie können die Event Notifications-Toolintegration mithilfe von Terraform zu Ihrer Toolchain hinzufügen.

IBM Cloud Terraform Provider Version 1.53.0 oder höher ist erforderlich, um eine Tool-Integration mit Terraform hinzuzufügen.

1. Um die Terraform-Befehlszeilenschnittstelle (CLI) zu installieren und das IBM Cloud-Anbieter-Plugin für Terraform zu konfigurieren, befolgen Sie die Anleitung Erste Schritte mit Terraform unter IBM Cloud®.

2. Erstellen Sie eine Terraform-Konfigurationsdatei mit dem Namen main.tf. Fügen Sie in dieser Datei die Konfiguration hinzu, um Ressourceninstanzen mithilfe der HashiCorp Configuration Language (HCL) zu erstellen. Weitere Informationen zur Verwendung dieser Konfigurationssprache finden Sie in der Terraform-Dokumentation.

   Im folgenden Beispiel wird eine Delivery Pipeline mithilfe der Ressource ibm_cd_toolchain_tool_pipeline erstellt, wobei toolchain_id eine GUID ist, die die Toolchain darstellt, in der die Toolintegration erstellt werden soll.

   data "ibm_cd_toolchain" "cd_toolchain" {
     toolchain_id = {toolchain_id}
   }
   resource "ibm_cd_toolchain_tool_eventnotifications" "en_instance" {
     toolchain_id = data.ibm_cd_toolchain.cd_toolchain.id
     parameters {
       name = "{event_notifications_tool_integration_name}"
       instance_crn = "{event_notifications_service_crn}"
     }
   }
   

   Weitere Informationen zu Toolintegrationsressourcen finden Sie in der vollständigen Liste der unterstützten Toolintegrationsressourcen in der IBM Cloud Terraform-Registry.

3. Terraform-Befehlszeilenschnittstelle initialisieren.

   terraform init
   

4. Erstellen Sie einen Terraform-Ausführungsplan. Dieser Plan fasst die Aktionen zusammen, die ausgeführt werden müssen, um die Toolintegration zu erstellen.

   terraform plan
   

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

   terraform apply
   

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