This repository has been archived by the owner on Aug 15, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* fix: Issue fetching * fix test
- Loading branch information
Showing
5 changed files
with
51 additions
and
4 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Github Provider | ||
|
||
The CloudQuery Github provider extracts and transforms your AWS cloud assets configuration into PostgreSQL. | ||
|
||
## Install | ||
|
||
```shell | ||
cloudquery init github | ||
``` | ||
|
||
## Authentication | ||
|
||
CloudQuery requires only a Personal Access Token, follow this [guide](https://docs.github.com/en/enterprise-server@3.4/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) by github | ||
on how to create a personal access token for CloudQuery. | ||
|
||
## Configuration | ||
|
||
CloudQuery needs to be authenticated with your Github account's Personal Token in order to fetch information about your Github organizations. | ||
CloudQuery requires only *read* permissions (we will never make any changes to your github account or organizations), | ||
so, following the principle of least privilege, it's recommended to grant it read-only permissions. | ||
|
||
Add the following Block your your providers list in your `cloudquery.yml` configuration. | ||
```yaml | ||
- name: github | ||
configuration: | ||
access_token: "<YOUR ACCESS TOKEN HERE> | ||
orgs: ["<YOUR ORG NAME>"] | ||
resources: | ||
- organizations | ||
- repositories | ||
- teams | ||
- billing.actions | ||
- billing.packages | ||
- billing.storage | ||
- issues | ||
- hooks | ||
- installations | ||
- external_groups | ||
|
||
|
||
|
||
``` | ||
|
||
More information can be found in the [CloudQuery documentation](https://docs.cloudquery.io/docs/developers/debugging) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters