jira oauth source Jira oauth Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Receive notifications about new issues from Jira through OAuth authentication.

Configuration Options

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

Property Name Description Type Default Example

accessToken

Username

Required The access token generated by the Jira server.

string

consumerKey

Password

Required The consumer key from Jira settings.

string

jiraUrl

Jira URL

Required The URL of your instance of Jira.

string

http://my_jira.com:8081

jql

JQL

Required A query to filter issues.

string

project=MyProject

privateKey

Password

Required The private key generated by the client to encrypt the conversation to the server.

string

verificationCode

Password

Required The verification code from Jira generated in the first step of the authorization proccess.

string

Dependencies

At runtime, the jira-oauth-source Kamelet relies upon the presence of the following dependencies:

  • camel:jackson

  • camel:jira

  • camel:kamelet

  • mvn:com.fasterxml.jackson.datatype:jackson-datatype-joda:2.12.5

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 jira-oauth-source.

Knative source

You can use the jira-oauth-source Kamelet as a Knative source by binding it to a Knative object.

jira-oauth-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: jira-oauth-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: jira-oauth-source
    properties:
      accessToken: The Username
      consumerKey: The Password
      jiraUrl: http://my_jira.com:8081
      jql: project=MyProject
      privateKey: The Password
      verificationCode: The Password
  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 jira-oauth-source-pipe.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 jira-oauth-source-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind jira-oauth-source -p "source.accessToken=The Username" -p "source.consumerKey=The Password" -p "source.jiraUrl=\http://my_jira.com:8081" -p "source.jql=project=MyProject" -p "source.privateKey=The Password" -p "source.verificationCode=The Password" channel:mychannel

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kafka source

You can use the jira-oauth-source Kamelet as a Kafka source by binding it to a Kafka topic.

jira-oauth-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: jira-oauth-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: jira-oauth-source
    properties:
      accessToken: The Username
      consumerKey: The Password
      jiraUrl: http://my_jira.com:8081
      jql: project=MyProject
      privateKey: The Password
      verificationCode: The Password
  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 jira-oauth-source-pipe.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 jira-oauth-source-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind jira-oauth-source -p "source.accessToken=The Username" -p "source.consumerKey=The Password" -p "source.jiraUrl=\http://my_jira.com:8081" -p "source.jql=project=MyProject" -p "source.privateKey=The Password" -p "source.verificationCode=The Password" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This command creates the Kamelet Pipe in the current namespace on the cluster.