Enabling event notifications for toolchains

Connecting to Event Notifications in the console

Configure Event Notifications to send critical events from toolchains and tool integration instances:

1. If you have a toolchain and are adding this tool integration to it, from the IBM Cloud console, click the Menu icon > Platform Automation > Toolchains. On the Toolchains page, click the toolchain to open its Overview page. Alternatively, on your app's Overview page, on the Continuous delivery card, click View toolchain. Then, click Overview.

   a. Click Add tool.

   b. In the Tool Integrations section, click Event Notifications.

2. Type the name that you want to display for this tool integration on the Event Notifications card in your toolchain. This name is used to identify the tool integration in your toolchain.

3. Select the Event Notifications instance to connect the toolchain to.

4. Click Create Integration to add the Event Notifications tool integration to your toolchain.

5. On your Toolchain's Overview page, on the IBM Cloud tools card, click Event Notifications.

Connecting to Event Notifications with the API

You can add the Event Notifications tool integration to your toolchain by using the API.

1. Obtain an IAM bearer token. Alternatively, if you are using an SDK, obtain an IAM API key and set the client options by using environment variables.

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

2. Look up the ID of the toolchain in which you want to create your tool integration.

3. Specify eventnotifications as the tool_type_id.

4. Specify the following tool_parameters that are required by the tool integration:

   • name: The name that is used to identify the Event Notifications tool integration.
   • instance-crn: The Cloud Resource Name (CRN) of the Event Notifications service instance.

5. Add the tool integration within the targeted toolchain.

   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();
   

The following table lists and describes each of the variables that are used in the previous steps.

Adding a tool integration with Terraform

You can add the Event Notifications tool integration to your toolchain by using Terraform.

IBM Cloud Terraform provider version 1.53.0 or later is required to add a tool integration by using Terraform.

1. To install the Terraform command-line interface (CLI) and configure the IBM Cloud provider plug-in for Terraform, follow the tutorial for Getting started with Terraform on IBM Cloud®.

2. Create a Terraform configuration file that is named main.tf. In this file, add the configuration to create resource instances by using the HashiCorp Configuration Language (HCL). For more information about using this configuration language, see the Terraform documentation.

   The following example creates a Delivery Pipeline tool integration by using the ibm_cd_toolchain_tool_pipeline resource, where toolchain_id is a GUID that represents the toolchain in which to create the tool integration.

   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}"
     }
   }
   

   For more information about tool integration resources, see the full list of supported tool integration resources in the IBM Cloud Terraform Registry.

3. Initialize the Terraform CLI.

   terraform init
   

4. Create a Terraform execution plan. This plan summarizes the actions that must run to create the tool integration.

   terraform plan
   

5. Apply the Terraform execution plan. Terraform takes the required actions to create the tool integration.

   terraform apply
   

The following table lists and describes each of the variables that are used in the previous steps.