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:jira-oauth-source"
      parameters:
        .
        .
        .
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Jira oauth Source Kamelet Description

Authentication methods

This Kamelet uses OAuth authentication to connect to JIRA. You need to provide:

  • OAuth access token generated by the JIRA server

  • OAuth verification code

  • Consumer key for OAuth application

  • Private key for OAuth authentication

  • JIRA instance URL

Output format

The Kamelet receives notifications about new issues from JIRA and produces the issue data in JSON format.

Configuration

The Kamelet requires the following parameters:

  • jiraUrl: The URL of your instance of JIRA

  • accessToken: The access token generated by the JIRA server

  • verificationCode: The verification code generated by the JIRA server

  • consumerKey: The consumer key from JIRA settings

  • privateKey: The private key generated by the user to encrypt the communication

  • jql: The JQL query to filter issues

Usage example

apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: jira-oauth-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: jira-oauth-source
    properties:
      jiraUrl: "http://my_jira.com:8081"
      accessToken: "{{access-token}}"
      verificationCode: "{{verification-code}}"
      consumerKey: "{{consumer-key}}"
      privateKey: "{{private-key}}"
      jql: "project = TEST"
  sink:
    ref:
      kind: Service
      apiVersion: v1
      name: my-service

Kamelet source file

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

Back to top