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
- Learn how to decommission a GitHub organization from a Guardrails workspace while managing associated resources effectively.
13
11
14
-
Guardrails allows administrators to remove a GitHub organization from a workspace. The delete action removes all associated policies and references from the Guardrails database, but **does not delete any resources** from the target GitHub organization. Careful consideration should be made when managing resources such as webhooks, as once removed, these changes cannot be undone.
15
-
16
-
Before starting the process, administrators should determine whether Guardrails-managed resources (e.g., webhooks) should remain in the organization. The following policies can be configured in Guardrails to facilitate cleanup. Ensure that these changes are applied **only to the target GitHub organization**.
12
+
Guardrails allows administrators to remove a [GitHub Organization](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/about-organizations) from a workspace. The delete action removes all associated policies and references from the Guardrails database, but `does not delete any resources` from the target GitHub organization.
17
13
18
-
1.`GitHub > Organization > Event Handlers` set to `Enforce: Disabled`. This removes Guardrails-configured webhooks.
14
+
<!-- Careful consideration should be made when managing resources such as webhooks, as once removed, these changes cannot be undone. -->
19
15
20
-
Once these policies have been applied and the associated controls have completed their cleanup, the GitHub organization can be safely removed from the Guardrails workspace.
16
+
> [!IMPORTANT]
17
+
> Before starting the process, administrators should determine whether Guardrails-managed resources (e.g., webhooks) should remain in the organization. The following policies can be configured in Guardrails to facilitate cleanup. Ensure that these changes are applied **only to the target GitHub organization**.
21
18
22
19
## Prerequisites
23
20
24
21
-**Turbot/Operator** permissions at the Turbot resource level.
25
22
- Familiarity with the Guardrails console.
23
+
- Familiarity with the GitHub.
24
+
25
+
DISCUSS THE SEQUENCE, WEBHOOKS SETUP WITH SD
26
+
27
+
## Disable Event Handlers
28
+
29
+
Disable Event Handlers associated with `GitHub > Organization > Event Handlers` with value set to `Enforce: Disabled`. This removes Guardrails-configured webhooks. Once these policies have been applied and the associated controls have completed their cleanup, the GitHub organization can be safely removed from the Guardrails workspace.
26
30
27
-
## Step 1: Remove Credentials Policies
31
+
## Remove Credentials Policies
28
32
29
33
Delete the policy `GitHub > Config > Personal Access Token` configured for the target GitHub organization. This ensures that Guardrails no longer has access to the organization.
Navigate to the `Organization` that needs to be removed.
42
+
43
+
Image
44
+
45
+
Select the **Actions** button in the top-right corner and choose **Actions** button in the top-right corner.
46
+
47
+
Image
48
+
49
+
Select the **Remove from Turbot**.
50
+
51
+
> [!NOTE]
52
+
> If you don’t see this button, contact your Guardrails administrator for the required permissions.
38
53
39
-
Using the Guardrails console, navigate to the GitHub organization that needs to be removed.
54
+
In the popup window, copy the `Organization ID` and paste it into the text box. Select **Delete**.
40
55
41
-
## Step 4: Delete the Organization
56
+
Image
42
57
43
-
1. Click the **Actions** button in the top-right corner.
44
-
2. Click the **Remove from Turbot** button in the top-right corner. If you don’t see this button, contact your Guardrails administrator for the required permissions.
45
-
3. In the popup window, copy the organization ID and paste it into the text box.
46
-
4. Click **Delete**. While the deletion is reversible by re-importing the organization, it can be resource-intensive. Double-check all configurations before proceeding.
58
+
> [!IMPORTANT]
59
+
> While the deletion is reversible by re-importing the organization, it can be resource-intensive. Double-check all configurations before proceeding.
47
60
48
-
## Step 5: Verify Deletion
61
+
## Verify
49
62
50
63
Guardrails will begin the deletion process. The time to complete the process depends on the number of policies and resources associated with the organization. Larger organizations may take longer.
Copy file name to clipboardExpand all lines: docs/guides/github/import-github-organization/index.md
+9-8Lines changed: 9 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,9 +23,10 @@ Importing a [GitHub Organization](https://docs.github.com/en/organizations/colla
23
23
## Prerequisites
24
24
25
25
- Access to the Guardrails console with *Turbot/Owner* or *Turbot/Admin* permissions at the Turbot resource level.
26
+
- Familiarity with the GitHub.
26
27
- GitHub mod should be installed in your Guardrails workspace.
27
-
- Ensure access to [GitHub CLI](https://cli.github.com/) to fetch organization id.
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.
28
+
- Ensure access to [GitHub CLI](https://cli.github.com/) to fetch organization ID.
29
+
- Ensure GitHub organization has allowed access via personal access tokens. Refer[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
30
31
<!-- ## Supported Authentication -->
31
32
@@ -51,20 +52,20 @@ To ensure full functionality of the GitHub integration, we recommend granting th
51
52
52
53
## Get GitHub Organization ID
53
54
54
-
There are various ways to get the GitHub organization ID
55
+
There are various ways to get the GitHub organization ID.
55
56
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.
57
+
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.
57
58
58
59
```
59
60
gh api orgs/<organization name> --jq '.id'
60
61
```
61
62
62
-
Alternatively, you can use `curl` command to render the ID
63
+
Alternatively, you can use `curl` command to get the organization ID.
0 commit comments