Update wiki Home page for jira-update-issue-sink

gitea_admin 2026-03-11 14:37:20 +00:00
parent 641c5df360
commit c220c9cfd8

57
Home.md

@ -1,21 +1,50 @@
# Deploy the Project on CamelX Platform # Jira Update Issue Sink
Deploy on CamelX Platform in three steps Update fields of an existing issue in Jira.
## Step 1: Create a release The Kamelet expects the following headers to be set:
From the project space, click on **"Create a release"**
The new version is automatically available in the list - `issueKey` / `ce-issueKey`: as the issue code in Jira.
## Step 2: Deploy - `issueTypeName` / `ce-issueTypeName`: as the name of the issue type (example: Bug, Enhancement).
Click on **"Deploy"**
- **Version:** Select the desired release - `issueSummary` / `ce-issueSummary`: as the title or summary of the issue.
- **Environment:** Choose `Development`, `Staging`, or `Production`
- **Configuration:** Select the configuration source
- **Resources:** Set CPU and Memory
## Step 3: Expose - `issueAssignee` / `ce-issueAssignee`: as the user assigned to the issue (Optional).
Enable **"Expose"**
Choose an **API Gateway** (Internal, Public, etc.) - `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.
## Metadata
| Property | Value |
|----------|-------|
| Type | sink |
| Group | JIRA |
| Namespace | JIRA |
| Support Level | Stable |
| Provider | Apache Software Foundation |
## Properties
| Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `jiraUrl` | string | ✓ | | The URL of your instance of Jira |
| `username` | string | | | The username to access Jira |
| `password` | string | | | The password to access Jira |
| `personal-token` | string | | | Personal Token |
## Dependencies
- `camel:core`
- `camel:jackson`
- `camel:jira`
- `camel:kamelet`
- `mvn:com.fasterxml.jackson.datatype:jackson-datatype-joda:2.12.5`