Chapter 32. Jira Add Comment Sink
Add a new comment to an existing issue in Jira.
The Kamelet expects the following headers to be set:
-
issueKey/ce-issueKey: as the issue code.
The comment is set in the body of the message.
32.1. Configuration Options
The following table summarizes the configuration options available for the jira-add-comment-sink Kamelet:
| Property | Name | Description | Type | Default | Example |
|---|---|---|---|---|---|
| jiraUrl * | Jira URL | The URL of your instance of Jira | string |
| |
| password * | Password | The password or the API Token to access Jira | string | ||
| username * | Username | The username to access Jira | string |
Fields marked with an asterisk (*) are mandatory.
32.2. Dependencies
At runtime, the jira-add-comment-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.4.redhat-00001
32.3. Usage
This section describes how you can use the jira-add-comment-sink.
32.3.1. Knative Sink
You can use the jira-add-comment-sink Kamelet as a Knative sink by binding it to a Knative object.
jira-add-comment-sink-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: jira-add-comment-sink-binding
spec:
source:
ref:
kind: KafkaTopic
apiVersion: kafka.strimzi.io/v1beta1
name: my-topic
steps:
- ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: insert-header-action
properties:
name: "issueKey"
value: "MYP-167"
sink:
ref:
kind: Channel
apiVersion: messaging.knative.dev/v1
name: mychannel
properties:
jiraUrl: "jira server url"
username: "username"
password: "password"
32.3.1.1. Prerequisite
Make sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.
32.3.1.2. Procedure for using the cluster CLI
-
Save the
jira-add-comment-sink-binding.yamlfile to your local drive, and then edit it as needed for your configuration. Run the sink by using the following command:
oc apply -f jira-add-comment-sink-binding.yaml
32.3.1.3. Procedure for using the Kamel CLI
Configure and run the sink by using the following command:
kamel bind --name jira-add-comment-sink-binding timer-source?message="The new comment"\&period=60000 --step insert-header-action -p step-0.name=issueKey -p step-0.value=MYP-167 jira-add-comment-sink?password="password"\&username="username"\&jiraUrl="jira url"
This command creates the KameletBinding in the current namespace on the cluster.
32.3.2. Kafka Sink
You can use the jira-add-comment-sink Kamelet as a Kafka sink by binding it to a Kafka topic.
jira-add-comment-sink-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: jira-add-comment-sink-binding
spec:
source:
ref:
kind: KafkaTopic
apiVersion: kafka.strimzi.io/v1beta1
name: my-topic
steps:
- ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: insert-header-action
properties:
name: "issueKey"
value: "MYP-167"
sink:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: jira-add-comment-sink
properties:
jiraUrl: "jira server url"
username: "username"
password: "password"
32.3.2.1. Prerequisites
Ensure that you’ve installed the AMQ Streams operator in your OpenShift cluster and created a topic named my-topic in the current namespace. Make also sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.
32.3.2.2. Procedure for using the cluster CLI
-
Save the
jira-add-comment-sink-binding.yamlfile to your local drive, and then edit it as needed for your configuration. Run the sink by using the following command:
oc apply -f jira-add-comment-sink-binding.yaml
32.3.2.3. Procedure for using the Kamel CLI
Configure and run the sink by using the following command:
kamel bind --name jira-add-comment-sink-binding timer-source?message="The new comment"\&period=60000 --step insert-header-action -p step-0.name=issueKey -p step-0.value=MYP-167 jira-add-comment-sink?password="password"\&username="username"\&jiraUrl="jira url"
This command creates the KameletBinding in the current namespace on the cluster.
32.4. Kamelet source file
https://github.com/openshift-integration/kamelet-catalog/jira-add-comment-sink.kamelet.yaml
