Google Pubsub Source
Provided by: "Apache Software Foundation"
Support Level for this Kamelet is: "Stable"
Consume messages from Google Cloud Pub/Sub.
If you specify the serviceAccountKey
property, you must base64 encode it before you pass it as a parameter.
Configuration Options
The following table summarizes the configuration options available for the google-pubsub-source
Kamelet:
Property | Name | Description | Type | Default | Example |
---|---|---|---|---|---|
Project Id | Required The Google Cloud Pub/Sub Project ID. | string | |||
Subscription Name | Required The subscription name. | string | |||
Concurrent Consumers | The number of parallel streams to consume from the subscription. | integer | 1 | ||
Max Messages Per Poll | The maximum number of messages to receive from the server in a single API call. | integer | 1 | ||
Service Account Key | The service account key to use as credentials for the Pub/Sub publisher/subscriber. You must encode this value in base64. | binary | |||
Synchronous Pull | Specifies to synchronously pull batches of messages. | boolean | false |
Dependencies
At runtime, the google-pubsub-source
Kamelet relies upon the presence of the following dependencies:
-
camel:kamelet
-
camel:google-pubsub
-
camel:jackson
Camel JBang usage
Prerequisites
-
You’ve installed JBang.
-
You have executed the following command:
jbang app install camel@apache/camel
Supposing you have a file named route.yaml with this content:
- route:
from:
uri: "kamelet:timer-source"
parameters:
period: 10000
message: 'test'
steps:
- to:
uri: "kamelet:log-sink"
You can now run it directly through the following command
camel run route.yaml
Camel K Environment Usage
This section describes how you can use the google-pubsub-source
.
Knative source
You can use the google-pubsub-source
Kamelet as a Knative source by binding it to a Knative object.
apiVersion: camel.apache.org/v1
kind: KameletBinding
metadata:
name: google-pubsub-source-binding
spec:
source:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1
name: google-pubsub-source
properties:
projectId: The Project Id
subscriptionName: The Subscription Name
sink:
ref:
kind: Channel
apiVersion: messaging.knative.dev/v1
name: mychannel
Prerequisite
You have Camel K installed on the cluster.
Procedure for using the cluster CLI
-
Save the
google-pubsub-source-binding.yaml
file to your local drive, and then edit it as needed for your configuration. -
Run the source by using the following command:
kubectl apply -f google-pubsub-source-binding.yaml
Procedure for using the Kamel CLI
Configure and run the source by using the following command:
kamel bind channel:mychannel -p "source.projectId=The Project Id" -p "source.subscriptionName=The Subscription Name" google-pubsub-source
This command creates the KameletBinding in the current namespace on the cluster.
Kafka source
You can use the google-pubsub-source
Kamelet as a Kafka source by binding it to a Kafka topic.
apiVersion: camel.apache.org/v1
kind: KameletBinding
metadata:
name: google-pubsub-source-binding
spec:
source:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1
name: google-pubsub-source
properties:
projectId: The Project Id
subscriptionName: The Subscription Name
sink:
ref:
kind: KafkaTopic
apiVersion: kafka.strimzi.io/v1beta1
name: my-topic
Prerequisites
-
You’ve installed Strimzi.
-
You’ve created a topic named
my-topic
in the current namespace. -
You have Camel K installed on the cluster.
Procedure for using the cluster CLI
-
Save the
google-pubsub-source-binding.yaml
file to your local drive, and then edit it as needed for your configuration. -
Run the source by using the following command:
kubectl apply -f google-pubsub-source-binding.yaml
Procedure for using the Kamel CLI
Configure and run the source by using the following command:
kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic -p "source.projectId=The Project Id" -p "source.subscriptionName=The Subscription Name" google-pubsub-source
This command creates the KameletBinding in the current namespace on the cluster.