Skip to content

Commit 3f7458f

Browse files
committed
Updates
1 parent 1a7592f commit 3f7458f

File tree

3 files changed

+40
-26
lines changed

3 files changed

+40
-26
lines changed
28.5 KB
Loading

docs/guides/github/decommission/index.md

Lines changed: 31 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,49 +3,62 @@ title: Decommission GitHub Organization
33
sidebar_label: Decommission GitHub Organization
44
---
55

6-
CHANGES TODO
7-
86
# Decommission GitHub Organization
97

108
In this guide, you will:
119

1210
- Learn how to decommission a GitHub organization from a Guardrails workspace while managing associated resources effectively.
1311

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.
1713

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. -->
1915

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**.
2118
2219
## Prerequisites
2320

2421
- **Turbot/Operator** permissions at the Turbot resource level.
2522
- 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.
2630

27-
## Step 1: Remove Credentials Policies
31+
## Remove Credentials Policies
2832

2933
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.
3034

31-
## Step 2: Log in to the Guardrails Console
35+
## Delete the Organization
3236

33-
Log in to the Guardrails console.
37+
Login to the Guardrails console.
3438

3539
![Guardrails Console Login](/images/docs/guardrails/guides/github/decommission-github-organization/guardrails-console-login.png)
3640

37-
## Step 3: Navigate to the Organization
41+
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.
3853
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**.
4055

41-
## Step 4: Delete the Organization
56+
Image
4257

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.
4760
48-
## Step 5: Verify Deletion
61+
## Verify
4962

5063
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.
5164

docs/guides/github/import-github-organization/index.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,10 @@ Importing a [GitHub Organization](https://docs.github.com/en/organizations/colla
2323
## Prerequisites
2424

2525
- Access to the Guardrails console with *Turbot/Owner* or *Turbot/Admin* permissions at the Turbot resource level.
26+
- Familiarity with the GitHub.
2627
- 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.
2930

3031
<!-- ## Supported Authentication -->
3132

@@ -51,20 +52,20 @@ To ensure full functionality of the GitHub integration, we recommend granting th
5152

5253
## Get GitHub Organization ID
5354

54-
There are various ways to get the GitHub organization ID
55+
There are various ways to get the GitHub organization ID.
5556

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.
5758

5859
```
5960
gh api orgs/<organization name> --jq '.id'
6061
```
6162

62-
Alternatively, you can use `curl` command to render the ID
63+
Alternatively, you can use `curl` command to get the organization ID.
6364

6465
```
6566
curl -H "Authorization: Bearer ghp_iio5FzBF4OLbbes3AKasdre5f4mps50s7YXE" https://api.github.com/orgs/<your-org-name>
6667
```
67-
The result will be shown as below
68+
The result will be shown as below:
6869

6970
```json
7071
{
@@ -89,11 +90,11 @@ Choose the location where you want to import the organization. Typically this wo
8990

9091
![Choose Location](/images/docs/guardrails/guides/github/import-github-organization/choose-location.png)
9192

92-
Provide `Organization Name`, `Organization ID`, `Personal Access Token` and choose **Connect**
93+
Provide `Organization Name`, `Organization ID`, `Personal Access Token` and choose **Connect**.
9394

9495
![Connect](/images/docs/guardrails/guides/github/import-github-organization/connect.png)
9596

96-
Verify that the controls are executed by navigating to **Controls** tab and select GitHub
97+
Verify that the controls are executed by navigating to **Controls** tab and select GitHub.
9798

9899
![Verify Controls](/images/docs/guardrails/guides/github/import-github-organization/verify-github-controls.png)
99100

0 commit comments

Comments
 (0)