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 an asterisk (*) are mandatory.

Dependencies

At runtime, the `github-source Kamelet relies upon the presence of the following dependencies:

  • camel:jackson

  • camel:github

  • camel:kamelet

Usage

This section describes how you can use the github-source.

Knative Source

You can use the github-source Kamelet as a 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

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the github-source-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f github-source-binding.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following 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 command creates the KameletBinding in the current namespace on the cluster.

Kafka Source

You can use the github-source Kamelet as a 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

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

  1. Save the github-source-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f github-source-binding.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following 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 command creates the KameletBinding in the current namespace on the cluster.