You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- This guide provides step-by-step instructions to import a GitHub organization into a Guardrails folder, ensuring that your GitHub environment is governed according to your organizational policies.
13
-
14
-
Turbot Guardrails enables seamless integration with GitHub, allowing you to manage your GitHub organizations and repositories effectively. By importing a GitHub organization into Guardrails, you gain the ability to:
10
+
- Learn how to import an entire GitHub organization into Turbot Guardrails. This process allows Guardrails to discover and manage resources across your organization in real-time.
11
+
- Monitor and troubleshoot the process.
15
12
16
-
- Centralize governance for your GitHub resources within Guardrails.
13
+
<!--- Centralize governance for your GitHub resources within Guardrails.
17
14
- Apply policies to enforce security, compliance, and operational best practices.
18
15
- Monitor real-time activity within your organization.
19
-
- Establish detailed audit logs to track all activities and changes for improved visibility and reporting.
16
+
- Establish detailed audit logs to track all activities and changes for improved visibility and reporting. -->
17
+
18
+
Importing a [GitHub Organization](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/about-organizations) into Guardrails involves these key steps:
19
+
20
+
- Configuring a GitHub with appropriate permissions at the Organization level.
21
+
- Importing the Organization via the Guardrails Console.
20
22
21
23
## Prerequisites
22
24
23
-
-**Turbot/Operator** permissions at the Turbot resource level.
24
-
-Familiarity with the Guardrails console.
25
+
-Access to the Guardrails console with *Turbot/Owner* or *Turbot/Admin* permissions at the Turbot resource level.
26
+
-GitHub mod should be installed in your Guardrails workspace.
25
27
- Ensure access to [GitHub CLI](https://cli.github.com/) to fetch organization id.
26
-
- Ensure GitHub organization has allowed access via personal access tokens. For more information [check here](https://docs.github.com/en/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization).
28
+
- Ensure GitHub organization has allowed access via personal access tokens. See [Setting a personal access token policy for your organization](https://docs.github.com/en/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization) for more information.
29
+
30
+
<!-- ## Supported Authentication -->
27
31
28
-
## Permissions required
32
+
## What Permissions to Grant
29
33
30
-
To make sure all functionality of GitHub integration work, we suggest you to provide all the following permissions.
34
+
<!--To make sure all functionality of GitHub integration work, we suggest you to provide all the following permissions.
31
35
32
36
- Organization Administration - Read and write
33
37
- Organization Blocking users - Read and write
34
38
- Organization Webhooks - Read and write
35
39
- Repository Administration - Read and write
36
-
- Repository Metadata - Read-only
40
+
- Repository Metadata - Read-only -->
41
+
42
+
To ensure full functionality of the GitHub integration, we recommend granting the following permissions:
| Organization Administration | Read and write | Allows Guardrails to manage settings and configurations at the organization level. |
47
+
| Organization Blocking Users | Read and write | Enables Guardrails to block and unblock users within the organization. |
48
+
| Organization Webhooks | Read and write | Allows Guardrails to manage webhooks for capturing real-time events at the organization level. |
49
+
| Repository Administration | Read and write | Grants Guardrails the ability to manage repository settings, including access controls and policies. |
50
+
| Repository Metadata | Read-only | Provides Guardrails with visibility into repository metadata without modifying its content. |
39
51
40
-
Run the following command to get the id of the organization you want to import
52
+
## Get GitHub Organization ID
53
+
54
+
There are various ways to get the GitHub organization ID
55
+
56
+
Use [GitHub CLI](https://docs.github.com/en/github-cli/github-cli/quickstart) and run the following command to get the id of the organization you want to import.
41
57
42
58
```
43
59
gh api orgs/<organization name> --jq '.id'
44
60
```
45
61
46
-
## Step 2: Login to Guardrails Console
62
+
Alternatively, you can use `curl` command to render the ID
Fill in the Parent Resource where you'd want your organization; typically this would be done at the `Turbot` root level of your hierarchy, however it can reside in a Folder instead.
88
+
Choose the location where you want to import the organization. Typically this would be done at the `Turbot` root level of your hierarchy, however it can reside in a [Folder](/guardrails/docs/concepts/resources/hierarchy#folders) based on your use-case.
| Permission Issues | TO DO. |[Troubleshoot Permission Issues](/guardrails/docs/enterprise/FAQ/admin-permissions#aws-permissions-for-turbot-guardrails-administrators)|
78
-
| Further Assistance | If you continue to encounter issues, please open a ticket with us and attach the relevant information to assist you more efficiently. |[Open Support Ticket](https://support.turbot.com)|
| Controls in Error | Controls may enter various states, including errors, which can impact their functionality. |[Learn More About Control States](/guardrails/docs/concepts/controls#control-state)|
106
+
| Message: `Bad Credentials`| Guardrails GitHub controls may generate errors with a `Bad credentials` message, often caused by invalid or expired tokens. |[Token Expiration and Revocation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation)|
107
+
| Further Assistance | If issues persist, please open a ticket with us and attach relevant details for more efficient troubleshooting. |[Open Support Ticket](https://support.turbot.com)|
0 commit comments