Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
Conectando GitHub
GitHub La integración permite al AWS DevOps agente acceder a los repositorios de códigos y recibir los eventos de despliegue durante la investigación de incidentes. Esta integración sigue un proceso de dos pasos: el registro a nivel de cuenta y, a continuación GitHub, la conexión de repositorios específicos a los espacios de agente individuales.
AWS DevOps Agent soporta GitHub.com instancias (SaaS), GitHub Enterprise Cloud con residencia de datos (*.ghe.com) e instancias GitHub Enterprise Server (autohospedadas).
Requisitos previos
Antes de conectarse GitHub, asegúrese de tener:
Acceso a la consola de administración del AWS DevOps agente
Una cuenta GitHub de usuario u organización con permisos de administrador
Autorización para instalar GitHub aplicaciones en su cuenta u organización
Para GitHub Enterprise Server, también necesitas:
Una instancia de GitHub Enterprise Server (versión 3.x o posterior) accesible a través de HTTPS
La URL HTTPS de su instancia de GitHub Enterprise Server (por ejemplo,
https://github.example.com)(Opcional) Una conexión privada, si su instancia de GitHub Enterprise Server no es de acceso público
En el GitHub caso de Enterprise Cloud con residencia de datos, también necesitará:
Una organización de nube GitHub empresarial con la residencia de datos habilitada y alojada en su
*.ghe.comsubdominio dedicadoPermisos de administrador de la organización, incluido el permiso para crear e instalar aplicaciones GitHub
La URL HTTPS de su instancia de residencia de datos (por ejemplo,
https://octocorp.ghe.com)
Registrarse GitHub (a nivel de cuenta)
GitHub se registra a nivel de AWS cuenta y se comparte entre todos los espacios de agentes de esa cuenta. Cada registro corresponde a un GitHub usuario, una organización o una instancia de GitHub Enterprise Server.
Paso 1: Diríjase a los proveedores en proceso
Inicie sesión en la consola AWS de administración
Navegue hasta la consola del AWS DevOps agente
Vaya a la pestaña Capacidades
En la sección Pipeline, elija Agregar
Seleccione GitHubde la lista de proveedores disponibles
Si GitHub aún no se ha registrado, se le pedirá que lo registre primero.
Paso 2: elige el tipo de conexión
En la pantalla « GitHub Registrar cuenta/organización», selecciona si te conectas como usuario u organización:
Usuario: su GitHub cuenta personal con un nombre de usuario y un perfil
Organización: una GitHub cuenta compartida en la que varias personas pueden colaborar en varios proyectos a la vez. Si seleccionas Organización, introduce el nombre de la GitHub organización. El nombre debe coincidir exactamente con el nombre de su GitHub organización, ya que debe autorizar e instalar la aplicación en esa organización en los siguientes pasos.
Seleccione los permisos de la GitHub aplicación para su GitHub aplicación. El nivel de permisos determina las acciones que la GitHub aplicación puede realizar en su repositorio:
Lectura y escritura (predeterminado): la GitHub aplicación solicita permisos de lectura y escritura. Esto habilita todas las funciones. DevOps El agente puede publicar comentarios sobre las solicitudes de cambios en línea, proponer correcciones y activar flujos de trabajo.
Solo lectura: la GitHub aplicación solo solicita permisos de lectura. DevOps El agente puede ver el código y las solicitudes de extracción, pero no puede publicar comentarios, proponer correcciones ni activar flujos de trabajo.
Si te estás conectando a una instancia de GitHub Enterprise Server, selecciona Usar GitHub Enterprise e introduce la URL HTTPS de la instancia (por ejemplo,https://github.example.com).
Si su instancia de GitHub Enterprise Server no es de acceso público, si lo desea, puede configurar una conexión privada para que el AWS DevOps agente pueda acceder a su instancia de forma segura. Para obtener más información, consulte Conexión a herramientas alojadas de forma privada.
nota
No incluyas /api/v3 ni ninguna ruta final en la URL; introduce solo la URL base.
En el caso de GitHub Enterprise Cloud con residencia de datos, selecciona Usar GitHub empresa e introduce la URL HTTPS de tu instancia de residencia de datos (por ejemplo,https://octocorp.ghe.com).
Paso 3: Configura la GitHub aplicación
Seleccione Enviar para iniciar el proceso de configuración de la aplicación. Los siguientes pasos varían en función de si se conecta a GitHub.com GitHub Enterprise Server o GitHub Enterprise Cloud con residencia de datos.
¿Para GitHub.com
GitHub te redirige para que inicies sesión y autorices al AWS DevOps agente.
Revisa la solicitud de autorización y autoriza al AWS DevOps agente.
Después de autorizar, el AWS DevOps agente completa el registro. Si la GitHub aplicación aún no está instalada en la cuenta u organización que especificó, continúe con la página de instalación (consulte el paso 4). Si la aplicación ya está instalada, el registro se completa sin tener que volver a instalarla.
Tras la instalación, el AWS DevOps agente recibe los eventos de los repositorios conectados, incluidos los eventos de despliegue.
nota
Debe autorizar e instalar la aplicación en el mismo usuario u organización que especificó durante el registro. Si autorizas o instalas en una cuenta u organización diferente, el registro fallará y tendrás que reiniciar el proceso y seleccionar la cuenta u organización correcta.
nota
AWS DevOps El agente usa una GitHub aplicación independiente para cada nivel de permiso (lectura y escritura y solo lectura), y cada aplicación se autoriza de forma independiente. GitHub recuerda una autorización hasta que la revoques en Configuración > Aplicaciones > GitHub Aplicaciones autorizadas. Si anteriormente autorizaste la aplicación con este nivel de permisos, es GitHub posible que te saltes la pantalla de autorización. Si cambias el nivel de permiso, te GitHub pedirá que autorices la aplicación correspondiente la primera vez.
Para GitHub Enterprise Server y GitHub Enterprise Cloud con residencia de datos
GitHub Tanto Enterprise Server como GitHub Enterprise Cloud con residencia de datos utilizan el flujo GitHub App Manifest, que configura automáticamente una nueva GitHub aplicación en la instancia. Durante la configuración, el navegador se redirige dos veces: una vez a la instancia y otra al AWS DevOps agente.
AWS DevOps El agente redirige el navegador a la página de creación de GitHub aplicaciones de la instancia GitHub empresarial.
El nombre de la aplicación viene rellenado previamente. Cambie el nombre si es necesario y, a continuación, seleccione Crear GitHub aplicación.
Una vez que el AWS DevOps agente redirige el navegador hacia atrás, intercambia el código del manifiesto por las credenciales de la aplicación.
Paso 4: Seleccione los repositorios y complete la instalación
Omita este paso si la GitHub aplicación ya está instalada en su cuenta u organización.
Aparece la página Instalar y autorizar la GitHub aplicación.
Seleccione los repositorios a los que desea permitir el acceso de la aplicación:
Todos los repositorios: otorga acceso a todos los repositorios actuales y futuros
Selecciona solo repositorios: elige repositorios específicos de tu cuenta u organización
Elija Instalar y autorizar.
Se te redirigirá de nuevo a la consola del AWS DevOps agente, donde GitHub aparecerá como registrado a nivel de cuenta.
Conectar los repositorios a un espacio de agentes
Tras registrarse GitHub a nivel de cuenta, puede conectar repositorios específicos a espacios de agente individuales:
En la consola de AWS DevOps agentes, selecciona tu espacio de agente
Ve a la pestaña Capacidades
En la sección Pipeline, elija Agregar
Seleccione GitHubde la lista de proveedores disponibles
Seleccione el GitHub registro que contiene los repositorios que quiere usar
Seleccione el subconjunto de repositorios correspondiente a este espacio de agentes
Elija Agregar para completar la conexión
Puede conectar diferentes conjuntos de repositorios a diferentes espacios de agentes en función de las necesidades de su organización. Un único espacio de agente puede utilizar repositorios de varios registros. Para añadir repositorios de otro registro, repita estos pasos.
Configuración de la revisión del código y las pruebas automatizadas
Al seleccionar los repositorios en el paso de GitHub conexión, se añaden automáticamente a la sección de revisión de código y pruebas automatizadas. En esta sección, se configuran los repositorios que activan automáticamente una Revisiones del código de preparación para el lanzamiento y las capacidades de prueba automatizadas.
La configuración de revisión de código y pruebas automatizadas incluye:
Capacidades: elija las capacidades de revisión de código y pruebas automatizadas para cada repositorio. La sección proporciona dos configuraciones por repositorio:
Activación automática de la revisión de cambios: cuando está habilitada para un repositorio, DevOps Agent se ejecuta automáticamente Revisiones del código de preparación para el lanzamiento cada vez que se abre o actualiza una solicitud de cambios. Los resultados de la revisión aparecen como comentarios en línea en la solicitud de extracción. Esta opción está habilitada de forma predeterminada para todos los repositorios conectados.
Pruebas de verificación automatizadas: cuando está habilitado para un repositorio, DevOps Agent crea, ejecuta y prueba los cambios de código en un entorno de verificación gestionado durante las revisiones del código. Esto proporciona una validación funcional más allá del análisis estático. Para obtener más información, consulte Pruebas de verificación automatizadas. Esta opción está habilitada de forma predeterminada para todos los repositorios conectados.
Lista de repositorios: muestra todos los repositorios que seleccionó durante el paso de conexión. Utilice el campo de búsqueda para filtrar los repositorios por nombre. Cada repositorio tiene casillas de verificación independientes para ambas capacidades.
Función de tiempo de ejecución (opcional): elija la función de IAM que asumirá el DevOps agente para ejecutar las funciones automatizadas en los repositorios que seleccione. Esta función se utiliza para acceder a los servicios internos necesarios durante las compilaciones, como los registros de paquetes privados y los sistemas de almacenamiento de artefactos. Te recomendamos que utilices una función diferente a la de agente principal.
Para configurar las revisiones automatizadas:
Tras conectar tus repositorios, dirígete a la sección Revisión de código y pruebas automatizadas en tus ajustes de GitHub integración.
Para cada repositorio, activa o desactiva la función de revisión automática de cambios en función de si deseas realizar revisiones automáticas mediante solicitudes de extracción de datos.
Para cada repositorio, habilita o deshabilita la función de pruebas de verificación automatizadas en función de si deseas realizar pruebas de verificación automatizadas en un entorno de verificación gestionado.
Si lo desea, seleccione una función de IAM de la lista desplegable de funciones en tiempo de ejecución que el DevOps agente asumirá al ejecutar las funciones automatizadas en los repositorios seleccionados.
Seleccione Guardar para aplicar la configuración.
Una vez configurada, cualquier nueva solicitud de extracción de un repositorio que tenga habilitada la revisión automática de cambios activará automáticamente una revisión del código de preparación para el lanzamiento. Si las pruebas de verificación automatizadas también están habilitadas, la revisión incluye la validación funcional en un entorno de verificación. Para obtener más información sobre las revisiones de código, consulteRevisiones del código de preparación para el lanzamiento.
Entendiendo la GitHub aplicación
La GitHub aplicación AWS DevOps Agent:
Solicita acceso a tus repositorios: puedes revisar los permisos específicos durante la instalación de GitHub la aplicación
Recibe eventos de despliegue y otros eventos del repositorio
Permite al AWS DevOps agente correlacionar los cambios de código con los incidentes operativos
Se puede desinstalar en cualquier momento a través de su configuración GitHub
En el caso de GitHub Enterprise Server y GitHub Enterprise Cloud con residencia de datos, AWS DevOps Agent crea automáticamente la GitHub aplicación en la instancia durante el registro. Puede administrar el acceso al repositorio de la aplicación o desinstalarla desde Configuración > Aplicaciones > GitHub Aplicaciones instaladas. Para eliminar por completo la definición de la aplicación, ve a Configuración > Configuración del desarrollador > GitHub Aplicaciones.
GitHub Actualizaciones de permisos de la aplicación
AWS DevOps El agente puede solicitar actualizaciones de permisos después de instalar la GitHub aplicación para admitir nuevas funciones. Cuando esto sucede:
Recibirá una notificación de parte de usted en GitHub relación con la solicitud de actualización del permiso.
Revisa los detalles de la actualización para saber qué permisos nuevos se están solicitando.
Selecciona Aceptar nuevos permisos para conceder los permisos actualizados.
No es necesario realizar cambios en el servicio o la aplicación. Tras aceptar los permisos actualizados, el siguiente token de acceso a la instalación que solicite el AWS DevOps agente GitHub incluirá automáticamente los nuevos permisos.
nota
Hasta que acepte una actualización de permisos, el AWS DevOps agente seguirá funcionando con los permisos concedidos anteriormente. Las nuevas capacidades que dependan de los permisos actualizados no estarán disponibles hasta que usted apruebe la solicitud. La aplicación conservará sus permisos actuales si decides no aceptar los nuevos permisos.
Permisos de solicitados
En la siguiente tabla se describe cada permiso que solicita la GitHub aplicación AWS DevOps agente y por qué es necesario.
Si seleccionó Solo lectura durante el registro, la GitHub aplicación solicita el acceso de nivel de lectura solo para cada permiso de la siguiente tabla. Con los permisos de solo lectura, la GitHub aplicación no puede realizar las acciones de nivel de escritura que se indican en la columna Propósito.
| Permiso | Nivel de acceso | Finalidad |
|---|---|---|
| Comprueba | Lee y escribe | La revisión del código posterior a su publicación se traduce en la comprobación de las solicitudes de cambios, lo que permite que el estado de la revisión aparezca directamente en la GitHub interfaz de usuario. |
| Flujos de trabajo | Lee y escribe | Lee las definiciones de los flujos de trabajo y activa los flujos de trabajo de GitHub Actions para realizar pruebas de versiones en CI/CD tus procesos. |
| Acciones | Lee y escribe | Supervise las ejecuciones del flujo de trabajo de GitHub Actions y acceda a los registros de ejecución durante las investigaciones de incidentes y las pruebas de lanzamiento. |
| Contenido | Lee y escribe | Lea el código fuente del repositorio para revisar el código, analizar y mapear las dependencias. El acceso de escritura permite al agente proponer soluciones para los problemas identificados. |
| Solicitudes de extracción | Lee y escribe | Lee los detalles de las solicitudes de extracción para activar las revisiones automatizadas del código. El acceso por escrito permite publicar comentarios de revisión en línea con los resultados y las correcciones recomendadas. |
| Administración de la organización | Lectura | Lea la lista de aplicaciones instaladas en la organización de destino para comprobar que la GitHub aplicación del AWS DevOps agente está instalada. |
Administrar GitHub las conexiones
Actualizar el acceso a los repositorios: para cambiar los repositorios a los que puede acceder la GitHub aplicación, ve a la configuración de tu GitHub cuenta u organización. En el caso de GitHub Enterprise Server o GitHub Enterprise Cloud con residencia de datos, accede a la configuración de la instancia. A continuación, diríjase a GitHub las aplicaciones instaladas y modifique la configuración de la aplicación del AWS DevOps agente.
Visualización de los repositorios conectados: en la consola del AWS DevOps agente, seleccione su espacio de agente y vaya a la pestaña Capacidades para ver los repositorios conectados en la sección Pipeline.
Eliminar una GitHub conexión: para desconectarse GitHub de un espacio de agentes, elija la conexión en la sección Pipeline y, a continuación, elija Eliminar. Para eliminar el GitHub registro de su cuenta, vaya a la página de proveedores de capacidades, localice su registro en la GitHubsección y elija Anular registro.
Para eliminar por completo la GitHub integración, haga lo siguiente:
Para desinstalar la GitHub aplicación, ve a la configuración de tu GitHub cuenta u organización.
Para volver a conectarse, vuelva a registrarse GitHub en la consola del AWS DevOps agente.
En el caso de GitHub Enterprise Server y GitHub Enterprise Cloud con residencia de datos, el AWS DevOps agente crea la GitHub aplicación en la instancia durante el registro. Para limpiar la aplicación por completo, realice las dos acciones siguientes:
Desinstala la aplicación: ve a Configuración > Aplicaciones > GitHub Aplicaciones instaladas, selecciona Configurar en la aplicación y desinstálala.
Eliminar la aplicación: ve a Configuración > Configuración del desarrollador > GitHub Aplicaciones, elige la aplicación, ve a la pestaña Avanzadas y selecciona Eliminar GitHub aplicación. Advertencia: la eliminación de la GitHub aplicación es permanente y no se puede deshacer. Para crear una aplicación nueva, vuelva a registrarse GitHub en la consola del AWS DevOps agente.
