Jira
Jira is a project management tool for software development, product
management, and bug tracking. You can use Amazon Kendra to index your
Jira projects, issues, comments, attachments, worklogs, and statuses.
Amazon Kendra currently only supports Jira Cloud.
You can connect Amazon Kendra to your Jira data source using either the
Amazon Kendra console or the JiraConfiguration API. For a list of features supported by each,
see Supported features.
For troubleshooting your Amazon Kendra Jira data source connector, see Troubleshooting data sources.
Supported features
Amazon Kendra Jira data source connector supports the following
features:
Prerequisites
Before you can use Amazon Kendra to index your Jira data source,
make these changes in your Jira and AWS accounts.
In Jira, make sure you have:
-
Created Jira API token authentication credentials that include a
Jira ID (user name or email) and a Jira credential (Jira API token). See Atlassian documentation on managing API tokens.
-
Noted the Jira account URL from your Jira account
settings. For example,
https://company.atlassian.net/
.
-
Checked each document is unique in Jira and across other
data sources you plan to use for the same index. Each data source that you
want to use for an index must not contain the same document across the data
sources. Document IDs are global to an index and must be unique per index.
In your AWS account, make sure you
have:
-
Created
an Amazon Kendra index and, if using the API, noted the index
ID.
-
Created an IAM role for your data source and, if
using the API, noted the ARN of the IAM role.
If you change your authentication type and credentials, you must
update your IAM role to access the correct AWS Secrets Manager secret ID.
-
Stored your Jira authentication credentials in an
AWS Secrets Manager secret and, if using the API, noted the ARN of the
secret.
We recommend that you regularly refresh or rotate your credentials
and secret. Provide only the necessary access level for your own security.
We do not recommend that you re-use
credentials and secrets across data sources, and connector versions 1.0 and
2.0 (where applicable).
If you don’t have an existing IAM role or secret, you can use the
console to create a new IAM role and Secrets Manager secret when you
connect your Jira data source to Amazon Kendra. If you are using the
API, you must provide the ARN of an existing IAM role and Secrets Manager secret, and an index ID.
Connection instructions
To connect Amazon Kendra to your Jira data source, you must provide
the necessary details of your Jira data source so that Amazon Kendra can access
your data. If you have not yet configured Jira for Amazon Kendra,
see Prerequisites.
- Console
-
To connect Amazon Kendra to
Jira
-
Sign in to the AWS Management Console and open the Amazon Kendra console.
-
From the left navigation pane, choose Indexes and then choose the index you want to use from the list of indexes.
You can choose to configure or edit your User access control settings under Index settings.
-
On the Getting started page, choose Add data source.
-
On the Add data source page, choose Jira connector, and then choose Add connector.
-
On the Specify data source details page, enter the following information:
-
In Name and description, for Data source name—Enter a name for your data source. You can include hyphens but not spaces.
-
(Optional) Description—Enter an optional description for your data source.
-
In Default language—Choose a language to filter your documents for the index. Unless you specify otherwise,
the language defaults to English. Language specified in the document metadata overrides the selected language.
-
In Tags, for Add new tag—Include optional tags to search and filter your resources or track your AWS costs.
-
Choose Next.
-
On the Define access and security page,
enter the following information:
-
Jira Account URL—Enter
your Jira Account URL. For example:
https://company.atlassian.net/
.
-
AWS Secrets Manager secret—Choose an existing secret or create a new
Secrets Manager secret to store your Jira authentication
credentials. If you choose to create a new secret an AWS Secrets Manager
secret window opens.
-
Enter following information in the
Create an AWS
Secrets Manager secret
window:
-
Secret name—A
name for your secret. The prefix
‘AmazonKendra-Jira-’ is
automatically added to your secret name.
-
For Jira
ID—Enter the Jira user name or
email.
-
For
Password/Token—Enter
the Jira API token you created from your
Jira account.
-
Choose Save.
-
Virtual Private Cloud (VPC)—You can choose to use a VPC. If
so, you must add Subnets and VPC security groups.
-
IAM role—Choose an existing IAM
role or create a new IAM role to access your repository credentials and index content.
IAM roles used for indexes cannot be used for data sources. If you are unsure
if an existing role is used for an index or FAQ, choose Create a new role to avoid
errors.
-
Choose Next.
-
On the Configure sync settings page,
enter the following information:
-
Select which Jira projects to
index—The Jira
entities or content types you want to crawl.
-
Statuses, Additional
elements, and Issue
types—Select content to refine the
scope of your index.
-
Change log—Select to
update your index instead of syncing all your
files.
-
Regex patterns—Regular
expression patterns to include or exclude certain files.
You can add up to 100 patterns.
-
In Sync run schedule, for
Frequency—Choose how
often Amazon Kendra will sync with your data
source.
-
Choose Next.
-
On the Set field mappings page, enter the
following information:
-
For Project,
Issue,
Comment,
Attachment,
Worklog—Select from the
Amazon Kendra generated default data source
fields you want to map to your index.
-
Add field—To add custom data
source fields to create an index field name to map to
and the field data type.
-
Choose Next.
-
On the Review and create page, check that
the information you have entered is correct and then select
Add data source. You can also choose to edit your information from this page.
Your data source will appear on the Data sources page after the data source has been
added successfully.
- API
-
To connect Amazon Kendra to
Jira
You must specify the following using the JiraConfiguration API:
-
Data source
URL—Specify your Jira account URL. For
example,
company.atlassian.net
.
-
Secret Amazon Resource Name
(ARN)—Provide the Amazon Resource
Name (ARN) of an Secrets Manager secret that contains the
authentication credentials for your Jira account.
The secret is stored in a JSON structure with the following keys:
{
"jiraId": "Jira user name or email
",
"jiraCredential": "Jira API token
"
}
We recommend that you regularly refresh or rotate your credentials
and secret. Provide only the necessary access level for your own security.
We do not recommend that you re-use
credentials and secrets across data sources, and connector versions 1.0 and
2.0 (where applicable).
-
IAM role—Specify RoleArn
when you call CreateDataSource
to provide an IAM role with permissions to access
your Secrets Manager secret and to call the required public
APIs for the Jira connector and Amazon Kendra.
For more information, see IAM roles for Jira
data sources.
You can also add the following optional features:
-
Virtual Private Cloud
(VPC)—Specify VpcConfiguration
as
part of the data source configuration. See Configuring
Amazon Kendra to use a VPC.
-
Change log—Whether
Amazon Kendra should use the Jira data
source change log mechanism to determine if a document must be
updated in the index.
Use the change log if you don’t want Amazon Kendra
to scan all of the documents. If your change log is large,
it might take Amazon Kendra less time to scan the
documents in the Jira data source than to
process the change log. If you are syncing your Jira
data source with your index for the first time, all documents are scanned.
-
Inclusion and exclusion
filters—You can specify whether to include or
exclude certain files.
Most data sources use regular expression patterns,
which are inclusion or exclusion patterns referred to as filters.
If you specify an inclusion filter, only content that
matches the inclusion filter is indexed. Any document that
doesn’t match the inclusion filter isn’t indexed. If you
specify an inclusion and exclusion filter, documents that
match the exclusion filter are not indexed, even if they
match the inclusion filter.
-
Comment, attachments, and work logs—You
can specify whether to crawl certain comments, attachments, and work logs of issues.
-
Projects, Issues, Statuses—You
can specify whether to crawl certain project IDs, issue types, and
statuses.
-
User context filtering and access control—Amazon Kendra
crawls the access control list (ACL) for your documents,
if you have an ACL for your documents. The ACL
information is used to filter search results based on the user or their
group access to documents. For more information, see User context
filtering.
-
Field mappings—Choose to map your Jira
data source fields to your
Amazon Kendra index fields. For more information, see
Mapping data
source fields.
The document body field or the document body equivalent for your documents is required
in order for Amazon Kendra to search your documents. You must map your document body
field name in your data source to the index field name _document_body
. All other
fields are optional.
Learn more
To learn more about integrating Amazon Kendra with your Jira data
source, see: