jira update issue sink Jira Update Issue Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Update fields of an existing issue in Jira.

The Kamelet expects the following headers to be set:

  • issueKey / ce-issueKey: as the issue code in Jira.

  • issueTypeName / ce-issueTypeName: as the name of the issue type (example: Bug, Enhancement).

  • issueSummary / ce-issueSummary: as the title or summary of the issue.

  • issueAssignee / ce-issueAssignee: as the user assigned to the issue (Optional).

  • issuePriorityName / ce-issuePriorityName: as the priority name of the issue (example: Critical, Blocker, Trivial) (Optional).

  • issueComponents / ce-issueComponents: as list of string with the valid component names (Optional).

  • issueDescription / ce-issueDescription: as the issue description (Optional).

The issue description can be set from the body of the message or the issueDescription/ce-issueDescription in the header, however the body takes precedence.

To authenticate a username/password or personal token must be defined. We recommend to use personal token as it is a safer way to get access to Jira.

Configuration Options

The following table summarizes the configuration options available for the jira-update-issue-sink Kamelet:

Property Name Description Type Default Example

jiraUrl

Jira URL

Required The URL of your instance of Jira.

string

http://my_jira.com:8081

password

Password

The password to access Jira.

string

personal-token

Personal Token

Personal Token.

string

username

Username

The username to access Jira.

string

Dependencies

At runtime, the jira-update-issue-sink Kamelet relies upon the presence of the following dependencies:

  • camel:core

  • 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-update-issue-sink.

Knative sink

You can use the jira-update-issue-sink Kamelet as a Knative sink by binding it to a Knative object.

jira-update-issue-sink-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: jira-update-issue-sink-pipe
spec:
  source:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: jira-update-issue-sink
    properties:
      jiraUrl: http://my_jira.com:8081

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the jira-update-issue-sink-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f jira-update-issue-sink-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind jira-update-issue-sink -p "sink.jiraUrl=\http://my_jira.com:8081" channel:mychannel

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

Kafka sink

You can use the jira-update-issue-sink Kamelet as a Kafka sink by binding it to a Kafka topic.

jira-update-issue-sink-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: jira-update-issue-sink-pipe
spec:
  source:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: jira-update-issue-sink
    properties:
      jiraUrl: http://my_jira.com:8081

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-update-issue-sink-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f jira-update-issue-sink-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind jira-update-issue-sink -p "sink.jiraUrl=\http://my_jira.com:8081" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

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