> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Google Pub/Sub Connector | OpenMetadata Messaging Integration

> Connect Google Cloud Pub/Sub to OpenMetadata with our comprehensive connector guide. Set up topic metadata ingestion, schema registry, and subscription configuration in minutes.

export const MetadataIngestionUi = ({connector, selectServicePath, addNewServicePath, serviceConnectionPath}) => {
  return <>
    <p>
      To ingest metadata from your sources, you need to create a service connection.
      The service connects your source system with OpenMetadata. Once you create
      a service, you can use it to configure your ingestion workflows.<br />
      <br />
      To create a service connection and ingest your metadata, follow the steps below:
    </p>
      <Steps>
      <Step title="Select the Service">
        <ol>
          <li>
            On the left navigation bar, click <strong>Settings</strong>.
          </li>
          <li>
            On the next page, click <strong>Services</strong>, and then select the service.
            <img src="/public/images/connectors/visit-services-page.png" alt="Visit Services Page" />
          </li>
        </ol>
      </Step>

      <Step title="Create a New Service">
        To add a new service connection, click <strong>Add New Service</strong>.
        <img src="/public/images/connectors/create-new-service.png" alt="Create a new Service" />
      </Step>

      <Step title="Select the Connector">
        Select <strong>{connector}</strong> as the service type and click <strong>Next</strong>.

        {selectServicePath && <img src={selectServicePath} alt="Select Service" />}
      </Step>

      <Step title="Name and Describe the Service">
        Enter a unique <strong>Service Name</strong> and <strong>Description</strong>.
        <ul>
         <li><strong>Service Name</strong>: OpenMetadata identifies services by their service name. Enter a name that distinguishes this deployment from other services, including other {connector} services you are ingesting metadata from.</li>
        </ul>

        <Note>
          The service name cannot be changed after it is set.
       </Note>

        {addNewServicePath && <img src={addNewServicePath} alt="Add New Service" />}
      </Step>

      <Step title="Configure the Service Connection">
        Set up the connection settings required for {connector} to set up the service and start ingesting metadata from your sources. The right-hand panel displays help documentation for the selected connection type in the product UI.
        {serviceConnectionPath && <img src={serviceConnectionPath} alt="Configure Service connection" />}
      </Step>
    </Steps>
  </>;
};

export const ConnectorDetailsHeader = ({name, icon, stage, availableFeatures, unavailableFeatures = [], availableFeaturesCollate = []}) => {
  const showSubHeading = availableFeatures?.length > 0 || unavailableFeatures?.length > 0 || availableFeaturesCollate?.length > 0;
  const totalAvailableFeatures = [...availableFeatures || [], ...availableFeaturesCollate || []];
  return <div className="container">
      <div className="Heading">
        <div className="flex items-center gap-3">
          {icon && <div className="IconContainer">
              <img src={icon} alt={name} noZoom className="ConnectorIcon" />
            </div>}
          <h1 className="ConnectorName">{name}</h1>
          <span className={`StageBadge ${stage === 'PROD' ? 'prod' : 'beta'}`}>
            {stage}
          </span>
        </div>
      </div>
      {showSubHeading && <div className="SubHeading">
          <div className="FeaturesHeading">Feature List</div>
          <div className="FeaturesList">
            {totalAvailableFeatures.map(feature => <div className="FeatureTag AvailableFeature" key={feature}>
                ✓ {feature}
              </div>)}
            {unavailableFeatures.map(feature => <div className="FeatureTag UnavailableFeature" key={feature}>
                ✕ {feature}
              </div>)}
          </div>
        </div>}
    </div>;
};

<ConnectorDetailsHeader icon="/public/images/connectors/pubsub.svg" name="Google Pub/Sub" stage="BETA" availableFeatures={["Topics"]} unavailableFeatures={["Sample Data"]} />

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

<Info>
  **Supported Authentication Types:**

  * **GCP Credentials** — Google Cloud service account authentication using a service account key file or Application Default Credentials.
</Info>

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

* [Requirements](#requirements)
* [Metadata Ingestion](#metadata-ingestion)
* [Troubleshooting](/v1.13.x/connectors/messaging/pubsub/troubleshooting)

## 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.

```json theme={null}
{
  "bindings": [
    {
      "role": "roles/pubsub.viewer",
      "members": [
        "serviceAccount:<your-service-account>@<project-id>.iam.gserviceaccount.com"
      ]
    }
  ]
}
```

## Metadata Ingestion

<MetadataIngestionUi connector={"Google Pub/Sub"} selectServicePath={"/public/images/connectors/pubsub/select-service.png"} addNewServicePath={"/public/images/connectors/pubsub/add-new-service.png"} serviceConnectionPath={"/public/images/connectors/pubsub/service-connection.png"} />

# Connection Details

<Steps>
  <Step title="Connection Details">
    <Tip>
      When using a **Hybrid Ingestion Runner**, any sensitive credential fields—such as passwords, API keys, or private keys—must reference secrets using the following format:

      ```
      password: secret:/my/database/password
      ```

      This applies **only to fields marked as secrets** in the connection form (these typically mask input and show a visibility toggle icon).
      For a complete guide on managing secrets in hybrid setups, see the [Hybrid Ingestion Runner Secret Management Guide](https://docs.getcollate.io/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner#3.-manage-secrets-securely).
    </Tip>

    * **GCP Credentials**: GCP service account credentials for authenticating with Pub/Sub. Provide a service account key in JSON format, or use Application Default Credentials when running on GCP infrastructure (GCE, GKE, Cloud Run). See [Creating a GCP Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts) for details.

    * **Project ID** (optional): GCP Project ID where Pub/Sub topics are located. If not specified, the project ID is read from the service account credentials.

    * **Host and Port** (optional): Pub/Sub API endpoint URL. Defaults to `pubsub.googleapis.com`. When connecting to a local **Pub/Sub emulator**, set this to the emulator address (e.g., `localhost:8085`) and enable **Use Emulator**.

    * **Use Emulator** (optional): Connect to a local Pub/Sub emulator instead of the production service. Useful for development and testing. When enabled, `hostPort` must be set to the emulator address (not the default `pubsub.googleapis.com`).

    * **Enable Schema Registry** (optional, default: `true`): Fetch topic schemas from the Pub/Sub Schema Registry. Supports Avro and Protocol Buffer schema types. Disable if your project does not use the Schema Registry.

    * **Include Subscriptions** (optional, default: `true`): Include subscription metadata for each topic. When enabled, subscription names, acknowledgment deadlines, retention durations, push endpoints, dead letter policies, and BigQuery export configurations are captured.

    <Tip>
      When a subscription has a **BigQuery export configuration**, OpenMetadata automatically extracts lineage from the Pub/Sub topic to the target BigQuery table. Enable `includeSubscriptions` to capture this lineage.
    </Tip>

    * **Include Dead Letter Topics** (optional, default: `false`): Include dead letter topics in metadata extraction. By default, dead letter topics are detected via subscription policies and excluded to keep the topic list focused on primary business topics.

    * **Topic Filter Pattern** (optional): Regex pattern to selectively include or exclude topics by name. Use `includes` for an allow-list and `excludes` for a deny-list. Example: exclude internal topics with `excludes: ["^_.*"]`.
  </Step>

  <Step title="Test the Connection">
    Once the credentials have been added, click on *Test Connection* and *Save* the changes.

    <img src="https://mintcdn.com/openmetadata/9G75p72jJKYgvFUQ/public/images/connectors/test-connection.png?fit=max&auto=format&n=9G75p72jJKYgvFUQ&q=85&s=4ac71a56e30fa3dd1be86f82c1f07068" alt="Test Connection" width="1494" height="310" data-path="public/images/connectors/test-connection.png" />
  </Step>

  <Step title=" Configure Metadata Ingestion">
    In this step we will configure the metadata ingestion pipeline,
    Please follow the instructions below

    <img src="https://mintcdn.com/openmetadata/9SXjaLbGROaofLQU/public/images/connectors/configure-metadata-ingestion-messaging.png?fit=max&auto=format&n=9SXjaLbGROaofLQU&q=85&s=222ed11278ae33af37cdc428865a5232" alt="Configure Metadata Ingestion" width="1518" height="1164" data-path="public/images/connectors/configure-metadata-ingestion-messaging.png" />

    #### Metadata Ingestion Options

    * **Name**: This field refers to the name of ingestion pipeline, you can customize the name or use the generated name.
    * **Topic Filter Pattern (Optional)**: Use it to control whether to include topics as part of metadata ingestion.
      * **Include**: Explicitly include topics by adding a list of comma-separated regular expressions to the 'Include' field. OpenMetadata will include all topics with names matching one or more of the supplied regular expressions. All other topics will be excluded.
      * **Exclude**: Explicitly exclude topics by adding a list of comma-separated regular expressions to the 'Exclude' field. OpenMetadata will exclude all topics with names matching one or more of the supplied regular expressions. All other topics will be included.
    * **Ingest Sample Data (toggle)**: Set the 'Ingest Sample Data' toggle to ingest sample data from the topics.
    * **Enable Debug Log (toggle)**: Set the 'Enable Debug Log' toggle to set the default log level to debug.
    * **Mark Deleted Topics (toggle):** Set the 'Mark Deleted Topics' toggle to flag topics as soft-deleted if they are not present anymore in the source system.
    * **Extract Consumer Groups (toggle):** Set the 'Extract Consumer Groups' toggle to extract active consumer group metadata for each topic, including group state, members, and partition assignments.
  </Step>

  <Step title="Schedule the Ingestion and Deploy">
    Scheduling can be set up at an hourly, daily, weekly, or manual cadence. The
    timezone is in UTC. Select a Start Date to schedule for ingestion. It is
    optional to add an End Date.

    Review your configuration settings. If they match what you intended,
    click Deploy to create the service and schedule metadata ingestion.

    If something doesn't look right, click the Back button to return to the
    appropriate step and change the settings as needed.

    After configuring the workflow, you can click on Deploy to create the
    pipeline.

    <img src="https://mintcdn.com/openmetadata/j50Bw6ZBiFbbFFnF/public/images/connectors/schedule.png?fit=max&auto=format&n=j50Bw6ZBiFbbFFnF&q=85&s=24b0c2f55f803efde5fb3b3bc24ed3ae" alt="Schedule the Workflow" width="2733" height="1083" data-path="public/images/connectors/schedule.png" />
  </Step>

  <Step title="View the Ingestion Pipeline">
    Once the workflow has been successfully deployed, you can view the
    Ingestion Pipeline running from the Service Page.

    <img src="https://mintcdn.com/openmetadata/9G75p72jJKYgvFUQ/public/images/connectors/view-ingestion-pipeline.png?fit=max&auto=format&n=9G75p72jJKYgvFUQ&q=85&s=7c4e411977371617cb1312efb9f9bfee" alt="View Ingestion Pipeline" width="2733" height="1271" data-path="public/images/connectors/view-ingestion-pipeline.png" />

    <Tip>
      If AutoPilot is enabled, workflows like usage tracking, data lineage, and similar tasks will be handled automatically. Users don’t need to set up or manage them - AutoPilot takes care of everything in the system.
    </Tip>
  </Step>
</Steps>