Cómo conectarse a un repositorio de GitHub

Console

Para conectar tu repositorio de GitHub a Cloud Build:

1. Abre la página Repositorios en la consola de Google Cloud .

   Abrir la página repositorios

   Verás la página Repositorios.

2. En el selector de proyectos de la barra superior, selecciona tu proyecto Google Cloud .

3. En la parte superior de la página, selecciona la pestaña 2ª gen.

4. Haz clic en Crear conexión de host para conectar un host nuevo a Cloud Build.

5. En el panel izquierdo, selecciona GitHub como tu proveedor de fuentes.

6. En la sección Configurar conexión, ingresa la siguiente información:

   1. Región: Selecciona una región para tu conexión.

   2. Nombre: Ingresa un nombre para tu conexión.

7. Haz clic en Conectar.

   Después de hacer clic en el botón Conectar, se te pedirá que autorices a la app de GitHub de Cloud Build para que acceda a tu cuenta de GitHub. Puedes revocar el acceso a la app desinstalándola o borrándola de tu host en cualquier momento.

   Cloud Build solicita la autorización de tu cuenta de usuario de GitHub y almacena el token de autorización resultante como un secreto en Secret Manager en tu proyecto. El token de autorización se usa para validar el acceso de tu cuenta de usuario para la instalación de la app de Cloud Build en GitHub y para los repositorios vinculados. La cuenta del agente de servicio de Cloud Build (service-{projectNumber}@gcp-sa-cloudbuild.iam.gserviceaccount.com) se usa para acceder a tu secreto. Para ver tu secreto, consulta Enumera secretos y visualiza detalles de secretos.

   Después de autorizar la app de GitHub de Cloud Build, se te redireccionará a la página Repositorios de Cloud Build.

gcloud

Para conectar tu host de GitHub con gcloud, completa los siguientes pasos:

1. Ingresa el siguiente comando para iniciar una conexión a tu repositorio de GitHub:

    gcloud builds connections create github CONNECTION_NAME --region=REGION
   

   Aquí:

   • CONNECTION_NAME es el nombre de tu conexión, tal como aparecerá en Cloud Build.

   • REGION es la región del activador.

   Después de ejecutar el comando gcloud builds connections, verás un vínculo para autorizar la app de GitHub de Cloud Build.

2. Accede a tu cuenta de github.com.

3. Sigue el vínculo para autorizar la app de GitHub de Cloud Build.

   Después de autorizar la app, Cloud Build almacena un token de autenticación como un secreto en Secret Manager en tu proyecto de Google Cloud. Puedes ver tus secretos en la página de Secret Manager.

4. Instala la app de GitHub de Cloud Build en tu cuenta o en una cuenta de organización que poseas.

   Permite la instalación con tu cuenta de GitHub y selecciona los permisos del repositorio cuando se te solicite.

5. Para verificar la instalación de tu conexión de GitHub, ejecuta el siguiente comando:

    gcloud builds connections describe CONNECTION_NAME --region=REGION
   

   Aquí:

   • CONNECTION_NAME es el nombre de tu conexión de host de GitHub en Cloud Build.
   • REGION es la región del activador.

   Si el campo installationState está configurado como COMPLETE, instalaste correctamente la conexión. De lo contrario, el campo installationState proporciona un vínculo para los pasos adicionales requeridos.

Terraform

Puedes conectar tu host de GitHub a Cloud Build con el proveedor de Google Terraform. Para ello, completa los siguientes pasos:

1. Instala la app de GitHub de Cloud Build en tu cuenta de GitHub o en una organización que poseas.

2. Crea un token de acceso personal.

   Asegúrate de configurar tu token para que no tenga fecha de vencimiento y selecciona los siguientes permisos cuando se te solicite en GitHub: repo y read:user. Si tu app está instalada en una organización, asegúrate de seleccionar también el permiso read:org.

   Después de generar tu token de acceso personal, guárdalo en un lugar seguro. Usarás el token generado en los siguientes pasos.

En el siguiente ejemplo, el fragmento de código hace lo siguiente:

• Configura el proveedor de Google de Terraform

• Crea un secreto para almacenar tokens de acceso personal de GitHub y otorgar permisos al agente de servicio de Cloud Build para acceder al secreto.

• Crea una conexión de GitHub

  // Configure the terraform google provider
  terraform {
    required_providers {
      google = {}
     }
  }
  
  // Create a secret containing the personal access token and grant permissions to the Service Agent
  resource "google_secret_manager_secret" "github_token_secret" {
      project = PROJECT_ID
      secret_id = SECRET_ID
  
      replication {
          auto {}
      }
  }
  
  resource "google_secret_manager_secret_version" "github_token_secret_version" {
      secret = google_secret_manager_secret.github_token_secret.id
      secret_data = GITHUB_PAT
  }
  
  data "google_iam_policy" "serviceagent_secretAccessor" {
      binding {
          role = "roles/secretmanager.secretAccessor"
          members = ["serviceAccount:service-PROJECT_NUMBER@gcp-sa-cloudbuild.iam.gserviceaccount.com"]
      }
  }
  
  resource "google_secret_manager_secret_iam_policy" "policy" {
    project = google_secret_manager_secret.github_token_secret.project
    secret_id = google_secret_manager_secret.github_token_secret.secret_id
    policy_data = data.google_iam_policy.serviceagent_secretAccessor.policy_data
  }
  
  // Create the GitHub connection
  resource "google_cloudbuildv2_connection" "my_connection" {
      project = PROJECT_ID
      location = REGION
      name = CONNECTION_NAME
  
      github_config {
          app_installation_id = INSTALLATION_ID
          authorizer_credential {
              oauth_token_secret_version = google_secret_manager_secret_version.github_token_secret_version.id
          }
      }
      depends_on = [google_secret_manager_secret_iam_policy.policy]
  }
  

Aquí:

• PROJECT_NUMBER es tu número de proyecto Google Cloud .
• SECRET_ID es el ID de tu token o secreto en Secret Manager.
• GITHUB_PAT es el ID de tu token de acceso personal en GitHub.
• PROJECT_ID es el Google Cloud ID del proyecto.
• REGION es la región de tu conexión.
• CONNECTION_NAME es el nombre de tu conexión, tal como aparecerá en Cloud Build.
• INSTALLATION_ID es el ID de instalación de tu app de GitHub de Cloud Build. Puedes encontrarlo en la URL de la app de GitHub de Cloud Build. En la siguiente URL, https://github.com/settings/installations/1234567, el ID de instalación es el valor numérico 1234567.

gcloud

Para conectar tu host de GitHub con un token y un ID de instalación existentes que obtuviste de una conexión anterior, completa los siguientes pasos:

1. Instala la app de GitHub de Cloud Build en tu cuenta de GitHub o en una organización que poseas.

2. Crea un token de acceso personal.

   Asegúrate de configurar tu token para que no tenga fecha de vencimiento y selecciona los siguientes permisos cuando se te solicite en GitHub: repo y read:user. Si tu app está instalada en una organización, asegúrate de seleccionar también el permiso read:org.

   Después de generar tu token de acceso personal, guárdalo en un lugar seguro. Usarás el token generado en los siguientes pasos.

3. Almacena tu token en Secret Manager en tu proyecto Google Cloud ejecutando el siguiente comando:

       echo -n TOKEN | gcloud secrets create SECRET_NAME --data-file=-
   

   Aquí:

   • TOKEN es tu token de acceso personal.
   • SECRET_NAME es el nombre que deseas darle a tu secreto en Secret Manager.

4. Otorga acceso al agente de servicio de Cloud Build en el secreto, donde SECRET_NAME es el nombre de tu secreto tal como se almacena en Secret Manager:

     PROJECT_ID=$(gcloud config list --format="value(core.project)")
     PN=$(gcloud projects describe ${PROJECT_ID} --format="value(projectNumber)")
     CLOUD_BUILD_SERVICE_AGENT="service-${PN}@gcp-sa-cloudbuild.iam.gserviceaccount.com"
     gcloud secrets add-iam-policy-binding SECRET_NAME \
       --member="serviceAccount:${CLOUD_BUILD_SERVICE_AGENT}" \
       --role="roles/secretmanager.secretAccessor"
   

5. Crea tu conexión de GitHub:

     gcloud builds connections create github CONNECTION_NAME \
       --authorizer-token-secret-version=projects/PROJECT_ID/secrets/SECRET_NAME/versions/1  \
       --app-installation-id=INSTALLATION_ID --region=REGION
   

   Aquí:

   • CONNECTION_NAME es el nombre de tu conexión de host de GitHub en Cloud Build.
   • PROJECT_ID es el Google Cloud ID del proyecto.
   • SECRET_NAME es el nombre de tu secreto almacenado en Secret Manager.
   • INSTALLATION_ID es el ID de instalación de tu app de GitHub. Puedes encontrarlo en la URL de tu app de GitHub de Cloud Build. En la siguiente URL, https://github.com/settings/installations/1234567, el ID de instalación es el valor numérico 1234567.
   • REGION es la región de tu conexión.

Console

Para conectar un repositorio de GitHub a una conexión con el host, completa los siguientes pasos:

1. Abre la página Repositorios en la consola de Google Cloud .

   Abrir la página repositorios

   Verás la página Repositorios.

2. En la parte superior de la página, selecciona la pestaña 2ª gen.

3. Haz clic en Vincular repositorios para vincular repositorios desde tu conexión.

   Verás el panel Conectar repositorios.

4. En el panel Conectar repositorios, ingresa la siguiente información:

   1. Conexión: Selecciona una conexión en el menú desplegable.

   2. Repositorio: Selecciona un repositorio para vincularlo a tu conexión.

   3. Nombre del repositorio: Ingresa un nombre para tu repositorio.

      1. Generados: Selecciona esta opción para que Cloud Build genere automáticamente nombres de repositorios en tu nombre para los repositorios seleccionados.

      2. Manual: Selecciona esta opción para especificar manualmente los nombres de los repositorios seleccionados.

         Si seleccionas Manual, puedes modificar los nombres de los repositorios seleccionados en la sección Nombres de repositorios.

5. Haz clic en Vincular para vincular tu repositorio a la conexión.

gcloud

Para agregar un repositorio de GitHub a tu conexión, ingresa el siguiente comando:

   gcloud builds repositories create REPO_NAME \
     --remote-uri=REPO_URI \
     --connection=CONNECTION_NAME --region=REGION

Aquí:

• REPO_NAME es el nombre del repositorio.
• REPO_URI es el vínculo a tu repositorio de GitHub. Por ejemplo, https://github.com/cloud-build/test-repo.git
• CONNECTION_NAME es el nombre que se le asigna a la conexión de host de GitHub Enterprise creada en Cloud Build desde Connect to a GitHub host.
• REGION es la región de tu conexión.

Terraform

Para agregar un repositorio de GitHub a tu conexión, agrega el siguiente fragmento de código a tu configuración de Terraform:

    resource "google_cloudbuildv2_repository" "my_repository" {
      project = "PROJECT_ID"
      location = "REGION"
      name = "REPO_NAME"
      parent_connection = google_cloudbuildv2_connection.my_connection.name
      remote_uri = "URI"
  }

Aquí:

• PROJECT_ID es el Google Cloud ID del proyecto.
• REPO_NAME es el nombre de tu repositorio de GitHub.
• REGION es la región de tu conexión.
• URI es el URI del host de tu repositorio. Por ejemplo, https://github.com/myuser/myrepo.git