Authentication #

Example Configuration #

kind: source
spec:
  name: "jira"
  path: "cloudquery/jira"
  registry: cloudquery
  version: "v2.5.4"
  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 #

• 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 #

• 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 #

• 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".