diff --git a/Home.md b/Home.md index 93a012c..53da07e 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,32 @@ -# Deploy the Project on CamelX Platform +# Jira Source -Deploy on CamelX Platform in three steps +Receive notifications about new issues from Jira. -## Step 1: Create a release -From the project space, click on **"Create a release"** +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. -The new version is automatically available in the list +## Metadata -## Step 2: Deploy -Click on **"Deploy"** +| Property | Value | +|----------|-------| +| Type | source | +| Group | JIRA | +| Namespace | JIRA | +| Support Level | Stable | +| Provider | Apache Software Foundation | -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +## Properties -## Step 3: Expose -Enable **"Expose"** +| 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 | +| `jql` | string | | | A query to filter issues. | -Choose an **API Gateway** (Internal, Public, etc.) +## Dependencies + +- `camel:jackson` +- `camel:jira` +- `camel:kamelet` +- `mvn:com.fasterxml.jackson.datatype:jackson-datatype-joda:2.12.5`