steampipe-plugin-jira

README

Jira Plugin for Steampipe

Use SQL to query infrastructure including servers, networks, facilities and more from Jira.

• Get started →
• Documentation: Table definitions & examples
• Community: Join #steampipe on Slack →
• Get involved: Issues

Quick start

Install

Download and install the latest Jira plugin:

steampipe plugin install jira

Configure your credentials and config file.

Configure your account details in ~/.steampipe/config/jira.spc:

connection "jira" {
  plugin = jira

  # Authentication information
  base_url              = "https://your-domain.atlassian.net/"
  username              = "abcd@xyz.com"
  token                 = "8WqcdT0rvIZpCjtDqReF48B1"
}

For self-hosted Jira instances, please use the personal_access_token field instead of token. This access token can only be used to query jira_backlog_issue, jira_board, jira_issue and jira_sprint tables.

connection "jira" {
  plugin = jira

  # Authentication information
  base_url              = "https://your-domain.atlassian.net/"
  personal_access_token = "MDU0MDMx7cE25TQ3OujDfy/vkv/eeSXXoh/zXY1ex9cp"
}

Or through environment variables:

export JIRA_URL=https://your-domain.atlassian.net/
export JIRA_USER=abcd@xyz.com
export JIRA_TOKEN=8WqcdT0rvIZpCjtDqReF48B1
export JIRA_PERSONAL_ACCESS_TOKEN="MDU0MDMx7cE25TQ3OujDfy/vkv/eeSXXoh/zXY1ex9cp"

Run steampipe:

steampipe query

List users in your Jira account:

select
  display_name,
  account_type as type,
  active as status,
  account_id
from
  jira_user;

+-------------------------------+-----------+--------+-----------------------------+
| display_name                  | type      | status | account_id                  |
+-------------------------------+-----------+--------+-----------------------------+
| Confluence Analytics (System) | app       | true   | 557058:cbc04d7be567aa5332c6 |
| John Smyth                    | atlassian | true   | 1f2e1d34e0e56a001ea44fc1    |
+-------------------------------+-----------+--------+-----------------------------+

Developing

Prerequisites:

• Steampipe
• Golang

Clone:

git clone https://github.com/turbot/steampipe-plugin-jira.git
cd steampipe-plugin-jira

Build, which automatically installs the new version to your ~/.steampipe/plugins directory:

make

Configure the plugin:

cp config/* ~/.steampipe/config
vi ~/.steampipe/config/jira.spc

Try it!

steampipe query
> .inspect jira

Further reading:

• Writing plugins
• Writing your first table

Contributing

Please see the contribution guidelines and our code of conduct. All contributions are subject to the Apache 2.0 open source license.

help wanted issues:

• Steampipe
• Jira Plugin