github source Github Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Receive events From Github.

Configuration Options

The following table summarizes the configuration options available for the github-source Kamelet:

Property Name Description Type Default Example

oauthToken *

OAuth Token

Oauth token

string

repoName *

Repository Name

The Github Repository name

string

repoOwner *

Repository Owner

The repository owner

string

type *

Event Type

The type of event to consume. One of event, pullRequest, pullRequestComment or tag

string

"event"
Fields marked with (*) are mandatory.

Usage

This section summarizes how the github-source can be used in various contexts.

Knative Source

The github-source Kamelet can be used as Knative source by binding it to a Knative object.

github-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: github-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: github-source
    properties:
      oauthToken: "The OAuth Token"
      repoName: "The Repository Name"
      repoOwner: "The Repository Owner"
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

Make sure you have Camel K installed into the Kubernetes cluster you’re connected to.

Save the github-source-binding.yaml file into your hard drive, then configure it according to your needs.

You can run the source using the following command:

kubectl apply -f github-source-binding.yaml

Dependencies

The Kamelet needs the following dependencies:

  • camel:jackson

  • camel:github

  • camel:kamelet

Binding to Knative using the Kamel CLI:

The procedure described above can be simplified into a single execution of the kamel bind command:

kamel bind github-source -p "source.oauthToken=The OAuth Token" -p "source.repoName=The Repository Name" -p "source.repoOwner=The Repository Owner" channel:mychannel

This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.

Kafka Source

The github-source Kamelet can be used as Kafka source by binding it to a Kafka topic.

github-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: github-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: github-source
    properties:
      oauthToken: "The OAuth Token"
      repoName: "The Repository Name"
      repoOwner: "The Repository Owner"
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

Ensure that you’ve installed Strimzi and created a topic named my-topic in the current namespace. Make also sure you have Camel K installed into the Kubernetes cluster you’re connected to.

Save the github-source-binding.yaml file into your hard drive, then configure it according to your needs.

You can run the source using the following command:

kubectl apply -f github-source-binding.yaml

Binding to Kafka using the Kamel CLI:

The procedure described above can be simplified into a single execution of the kamel bind command:

kamel bind github-source -p "source.oauthToken=The OAuth Token" -p "source.repoName=The Repository Name" -p "source.repoOwner=The Repository Owner" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.

Kamelet source file

Have a look at the following link:

https://github.com/apache/camel-kamelets/blob/main/github-source.kamelet.yaml

Back to top