Conéctate a un repositorio de Git de terceros

En este documento, se muestra cómo vincular un repositorio de Dataform a un repositorio de Git remoto de terceros.

Después de vincular los repositorios, los cambios que realices en un lugar de trabajo de desarrollo de Dataform se pueden enviar al repositorio remoto de Git y extraerlos.

Puedes vincular un repositorio de Dataform a un repositorio de Git remoto alojado por los siguientes proveedores de Git:

• Azure DevOps Services

• Bitbucket

• GitHub

• GitLab

Para vincular un repositorio remoto de terceros a un repositorio de Dataform, primero debes autenticarlo. Puedes autenticar un repositorio remoto en Dataform con HTTPS o SSH.

En el caso de los repositorios remotos de GitHub y GitLab, puedes usar HTTPS o SSH para la autenticación. Para los servicios de Azure DevOps y los repositorios remotos de Bitbucket, debes usar SSH.

Nota: La conexión de un repositorio de Dataform a uno remoto puede fallar si el repositorio remoto no está abierto a la Internet pública, por ejemplo, si está detrás de un firewall. Puedes completar el formulario de lista de espera de rangos fijos de IP de salida de Dataform para registrarte y recibir actualizaciones sobre direcciones IP de salida coherentes en Dataform, que permiten conexiones a repositorios remotos protegidos.

Antes de comenzar

Si aún no lo hiciste, crea un repositorio de Dataform. Lo necesitarás más adelante para compartir un secreto con tu cuenta de servicio de Dataform.

Importante: Si tu organización o proyecto restringe los repositorios de Git remotos con la política de la organización dataform.restrictGitRemotes, asegúrate de que el repositorio remoto de Git esté incluido en la lista de entidades permitidas antes de crear un repositorio de Dataform y conectarlo al repositorio remoto. Para obtener más información, consulta Restringe repositorios remotos.

Funciones obligatorias

Si quieres obtener los permisos que necesitas para vincular un repositorio de Dataform a un repositorio de Git remoto, pídele a tu administrador que te otorgue el rol de IAM Administrador de Dataform (roles/dataform.admin) en los repositorios. Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso.

Es posible que también puedas obtener los permisos necesarios a través de funciones personalizadas o, también, otras funciones predefinidas.

Autentica un repositorio remoto a través de HTTPS

Puedes autenticar los repositorios de GitHub y GitLab a través de HTTPS si creas un secreto de Secret Manager con un token de acceso personal y compartes el secreto con tu cuenta de servicio de Dataform.

Luego, Dataform usa el token de acceso para acceder a tu proveedor de Git y confirmar los cambios en nombre de los desarrolladores. Dataform realiza estas confirmaciones mediante la dirección de correo electrónico de Google Cloud del desarrollador para que puedas saber quién realizó cada confirmación.

Para autenticar un repositorio de GitHub, crea un token de acceso personal clásico o un token de acceso personal detallado que te permita personalizar los permisos del token.

Para autenticar un repositorio de GitLab, crea un token de acceso personal clásico.

Advertencia: El token de acceso se comparte entre todos los usuarios de Dataform que usan la cuenta de servicio correspondiente. Te recomendamos que crees un usuario de máquina con tu proveedor de Git y limites su acceso a los repositorios de Git remotos que planeas usar con Dataform. Solo los propietarios de proyectos de Google Cloud y los usuarios de Dataform con la función de administrador de Dataform pueden usar el token para conectar repositorios. Los usuarios de Dataform no pueden ver el token en sí.

Para autenticar un repositorio de GitHub o GitLab en Dataform mediante HTTPS, sigue estos pasos:

1. En GitHub o GitLab, crea un token de acceso personal.

2. Cuando crees un token de acceso personal de GitHub, haz lo siguiente:

   1. Otorga a Dataform el permiso repo.

   2. Asegúrate de establecer un tiempo de caducidad de token que sea adecuado para tus necesidades.

   3. Si en tu organización se usa el inicio de sesión único (SSO) de SAML, autoriza el token.

3. Opcional: Cuando crees un token de acceso personal detallado de GitHub, haz lo siguiente:

   1. Selecciona el acceso al repositorio solo para los repositorios seleccionados y, luego, selecciona el repositorio al que deseas conectarte.

   2. Otorga acceso de lectura y escritura a los contenidos del repositorio.

   3. Asegúrate de establecer un tiempo de caducidad de token que sea adecuado para tus necesidades.

   4. Si en tu organización se usa el inicio de sesión único (SSO) de SAML, autoriza el token.

4. Cuando crees un token de acceso personal de GitLab, haz lo siguiente:

   1. Asigna el nombre dataform al token.

      El token de acceso personal de GitLab debe llamarse dataform.

   2. Otorga a Dataform los permisos api, read_repository y write_repository.

   3. Asegúrate de establecer un tiempo de caducidad de token que sea adecuado para tus necesidades.

5. En Secret Manager, crea un Secret que contenga un token de acceso personal para conectarte con tu proveedor de Git.

6. Otorga acceso al secreto a tu cuenta de servicio de Dataform.

   Tu cuenta de servicio de Dataform tiene el siguiente formato:

   [e-mail]
   

   1. Cuando otorgues acceso, asegúrate de otorgar el rol roles/secretmanager.secretAccessor a la cuenta de servicio de Dataform.

Dataform usa el token de acceso para acceder a tu proveedor de Git y confirmar los cambios en nombre de los desarrolladores. Dataform realiza estas confirmaciones mediante la dirección de correo electrónico de Google Cloud del desarrollador para que puedas saber quién realizó cada confirmación.

Autentica un repositorio remoto mediante SSH

Puedes autenticar Azure DevOps Services, Bitbucket, GitHub y repositorios de GitLab a través de SSH si generas una clave SSH y un secreto de Secret Manager.

La clave SSH consta de una clave SSH pública y una privada. Debes compartir la clave SSH pública con tu proveedor de Git y crear un secreto de Secret Manager con la clave SSH privada. Luego, comparte el secreto con tu cuenta de servicio de Dataform.

Dataform usa el secreto con la clave SSH privada para acceder a tu proveedor de Git y confirmar los cambios en nombre de los desarrolladores. Dataform realiza estas confirmaciones con la dirección de correo electrónico de Google Cloud del desarrollador para que puedas saber quién realizó cada confirmación.

Advertencia: La clave SSH privada se comparte entre todos los usuarios de Dataform que usan la cuenta de servicio correspondiente. Te recomendamos que crees un usuario de máquina con tu proveedor de Git y limites su acceso a los repositorios de Git remotos que planeas usar con Dataform. Solo los propietarios de proyectos de Google Cloud y los usuarios de Dataform con la función de administrador de Dataform pueden usar la clave para conectar repositorios. Los usuarios de Dataform no pueden ver la clave en sí.

Para autenticar un repositorio de Azure DevOps Services, Bitbucket, GitHub o GitLab en Dataform mediante SSH, sigue estos pasos:

1. En Azure DevOps Services, Bitbucket, GitHub o GitLab, crea una clave SSH.

   • Si quieres obtener instrucciones para crear una clave SSH de Azure DevOps Services, consulta Usa la autenticación de claves SSH.

   • Si quieres obtener instrucciones para crear una clave SSH de Bitbucket, consulta Configura SSH.

   • Si quieres obtener instrucciones para crear una clave SSH de GitHub, consulta Genera una clave SSH nueva.

   • Si quieres obtener instrucciones para crear una clave SSH de GitLab, consulta Genera un par de claves SSH.

2. Sube la clave SSH pública a tu cuenta de Git de terceros.

   • Si quieres obtener instrucciones para subir una clave SSH pública a los servicios de Azure DevOps, consulta Usa la autenticación de claves SSH.

   • Si quieres obtener instrucciones para subir una clave SSH pública a Bitbucket, consulta Configura SSH.

   • Si quieres obtener instrucciones para subir una clave SSH pública a GitHub, consulta Agrega una clave SSH nueva a tu cuenta de GitHub.

   • Si quieres obtener instrucciones para subir una clave SSH pública a GitLab, consulta Agrega una clave SSH a tu cuenta de GitLab.

3. En Secret Manager, crea un secreto con la clave SSH privada como valor del secreto.

4. Otorga acceso al secreto a tu cuenta de servicio de Dataform.

   Tu cuenta de servicio de Dataform tiene el siguiente formato:

   [e-mail]
   

   1. Cuando otorgues acceso, asegúrate de otorgar el rol roles/secretmanager.secretAccessor a la cuenta de servicio de Dataform.

Conecta un repositorio de Dataform

Para vincular un repositorio de Dataform a un repositorio de Git remoto, sigue estos pasos:

1. En la consola de Google Cloud, ve a la página Dataform.

   Ir a Dataform

2. Selecciona el repositorio que deseas conectar.

3. En la página del repositorio, haz clic en Settings > Connect with Git.

4. En el panel Vínculo al repositorio remoto, en el campo URL del repositorio de Git remoto, ingresa la URL del repositorio de Git remoto, que termina con .git.

   Para la autenticación HTTPS, la URL del repositorio de Git remoto no puede contener nombres de usuario ni contraseñas.

   Para la autenticación SSH, la URL del repositorio de Git remoto debe estar en uno de los siguientes formatos:

   • URL absoluta: ssh://git@{host_name}[:{port}]/{repository_path}, port es opcional.
   • URL similar a SCP: git@{host_name}:{repository_path}.

5. En el campo Nombre de rama remota predeterminada, ingresa el nombre de la rama de desarrollo principal del repositorio de Git remoto.

6. En el menú desplegable Secreto, selecciona tu secreto para el repositorio remoto de Git.

7. Si usaste la autenticación SSH para el repositorio remoto, en el campo Valor de la clave de host público SSH, ingresa una única clave de host público de tu proveedor de Git.

   El valor de la clave de host público de SSH debe tener el formato de un archivo known_hosts. El valor debe contener un algoritmo y una clave pública codificadas en formato base64, pero sin el nombre de host o la IP, en el siguiente formato:

     ALGORITHM BASE64_KEY_VALUE
   

   • Para la clave de host público de los servicios de Azure DevOps, ejecuta el comando ssh-keyscan -t rsa ssh.dev.azure.com en la terminal.

   • Para la clave de host pública de Bitbucket, consulta Configura SSH.

   • Para la clave de host público de GitHub, consulta Huellas digitales de la clave SSH de GitHub.

   • Para obtener información sobre la clave de host pública de GitLab, consulta Entradas known_hosts de SSH.

8. Haz clic en Link.

Edita la conexión del repositorio remoto

Para editar una conexión entre un repositorio de Dataform y un repositorio de Git remoto, sigue estos pasos:

1. En la consola de Google Cloud, ve a la página Dataform.

   Ir a Dataform

2. Haz clic en el repositorio que deseas editar.

3. En la página del repositorio, haz clic en Configuración > Editar conexión de Git.

4. En el panel Vincular al repositorio remoto, edita cualquiera de las siguientes opciones:

   1. En el campo URL del repositorio de Git remoto, edita la URL del repositorio de Git remoto vinculado.

      La URL del repositorio remoto de Git no puede contener nombres de usuario ni contraseñas.

   2. En el campo Nombre de rama remota predeterminada, edita el nombre de la rama de desarrollo principal del repositorio de Git remoto.

   3. En el menú desplegable Secreto (Secret), selecciona el secreto para el repositorio de Git remoto.

   4. Si usaste la autenticación SSH para el repositorio remoto, en el campo Valor de la clave de host público SSH, ingresa la clave de host pública de tu proveedor de Git.

      El valor de la clave de host público de SSH debe tener el formato de un archivo de host conocido. El valor debe contener un algoritmo y una clave pública codificadas en formato base64, pero sin el nombre de host o la IP, en el siguiente formato:

       ALGORITHM BASE64_KEY_VALUE
      

      • Para la clave de host pública de Bitbucket, consulta Configura SSH.

      • Para la clave de host público de GitHub, consulta Huellas digitales de la clave SSH de GitHub.

      • Para obtener información sobre la clave de host pública de GitLab, consulta Entradas known_hosts de SSH.

5. Haga clic en Update.

¿Qué sigue?

• Para obtener más información sobre los repositorios de Dataform, consulta Introducción a los repositorios.

• Para crear un lugar de trabajo de desarrollo, consulta Crea un lugar de trabajo.

• Para obtener más información sobre Dataform, consulta Descripción general de Dataform.