• Docs
  • Getting Started
  • Getting started with GCP

Getting Started with GCP

Download and Install

You can download the precompiled binary from releases, or using CLI:

curl -L https://versions.cloudquery.io/latest/v1/cloudquery_linux_x86_64 -o cloudquery
chmod a+x cloudquery
curl -L https://versions.cloudquery.io/latest/v1/cloudquery_linux_arm64 -o cloudquery
chmod a+x cloudquery
brew install cloudquery/tap/cloudquery
 
# After initial install you can upgrade the version via:
# brew upgrade cloudquery
curl -L https://versions.cloudquery.io/latest/v1/cloudquery_darwin_x86_64 -o cloudquery
chmod a+x cloudquery
curl -L https://versions.cloudquery.io/latest/v1/cloudquery_darwin_arm64 -o cloudquery
chmod a+x cloudquery
curl -L https://versions.cloudquery.io/latest/v1/cloudquery_windows_x86_64.exe -o cloudquery.exe
Invoke-WebRequest https://versions.cloudquery.io/latest/v1/cloudquery_windows_x86_64.exe -o cloudquery.exe

Running

Init command

After installing CloudQuery, you need to generate a cloudquery.yml file that will describe which cloud provider you want to use and which resources you want CloudQuery to ETL:

cloudquery init gcp
 
# cloudquery init gcp aws # This will generate a config containing gcp and aws providers
# cloudquery init --help # Show all possible auto generated configs and flags

All official and approved community plugins are listed here with their respective documentation.

Spawn or connect to a Database

CloudQuery needs a PostgreSQL database (>=10). You can either spawn a local one (usually good for development and local testing) or connect to an existing one.

By default, cloudquery will try to connect to the database postgres on localhost:5432 with username postgres and password pass. After installing docker, you can create such a local postgres instance with:

docker run --name cloudquery_postgres -p 5432:5432 -e POSTGRES_PASSWORD=pass -d postgres

If you are running postgres at a different location or with different credentials, you need to edit cloudquery.yml - see the Connect to an Existing Database tab.

CloudQuery connects to the postgres database that is defined in the cloudquery.yml's connection section. Edit this section to configure the location and credentials of your postgres database.

cloudquery:
  ...
  ...
 
  connection:
    type: postgres
    username: postgres
    password: pass
    host: localhost
    port: 5432
    database: postgres
    sslmode: disable

Authenticate with GCP

CloudQuery needs to be authenticated with your GCP account in order to fetch information about your cloud setup.

💡

CloudQuery requires only read permissions (we will never make any changes to your cloud setup), so, following the principle of least privilege, it's recommended to grant it read-only permissions.

You need to set the GOOGLE_APPLICATION_CREDENTIALS environment variable - see GCP documentation for more details on where to get it.

export GOOGLE_APPLICATION_CREDENTIALS={Path to your google credentials}
SET GOOGLE_APPLICATION_CREDENTIALS={Path to your google credentials}
$Env:GOOGLE_APPLICATION_CREDENTIALS={Path to your google credentials}

Fetch Command

Once cloudquery.yml is generated and you are authenticated with GCP, run the following command to fetch the resources.

cloudquery fetch
# cloudquery fetch --help # Show all possible fetch flags

Exploring and Running Queries

Once CloudQuery fetched the resources, you can explore your cloud infrastructure with SQL!

You can use psql to connect to your postgres instance (of course, you need to change the connection-string to match the location and credentials of your database):

psql "postgres://postgres:pass@localhost:5432/postgres?sslmode=disable"

If you opted for running the PostgreSQL server in a docker as described above, you can also run psql directly from the docker instead of installing it on your machine:

docker exec -it cloudquery_postgres psql -U postgres

Schema and tables for GCP are available here.

Here is an example query for GCP:

Find all buckets Without uniform bucket level access

SELECT project_id, name, self_link AS link
FROM gcp_storage_buckets
WHERE iam_configuration_uniform_bucket_level_access_enabled = FALSE;

Cloudquery Policies

CloudQuery Policies allow users to write security, governance, cost, and compliance rules with SQL, and run them with psql. You can read more about policies here.

Next Steps

Visit the GCP plugin documentation to read more about it, explore the supported tables and learn about advanced configurations.