IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Elastic Google Drive connector reference Elastic Microsoft SQL connector reference »
Elastic Docs › ›Elastic connectors

Elastic Jira connector reference

edit

Elastic Jira connector reference

edit

The Elastic Jira connector is a connector for Atlassian Jira.

Availability and prerequisites

edit

This connector is available as a native connector on Elastic Cloud, as of 8.9.1.

This connector is available as a connector client from the Elastic connector framework. This connector client is compatible with Elastic versions 8.7.0+. To use this connector, satisfy all connector client requirements.

Usage

edit

To use this connector as a native connector, see Native connectors logo cloud (managed service).

To use this connector as a connector client, see Connector clients.

For additional operations, see Using connectors.

Compatibility

edit
  • Jira Cloud or Jira Server versions 7 or later are compatible with Elastic connector frameworks.
  • Jira Data Center editions are not currently supported.

Configuration

edit

When using the connector client workflow, initially these fields will use the default configuration set in the connector source code. These are set in the get_default_configuration function definition.

These configurable fields will be rendered with their respective labels in the Kibana UI. Once connected, you’ll be able to update these values in Kibana.

The following configuration fields are required to set up the connector:

data_source
Dropdown to determine Jira platform type: jira_cloud or jira_server. Default value is jira_cloud.
username
The username of the account for Jira server.
password
The password of the account to be used for Jira server.
account_email
The account email for Jira cloud.
api_token
The API Token to authenticate with Jira cloud.
jira_url

The domain where Jira is hosted. Examples:

projects

Comma-separated list of Project Keys to fetch data from Jira server or cloud. If the value is * the connector will fetch data from all projects present in the configured projects. Default value is *. Examples:

  • EC, TP
  • *
ssl_enabled
Whether SSL verification will be enabled. Default value is False.
ssl_ca

Content of SSL certificate. Note: In case of ssl_enabled is False, the ssl_ca value will be ignored. Example certificate: 

-----BEGIN CERTIFICATE-----
MIID+jCCAuKgAwIBAgIGAJJMzlxLMA0GCSqGSIb3DQEBCwUAMHoxCzAJBgNVBAYT
...
7RhLQyWn2u00L7/9Omw=
-----END CERTIFICATE-----
retry_count
The number of retry attempts after failed request to Jira. Default value is 3.
concurrent_downloads
The number of concurrent downloads for fetching the attachment content. This speeds up the content extraction of attachments. Defaults to 100.
Enable document level security

Toggle to enable document level security (DLS). Only available for Atlassian Jira Cloud. When enabled, full and incremental syncs will fetch access control lists for each document and store them in the _allow_access_control field. Access control syncs fetch users' access control lists and store them in a separate index.

To access user data in Jira Administration, the account you created must be granted Product Access for Jira Administration. This access needs to be provided by an administrator from the Atlassian Admin, and the access level granted should be Product Admin.

Deployment using Docker

edit

You can deploy the Jira connector as a self-managed connector client using Docker. Follow these instructions.

Step 1: Download sample configuration file

Download the sample configuration file. You can either download it manually or run the following command:

curl https://raw.githubusercontent.com/elastic/connectors/main/config.yml.example --output ~/connectors-config/config.yml

Remember to update the --output argument value if your directory name is different, or you want to use a different config file name.

Step 2: Update the configuration file for your self-managed connector

Update the configuration file with the following settings to match your environment:

  • elasticsearch.host
  • elasticsearch.api_key
  • connectors

If you’re running the connector service against a Dockerized version of Elasticsearch and Kibana, your config file will look like this:

# When connecting to your cloud deployment you should edit the host value
elasticsearch.host: http://host.docker.internal:9200
elasticsearch.api_key: <ELASTICSEARCH_API_KEY>

connectors:
  -
    connector_id: <CONNECTOR_ID_FROM_KIBANA>
    service_type: jira
    api_key: <CONNECTOR_API_KEY_FROM_KIBANA>

Using the elasticsearch.api_key is the recommended authentication method. However, you can also use elasticsearch.username and elasticsearch.password to authenticate with your Elasticsearch instance.

Note: You can change other default configurations by simply uncommenting specific settings in the configuration file and modifying their values.

Step 3: Run the Docker image

Run the Docker image with the Connector Service using the following command:

docker run \
-v ~/connectors-config:/config \
--network "elastic" \
--tty \
--rm \
docker.elastic.co/enterprise-search/elastic-connectors:8.10.4.0 \
/app/bin/elastic-ingest \
-c /config/config.yml

Refer to DOCKER.md in the elastic/connectors repo for more details.

Find all available Docker images in the official registry.

Documents and syncs

edit

The connector syncs the following objects and entities:

  • Projects

    • Includes metadata such as description, project key, project type, lead name, etc.

  • Issues

    • All types of issues including Task, Bug, Sub-task, Enhancement, Story, etc.
    • Includes metadata such as issue type, parent issue details, fix versions, affected versions, resolution, attachments, comments, sub-task details, priority, custom fields, etc.
  • Attachments

Note: Archived projects and issues are not indexed.

  • Content of files bigger than 10 MB won’t be extracted.
  • Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.

Sync rules

edit

Basic sync rules are identical for all connectors and are available by default.

This connector supports advanced sync rules for remote filtering. These rules cover complex query-and-filter scenarios that cannot be expressed with basic sync rules. Advanced sync rules are defined through a source-specific DSL JSON snippet.

Advanced sync rules example

edit

Example 1: Queries to index content based on status of Jira issues.

[
  {
    "query": "project = Collaboration AND status = 'In Progress'"
  },
  {
    "query": "status IN ('To Do', 'In Progress', 'Closed')"
  }
]

Example 2: Query to index data based on priority of issues for given projects.

[
  {
    "query": "priority in (Blocker, Critical) AND project in (ProjA, ProjB, ProjC)"
  }
]

Example 3: Query to index data based on assignee and created time.

[
  {
    "query": "assignee is EMPTY and created < -1d"
  }
]

Document level security

edit

Document level security (DLS) is only available for Atlassian Jira Cloud.

Document level security (DLS) enables you to restrict access to documents based on a user’s permissions. Refer to configuration on this page for how to enable DLS for this connector.

Enabling DLS for your connector will cause a significant performance degradation, as the API calls to the data source required for this functionality are rate limited. This impacts the speed at which your content can be retrieved.

Refer to DLS in Search Applications to learn how to ingest data from a connector with DLS enabled, when building a search application. The example uses SharePoint Online as the data source, but the same steps apply to every connector.

Content Extraction

edit

See Content extraction.

Connector client operations

edit

End-to-end testing

edit

The connector framework enables operators to run functional tests against a real data source. Refer to Connector testing for more details.

To perform E2E testing for the Jira connector, run the following command:

$ make ftest NAME=jira

For faster tests, add the DATA_SIZE=small flag:

make ftest NAME=jira DATA_SIZE=small

Known issues

edit

  • Missing configuration fields

    Due to a bug introduced in 8.10.0, the Jira native connector is missing configuration fields. This will lead to the error Connector for <connector_id> has missing configuration fields: use_document_level_security.

    • This issue will be fixed in 8.11.0. We recommend upgrading to 8.11.0. Otherwise, you can manually add the missing configuration field via the Dev Tools Console.

      Expand for workaround steps

      To workaround the issue, follow these steps:

      1. Create a new connector with identical configuration as the existing connector.

      2. Using the Kibana Dev Tools Console, execute a query to add the missing configuration fields to the new connector.

        • Example: Adding the use_document_level_security configuration field to a Jira native connector:

          POST /.elastic-connectors/_update/<connector_id>
{
  "doc": {
    "configuration": {
      "use_document_level_security": {
        "display": "toggle",
        "depends_on": [
          {
            "field": "data_source",
            "value": "jira_cloud"
          }
        ],
        "label": "Enable document level security",
        "order": 12,
        "tooltip": "Document level security ensures identities and permissions set in Jira are maintained in Elasticsearch. This enables you to restrict and personalize read-access users and groups have to documents in this index. Access control syncs ensure this metadata is kept up to date in your Elasticsearch documents.",
        "type": "bool",
        "value": false
      }
    }
  }
}
      3. Delete the old connector.

  • Enabling document-level security impacts performance.

    Enabling DLS for your connector will cause a significant performance degradation, as the API calls to the data source required for this functionality are rate limited. This impacts the speed at which your content can be retrieved.

Refer to Known issues for a list of known issues for all connectors.

Troubleshooting

edit

See Troubleshooting.

Security

edit

See Security.

Framework and source

edit

This connector is included in the Elastic connector framework.

View the source code for this connector (branch 8.10, compatible with Elastic 8.10).

« Elastic Google Drive connector reference Elastic Microsoft SQL connector reference »