Skip to content

Latest commit

 

History

History
220 lines (167 loc) · 8.01 KB

index.md

File metadata and controls

220 lines (167 loc) · 8.01 KB
Raw
organization category icon_url brand_color display_name name description og_description og_image
Turbot
public cloud
/images/plugins/turbot/gcp.svg
#ea4335
GCP
gcp
Steampipe plugin for querying buckets, instances, functions and more from GCP.
Query GCP with SQL! Open source CLI. No DB required.
/images/plugins/turbot/gcp-social-graphic.png

GCP + Steampipe

Steampipe is an open source CLI to instantly query cloud APIs using SQL.

GCP provides on-demand cloud computing platforms and APIs to authenticated customers on a metered pay-as-you-go basis.

For example:

select
  name,
  location,
  versioning_enabled
from
  gcp_storage_bucket;
+--------------------+----------+--------------------+
| name               | location | versioning_enabled |
+--------------------+----------+--------------------+
| steampipe-io-dev   | us-east1 | false              |
| steampipe-io-stage | us       | false              |
| steampipe-io-prod  | us       | true               |
+--------------------+----------+--------------------+

Documentation

Get started

Install

Download and install the latest GCP plugin:

steampipe plugin install gcp

Credentials

Item Description
Credentials When running locally, you must configure your Application Default Credentials. If you are running in Cloud Shell or Cloud Code, the tool uses the credentials you provided when you logged in, and manages any authorizations required.
Permissions Assign the Viewer role to your user or service account.
Radius Each connection represents a single GCP project.
Resolution 1. Credentials from the JSON file specified by the credentials parameter in your steampipe config.
2. Credentials from the JSON file specified by the GOOGLE_APPLICATION_CREDENTIALS environment variable.
3. Credentials from the default JSON file location (~/.config/gcloud/application_default_credentials.json).
4. Credentials from the metadata server

Configuration

Installing the latest gcp plugin will create a config file (~/.steampipe/config/gcp.spc) with a single connection named gcp:

connection "gcp" {
  plugin    = "gcp"

  # `project` (optional) - The project ID to connect to. This is the project ID (string), not the
  # project name or number. If the `project` argument is not specified for a connection,
  # the project will be determined in the following order:
  #   - The standard gcloud SDK `CLOUDSDK_CORE_PROJECT` environment variable, if set; otherwise
  #   - The `GCP_PROJECT` environment variable, if set (this is deprecated); otherwise
  #   - The current active project, as returned by the `gcloud config get-value project` command
  #project = "YOUR_PROJECT_ID"

  # `credentials` (optional) - Either the path to a JSON credential file that contains Google application credentials,
  # or the contents of a service account key file in JSON format. If `credentials` is not specified in a connection,
  # credentials will be loaded from:
  #   - The path specified in the `GOOGLE_APPLICATION_CREDENTIALS` environment variable, if set; otherwise
  #   - The standard location (`~/.config/gcloud/application_default_credentials.json`)
  #credentials = "~/.config/gcloud/application_default_credentials.json"

  # `impersonate_service_account` (optional) - The GCP service account (string) which should be impersonated.
  # If not set, no impersonation is done.
  #impersonate_service_account = "YOUR_SERVICE_ACCOUNT"

  # `ignore_error_codes` (optional) - List of additional GCP error codes to ignore for all queries.
  # By default, the common not found error codes are ignored and will still be ignored even if this argument is not set.
  # Refer https://cloud.google.com/resource-manager/docs/core_errors#Global_Errors for more information on GCP error codes
  #ignore_error_codes = ["401", "403"]
}

NOTE: The credential_file property has been deprecated and will be removed in the next major version. Please use credentials instead.

Advanced configuration options

By default, the GCP plugin uses your Application Default Credentials to connect to GCP. If you have not set up ADC, simply run gcloud auth application-default login. This command will prompt you to log in, and then will download the application default credentials to ~/.config/gcloud/application_default_credentials.json.

For users with multiple GCP project and more complex authentication use cases, here are some examples of advanced configuration options:

Use a service account

Generate and download a JSON key for an existing service account using: create service account key page.

connection "gcp_my_other_project" {
  plugin      = "gcp"
  project     = "my-other-project"
  credentials = "/home/me/my-service-account-creds.json"
}

Multi-Project Connections

You may create multiple gcp connections:

connection "gcp_all" {
  type        = "aggregator"
  plugin      = "gcp"
  connections = ["gcp_project_*"]
}

connection "gcp_project_aaa" {
  plugin  = "gcp"
  project = "project-aaa"
}

connection "gcp_project_bbb" {
  plugin  = "gcp"
  project = "project-bbb"
}

connection "gcp_project_ccc" {
  plugin  = "gcp"
  project = "project-ccc"
}

Depending on the mode of authentication, a multi-project configuration can also look like:

connection "gcp_all" {
  type        = "aggregator"
  plugin      = "gcp"
  connections = ["gcp_project_*"]
}

connection "gcp_project_aaa" {
  plugin      = "gcp"
  project     = "project-aaa"
  credentials = "/home/me/my-service-account-creds-for-project-aaa.json"
}

connection "gcp_project_bbb" {
  plugin      = "gcp"
  project     = "project-bbb"
  credentials = "/home/me/my-service-account-creds-for-project-bbb.json"
}

connection "gcp_project_ccc" {
  plugin      = "gcp"
  project     = "project-ccc"
  credentials = "/home/me/my-service-account-creds-for-project-ccc.json"
}

Each connection is implemented as a distinct Postgres schema. As such, you can use qualified table names to query a specific connection:

select * from gcp_project_aaa.gcp_project

Alternatively, you can use an unqualified name and it will be resolved according to the Search Path:

select * from gcp_project

You can create multi-project connections by using an aggregator connection. Aggregators allow you to query data from multiple connections for a plugin as if they are a single connection:

connection "gcp_all" {
  plugin      = "gcp"
  type        = "aggregator"
  connections = ["gcp_project_aaa", "gcp_project_bbb", "gcp_project_ccc"]
}

Querying tables from this connection will return results from the gcp_project_aaa, gcp_project_bbb, and gcp_project_ccc connections:

select * from gcp_all.gcp_project

Steampipe supports the * wildcard in the connection names. For example, to aggregate all the GCP plugin connections whose names begin with gcp_:

connection "gcp_all" {
  type        = "aggregator"
  plugin      = "gcp"
  connections = ["gcp_*"]
}

Specify static credentials using environment variables

export CLOUDSDK_CORE_PROJECT=myproject
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/my/creds.json

Get involved