turbot / steampipe-plugin-gcp Goto Github PK

View Code? Open in Web Editor NEW

39.0 13.0 24.0 2.92 MB

Use SQL to instantly query GCP resources across regions, projects and organizations. Open source CLI. No DB required.

Home Page: https://hub.steampipe.io/plugins/turbot/gcp

License: Apache License 2.0

JavaScript 1.92% Makefile 0.02% PLSQL 0.28% HCL 13.51% Go 84.28%

gcp steampipe steampipe-plugin postgresql postgresql-fdw sql gcloud gcloud-cli hacktoberfest backup

steampipe-plugin-gcp's Introduction

GCP Plugin for Steampipe

Use SQL to query infrastructure including servers, networks, databases and more from GCP.

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

Quick start

Install the plugin with Steampipe:

steampipe plugin install gcp

Run a query:

select
  name,
  role_id
from
  gcp_iam_role;

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-gcp.git
cd steampipe-plugin-gcp

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

make

Configure the plugin:

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

Try it!

steampipe query
> .inspect gcp

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:

steampipe-plugin-gcp's People

Contributors

Stargazers

Watchers

steampipe-plugin-gcp's Issues

Add compute snapshot table

Update compute image table to list publicly available images

CLI commands that lists the standard images
gcloud compute images list
gcloud compute images list --show deprecated

Add Compute Subnetwork table

https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks

Add tests for gcp_pubsub_topic, gcp_pubsub_subscription, gcp_monitoring_group tables

Update GCP Pub/Sub tables to handle NotFound errors

Add Compute Backend Bucket table

https://cloud.google.com/compute/docs/reference/rest/beta/backendBuckets

Add gcp compute global forwarding rule table

https://cloud.google.com/compute/docs/reference/rest/v1/globalForwardingRules/get

Add compute target pool table

Included_permission column coming empty for gcp_iam_role table.

Add google audit policy table

Add a table with the google audit policy from the project iam policy. This will allow users to query whether logging is enabled for specific servers or allServices

Add gcp compute route table

https://cloud.google.com/compute/docs/reference/rest/v1/routes

Add gcp_logging_metric and gcp_audit_policy docs.

Add gcp compute router table

https://cloud.google.com/compute/docs/reference/rest/v1/routers

Add gcp_monitoring_group and gcp_monitoring_notification_channel docs.

Add gcp compute instance group table

https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroups

Add gcp_pubsub_subscription, gcp_pubsub_snapshot, gcp_project_service docs

Add compute instance table

Add bigtable instance table

https://cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances

Add gcp compute forwarding rule table

https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules

Add gcp storage bucket table

Add gcp_compute_global_forwarding_rule and gcp_compute_global_address docs.

Add Cloud SQL Database table

https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1beta4/databases

Add composer environment table.

Add compute node template table

https://cloud.google.com/compute/docs/reference/rest/v1/nodeTemplates

Add Cloud SQL Database Instance table

https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1beta4/instances

Add gcp_compute_address table docs

Add gcp compute image table

https://cloud.google.com/compute/docs/reference/rest/v1/images

Add gcp_compute_disk table

Add gcp_iam_policy, gcp_iam_role, gcp_logging_sink docs.

Add CHANGELOG for v0.0.5 of the plugin

Add gcp_logging_exclusion doc

Add google compute global address table

https://cloud.google.com/compute/docs/reference/rest/v1/globalAddresses

Add gcp compute vpn tunnel table

https://cloud.google.com/compute/docs/reference/rest/v1/vpnTunnels

Update readme for the plugin

update all gcp tables for common columns description, formatting

			// standard steampipe columns
			{
				Name:        "title",
				Description: ColumnDescriptionTitle,
				Type:        proto.ColumnType_STRING,
				Transform:   transform.FromField("Name"),
			},
			{
				Name:        "tags",
				Description: ColumnDescriptionTags,
				Type:        proto.ColumnType_JSON,
				Transform:   transform.FromField("Labels"),
			},
			{
				Name:        "akas",
				Description: ColumnDescriptionAkas,
				Type:        proto.ColumnType_JSON,
				Transform:   transform.From(instanceAka),
			},

			// standard gcp columns
			{
				Name:        "location",
				Description: ColumnDescriptionLocation,
				Type:        proto.ColumnType_STRING,
				Transform:   transform.FromField("Zone").Transform(lastPathElement),
			},
			{
				Name:        "project",
				Description: ColumnDescriptionProject,
				Type:        proto.ColumnType_STRING,
				Transform:   transform.FromConstant(activeProject()),
			},