steampipe-plugin-crc

README

CRC Plugin for Steampipe

Use SQL to query console.redhat.com APIs.

Get started: https://hub.steampipe.io/plugins/juandspy/crc

Documentation: Table definitions & examples

Community:

Get involved: https://github.com/juandspy/steampipe-plugin-crc/issues

Quick start

Install the plugin with Steampipe:

steampipe plugin install juandspy/crc

Authenticate with the plugin:

export CRC_CLIENT_ID="12345678-0000-1111-2222-123456789012"
export CRC_CLIENT_SECRET="abcdefghijklmnopqrstuvwxyz123456"

Run a query:

SELECT
    cluster_name, cluster_version,
    total_hit_count, hits_by_total_risk
FROM crc_openshift_insights_aggregator_v2_clusters
LIMIT 3

Developing

Prerequisites:

• Steampipe
• Golang

Clone:

git clone git@github.com:juandspy/steampipe-plugin-crc
cd steampipe-plugin-crc

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

make install

Configure the plugin:

cp config/crc.spc ~/.steampipe/config
vi ~/.steampipe/config/crc.spc

Note that there are some variables that need to be defined there, used for authentication.

Try it!

steampipe query
> .inspect crc
> SELECT version, conditions, gathering_functions FROM crc_openshift_insights_gcs_v1_gathering_rules;

You can check the plugin and steampipe logs using

tail -f ~/.steampipe/logs/*$(date "+%Y-%m-%d").log;                                                                           

Further reading:

• Writing plugins
• Writing your first table

Examples

Visit the tables folder for examples.