Run the Google Pub/Sub Connector Externally

Use YAML to configure Google Cloud Pub/Sub ingestion and capture topic metadata, schema definitions, and subscription information.

In this section, we provide guides and references to use the Google Pub/Sub connector.

Supported Authentication Types:

• GCP Credentials — Google Cloud service account authentication using a service account key file or Application Default Credentials.

Configure and schedule Google Pub/Sub metadata workflows from the OpenMetadata UI:

• Requirements
• Metadata Ingestion

How to Run the Connector Externally

To run the Ingestion via the UI you’ll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment.

If, instead, you want to manage your workflows externally on your preferred orchestrator, you can check the following docs to run the Ingestion Framework anywhere.

External Schedulers

Get more information about running the Ingestion Framework Externally

Requirements

The Google Cloud service account used for ingestion needs the following IAM permissions:

Metadata Ingestion

Permission	Purpose
pubsub.topics.list	List topics in the project
pubsub.subscriptions.list	List subscriptions (for dead letter detection and subscription metadata)
pubsub.subscriptions.get	Read individual subscription details

Schema Registry (when schemaRegistryEnabled is true)

Permission	Purpose
pubsub.schemas.list	List schemas in the Schema Registry
pubsub.schemas.get	Read schema definitions (Avro, Protocol Buffer)

The built-in GCP role roles/pubsub.viewer grants all of the above permissions and is the recommended role for OpenMetadata ingestion.

Python Requirements

We have support for Python versions 3.9-3.11

To run the Google Pub/Sub ingestion, you will need to install:

pip3 install "openmetadata-ingestion[pubsub]"

Metadata Ingestion

All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to Google Pub/Sub.

In order to create and run a Metadata Ingestion workflow, we will follow the steps to create a YAML configuration able to connect to the source, process the Entities if needed, and reach the OpenMetadata server.

The workflow is modeled around the following JSON Schema

1. Define the YAML Config

2. Run with the CLI

First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run:

metadata ingest -c <path-to-yaml>

Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration, you will be able to extract metadata from different sources.