Skip to content

Latest commit

 

History

History
149 lines (105 loc) · 5.95 KB

README.md

File metadata and controls

149 lines (105 loc) · 5.95 KB
Raw

image

Jira Plugin for Steampipe

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

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              = "[email protected]"
  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 [email protected]
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    |
+-------------------------------+-----------+--------+-----------------------------+

Engines

This plugin is available for the following engines:

Engine Description
Steampipe The Steampipe CLI exposes APIs and services as a high-performance relational database, giving you the ability to write SQL-based queries to explore dynamic data. Mods extend Steampipe's capabilities with dashboards, reports, and controls built with simple HCL. The Steampipe CLI is a turnkey solution that includes its own Postgres database, plugin management, and mod support.
Postgres FDW Steampipe Postgres FDWs are native Postgres Foreign Data Wrappers that translate APIs to foreign tables. Unlike Steampipe CLI, which ships with its own Postgres server instance, the Steampipe Postgres FDWs can be installed in any supported Postgres database version.
SQLite Extension Steampipe SQLite Extensions provide SQLite virtual tables that translate your queries into API calls, transparently fetching information from your API or service as you request it.
Export Steampipe Plugin Exporters provide a flexible mechanism for exporting information from cloud services and APIs. Each exporter is a stand-alone binary that allows you to extract data using Steampipe plugins without a database.
Turbot Pipes Turbot Pipes is the only intelligence, automation & security platform built specifically for DevOps. Pipes provide hosted Steampipe database instances, shared dashboards, snapshots, and more.

Developing

Prerequisites:

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:

Open Source & Contributing

This repository is published under the Apache 2.0 (source code) and CC BY-NC-ND (docs) licenses. Please see our code of conduct. We look forward to collaborating with you!

Steampipe is a product produced from this open source software, exclusively by Turbot HQ, Inc. It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our Open Source FAQ.

Get Involved

Join #steampipe on Slack →

Want to help but don't know where to start? Pick up one of the help wanted issues: