Creación de un Delivery Pipeline para Tekton utilizando la consola

Cuando configure una integración de herramientas de Delivery Pipeline, puede seleccionar el tipo de conducto que desea crear.

1. Si no tiene una cadena de herramientas, seleccione una plantilla para crear una. En función de la plantilla que utilice, los campos disponibles serán distintos. Revise los valores del campo predeterminado y, si es necesario, realice cambios.

2. Si tiene una cadena de herramientas y está agregando esta integración de herramientas a ella, desde la consola IBM Cloud, haga clic en el ícono de Menú > Automatización de la plataforma > Cadenas de herramientas. En la página de cadenas de herramientas, haga clic en la cadena de herramientas para abrir su página de descripción general. Como alternativa, en la página Visión general de su app, en la tarjeta de Entrega continua, pulse Ver cadena de herramientas. A continuación, pulse Visión general.

3. Añada la integración de Delivery Pipeline a la cadena de herramientas:

   a. Pulse Añadir herramienta.

   b. En la sección Integraciones de herramientas, pulse Delivery Pipeline.

4. Especifique un nombre para el nuevo conducto.

5. Seleccione Tekton para crear un Delivery Pipeline de Tekton. Puede ver el resultado de las ejecuciones de canalización de Tekton en un clúster definido de Kubernetes, con soporte para configurar los repositorios de definiciones de canalización, los disparadores de canalización, dónde se ejecuta la canalización y secretos sencillos.

6. Si tiene previsto utilizar el conducto para desplegar una interfaz de usuario, marque el recuadro de selección Mostrar apps en el menú Ver app. Todas las apps creadas por el conducto se muestran en la lista Ver app de la página de visión general de la cadena de herramientas.

7. Pulse Crear integración para añadir el Delivery Pipeline a la cadena de herramientas.

   header['x-github-event'] == 'pull_request' &&
      (body.action == 'opened' || body.action == 'synchronize') &&
      body.pull_request.base.ref == 'main'

   header['x-github-event'] == 'push' && body.ref == 'refs/heads/main'

   header['x-github-event'] == 'push' &&
      body.ref == 'refs/heads/main' &&
      !body.head_commit.message.contains("skip run")

   header['x-github-event'] == 'issue_comment' &&
      body.action == 'created' && has(body.issue.pull_request) &&
      body.comment.body.contains('/lgtm')

   header['x-github-event'] == 'issues' &&
      body.action == 'opened' &&
      body.issue.labels.exists(label, label.name == 'urgent')

   header['x-gitlab-event'] == 'Merge Request Hook' &&
      (body.object_attributes.action == 'open' || body.object_attributes.action == 'update') &&
      body.object_attributes.target_branch == 'main'

   header['x-gitlab-event'] == 'Push Hook' && body.ref == 'refs/heads/main'

   header['x-gitlab-event'] == 'Push Hook' &&
      body.ref == 'refs/heads/main' &&
      !body.object_attributes.last_commit.message("skip run")

   header['x-gitlab-event'] == 'Note Hook' &&
      body.object_attributes.noteable_type == 'MergeRequest' &&
      body.object_attributes.action == 'create' &&
      body.object_attributes.note.contains('/lgtm')

   header['x-gitlab-event'] == 'Issue Hook' &&
      (body.object_attributes.action == 'open') &&
      body.object_attributes.labels.exists(label, label.name == 'urgent')

   (header['x-event-key'] == 'pullrequest:created' || header['x-event-key'] == 'pullrequest:updated') &&
       body.pullrequest.destination.branch.name == 'main'

   header['x-event-key'] == 'repo:push' && body.push.changes[0].new.name == 'main'

   header['x-event-key'] == 'repo:push' &&
      body.push.changes[0].new.name == 'main' &&
      !body.push.changes[0].commits[0].message("skip run")

   header['x-event-key'] == 'pullrequest:comment_created' &&
      body.comment.content.raw.contains('/lgtm')

   header['x-event-key'] == 'issue:created' &&
      body.issue.kind == 'bug'

Filtros

Los filtros permiten a los usuarios refinar las solicitudes de extracción en función de criterios específicos. Actualmente, el campo de filtrado permite especificar etiquetas en las solicitudes de extracción, controlando así la ejecución de la canalización en función de su presencia o ausencia. Sin embargo, no activa una canalización cuando se añaden o eliminan etiquetas, sino que verifica las etiquetas del RP antes de permitir la ejecución de la canalización.

Cómo funciona:

• Si se produce un evento PR (como la adición de un nuevo commit), el pipeline comprueba las etiquetas del PR.
• Si el RP cumple las condiciones de la etiqueta (por ejemplo, tiene la etiqueta "aprobado"), la canalización se pone en marcha.
• Si el RP no cumple las condiciones de la etiqueta, la canalización no se ejecutará.

Configuración de ejemplo

La siguiente captura de pantalla muestra un ejemplo en el que el activador está configurado para las etiquetas "aprobado" y "revisado".

• El proceso PR sólo se activará si ambas etiquetas están presentes.
• Si falta alguna de las etiquetas, la canalización no se ejecutará.

Comprobación de la carga útil del evento

Cuando escriba expresiones CEL para filtrar eventos, debe comprender la estructura y el contenido de la carga útil del webhook contra la que se evaluará la expresión. Puede inspeccionar la carga útil de una ejecución existente desde la página de detalles de la ejecución del pipeline.

Para ver la carga útil del evento, vaya a la página de detalles de la ejecución de la tubería y haga clic en Mostrar contexto. Puede ver la carga útil sin procesar del webhook que desencadenó la ejecución de la canalización y confirmar los campos relevantes para que sus expresiones CEL coincidan con las condiciones que desea.

Creación de un Delivery Pipeline para Tekton con la API

1. Obtener una señal portadora de IAM. De forma alternativa, si utiliza un SDK, obtenga una clave de API de IAM y establezca las opciones de cliente utilizando variables de entorno.

   export CD_TEKTON_PIPELINE_APIKEY={api_key}
   

2. Determine la región y el ID de la cadena de herramientas a la que desea añadir la integración de herramientas de Delivery Pipeline.

3. Añada la integración de herramientas de Delivery Pipeline a la cadena de herramientas.

   curl -X POST \
     https://api.{region}.devops.cloud.ibm.com/toolchain/v2/toolchains/{toolchain_id}/tools \
     -H 'Authorization: Bearer {iam_token}' \
     -H 'Accept: application/json` \
     -H 'Content-Type: application/json' \
     -d '{
       "tool_type_id": "pipeline",
       "parameters": {
         "name": "{tool_integration_name}",
         "type" : "tekton"
       }
     }'
   

   const CdToolchainV2 = require('@ibm-cloud/continuous-delivery/cd-toolchain/v2');
   ...
   (async () => {
      const toolchainService = CdToolchainV2.newInstance();
      const pipelinePrototypeModel = {
         toolchainId: {toolchain_id},
         toolTypeId: 'pipeline',
         name: {tool_integration_name},
         type: "tekton"
      };
      const pipelineTool = await toolchainService.createTool(pipelinePrototypeModel);
   })();
   

   import (
   	   "github.com/IBM/continuous-delivery-go-sdk/cdtoolchainv2"
   )
   ...
   toolchainClientOptions := &cdtoolchainv2.CdToolchainV2Options{}
   toolchainClient, err := cdtoolchainv2.NewCdToolchainV2UsingExternalConfig(toolchainClientOptions)
   createPipelineToolOptions := toolchainClient.NewCreateToolOptions({toolchain_id}, "pipeline")
   createPipelineToolOptions.SetName({tool_integration_name})
   createPipelineToolOptions.SetType("tekton")
   pipelineTool, response, err := toolchainClient.CreateTool(createPipelineToolOptions)
   

   from ibm_continuous_delivery.cd_toolchain_v2 import CdToolchainV2
   ...
   toolchain_service = CdToolchainV2.new_instance()
   pipeline_tool = toolchain_service.create_tool(
      name = {tool_integration_name},
      toolchain_id = {toolchain_id},
      tool_type_id = "pipeline",
      type = "tekton"
   )
   

   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 createPipelineToolOptions = new CreateToolOptions.Builder()
      .name({tool_integration_name})
      .toolchainId({toolchain_id})
      .toolTypeId("pipeline")
      .type("tekton")
      .build();
   Response<ToolchainToolPost> response = toolchainService.createTool(createPipelineToolOptions).execute();
   ToolchainToolPost pipelineTool = response.getResult();
   

   La tabla siguiente lista y describe cada una de las variables que se utilizan en el paso anterior.

   Variables para añadir la integración de la herramienta Delivery Pipeline con la API

   Variable	Descripción
   {region}	La región en la que reside la cadena de herramientas, por ejemplo, us-south.
   {tool_integration_name}	Un nombre para la integración de herramientas, por ejemplo, ci-pipeline.
   {toolchain_id}	El ID de la cadena de herramientas a la que añadir la integración de herramientas.
   {iam_token}	Un token de portador IAM válido.

4. Configure Delivery Pipeline para utilizar trabajadores gestionados públicos dentro de las regiones especificadas.

   curl -X POST \
      https://api.{region}.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines \
      -H 'Authorization: Bearer {iam_token}' \
      -H 'Accept: application/json` \
      -H 'Content-Type: application/json' \
      -d '{
         "id": "{pipeline_id}",
         "worker": { "id": "public" }
      }'
   

   const CdTektonPipelineV2 = require('@ibm-cloud/continuous-delivery/cd-tekton-pipeline/v2');
   ...
   (async () => {
      const tektonService = CdTektonPipelineV2.newInstance();
      const workerIdentityModel = {
         id: 'public',
      };
      const params = {
         id: {pipeline_id},
         worker: workerIdentityModel,
      };
      const res = await tektonService.createTektonPipeline(params);
   })();
   

   import {
      "github.com/IBM/continuous-delivery-go-sdk/cdtektonpipelinev2"
   }
   ...
   cdTektonPipelineOptions := &cdtektonpipelinev2.CdTektonPipelineV2Options{}
   pipelineSvc, err = cdtektonpipelinev2.NewCdTektonPipelineV2UsingExternalConfig(cdTektonPipelineOptions)
   createTektonPipelineOptions := pipelineSvc.NewCreateTektonPipelineOptions(
      {pipeline_id}
   )
   workerIdentityModel := &cdtektonpipelinev2.WorkerIdentity{
      ID: core.StringPtr("public"),
   }
   createTektonPipelineOptions.SetWorker(workerIdentityModel)
   tektonPipeline, response, err := pipelineSvc.CreateTektonPipeline(createTektonPipelineOptions)
   

   from ibm_continuous_delivery.cd_tekton_pipeline_v2 import CdTektonPipelineV2
   ...
   pipeline_service = CdTektonPipelineV2.new_instance()
   worker_identity_model = {
      'id': 'public',
   }
   response = pipeline_service.create_tekton_pipeline(
      id = {pipeline_id},
      worker = worker_identity_model
   )
   tekton_pipeline = response.get_result()
   

   import com.ibm.cloud.continuous_delivery.cd_tekton_pipeline.v2.CdTektonPipeline;
   import com.ibm.cloud.continuous_delivery.cd_tekton_pipeline.v2.model.*;
   ...
   CdTektonPipeline pipelineSvc = CdTektonPipeline.newInstance();
   WorkerIdentity workerIdentityModel = new WorkerIdentity.Builder()
      .id("public")
      .build();
   CreateTektonPipelineOptions createTektonPipelineOptions = new CreateTektonPipelineOptions.Builder()
      .id({pipeline_id})
      .worker(workerIdentityModel)
      .build();
   Response<TektonPipeline> response = pipelineSvc.createTektonPipeline(createTektonPipelineOptions).execute();
   TektonPipeline tektonPipeline = response.getResult();
   

   La tabla siguiente lista y describe cada una de las variables que se utilizan en el paso anterior.

   Variables para configurar el Delivery Pipeline con la API

   Variable	Descripción
   {region}	La región en la que reside la cadena de herramientas, por ejemplo, us-south.
   {pipeline_id}	El ID de la interconexión que se devuelve del paso anterior donde se ha creado la integración de la herramienta de interconexión.
   {iam_token}	Un token de portador IAM válido.

Para más información sobre la API Delivery Pipeline, consulte los documentos de la API.

Creación de un Delivery Pipeline para Tekton con Terraform

1. Para instalar la CLI de Terraform y configurar el plug-in de proveedor de IBM Cloud para Terraform, siga la guía de aprendizaje Cómo empezar con Terraform en IBM Cloud®.

2. Cree un archivo de configuración de Terraform denominado main.tf. En este archivo, añada la configuración para crear una canalización utilizando el lenguaje de configuración HashiCorp. Para obtener más información sobre cómo utilizar este idioma de configuración, consulte la documentación de Terraform.

   Un conducto debe pertenecer a una cadena de herramientas. También puede crear cadenas de herramientas utilizando Terraform.

   El ejemplo siguiente crea una cadena de herramientas y un conducto utilizando los recursos de Terraform especificados.

   data "ibm_resource_group" "group" {
     name = "default"
   }
   
   resource "ibm_cd_toolchain" "my_toolchain" {
     name              = "terraform_toolchain"
     resource_group_id = data.ibm_resource_group.group.id
   }
   
   resource "ibm_cd_toolchain_tool_pipeline" "my_pipeline_tool" {
     parameters {
        name = "terraform-pipeline-integration"
     }
     toolchain_id = ibm_cd_toolchain.my_toolchain.id
   }
   
   resource "ibm_cd_tekton_pipeline" "my_tekton_pipeline" {
    worker {
        id = "public"
    }
    pipeline_id = ibm_cd_toolchain_tool_pipeline.my_pipeline_tool.tool_id
   }
   

   Para obtener más información sobre los recursos ibm_cd_toolchain_tool_pipeline y ibm_cd_tekton_pipeline, consulte los detalles de referencia de argumentos en la documentación del registro de Terraform.

3. Inicialice la CLI de Terraform, si es necesario.

   terraform init
   

4. Cree un plan de ejecución de Terraform. Este plan resume todas las acciones que deben ejecutarse para crear una cadena de herramientas.

   terraform plan
   

5. Aplique el plan de ejecución de Terraform. Terraform realiza todas las acciones necesarias para crear la cadena de herramientas.

   terraform apply
   

Borrar un Delivery Pipeline con la API

1. Obtener una señal portadora de IAM. De forma alternativa, si utiliza un SDK, obtenga una clave de API de IAM y establezca las opciones de cliente utilizando variables de entorno.

   export CD_TEKTON_PIPELINE_APIKEY={api_key}
   

2. Determine la región y el ID de la cadena de herramientas a la que desea añadir la integración de la herramienta DevOps Insights.

3. Suprima la interconexión.

   curl -X DELETE \
     https://api.{region}.devops.cloud.ibm.com/toolchain/v2/toolchains/{toolchain_id}/tools/{pipeline_id} \
     -H 'Authorization: Bearer {iam_token}'
   

   const CdTektonPipelineV2 = require('@ibm-cloud/continuous-delivery/cd-tekton-pipeline/v2');
   ...
   (async () => {
      const pipelineSvc = CdTektonPipelineV2.newInstance();
      const params = {
         id: {pipeline_id},
      };
      const res = await pipelineSvc.deleteTektonPipeline(params);
   })();
   

   import {
      "github.com/IBM/continuous-delivery-go-sdk/cdtektonpipelinev2"
   }
   ...
   cdTektonPipelineOptions := &cdtektonpipelinev2.CdTektonPipelineV2Options{}
   pipelineSvc, err = cdtektonpipelinev2.NewCdTektonPipelineV2UsingExternalConfig(cdTektonPipelineOptions)
   deleteTektonPipelineOptions := pipelineSvc.NewDeleteTektonPipelineOptions(
      {pipeline_id}
   )
   response, err := pipelineSvc.DeleteTektonPipeline(deleteTektonPipelineOptions)
   

   from ibm_continuous_delivery.cd_tekton_pipeline_v2 import CdTektonPipelineV2
   ...
   pipeline_service = CdTektonPipelineV2.new_instance()
   response = pipeline_service.delete_tekton_pipeline(
      id={pipeline_id}
   )
   

   import com.ibm.cloud.continuous_delivery.cd_tekton_pipeline.v2.CdTektonPipeline;
   import com.ibm.cloud.continuous_delivery.cd_tekton_pipeline.v2.model.*;
   ...
   CdTektonPipeline pipelineSvc = CdTektonPipeline.newInstance();
   DeleteTektonPipelineOptions deleteTektonPipelineOptions = new DeleteTektonPipelineOptions.Builder()
      .id({pipeline_id})
      .build();
   Response<Void> response = pipelineSvc.deleteTektonPipeline(deleteTektonPipelineOptions).execute();
   

La tabla siguiente lista y describe cada una de las variables que se utilizan en el paso anterior.

Supresión de un Delivery Pipeline con Terraform

1. Localice el archivo Terraform (por ejemplo, main.tf) que contiene el bloque resource para la interconexión existente.

   El resource del ejemplo siguiente describe una interconexión existente.

   data "ibm_resource_group" "group" {
     name = "default"
   }
   
   resource "ibm_cd_toolchain" "my_toolchain" {
     name              = "terraform_toolchain"
     resource_group_id = data.ibm_resource_group.group.id
   }
   
   resource "ibm_cd_toolchain_tool_pipeline" "my_pipeline_tool" {
     parameters {
        name = "terraform-pipeline-integration"
     }
     toolchain_id = ibm_cd_toolchain.my_toolchain.id
   }
   
   resource "ibm_cd_tekton_pipeline" "my_tekton_pipeline" {
    worker {
        id = "public"
    }
    pipeline_id = ibm_cd_toolchain_tool_pipeline.my_pipeline_tool.tool_id
   }
   

2. Elimine los bloques ibm_cd_toolchain_tool_pipeline y ibm_cd_tekton_pipeline resource del archivo Terraform.

3. Inicialice la CLI de Terraform, si es necesario.

   terraform init
   

4. Cree un plan de ejecución de Terraform. Este plan resume todas las acciones que se deben ejecutar para suprimir el conducto.

   terraform plan
   

5. Aplique el plan de ejecución de Terraform. Terraform realiza todas las acciones necesarias para suprimir la interconexión.

   terraform apply
   

Visualización de los detalles de un pod de TaskRun

Para ver información sobre el pod Kubernetes subyacente para un TaskRun específico, haga clic en el nombre Task y, a continuación, en Pod.

Puede ver los detalles del pod y todos los sucesos relacionados notificados por el trabajador. Esta información puede ayudarle a depurar errores específicos o a determinar a qué se dedica el tiempo durante una ejecución.