Back to source list
jira
Official
Premium

Jira

The CloudQuery Jira plugin extracts Jira information and loads it into any supported CloudQuery destination

Publisher

cloudquery

Latest version

v2.4.1

Type

Source

Platforms
Date Published

Price per 1M rows

Starting from $15

monthly free quota

1M rows

Set up process #


brew install cloudquery/tap/cloudquery

1. Download CLI and login

See installation options

2. Create source and destination configs

Plugin configuration

cloudquery sync jira.yml postgresql.yml

3. Run the sync

CloudQuery sync

Overview #

The CloudQuery Jira plugin extracts Jira information and loads it into any supported CloudQuery destination. It is based on the Jira API and the github.com/andygrunwald/go-jira library.

Authentication #

In order for CloudQuery to sync resources from your Jira setup, you will need to use one of the supported authentication methods. More details on each method are provided in the configuration reference section.

Example Configuration #

kind: source
spec:
  name: "jira"
  path: "cloudquery/jira"
  registry: cloudquery
  version: "v2.4.1"
  destinations: ["postgresql"]
  tables: ["*"]
  # Learn more about the configuration options at https://cql.ink/jira_source
  spec:
    auth_method: api_key
    # Note that [email protected] here is the email address for the Atlassian account you're using to create the token
    username: "[email protected]"
    api_key: ${JIRA_API_KEY}
    base_url: "https://mycompany.atlassian.net"
    # Optional table options
    table_options:
      jira_issues:
        jql: 'status = "In Progress"'

Configuration Reference #

This is the (nested) spec used by the Jira source plugin:
  • base_url (string) (required)
    Your Jira base URL. For hosted versions URI is https://your_account_name.atlassian.net/
  • auth_method (string) (optional, default: api_key)
    This plugin supports different authentication methods when communicating with the Jira API. Depending on the chosen authentication method, additional configuration parameters are required.
    Supported values are api_key and bearer_token. If the api_key method is selected, the following additional configuration parameters will be used. If the bearer_token method is selected, the following additional configuration parameters will be used.
  • concurrency (integer, optional, default: 10000): A best effort maximum number of Go routines to use. Lower this number to reduce memory usage.
  • scheduler (string, optional, default: dfs): The scheduler to use when determining the priority of resources to sync. Supported values are dfs (depth-first search), round-robin, shuffle and shuffle-queue.
    For more information about this, see performance tuning.
  • table_options (Table Options spec) (optional)
    Options to apply to specific tables. See [Table Options](#Table Options) for more information.

API Key Configuration Reference #

To use this authentication method, you will need to generate a Jira API Key.
  • username (string) (required)
    The username to authenticate with.
  • api_key (string) (required)
    Personal access key to authenticate with (recommendation: Use environment variable instead of hardcoded the key in the config).

Bearer Token Configuration Reference #

To use this authentication method, you will need an OAuth 2.0 integration.
  • bearer_token (string) (required)
    The OAuth 2.0 Bearer Token to authenticate with (recommendation: Use environment variable instead of hardcoded the token in the config).

Jira Table Options Spec #

  • jira_issues
    • jql (string Jira Query Language (JQL) string to filter issues) (optional)
      Defaults to an empty string (no filter). Example: status = "In Progress".


Join our mailing list

Subscribe to our newsletter to make sure you don't miss any updates.

Legal

© 2024 CloudQuery, Inc. All rights reserved.

We use tracking cookies to understand how you use the product and help us improve it. Please accept cookies to help us improve. You can always opt out later via the link in the footer.