Estas instrucciones son para desarrolladores de aplicaciones, administradores de plataformas y administradores de seguridad que desean usar repositorios de código fuente de GitHub Enterprise con Google. En particular, puedes usar repositorios de GitHub Enterprise con Gemini Code Assist.
Para obtener más información sobre Developer Connect, consulta Descripción general de Developer Connect.
Antes de comenzar
-
Accede a tu cuenta de Google.
Si todavía no tienes una cuenta, regístrate para obtener una nueva.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
-
Create a project: To create a project, you need the Project Creator role
(
roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.createpermission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
Enable the Developer Connect API.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (
roles/serviceusage.serviceUsageAdmin), which contains theserviceusage.services.enablepermission. Learn how to grant roles.-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
-
Create a project: To create a project, you need the Project Creator role
(
roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.createpermission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
Enable the Developer Connect API.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (
roles/serviceusage.serviceUsageAdmin), which contains theserviceusage.services.enablepermission. Learn how to grant roles.-
Asegúrate de tener acceso a una cuenta en GitHub Enterprise.
Para ayudar a proteger el trabajo de tu equipo, te recomendamos que completes las tareas de esta guía con una cuenta de bot o una cuenta compartida por tu equipo, no con una cuenta personal.
- Asegúrate de ser propietario de un repositorio de GitHub Enterprise o de tener permisos de nivel de administrador en un repositorio compartido.
Cuando uses un repositorio en una organización de GitHub Enterprise, asegúrate de que tengas permisos de administrador de apps de GitHub.
- Opcional: Crea una clave de encriptación administrada por el cliente (CMEK) para encriptar los secretos de autenticación que crea Developer Connect.
- Opcional: Para usar las instrucciones de línea de comandos de esta guía, completa los siguientes pasos:
- Instala la Google Cloud CLI. Si ya instalaste gcloud CLI, asegúrate de tener la última versión disponible ejecutando
gcloud components update. - Ejecuta el siguiente comando para crear una cuenta de servicio de Developer Connect, en el que PROJECT_ID es el Google Cloud ID de tu proyecto:
gcloud beta services identity create \ --service=developerconnect.googleapis.com \ --project=PROJECT_ID
- Instala la Google Cloud CLI. Si ya instalaste gcloud CLI, asegúrate de tener la última versión disponible ejecutando
Cuando habilitas Developer Connect, también se habilita la API de Secret Manager.
Otorga los permisos de IAM necesarios
Para obtener los permisos que necesitas para crear conexiones y vínculos, pídele a tu administrador que te otorgue los siguientes roles de IAM:
-
Si no eres el propietario del proyecto:
Administrador de Developer Connect (
roles/developerconnect.admin) en tu cuenta de usuario. -
Si planeas usar una CMEK para encriptar los secretos que crea Developer Connect:
Encriptador/Desencriptador de CryptoKeys de Cloud KMS (
roles/cloudkms.cryptoKeyEncrypterDecrypter) en la cuenta de servicio de Secret Manager. -
Si planeas usar gcloud CLI para completar los pasos de esta guía:
rol de administrador de Secret Manager (
roles/secretmanager.admin) en la cuenta de servicio de Developer Connect -
Si planeas usar la Google Cloud consola para completar los pasos de esta guía:
Administrador de IAM de proyectos (
roles/resourcemanager.projectIamAdmin) en tu cuenta de usuario
Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.
También puedes obtener los permisos necesarios a través de roles personalizados o cualquier otro rol predefinido.
Crear una conexión
En esta sección, se describe cómo crear una conexión entre Developer Connect y GitHub Enterprise. Si usas la Google Cloud consola, también puedes comenzar a agregar vínculos a repositorios cuando termines de configurar tu conexión.
Para crear una conexión nueva de GitHub Enterprise, selecciona una de las siguientes opciones:
Console
Para iniciar una conexión, completa los siguientes pasos:
En la Google Cloud consola, abre Developer Connect.
Developer Connect muestra la página Repositorios de Git.
- Si ves una lista de proveedores de administración de código fuente: Selecciona un proveedor de administración de código fuente para comenzar a configurar tu primera conexión. Haz clic en Conectar en la tarjeta de GitHub Enterprise.
Si ves una tabla con las conexiones existentes: Haz clic en Crear conexión > GitHub Enterprise para configurar el proveedor de administración de código fuente.
Se abrirá la página Crear conexión.
En Región, elige una región para tus recursos de conexión.
- En Nombre, ingresa un nombre para tu conexión nueva.
Activa la casilla de verificación Habilitar una conexión que cumpla con la residencia de datos para que esta conexión cumpla con los requisitos de residencia de datos.
Las conexiones de GitHub creadas con la Google Cloud consola cumplen con la residencia de datos si activas esta casilla de verificación cuando creas la conexión. Cuando lo haces, Developer Connect crea una app de GitHub.
Cuando creas conexiones de GitHub con Google Cloud CLI, esas conexiones no cumplen con la residencia de datos. Todos los demás tipos de conexión cumplen con la residencia de datos.
- En URL del host, ingresa la URL del host al que deseas conectarte.
Haz clic en Mostrar más para ver la configuración opcional.
Opcional: De forma predeterminada, Developer Connect puede actuar como un proxy para las llamadas de Git a GitHub Enterprise. Para inhabilitar esta opción, desmarca la casilla de verificación Habilitar el proxy de Developer Connect.
En Tipo de red, selecciona Internet pública.
Si deseas usar una red privada, consulta Conéctate a repositorios de GitHub Enterprise alojados en una red privada.
Opcional: En la sección Encriptación, selecciona una clave de CMEK para encriptar los secretos de Secret Manager que crea Developer Connect.
Haz clic en Continuar.
Aparecerá un diálogo de GitHub que te invitará a crear una app de GitHub.
Sigue las indicaciones de GitHub para completar estas tareas:
Ingresa un nombre para tu aplicación.
Elige la organización en la que deseas instalar la app.
Selecciona los repositorios a los que deseas otorgar acceso.
El diálogo se cerrará.
Developer Connect recupera tu clave privada de GitHub y la almacena en tu Google Cloud proyecto como un secreto de Secret Manager Para ver tus secretos, consulta la lista de secretos en Secret Manager.
Una vez que se crea la conexión, aparece la página Vincular repositorios.
Completa los siguientes pasos para vincular repositorios a tu conexión:
En la lista de repositorios disponibles, selecciona los que deseas usar.
Haz clic en Aceptar.
Haz clic en Vincular.
Tu conexión se agrega a la página Conexiones y los vínculos de tu repositorio se agregan a la página Repositorios en la Google Cloud consola. Puedes agregar más vínculos a las conexiones existentes en cualquier momento.
Si estás configurando Gemini Code Assist, continúa el proceso siguiendo los pasos que se indican en Configura y usa la personalización de código de Gemini Code Assist.
gcloud
Las siguientes tareas requieren algunas acciones en tu navegador web.
Para iniciar una conexión, completa los siguientes pasos:
Ejecuta el
gcloud developer-connect connections createcomando para crear una conexión a GitHub Enterprise:gcloud developer-connect connections create CONNECTION_NAME \ --location=REGION \ --github-enterprise-config-host-uri=HOST_URI --git-proxy-config-enabledReemplaza lo siguiente:
- CONNECTION_NAME: Es el nombre de tu conexión.
- REGION: Es la región de tu conexión.
- HOST_URI: Es el URI del host al que deseas conectarte.
--git-proxy-config-enabled: Es una marca opcional que permite que Developer Connect actúe como un proxy para las llamadas de Git a GitHub Enterprise. Esta función se encuentra en vista previa.
Debes crear una app de GitHub para administrar las conexiones con GitHub. Ejecuta el siguiente comando para obtener el URI de configuración de la app:
gcloud developer-connect connections describe CONNECTION_NAME \ --location=REGIONReemplaza lo siguiente:
- CONNECTION_NAME: Es el nombre de tu conexión.
- REGION: Es la región de tu conexión.
Developer Connect muestra un vínculo para completar los siguientes pasos en una ventana del navegador. Cópielo.
Abre el vínculo en un navegador web.
Accede a tu cuenta de GitHub si se te solicita.
Sigue las indicaciones de GitHub para completar estas tareas:
Ingresa un nombre para tu aplicación.
Elige la organización en la que deseas instalar la app.
Selecciona los repositorios a los que deseas otorgar acceso.
El diálogo se cerrará.
Developer Connect recupera tu clave privada de GitHub y la almacena en tu Google Cloud proyecto como un secreto de Secret Manager Para ver tus secretos, consulta la lista de secretos en Secret Manager.
Verifica la conexión
Para verificar la creación de tu conexión de GitHub, ejecuta el siguiente comando:
gcloud developer-connect connections describe CONNECTION_NAME \
--location=REGION
Aquí:
- CONNECTION_NAME: Es el nombre de tu conexión.
- REGION: Es la región de tu conexión.
Developer Connect muestra un estado en el campo installationState. Si el valor de este campo es COMPLETE, se completó la instalación de la app.
De lo contrario, Developer Connect muestra un URI para volver a la configuración en el navegador.
Una vez que se complete la conexión, sigue las instrucciones de Vincula a repositorios para elegir qué repositorios vincular.
Agrega vínculos de repositorios a las conexiones existentes
Una vez que establezcas una conexión a GitHub Enterprise, podrás vincularla a repositorios. Puedes repetir estos pasos más adelante para vincular repositorios adicionales según sea necesario.
Para crear vínculos de repositorios en una conexión existente de GitHub Enterprise, selecciona una de las siguientes opciones:
Console
Abre la página Repositorios en la Google Cloud consola.
Haz clic en Vincular repositorio.
Se abrirá el panel Vincular repositorios de Git.
En la lista de conexiones, elige una conexión.
Haz clic en Continuar.
En la lista de repositorios, selecciona los repositorios a los que deseas vincularte.
Haz clic en Crear.
Developer Connect crea los vínculos de repositorios y los muestra en la Google Cloud consola.
gcloud
Ejecuta el siguiente comando:
gcloud developer-connect connections git-repository-links create REPO_NAME \
--clone-uri=REPO_URI \
--connection=CONNECTION_NAME \
--location=REGION
Reemplaza lo siguiente:
- REPO_NAME: Es un nombre para el vínculo de tu repositorio.
- REPO_URI: Es el vínculo a tu repositorio.
Por ejemplo,
https://github.com/cloud-build/test-repo.git. - CONNECTION_NAME: Es el nombre de tu conexión.
- REGION: Es la región de tu conexión.
Developer Connect crea los vínculos de repositorios.
Para mostrar los repositorios vinculados, ejecuta el
developer-connect connections git-repository-links list comando.
Si estás configurando Gemini Code Assist, continúa el proceso siguiendo los pasos que se indican en Configura y usa la personalización de código de Gemini Code Assist.
Uso compartido de datos
Es posible que el contenido de los Google Cloud recursos vinculados a esta conexión se transfiera a GitHub. Esta declaración se aplica a todos los recursos existentes y futuros que usen esta conexión. Para dejar de compartir información con GitHub, borra las conexiones de Developer Connect en la Google Cloud consola o gcloud CLI y revoca el acceso en GitHub.
¿Qué sigue?
- Termina de configurar la personalización de código de Gemini Code Assist.
- Obtén más información sobre cómo Gemini Code Assist te ayuda a acelerar el desarrollo de software.
- Explora otras integraciones disponibles a través de Developer Connect.