Toolintegration über die Konsole hinzufügen

Sie können Toolintegrationen über die Konsole zu Ihrer Toolchain hinzufügen.

1. Klicken Sie in der Konsole IBM Cloud auf das im Menü > Plattformautomatisierung > Toolchains.
2. Klicken Sie auf der Seite 'Toolchains' auf eine Toolchain, um die zugehörige Übersichtsseite zu öffnen. Klicken Sie alternativ auf der Seite mit den App-Details in Ihrer App auf den Toolchainnamen.
3. Um eine Liste der hinzuzufügenden Tool-Integrationen anzuzeigen, klicken Sie auf Hinzufügen.
4. Klicken Sie auf eine Toolintegration, die Sie hinzufügen möchten.
5. Geben Sie alle erforderlichen Informationen zum Konfigurieren der Toolintegration ein.
6. Klicken Sie auf Integration erstellen, um die Toolintegration zu Ihrer Toolchain hinzuzufügen.

Toolintegration mit der API hinzufügen

Sie können Toolintegrationen mit 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. Suchen Sie den tool_type_id Wert, der der Toolintegration entspricht, die Sie hinzufügen wollen.

4. 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": "{tool_type_id}", "parameters": {tool_parameters} }' \
     "{base_url}/toolchains/{toolchain_id}/tools"
   

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

   import (
   	   "github.com/IBM/continuous-delivery-go-sdk/cdtoolchainv2"
   )
   ...
   toolchainClientOptions := &cdtoolchainv2.CdToolchainV2Options{}
   toolchainClient, err := cdtoolchainv2.NewCdToolchainV2UsingExternalConfig(toolchainClientOptions)
   createToolOptions := toolchainClient.NewCreateToolOptions({toolchain_id}, {tool_type_id})
   createToolOptions.SetName({tool_name})
   createToolOptions.SetParameters({tool_parameters})
   tool, response, err := toolchainClient.CreateTool(createToolOptions)
   

   from ibm_continuous_delivery.cd_toolchain_v2 import CdToolchainV2
   ...
   toolchain_service = CdToolchainV2.new_instance()
   tool = toolchain_service.create_tool(
      name = {tool_name},
      toolchain_id = {toolchain_id},
      tool_type_id = {tool_type_id},
      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();
   CreateToolOptions createToolOptions = new CreateToolOptions.Builder()
      .name({tool_name})
      .parameters({tool_parameters})
      .toolchainId({toolchain_id})
      .toolTypeId({tool_type_id})
      .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 Toolintegrationen mit Terraform zu Ihrer Toolchain hinzufügen.

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 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_pipeline" "cd_pipeline" {
     toolchain_id = data.ibm_cd_toolchain.cd_toolchain.id
     parameters {
       name = "myPipeline"
     }
   }
   

   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 alle 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 alle erforderlichen Aktionen zum Erstellen der Toolintegration aus.

   terraform apply
   

Toolintegration über die Konsole aktualisieren

Wenn Sie die Konfiguration einer Tool-Integration beim Erstellen einer Toolchain zurückgestellt haben, wird auf der entsprechenden Karte die Schaltfläche Konfigurieren angezeigt. Wenn Sie beim Erstellen einer Toolchain eine Tool-Integration konfiguriert haben, können Sie die Konfigurationseinstellungen über die Konsole aktualisieren.

1. Klicken Sie in der Konsole IBM Cloud auf das im Menü > Plattformautomatisierung > Toolchains.
2. Klicken Sie auf der Seite Toolchains auf die Toolchain, die die von Ihnen zu aktualisierende Tool-Integration enthält, um deren Übersichtsseite zu öffnen. Klicken Sie alternativ auf der Seite mit den App-Details in Ihrer App auf den Toolchainnamen.
3. Wenn Sie eine Toolintegration erstmalig konfigurieren müssen, klicken Sie auf der zugehörigen Karte auf Konfigurieren.
4. Wenn Sie die Konfiguration der Toolintegration abgeschlossen haben, klicken Sie auf Integration speichern.
5. Wenn Sie die Konfiguration einer Toolintegration aktualisieren müssen, klicken Sie auf das Symbol Aktionen > Konfigurieren.
6. Wenn Sie die Aktualisierung der Einstellungen abgeschlossen haben, klicken Sie auf Integration speichern.

Toolintegration mit der API aktualisieren

Wenn Sie beim Erstellen einer Toolchain eine Tool-Integration konfiguriert haben, können Sie die Konfigurationseinstellungen über die API aktualisieren.

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 Toolchain, in der sich die Toolintegration befindet.

3. Suchen Sie mithilfe der ID der Toolchain nach der ID der Toolintegration.

4. Aktualisieren Sie die Toolintegration innerhalb der Zieltoolchain.

   curl -X PATCH --location --header "Authorization: Bearer {iam_token}" \
     --header "Accept: application/json" \
     --header "Content-Type: application/merge-patch+json" \
     --data '{ "name": "{new_tool_name}", "parameters": {new_tool_parameters} }' \
     "{base_url}/toolchains/{toolchain_id}/tools/{tool_id}"
   

   const CdToolchainV2 = require('@ibm-cloud/continuous-delivery/cd-toolchain/v2');
   const toolchainService = CdToolchainV2.newInstance();
   ...
   (async() => {
      const toolPatchModel = {
         toolchainId: {toolchain_id},
         toolId: {tool_id},
         name: {new_tool_name},
         parameters: {new_tool_parameters}
      };
      const response = await toolchainService.updateTool(toolPatchModel);
   })();
   

   import (
   	   "github.com/IBM/continuous-delivery-go-sdk/cdtoolchainv2"
   )
   ...
   toolchainClientOptions := &cdtoolchainv2.CdToolchainV2Options{}
   toolchainClient, err := cdtoolchainv2.NewCdToolchainV2UsingExternalConfig(toolchainClientOptions)
   toolPatchModel := map[string]interface{}{
      "name": {new_tool_name},
      "parameters": {new_tool_parameters},
   }
   updateToolOptions := toolchainClient.NewUpdateToolOptions({toolchain_id}, {tool_id}, toolPatchModel)
   tool, response, err := toolchainClient.UpdateTool(updateToolOptions)
   

   from ibm_continuous_delivery.cd_toolchain_v2 import CdToolchainV2
   ...
   toolchain_service = CdToolchainV2.new_instance()
   tool = toolchain_service.update_tool(
      toolchain_id = {toolchain_id},
      tool_id = {tool_id},
      toolchain_tool_prototype_patch = {
         "name": {new_tool_name},
         "parameters": {new_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> toolchainToolPrototypePatch = new HashMap<>();
   toolchainToolPrototypePatch.put("name", {new_tool_name});
   toolchainToolPrototypePatch.put("parameters", {new_tool_parameters});
   UpdateToolOptions updateToolOptions = new UpdateToolOptions.Builder()
      .toolchainId({toolchain_id})
      .toolId({tool_id})
      .toolchainToolPrototypePatch(toolchainToolPrototypePatch)
      .build();
   Response<ToolchainToolPatch> response = toolchainService.updateTool(updateToolOptions).execute();
   ToolchainToolPatch tool = response.getResult();
   

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

Toolintegration mit Terraform aktualisieren

Wenn Sie beim Erstellen einer Toolchain eine Tool-Integration konfiguriert haben, können Sie die Konfigurationseinstellungen mit Terraform aktualisieren.

1. Installieren Sie die Terraform-CLI und konfigurieren Sie das IBM Cloud-Provider-Plug-in für Terraform, indem Sie das Lernprogramm für Erste Schritte mit Terraform auf IBM Cloudausführen.

2. Verwenden Sie die Terraform-Konfigurationsdatei, die Sie zum Erstellen der Toolintegration verwendet haben. Wenn Ihre Toolintegration nicht mit Terraform erstellt wurde, führen Sie terraform import aus, damit keine weitere Toolintegration erstellt wird. Weitere Informationen zur Verwendung dieser Konfigurationssprache finden Sie in der Terraform-Dokumentation.

   Im folgenden Beispiel wird der Name einer vorhandenen Delivery Pipeline-Toolintegration mithilfe der Ressource ibm_cd_toolchain_tool_pipeline aktualisiert, wobei toolchain_id eine GUID ist, die die Toolchain darstellt, in der die Toolintegration vorhanden ist.

   data "ibm_cd_toolchain" "cd_toolchain" {
     toolchain_id = {toolchain_id}
   }
   resource "ibm_cd_toolchain_tool_pipeline" "cd_pipeline" {
     toolchain_id = data.ibm_cd_toolchain.cd_toolchain.id
     parameters {
       name = "myUpdatedPipelineName"
     }
   }
   

   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 alle Aktionen zusammen, die ausgeführt werden müssen, um die Toolintegration zu ändern.

   terraform plan
   

5. Wenden Sie den Terraform-Ausführungsplan an. Terraform führt alle erforderlichen Aktionen aus, um die Toolintegration zu ändern.

   terraform apply
   

Toolintegration über die Konsole löschen

Sie können Toolintegrationen über die Konsole aus Ihrer Toolchain löschen. Wenn Sie eine Toolintegration aus der Toolchain löschen, kann der Löschvorgang nicht rückgängig gemacht werden.

1. Klicken Sie in der Konsole IBM Cloud auf das im Menü > Plattformautomatisierung > Toolchains.
2. Klicken Sie auf der Seite 'Toolchains' auf eine Toolchain, um die zugehörige Übersichtsseite zu öffnen. Klicken Sie alternativ auf der Seite mit den App-Details in Ihrer App auf den Toolchainnamen.
3. Klicken Sie in der zu löschenden Toolintegration auf das Symbol Aktionen > Löschen.
4. Bestätigen Sie dies, indem Sie nochmals auf Löschen klicken.

Toolintegration mit der API löschen

Sie können Toolintegrationen aus Ihrer Toolchain mit der API löschen. Wenn Sie eine Toolintegration aus der Toolchain löschen, kann der Löschvorgang nicht rückgängig gemacht werden.

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 Toolchain, in der sich die Toolintegration befindet.

3. Suchen Sie mithilfe der ID der Toolchain nach der ID der Toolintegration.

4. Löschen Sie die Toolintegration innerhalb der Zieltoolchain.

   curl -X DELETE --location --header "Authorization: Bearer {iam_token}" \
     "{base_url}/toolchains/{toolchain_id}/tools/{tool_id}"
   

   const CdToolchainV2 = require('@ibm-cloud/continuous-delivery/cd-toolchain/v2');
   const toolchainService = CdToolchainV2.newInstance();
   ...
   (async() => {
      const response = await toolchainService.deleteTool({
         toolchainId: {toolchain_id},
         toolId: {tool_id}
      });
   })();
   

   import (
   	   "github.com/IBM/continuous-delivery-go-sdk/cdtoolchainv2"
   )
   ...
   toolchainClientOptions := &cdtoolchainv2.CdToolchainV2Options{}
   toolchainClient, err := cdtoolchainv2.NewCdToolchainV2UsingExternalConfig(toolchainClientOptions)
   deleteToolOptions := toolchainClient.NewDeleteToolOptions({toolchain_id}, {tool_id})
   response, err := toolchainClient.DeleteTool(deleteToolOptions)
   

   from ibm_continuous_delivery.cd_toolchain_v2 import CdToolchainV2
   ...
   toolchain_service = CdToolchainV2.new_instance()
   response = toolchain_service.delete_tool(
      toolchain_id = {toolchain_id},
      tool_id = {tool_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();
   DeleteToolOptions deleteToolOptions = new DeleteToolOptions.Builder()
      .toolchainId({toolchain_id})
      .toolId({tool_id})
      .build();
   Response<Void> response = toolchainService.deleteTool(deleteToolOptions).execute();
   

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

Toolintegration mit Terraform löschen

Sie können Toolintegrationen aus Ihrer Toolchain mit Terraform löschen. Wenn Sie eine Toolintegration aus der Toolchain löschen, kann der Löschvorgang nicht rückgängig gemacht werden.

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. Verwenden Sie die Terraform-Konfigurationsdatei, die Sie zum Erstellen der Toolintegration verwendet haben. Kommentieren Sie die Toolintegrationsressource aus oder entfernen Sie sie aus der Konfigurationsdatei.

3. Terraform-Befehlszeilenschnittstelle initialisieren.

   terraform init
   

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

   terraform plan
   

5. Wenden Sie den Terraform-Ausführungsplan an. Terraform führt alle erforderlichen Aktionen aus, um die Toolintegration zu löschen.

   terraform apply