Introducing the GitHub CloudQuery Plugin
August 8, 2022
CloudQuery is an open-source, extendable framework that gives you a single-pane-of-glass to your cloud-infrastructure using SQL. Today, we are happy to announce the release of the GitHub Provider for CloudQuery.
GitHub is a source-control provider that helps developers store and manage their code, as well as track and control changes to their code.
In this tutorial, we will install CloudQuery and use it to fetch GitHub resources. Then, we will use SQL to get visibility into security, compliance and cost-management in GitHub.
- Download CloudQuery.
- Acquire a GitHub (personal access token)[https://email@example.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token (opens in a new tab)]
with the scopes:
read:org read:project public_repo ```.
- Create a
cloudquery.ymlfile, similar to the following:
kind: source spec: name: github path: cloudquery/github registry: cloudquery version: "v7.5.1" tables: ["*"] destinations: ["postgresql"] spec: access_token: <YOUR_ACCESS_TOKEN> orgs: ["cloudquery"] --- kind: destination spec: name: "postgresql" path: cloudquery/postgresql registry: cloudquery version: "v7.1.0" write_mode: "overwrite-delete-stale" spec: connection_string: "postgresql://postgres:pass@localhost:5432/postgres?sslmode=disable"
cloudquery sync cloudquery.yml
After we finish fetching our config data we can make queries for security, compliance, cost management and other purposes.
-- Query all repositories in the organizations that are public SELECT id, org, name, description FROM github_repositories WHERE private = false
-- Get billing information state for actions, packages and storage SELECT * FROM github_billing_action SELECT * FROM github_billing_package SELECT * FROM github_billing_storage
-- Find all open issues that have been open for more than 7 days SELECT gr.org, gr.name, gi.id, gi.state, gi.created_at, gi.updated_at FROM github_issues gi INNER JOIN github_repositories gr ON gr.id = (gi.repository->'id')::bigint WHERE state = 'open' AND NOW() - interval '7 days' > gi.created_at
We are going to continue expanding the GitHub Provider, adding support for more resources. Interested in seeing another plugin? Check out Developing New plugin and/or open an issue on our GitHub (opens in a new tab).