GCP Pub Sub Integration with Orkes Conductor

To use the Event task, Event Handler, or enable Change Data Capture (CDC) in Orkes Conductor, you must integrate your Conductor cluster with the necessary message brokers. This guide explains how to integrate GCP Pub Sub with Orkes Conductor to publish and receive messages from queues. Here’s an overview:

1. Get the required credentials from GCP Pub Sub.
2. Configure a new GCP Pub Sub integration in Orkes Conductor.
3. Set access limits to the message broker to govern which applications or groups can use them.

Step 1: Get the GCP credentials

To integrate GCP Pub Sub with Orkes Conductor, retrieve the following credentials from the Google Cloud Console:

• Project ID
• Subscription ID
• Service account JSON

Get the project ID

To get the project ID:

1. Sign in to the Google Cloud Console.
2. Create a new project or select an existing one.
3. Get the Project ID from the dashboard.

For more information, refer to the official documentation on creating and managing projects in GCP.

Get the subscription ID

The subscription ID is retrieved along with an associated topic.

To get the subscription ID:

1. Go to Solutions > All products > Categories - Analytics > Pub/Sub from the left navigation menu on your GCP console.
2. Select Topics and create a topic if you don’t have one.
3. Select Subscriptions, and create a new subscription or select an existing one.
4. Copy the Subscription ID.

Get the service account JSON

To get the service account JSON:

1. Go to IAM & Admin > Service Accounts from the left menu on your GCP console.
2. Create a new service or select an existing one.
3. In the KEYS tab, select ADD KEY > Create new key.

4. Select the key type as JSON.
5. Select Create to download the JSON file.

To use GCP Pub Sub with Orkes Conductor, you must enable the Cloud Pub/Sub API from the GCP console.

Enable Cloud Pub/Sub API​

To enable Cloud Pub/Sub API:

1. Go to APIs & Services > Enabled APIs & services from the left menu on your GCP console.
2. Select + ENABLE APIS AND SERVICES.

3. In the API Library, search for Cloud Pub/Sub API.

4. Select ENABLE.

Once enabled, the GCP Pub/Sub API is ready for use with your GCP project.

Step 2: Add an integration for GCP Pub Sub

After obtaining the credentials, add a GCP Pub Sub integration to your Conductor cluster.

To create a GCP Pub Sub integration:

1. Go to Integrations from the left navigation menu on your Conductor cluster.
2. Select + New integration.
3. In the Message Broker section, choose GCP Pub Sub.
4. Select + Add and enter the following parameters:

Paremeters	Description
Integration name	A name for the integration.
Project ID	The Project ID retrieved from the GCP console.
Subscription ID	The Subscription ID retrieved from the GCP console.
Upload Service Account JSON	Upload the service account JSON file, which is a key file containing the credentials for authenticating the Orkes Conductor cluster with the GCP services.
Description	A description of the integration.

5. (Optional) Toggle the Active button off if you don’t want to activate the integration instantly.
6. Select Save.

Step 3: Set access limits to integration

Once the integration is configured, set access controls to manage which applications or groups can use the message broker.

To provide access to an application or group:

1. Go to Access Control > Applications or Groups from the left navigation menu on your Conductor cluster.
2. Create a new group/application or select an existing one.
3. In the Permissions section, select + Add Permission.
4. In the Integration tab, select the required message broker and toggle the necessary permissions.

The group or application can now access the message broker according to the configured permissions.

Next steps

With the integration in place, you can now:

• Create Event Handlers.
• Configure Event tasks.
• Enable Change Data Capture (CDC) to send workflow state changes to message brokers.