En este documento se describe cómo importar metadatos de una fuente de terceros a Dataplex Universal Catalog ejecutando una canalización de conectividad gestionada en Workflows.
Para configurar una canalización de conectividad gestionada, debe crear un conector para su fuente de datos. Después, ejecuta el flujo de trabajo en Workflows. La pipeline extrae metadatos de su fuente de datos y, a continuación, los importa a Dataplex Universal Catalog. Si es necesario, la canalización también crea grupos de entradas de Dataplex Universal Catalog en tu Google Cloud proyecto.
Para obtener más información sobre la conectividad gestionada, consulta el artículo Información general sobre la conectividad gestionada.
Antes de empezar
Antes de importar metadatos, completa las tareas de esta sección.
Crear un conector
Un conector extrae los metadatos de su fuente de datos y genera un archivo de importación de metadatos que puede importar Dataplex Universal Catalog. El conector es una imagen de Artifact Registry que se puede ejecutar en Dataproc Serverless.
Crea un conector personalizado que extraiga metadatos de tu fuente de terceros.
Para ver un conector de ejemplo que puedes usar como plantilla de referencia para crear tu propio conector, consulta Desarrollar un conector personalizado para importar metadatos.
Configurar recursos de Google Cloud
-
Enable the Workflows, Dataproc, Cloud Storage, Dataplex, Secret Manager, Artifact Registry, and Cloud Scheduler APIs.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (
roles/serviceusage.serviceUsageAdmin
), which contains theserviceusage.services.enable
permission. Learn how to grant roles.Si no tienes previsto ejecutar la canalización de forma programada, no es necesario que habilites la API Cloud Scheduler.
Crea secretos en Secret Manager para almacenar las credenciales de tu fuente de datos de terceros.
Configura tu red de nube privada virtual (VPC) para ejecutar Dataproc sin servidor para cargas de trabajo de Spark.
Crea un segmento de Cloud Storage para almacenar los archivos de importación de metadatos.
Crea los siguientes recursos de Dataplex Universal Catalog:
Crea tipos de aspecto personalizados para las entradas que quieras importar.
Crea tipos de entrada personalizados para las entradas que quieras importar.
Roles obligatorios
Una cuenta de servicio representa la identidad de un flujo de trabajo y determina qué permisos tiene el flujo de trabajo y a qué recursos puede acceder. Google Cloud Necesitas una cuenta de servicio para Workflows (para ejecutar la canalización) y otra para Dataproc sin servidor (para ejecutar el conector).
Puedes usar la cuenta de servicio predeterminada de Compute Engine (PROJECT_NUMBER-compute@developer.gserviceaccount.com
) o crear tu propia cuenta de servicio (o cuentas) para ejecutar la canalización de conectividad gestionada.
Consola
En la consola, ve a la página Gestión de identidades y accesos. Google Cloud
Selecciona el proyecto en el que quieras importar los metadatos.
Haz clic en
Dar acceso. A continuación, introduce la dirección de correo de la cuenta de servicio.Asigna los siguientes roles a la cuenta de servicio:
- Editor de registros
- Propietario de EntryGroup de Dataplex
- Propietario de trabajos de metadatos de Dataplex
- Editor de catálogo de Dataplex
- Editor de Dataproc
- Trabajador de Dataproc
- Lector de recursos de Secret Manager en el secreto que almacena las credenciales de tu fuente de datos
- Usuario de objeto de almacenamiento en el segmento de Cloud Storage
- Lector de Artifact Registry: en el repositorio de Artifact Registry que contiene la imagen del conector
- Usuario de cuenta de servicio: si usas diferentes cuentas de servicio, otorga este rol a la cuenta de servicio que ejecuta Workflows en la cuenta de servicio que ejecuta los trabajos por lotes de Dataproc Serverless.
- Invocador de flujos de trabajo: si quieres programar el flujo de procesamiento
Guarda los cambios.
gcloud
Asigna roles a la cuenta de servicio. Ejecuta estos comandos:
gcloud projects add-iam-policy-binding PROJECT_ID \ --member="serviceAccount:SERVICE_ACCOUNT_ID" \ --role=roles/logging.logWriter gcloud projects add-iam-policy-binding PROJECT_ID \ --member="serviceAccount:SERVICE_ACCOUNT_ID" \ --role=roles/dataplex.entryGroupOwner gcloud projects add-iam-policy-binding PROJECT_ID \ --member="serviceAccount:SERVICE_ACCOUNT_ID" \ --role=roles/dataplex.metadataJobOwner gcloud projects add-iam-policy-binding PROJECT_ID \ --member="serviceAccount:SERVICE_ACCOUNT_ID" \ --role=roles/dataplex.catalogEditor gcloud projects add-iam-policy-binding PROJECT_ID \ --member="serviceAccount:SERVICE_ACCOUNT_ID" \ --role=roles/dataproc.editor gcloud projects add-iam-policy-binding PROJECT_ID \ --member="serviceAccount:SERVICE_ACCOUNT_ID" \ --role=roles/dataproc.worker
Haz los cambios siguientes:
-
PROJECT_ID
: el nombre del proyecto Google Cloud de destino al que se importarán los metadatos. SERVICE_ACCOUNT_ID
: la cuenta de servicio, comomy-service-account@my-project.iam.gserviceaccount.com
.
-
Concede a la cuenta de servicio los siguientes roles a nivel de recurso:
gcloud secrets add-iam-policy-binding SECRET_ID \ --member="serviceAccount:SERVICE_ACCOUNT_ID" \ --role=roles/secretmanager.secretaccessor gcloud projects add-iam-policy-binding PROJECT_ID \ --member="serviceAccount:SERVICE_ACCOUNT_ID" \ --role=roles/storage.objectUser \ --condition=resource.name.startsWith('projects/_/buckets/BUCKET_ID') gcloud artifacts repositories add-iam-policy-binding REPOSITORY \ --location=REPOSITORY_LOCATION \ --member=SERVICE_ACCOUNT_ID} \ --role=roles/artifactregistry.reader
Haz los cambios siguientes:
SECRET_ID
: el ID del secreto que almacena las credenciales de su fuente de datos. Utiliza el formatoprojects/PROJECT_ID/secrets/SECRET_ID
.BUCKET_ID
: el nombre del segmento de Cloud Storage.REPOSITORY
: el repositorio de Artifact Registry que contiene la imagen del conector.REPOSITORY_LOCATION
: la Google Cloud ubicación en la que se aloja el repositorio.
Asigna a la cuenta de servicio que ejecuta Workflows el rol
roles/iam.serviceAccountUser
en la cuenta de servicio que ejecuta los trabajos por lotes de Dataproc sin servidor. Debes conceder este rol aunque uses la misma cuenta de servicio para Workflows y Dataproc sin servidor.gcloud iam service-accounts add-iam-policy-binding \ serviceAccount:SERVICE_ACCOUNT_ID \ --member='SERVICE_ACCOUNT_ID' \ --role='roles/iam.serviceAccountUser'
Si usas cuentas de servicio diferentes, el valor de la marca
--member
es la cuenta de servicio que ejecuta los trabajos por lotes de Dataproc Serverless.Si quieres programar la canalización, concede a la cuenta de servicio el siguiente rol:
gcloud projects add-iam-policy-binding PROJECT_ID \ --member="SERVICE_ACCOUNT_ID" \ --role=roles/workflows.invoker
Importar metadatos
Para importar metadatos, crea y ejecuta un flujo de trabajo que ejecute la canalización de conectividad gestionada. También puedes crear una programación para ejecutar la canalización.
Consola
Crea el flujo de trabajo. Introduce la información siguiente:
- Cuenta de servicio: la cuenta de servicio que has configurado en la sección Roles obligatorios de este documento.
Cifrado: selecciona Google-managed encryption key.
Define workflow: proporciona el siguiente archivo de definición:
Para ejecutar el flujo de procesamiento bajo demanda, ejecuta el flujo de trabajo.
Proporciona los siguientes argumentos de tiempo de ejecución:
Haz los cambios siguientes:
-
PROJECT_ID
: el nombre del proyecto Google Cloud de destino al que se importarán los metadatos. -
LOCATION_ID
: la ubicación de destino Google Cloud donde se ejecutarán los trabajos de importación de metadatos y de Dataproc Serverless, y donde se importarán los metadatos. -
ENTRY_GROUP_ID
: el ID del grupo de entradas en el que se importarán los metadatos. El ID del grupo de entradas puede contener letras minúsculas, números y guiones.El nombre de recurso completo de este grupo de entradas es
projects/PROJECT_ID/locations/LOCATION_ID/entryGroups/ENTRY_GROUP_ID
. -
CREATE_ENTRY_GROUP_BOOLEAN
: si quieres que la canalización cree el grupo de entradas si aún no existe en tu proyecto, asigna el valortrue
. -
BUCKET_ID
: el nombre del segmento de Cloud Storage en el que se almacenará el archivo de importación de metadatos generado por el conector. Cada ejecución de un flujo de trabajo crea una carpeta. -
SERVICE_ACCOUNT_ID
: la cuenta de servicio que has configurado en la sección Roles obligatorios de este documento. La cuenta de servicio ejecuta el conector en Dataproc sin servidor. -
ADDITIONAL_CONNECTOR_ARGUMENTS
: lista de argumentos adicionales que se deben pasar al conector. Para ver ejemplos, consulta Desarrollar un conector personalizado para importar metadatos. Escribe cada argumento entre comillas dobles y sepáralos con comas. -
CONTAINER_IMAGE
: la imagen de contenedor personalizada del conector alojada en Artifact Registry. -
ENTRY_TYPES
: lista de tipos de entrada que se incluyen en el ámbito de la importación, en el formatoprojects/PROJECT_ID/locations/LOCATION_ID/entryTypes/ENTRY_TYPE_ID
. ElLOCATION_ID
debe ser la misma ubicaciónGoogle Cloud en la que importa los metadatos oglobal
. -
ASPECT_TYPES
: una lista de tipos de aspectos que están incluidos en el ámbito de la importación, en el formatoprojects/PROJECT_ID/locations/LOCATION_ID/aspectTypes/ASPECT_TYPE_ID
. ElLOCATION_ID
debe ser la misma ubicaciónGoogle Cloud en la que importa los metadatos oglobal
. -
Opcional: en el argumento
NETWORK_TAGS
, proporcione una lista de etiquetas de red. -
Opcional: En el argumento
NETWORK_URI
, proporciona el URI de la red de VPC que se conecta a la fuente de datos. Si proporcionas una red, omite el argumento de subred. -
Opcional: En el argumento
SUBNETWORK_URI
, proporciona el URI de la subred que se conecta a la fuente de datos. Si proporcionas una subred, omite el argumento de red.
En función de la cantidad de metadatos que importes, la canalización puede tardar varios minutos o más en ejecutarse. Para obtener más información sobre cómo ver el progreso, consulta Acceder a los resultados de la ejecución de un flujo de trabajo.
Una vez que el flujo de trabajo haya terminado de ejecutarse, puedes buscar los metadatos importados en Universal Catalog de Dataplex.
-
Opcional: Si quieres ejecutar la canalización según una programación, crea una programación con Cloud Scheduler. Introduce la información siguiente:
- Frecuencia: una expresión cron de Unix que define la programación para ejecutar la canalización.
- Argumento de flujo de trabajo: los argumentos de tiempo de ejecución del conector, tal como se describe en el paso anterior.
- Cuenta de servicio: la cuenta de servicio. La cuenta de servicio gestiona el programador.
gcloud
Guarda la siguiente definición de carga de trabajo como un archivo YAML:
Define variables de Bash, crea el flujo de trabajo y, de forma opcional, crea una programación para ejecutar la canalización:
Haz los cambios siguientes:
-
PROJECT_ID
: el nombre del proyecto Google Cloud de destino al que se importarán los metadatos. -
LOCATION_ID
: la ubicación de destino Google Cloud donde se ejecutarán los trabajos de importación de metadatos y de Dataproc Serverless, y donde se importarán los metadatos. -
SERVICE_ACCOUNT_ID
: la cuenta de servicio que has configurado en la sección Roles obligatorios de este documento. WORKFLOW_DEFINITION_FILE
: la ruta al archivo YAML de definición del flujo de trabajo.WORKFLOW_NAME
: nombre del flujo de trabajo.WORKFLOW_ARGUMENTS
: los argumentos de tiempo de ejecución que se deben transferir al conector. Los argumentos están en formato JSON:En Cloud Scheduler, las comillas dobles que hay dentro de la cadena entre comillas se escapan con barras inversas (\). Por ejemplo:
--message-body="{\"argument\": \"{\\\"key\\\": \\\"value\\\"}\"}"
.Haz los cambios siguientes:
-
ENTRY_GROUP_ID
: el ID del grupo de entradas en el que se importarán los metadatos. El ID del grupo de entradas puede contener letras minúsculas, números y guiones.El nombre de recurso completo de este grupo de entradas es
projects/PROJECT_ID/locations/LOCATION_ID/entryGroups/ENTRY_GROUP_ID
. -
CREATE_ENTRY_GROUP_BOOLEAN
: si quieres que la canalización cree el grupo de entradas si aún no existe en tu proyecto, asigna el valortrue
. -
BUCKET_ID
: el nombre del segmento de Cloud Storage en el que se almacenará el archivo de importación de metadatos generado por el conector. Cada ejecución de un flujo de trabajo crea una carpeta. -
ADDITIONAL_CONNECTOR_ARGUMENTS
: lista de argumentos adicionales que se deben pasar al conector. Para ver ejemplos, consulta Desarrollar un conector personalizado para importar metadatos. -
CONTAINER_IMAGE
: la imagen de contenedor personalizada del conector alojada en Artifact Registry. -
ENTRY_TYPES
: lista de tipos de entrada que se incluyen en el ámbito de la importación, en el formatoprojects/PROJECT_ID/locations/LOCATION_ID/entryTypes/ENTRY_TYPE_ID
. ElLOCATION_ID
debe ser la misma ubicaciónGoogle Cloud en la que importa los metadatos oglobal
. -
ASPECT_TYPES
: una lista de tipos de aspectos que están incluidos en el ámbito de la importación, en el formatoprojects/PROJECT_ID/locations/LOCATION_ID/aspectTypes/ASPECT_TYPE_ID
. ElLOCATION_ID
debe ser la misma ubicaciónGoogle Cloud en la que importa los metadatos oglobal
. -
Opcional: en el argumento
NETWORK_TAGS
, proporcione una lista de etiquetas de red. -
Opcional: En el argumento
NETWORK_URI
, proporciona el URI de la red de VPC que se conecta a la fuente de datos. Si proporcionas una red, omite el argumento de subred. -
Opcional: En el argumento
SUBNETWORK_URI
, proporciona el URI de la subred que se conecta a la fuente de datos. Si proporcionas una subred, omite el argumento de red.
-
CRON_SCHEDULE_EXPRESSION
: una expresión cron que define la programación para ejecutar el flujo de procesamiento. Por ejemplo, para ejecutar la programación a medianoche todos los días, usa la expresión0 0 * * *
.
-
Para ejecutar el flujo de procesamiento bajo demanda, ejecuta el flujo de trabajo:
Los argumentos del flujo de trabajo están en formato JSON, pero no se han escapado.
En función de la cantidad de metadatos que importes, el flujo de trabajo puede tardar varios minutos o más en ejecutarse. Para obtener más información sobre cómo ver el progreso, consulta Acceder a los resultados de la ejecución de un flujo de trabajo.
Una vez que el flujo de trabajo haya terminado de ejecutarse, puedes buscar los metadatos importados en Universal Catalog de Dataplex.
Terraform
Clona el
cloud-dataplex
repositorio.El repositorio incluye los siguientes archivos de Terraform:
main.tf
: define los Google Cloud recursos que se van a crear.variables.tf
: declara las variables.byo-connector.tfvars
: define las variables de tu canalización de conectividad gestionada.
Edita el archivo
.tfvars
para sustituir los marcadores de posición por la información de tu conector.Haz los cambios siguientes:
-
PROJECT_ID
: el nombre del proyecto Google Cloud de destino al que se importarán los metadatos. -
LOCATION_ID
: la ubicación de destino Google Cloud donde se ejecutarán los trabajos de importación de metadatos y de Dataproc Serverless, y donde se importarán los metadatos. -
SERVICE_ACCOUNT_ID
: la cuenta de servicio que has configurado en la sección Roles obligatorios de este documento. -
CRON_SCHEDULE_EXPRESSION
: una expresión cron que define la programación para ejecutar el flujo de procesamiento. Por ejemplo, para ejecutar la programación a medianoche todos los días, usa la expresión0 0 * * *
. -
ENTRY_GROUP_ID
: el ID del grupo de entradas en el que se importarán los metadatos. El ID del grupo de entradas puede contener letras minúsculas, números y guiones.El nombre de recurso completo de este grupo de entradas es
projects/PROJECT_ID/locations/LOCATION_ID/entryGroups/ENTRY_GROUP_ID
. -
CREATE_ENTRY_GROUP_BOOLEAN
: si quieres que la canalización cree el grupo de entradas si aún no existe en tu proyecto, asigna el valortrue
. -
BUCKET_ID
: el nombre del segmento de Cloud Storage en el que se almacenará el archivo de importación de metadatos generado por el conector. Cada ejecución de un flujo de trabajo crea una carpeta. -
ADDITIONAL_CONNECTOR_ARGUMENTS
: lista de argumentos adicionales que se deben pasar al conector. Para ver ejemplos, consulta Desarrollar un conector personalizado para importar metadatos. Escribe cada argumento entre comillas dobles y sepáralos con comas. -
CONTAINER_IMAGE
: la imagen de contenedor personalizada del conector alojada en Artifact Registry. -
ENTRY_TYPES
: lista de tipos de entrada que se incluyen en el ámbito de la importación, en el formatoprojects/PROJECT_ID/locations/LOCATION_ID/entryTypes/ENTRY_TYPE_ID
. ElLOCATION_ID
debe ser la misma ubicaciónGoogle Cloud en la que importa los metadatos oglobal
. -
ASPECT_TYPES
: una lista de tipos de aspectos que están incluidos en el ámbito de la importación, en el formatoprojects/PROJECT_ID/locations/LOCATION_ID/aspectTypes/ASPECT_TYPE_ID
. ElLOCATION_ID
debe ser la misma ubicaciónGoogle Cloud en la que importa los metadatos oglobal
. -
Opcional: en el argumento
NETWORK_TAGS
, proporcione una lista de etiquetas de red. -
Opcional: En el argumento
NETWORK_URI
, proporciona el URI de la red de VPC que se conecta a la fuente de datos. Si proporcionas una red, omite el argumento de subred. -
Opcional: En el argumento
SUBNETWORK_URI
, proporciona el URI de la subred que se conecta a la fuente de datos. Si proporcionas una subred, omite el argumento de red.
-
Inicializa Terraform:
terraform init
Valida Terraform con tu archivo
.tfvars
:terraform plan --var-file=CONNECTOR_VARIABLES_FILE.tfvars
Sustituye
CONNECTOR_VARIABLES_FILE
por el nombre del archivo de definiciones de variables.Despliega Terraform con tu archivo
.tfvars
:terraform apply --var-file=CONNECTOR_VARIABLES_FILE.tfvars
Terraform crea un flujo de trabajo y una tarea de Cloud Scheduler en el proyecto especificado. Workflows ejecuta el flujo de procesamiento según la programación que especifiques.
En función de la cantidad de metadatos que importes, el flujo de trabajo puede tardar varios minutos o más en ejecutarse. Para obtener más información sobre cómo ver el progreso, consulta Acceder a los resultados de la ejecución de un flujo de trabajo.
Una vez que el flujo de trabajo haya terminado de ejecutarse, puedes buscar los metadatos importados en Universal Catalog de Dataplex.
Ver registros de tarea
Usa Cloud Logging para ver los registros de una canalización de conectividad gestionada. La carga útil del registro incluye un enlace a los registros del trabajo por lotes de Dataproc Serverless y del trabajo de importación de metadatos, según corresponda. Para obtener más información, consulta Ver registros de flujo de trabajo.
Solución de problemas
Prueba estas sugerencias para solucionar el problema:
- Configura el nivel de registro de la tarea de importación de la tarea de metadatos para usar el registro de nivel de depuración en lugar del registro de nivel de información.
- Revisa los registros de la tarea por lotes de Dataproc Serverless (para las ejecuciones del conector) y de la tarea de importación de metadatos. Para obtener más información, consulta los artículos Consultar registros de Spark de Dataproc sin servidor y Consultar registros de tareas de metadatos.
- Si no se puede importar una entrada mediante la canalización y el mensaje de error no proporciona suficiente información, prueba a crear una entrada personalizada con los mismos detalles en un grupo de entradas de prueba. Para obtener más información, consulta el artículo Crear una entrada personalizada.
Siguientes pasos
- Información sobre la gestión de metadatos en Dataplex Universal Catalog
- Desarrollar un conector personalizado para importar metadatos