Cloud Foundry Plugin for Steampipe

Use SQL to query apps, spaces, and more from Cloud Foundry.

• Get started →
• Documentation: Table definitions & examples
• Community: Slack Channel
• Get involved: Issues
  • Implementation status of CF API resources

Quickstart

Download latest release from GitHub.

Unzip and install the plugin:

gzip -d steampipe-plugin-cf_*.gz
chmod +x steampipe-plugin-cf_*
mkdir -p ~/.steampipe/plugins/hub.steampipe.io/plugins/svento/cf@latest/
mv steampipe-plugin-cf_* ~/.steampipe/plugins/hub.steampipe.io/plugins/svento/cf@latest/steampipe-plugin-cf.plugin
# download default config:
wget -O ~/.steampipe/config/cf.spc https://raw.githubusercontent.com/SvenTo/steampipe-plugin-cf/main/config/cf.spc

Log in with the Cloud Foundry CLI:

cf login

Try it!

steampipe query
> .inspect cf

Run a query:

select
  a.name,
  a.state,
  s.name as space_name,
  o.name as org_name
from
  cf_app as a,
  cf_space as s,
  cf_org as o
where
  s.org_guid = o.guid and 
  a.space_guid = s.guid;

Developing

Prerequisites:

• Steampipe
• Golang

Clone:

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

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

make

Configure the plugin:

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

Try it!

cf login
steampipe query
> .inspect cf

Further reading about Steampipe development:

• Writing plugins
• Writing your first table

Further reading about the Cloud Foundry API:

• Go reference: cloudfoundry-community/go-cfclient
• github.com/cloudfoundry-community/go-cfclient: Golang client lib for Cloud Foundry
• Cloud Foundry V3 API docs
• Cloud Foundry V2 API docs
• Cloud Foundry Concepts

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
• CF Plugin

The GitHub issue #1 lists all CF API resources and the implementation status as a Steampipe table.