Conéctate a GitHub Enterprise

En esta página, se describe cómo crear conexiones a GitHub Enterprise y vínculos a repositorios de GitHub Enterprise. Puedes completar estas tareas con la consola de Google Cloud o Google Cloud CLI.

Estas instrucciones son para desarrolladores de aplicaciones, administradores de plataformas y administradores de seguridad que deseen usar repositorios de código fuente de GitHub Enterprise con Google. Específicamente, puedes usar repositorios de GitHub Enterprise con Gemini Code Assist.

Para obtener más información sobre Developer Connect, consulta la descripción general de Developer Connect.

Antes de comenzar

  1. Accede a tu Cuenta de Google.

    Si todavía no tienes una cuenta, regístrate para obtener una nueva.

  2. 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 the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Developer Connect, Secret Manager APIs, if any are not already enabled.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the APIs

  5. 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 the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

  7. Enable the Developer Connect, Secret Manager APIs, if any are not already enabled.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the APIs

    8.

  8. Asegúrate de tener acceso a una cuenta en GitHub Enterprise.

    Para 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.

  9. Asegúrate de ser propietario de un repositorio de GitHub Enterprise o de tener permisos de nivel de administrador en un repositorio compartido.

  10. Cuando uses un repositorio en una organización de GitHub Enterprise, asegúrate de tener permisos de administrador de la app de GitHub.

  11. Opcional: Crea una clave de encriptación administrada por el cliente (CMEK) para encriptar los secretos de autenticación que crea Developer Connect.
  12. Opcional: Para usar las instrucciones de la línea de comandos de esta guía, completa los siguientes pasos:
    1. Instala la Google Cloud CLI. Si ya instalaste gcloud CLI, asegúrate de tener la versión más reciente disponible ejecutando gcloud components update.
    2. Ejecuta el siguiente comando para crear una cuenta de servicio de Developer Connect, en el que PROJECT_ID es tu Google Cloud ID del proyecto: 
              gcloud beta services identity create \
            --service=developerconnect.googleapis.com \
            --project=PROJECT_ID

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:

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 consola de Google Cloud , 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:

  1. En la consola de Google Cloud , abre Developer Connect.

    Ir a Developer Connect

    Developer Connect muestra la página Git repositories.

    • 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 Create Connection.

  2. En Región, elige una región para los recursos de tu conexión.

    1. En Nombre, ingresa un nombre para la conexión nueva.

  3. 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 consola de Google Cloud cumplen con la residencia de datos si activas esta casilla de verificación cuando creas la conexión. Cuando lo hagas, Developer Connect creará una app de GitHub.

    Cuando creas conexiones de GitHub con la 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.

    1. En URL de host, ingresa la URL del host al que deseas conectarte.

  4. Haz clic en Mostrar más para ver los parámetros de configuración opcionales.

    1. Opcional: De forma predeterminada, Developer Connect puede actuar como 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.

    2. En Tipo de red, selecciona Internet pública.

      Si deseas usar una red privada, consulta Cómo conectarse a repositorios de GitHub Enterprise alojados en una red privada.

    3. Opcional: En la sección Encryption, selecciona una clave de CMEK para encriptar los secretos de Secret Manager que crea Developer Connect.

  5. Haz clic en Continuar.

    Aparecerá un diálogo de GitHub que te invitará a crear una app de GitHub.

  6. Sigue las instrucciones en GitHub para completar estas tareas:

    1. Ingresa un nombre para tu app.

    2. Elige la organización en la que deseas instalar la app.

    3. Selecciona los repositorios a los que quieres otorgar acceso.

    Se cierra el diálogo.

    Developer Connect recupera tu clave privada de GitHub y la almacena en tu proyecto de Google Cloud como un secreto de Secret Manager. Para ver tus secretos, enumera los secretos en Secret Manager.

Una vez que se crea la conexión, aparece la página Vincular repositorios.

Sigue estos pasos para vincular repositorios a tu conexión:

  1. En la lista de repositorios disponibles, selecciona los que deseas usar.

  2. Haz clic en Aceptar.

  3. Haz clic en Vincular.

Tu conexión se agrega a la página Conexiones y los vínculos a tu repositorio se agregan a la página Repositorios en la consola de Google Cloud . 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 Cómo configurar y usar la personalización de código de Gemini Code Assist.

gcloud

Las siguientes tareas requieren que realices algunas acciones en tu navegador web.

Para iniciar una conexión, completa los siguientes pasos:

  1. Ejecuta el comando gcloud developer-connect connections create 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-enabled

    Reemplaza 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 proxy para las llamadas de Git a GitHub Enterprise. Esta función se encuentra en vista previa.

  2. 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=REGION

    Reemplaza lo siguiente:

    • CONNECTION_NAME: Es el nombre de tu conexión.
    • REGION: Es la región de tu conexión.

    Developer Connect devuelve un vínculo para completar los próximos pasos en una ventana del navegador. Cópielo.

  3. Abre el vínculo en un navegador web.

  4. Accede a tu cuenta de GitHub si se te solicita.

  5. Sigue las instrucciones en GitHub para completar estas tareas:

    1. Ingresa un nombre para tu app.

    2. Elige la organización en la que deseas instalar la app.

    3. Selecciona los repositorios a los que quieres otorgar acceso.

    El diálogo se cierra.

    Developer Connect recupera tu clave privada de GitHub y la almacena en tu proyecto de Google Cloud como un secreto de Secret Manager. Para ver tus secretos, enumera los secretos en Secret Manager.

Verifica la conexión

Ejecuta el siguiente comando para verificar la creación de tu conexión de GitHub:

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 devuelve 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 devuelve un URI para que vuelvas a la configuración en el navegador.

Una vez que se complete la conexión, elige qué repositorios vincular siguiendo las instrucciones en Vincular a repositorios.

Una vez que hayas establecido una conexión con GitHub Enterprise, podrás vincularte 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

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

    Abre la página Repositorios

  2. Haz clic en Vincular repositorio.

    Se abrirá el panel Vincular repositorios de Git.

  3. En la lista de conexiones, elige una.

  4. Haz clic en Continuar.

  5. En la lista de repositorios, selecciona los que deseas vincular.

  6. Haz clic en Crear.

Developer Connect crea los vínculos del repositorio 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 a 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 del repositorio.

Para enumerar los repositorios vinculados, ejecuta el comando developer-connect connections git-repository-links list.

Si estás configurando Gemini Code Assist, continúa el proceso siguiendo los pasos que se indican en Cómo configurar y usar la personalización de código de Gemini Code Assist.

Uso compartido de datos

Es posible que el contenido de los recursos de Google Cloud vinculados a esta conexión se transfiera a GitHub. Esta declaración se aplica a todos los recursos existentes y futuros que utilicen 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?