Conectarse a un repositorio de Git de terceros

En este documento se explica cómo conectar un repositorio remoto a un repositorio de Dataform. Una vez que hayas conectado los repositorios, los cambios que hagas en un espacio de trabajo de desarrollo de Dataform se podrán insertar y extraer del repositorio de Git remoto.

Importante: Dataform no puede conectarse directamente a una dirección IP privada de un host Git local.

Puedes conectar un repositorio remoto a través de HTTPS o SSH.

En la siguiente tabla se indican los proveedores de Git admitidos y los métodos de conexión disponibles para sus repositorios:

Proveedor de Git	Método de conexión
Azure DevOps Services	SSH
Bitbucket	SSH
GitHub	SSH o HTTPS
GitLab	SSH o HTTPS

Importante: Para conectar tu repositorio de Git remoto a Dataform, comprueba que tu host de Git tenga una dirección IP pública. Si tu host de Git solo tiene configurada una dirección IP privada (por ejemplo, 10.x.x.x, 172.16.x.x-172.31.x.x o 192.168.x.x), Dataform no podrá establecer una conexión. La conexión de un repositorio de Git remoto a un repositorio de Dataform puede fallar si el repositorio remoto no está abierto a la red pública de Internet, por ejemplo, si está detrás de un cortafuegos. En este caso, añade los intervalos de direcciones IP de salida de Dataform necesarios a las reglas de tu cortafuegos para habilitar las conexiones a repositorios remotos protegidos.

Antes de empezar

1. Si tu organización o proyecto restringe los repositorios de Git remotos con la política de organización dataform.restrictGitRemotes, asegúrate de que el repositorio de Git remoto se haya añadido a la lista de permitidos de la política antes de crear un repositorio de Dataform que quieras conectar a un repositorio remoto. Para obtener más información, consulta Restringir repositorios remotos.
2. Seleccione o cree un repositorio de Dataform. La necesitarás más adelante para compartir un secreto con tu cuenta de servicio de Dataform predeterminada.

Roles obligatorios

Para obtener los permisos que necesitas para conectar un repositorio de Dataform a un repositorio de Git remoto, pide a tu administrador que te conceda el rol de gestión de identidades y accesos Administrador de Dataform (roles/dataform.admin) en los repositorios. Para obtener más información sobre cómo conceder roles, consulta el artículo Gestionar el acceso a proyectos, carpetas y organizaciones.

También puedes conseguir los permisos necesarios a través de roles personalizados u otros roles predefinidos.

Conectar un repositorio remoto mediante SSH

Para conectar un repositorio remoto a través de SSH, debes generar una clave SSH y un secreto de Secret Manager. La clave SSH consta de una clave SSH pública y una clave SSH 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. A continuación, comparte el secreto con tu cuenta de servicio predeterminada de Dataform.

Dataform usa el secreto con la clave SSH privada para iniciar sesión en tu proveedor de Git y confirmar los cambios en nombre de los desarrolladores. Dataform hace estas confirmaciones con la dirección de correo del desarrollador para que sepas quién ha hecho cada confirmación. Google Cloud

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 que limites su acceso a los repositorios de Git remotos que quieras usar con Dataform. Solo los Google Cloud propietarios de proyectos y los usuarios de Dataform con el rol Administrador de Dataform pueden usar la clave para conectar repositorios. Los usuarios de Dataform no pueden ver la clave en sí.

Para conectar un repositorio remoto a un repositorio de Dataform mediante SSH, sigue estos pasos:

1. En tu proveedor de Git, haz lo siguiente:

   Azure DevOps Services

   1. En Azure DevOps Services, crea una clave SSH privada.
   2. Sube la clave pública SSH a tu repositorio de Azure DevOps Services.

   Bitbucket

   1. En Bitbucket, crea una clave SSH privada.
   2. Sube la clave pública SSH a tu repositorio de Bitbucket.

   GitHub

   1. En GitHub, crea una clave SSH privada.
   2. Sube la clave SSH pública de GitHub a tu repositorio de GitHub.

   GitLab

   1. En GitLab, crea una clave SSH privada.
   2. Sube la clave pública SSH de GitLab a tu repositorio de GitLab.

2. En Secret Manager, crea un secreto y define tu clave SSH privada como valor del secreto.

   1. Concede acceso al secreto a tu cuenta de servicio predeterminada de Dataform.

      Tu cuenta de servicio predeterminada de Dataform tiene el siguiente formato:

      [e-mail]
      

   2. Asigna el rol roles/secretmanager.secretAccessor a la cuenta de servicio.

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

   Ir a Dataform

4. Selecciona el repositorio de Dataform que quieras conectar al repositorio remoto.

5. En la página del repositorio, haz clic en Configuración > Conectar con Git.

6. En el panel Enlazar con repositorio remoto, en el campo URL del repositorio Git remoto, introduce la URL del repositorio Git remoto, que termina en .git.

   La URL del repositorio de Git remoto debe tener 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}.

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

8. En el desplegable Secreto, selecciona el secreto del repositorio Git remoto.

9. En el campo Valor de la clave de host pública SSH, introduce la clave de host pública de tu proveedor de Git.

   Azure DevOps Services

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

   ALGORITHM BASE64_KEY_VALUE
   

   Para obtener la clave de host pública de Azure DevOps Services, ejecuta el comando ssh-keyscan -t rsa ssh.dev.azure.com en el terminal.

   Bitbucket

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

   ALGORITHM BASE64_KEY_VALUE
   

   Para obtener la clave de host pública de Bitbucket, consulta Configurar SSH.

   GitHub

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

   ALGORITHM BASE64_KEY_VALUE
   

   Para obtener la clave pública de host de GitHub, consulta las huellas digitales de la clave SSH de GitHub.

   GitLab

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

   ALGORITHM BASE64_KEY_VALUE
   

   Para obtener la clave de host pública de GitLab, consulta las entradas de SSH known_hosts.

10. Haz clic en Vincular.

Conectar un repositorio remoto a través de HTTPS

Para conectar un repositorio remoto a través de HTTPS, debes crear un secreto de Secret Manager con un token de acceso personal y compartirlo con tu cuenta de servicio predeterminada de Dataform.

A continuación, Dataform usa el token de acceso para iniciar sesión en tu proveedor de Git y confirmar los cambios en nombre de los desarrolladores. Dataform realiza estas confirmaciones con la dirección de correo del desarrollador Google Cloud para que sepas quién ha hecho cada confirmación.

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

Para conectar un repositorio remoto a un repositorio de Dataform mediante HTTPS, sigue estos pasos:

1. En tu proveedor de Git, haz lo siguiente:

   GitHub

   1. En GitHub, crea un token de acceso personal detallado o un token de acceso personal clásico.

      • Para obtener un token de acceso personal de GitHub detallado, haz lo siguiente:

      1. Selecciona el acceso al repositorio solo a los repositorios seleccionados y, a continuación, selecciona el repositorio al que quieras conectarte.

      2. Concede acceso de lectura y escritura al contenido del repositorio.

      3. Define un tiempo de caducidad del token que se adapte a tus necesidades.

      • Para obtener un token de acceso personal clásico de GitHub, sigue estos pasos:

      1. Concede a Dataform el permiso repo.

      2. Define un tiempo de caducidad del token que se adapte a tus necesidades.

   2. Si tu organización utiliza el inicio de sesión único (SSO) basado en SAML, autoriza el token.

   GitLab

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

   2. Ponle el nombre dataform al token.

      El token de acceso personal de GitLab debe llamarse dataform.

   3. Concede a Dataform los permisos api, read_repository y write_repository.

   4. Define un tiempo de caducidad del token que se adapte a tus necesidades.

2. En Secret Manager, crea un secreto que contenga el token de acceso personal de tu repositorio remoto.

3. Concede acceso al secreto a tu cuenta de servicio predeterminada de Dataform.

   Tu cuenta de servicio predeterminada de Dataform tiene el siguiente formato:

   [e-mail]
   

   1. Asigna el rol roles/secretmanager.secretAccessor a la cuenta de servicio.

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

   Ir a Dataform

5. Selecciona el repositorio de Dataform que quieras conectar al repositorio remoto.

6. En la página del repositorio, haz clic en Configuración > Conectar con Git.

7. En el panel Enlazar con repositorio remoto, en el campo URL del repositorio Git remoto, introduce la URL del repositorio Git remoto, que termina en .git.

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

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

9. En el desplegable Secreto, selecciona el secreto del repositorio Git remoto.

10. Haz clic en Vincular.

Editar 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 Google Cloud consola, ve a la página Dataform.

   Ir a Dataform

2. Haz clic en el repositorio que quieras editar.

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

4. En el panel Vincular a repositorio remoto, edita la configuración de la conexión.

5. Haz clic en Actualizar.

Siguientes pasos

• Para obtener más información sobre los repositorios de Dataform, consulta el artículo Crear un repositorio.

• Para crear un espacio de trabajo de desarrollo, consulta Crear un espacio de trabajo.

• Para saber cómo solucionar problemas con las conexiones de repositorios remotos, consulta Solucionar problemas de Dataform.