Governing GitHub

docs/guides/github/github-sidebar.json

@@ -0,0 +1,10 @@
+{
+  "type": "category",
+  "id": "github",
+  "link": "guides/github",
+  "items": [
+    "guides/github/import-organization",
+    "guides/github/real-time-events",
+    "guides/github/remove-organization"
+  ]
+}

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

@@ -0,0 +1,137 @@
+---
+title: Import Organization
+sidebar_label: Import Organization
+---
+
+# Importing GitHub Organization
+
+In this guide, you will:
+
+- 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.
+- Monitor and troubleshoot the process.
+
+Importing a [GitHub Organization](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/about-organizations) into Guardrails involves these key steps:
+
+- Configuring a GitHub with appropriate permissions at the Organization level.
+- Importing the Organization via the Guardrails Console.
+
+## Prerequisites
+
+- Turbot Enterprise (TE) version `>=v5.48.x`, with the [GitHub mod](https://hub.guardrails.turbot.com/mods/github/mods) installed.
+- Access to [GitHub](https://github.com/) and familiarity with its interface.
+- Access to the Guardrails console with *Turbot/Owner* or *Turbot/Admin* permissions at the Turbot resource level.
+
+## Step 1: Set Personal Access Token Policy for Your Organization
+
+Setup the a personal access token policy for your organization prior to importing the organization into Guardrails. Refer steps provided in the GitHub [documentation](https://docs.github.com/en/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization).
+
+Choose `Allow access via fine-grained personal access tokens`.
+
+![Allow Fine-grained Personal Access Tokens](/images/docs/guardrails/guides/github/import-organization/allow-fine-grained-personal-access-tokens.png)
+
+## Step 2: Create Personal Access Token
+
+Turbot Guardrails supports both [Fine-grained](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#fine-grained-personal-access-tokens) or [Classic](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic) GitHub token. This token is available in the GitHub portal under Developer settings and provide secure access to your resources.
+
+Follow the GitHub provided steps in [Creating a fine-grained personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)
+
+![Create Personal Token](/images/docs/guardrails/guides/github/import-organization/create-personal-token.png)
+
+Copy the personal access token.
+
+> [!IMPORTANT]
+> Make sure to copy your personal access token during the creation step as you will not be able to see this again.
+
+![Copy Token](/images/docs/guardrails/guides/github/import-organization/copy-personal-token.png)
+
+
+## Step 3: Grant Permissions
+
+Once you create a fine-grained token, initially it does not have any associated permission.
+
+![Personal Token with No Permission](/images/docs/guardrails/guides/github/import-organization/personal-token-with-no-permission.png)
+
+### Required Permissions
+
+To ensure full functionality of the GitHub integration, we recommend granting the following permissions:
+
+| **Permission**                       | **Access Level**    | **Description**                                                                                       |
+|--------------------------------------|---------------------|-------------------------------------------------------------------------------------------------------|
+| Organization Administration          | Read and write      | Allows Guardrails to manage settings and configurations at the organization level.                   |
+| Organization Webhooks                | Read and write      | Allows Guardrails to manage webhooks for capturing real-time events at the organization level.        |
+| Repository Metadata                  | Read-only           | Provides Guardrails with visibility into repository metadata without modifying its content.           |
+| Repository Administration            | Read and write      | Grants Guardrails the ability to manage repository settings, including access controls and policies.  |
+| Organization Blocking Users          | Read and write      | Enables Guardrails to block and unblock users within the organization.                               |
+
+Select **Edit**, which allows to make edit in `Permissions` section.
+
+![Edit Personal Token](/images/docs/guardrails/guides/github/import-organization/edit-personal-token.png)
+
+Grant the [required permissions](#required-permissions) by selecting **All repositories** under `Repository access` and configuring the appropriate options in both **Repository permissions** and **Organization permissions** sections.
+
+![Associated Permission](/images/docs/guardrails/guides/github/import-organization/associate-org-permission.png)
+
+## Step 4: Validate Personal Access Token at Organization
+
+Navigate to your GitHub organization URL e.g. `https://github.com/organizations/adapt-cloud-security` and select **Settings**.
+
+![Organization Settings](/images/docs/guardrails/guides/github/import-organization/organization-settings.png)
+
+Navigate to **Personal access tokens** in left side panel, select **Active tokens**.
+
+![Org Personal Access Token](/images/docs/guardrails/guides/github/import-organization/select-active-tokens.png)
+
+It should display you the token created in the above step, select the token to check the required permissions are associated.
+
+![Associated Permissions](/images/docs/guardrails/guides/github/import-organization/associated-permissions-in-pat.png)
+
+## Step 5: Log in to Guardrails Console
+
+Log into the Guardrails console with provided local credentials or by using any SAML based login.
+
+![Guardrails Console Login](/images/docs/guardrails/guides/github/import-organization/guardrails-console-login.png)
+
+## Step 6: Import Organization into Guardrails
+
+Login to your Guardrails workspace console and select the **CONNECT** card.
+
+![Guardrails Console Login](/images/docs/guardrails/guides/github/import-organization/select-connect-card.png)
+
+Select **GitHub** card from the `Connect` panel.
+
+![Connect GitHub Card](/images/docs/guardrails/guides/github/import-organization/connect-github-card.png)
+
+Choose the folder 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.
+
+![Choose Location](/images/docs/guardrails/guides/github/import-organization/choose-location.png)
+
+Get the Organization URL from GitHub **Overview** section. Copy the URL and past it in `Organization URL` text box.
+
+![Get Org URL](/images/docs/guardrails/guides/github/import-organization/get-org-url.png)
+
+Provide `Personal Access Token` and Select **Connect**.
+
+![Connect](/images/docs/guardrails/guides/github/import-organization/connect.png)
+
+## Step 7: Review
+
+- [ ] Check that the controls are executed by navigating to **Controls** tab and select GitHub. This should display the default controls for `Organization` and `Repository` in `OK` state.
+
+![Verify Controls](/images/docs/guardrails/guides/github/import-organization/verify-github-controls.png)
+
+## Next Steps
+
+Please see the following resources to learn more about Turbot Guardrails:
+
+- Learn more about [GitHub Event Handlers](/guardrails/docs/guides/github/real-time-events).
+- Explore the GitHub supported use cases in Guardrails with [Policy Packs](https://hub.guardrails.turbot.com/policy-packs?providers=github).
+
+## Troubleshooting
+
+| **Issue**                | **Description**                                                                                                                      | **Guide**                                                                                                                                |
+|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
+| 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)                                                     |
+| 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) |
+| Message: `forbids access via a personal access token with fine-grained permissions`  | Guardrails GitHub controls may generate errors with a `forbids access` error, often caused, in case the used personal token does not have any required permissions.                                | Check the required permissions at [Importing GitHub Organization Required Permissions](#required-permissions) & more details at [Permissions required for fine-grained personal access tokens](https://docs.github.com/en/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens?apiVersion=2022-11-28) |
+| Message: `Resource not accessible by personal access token .. list-users-blocked-by-an-organization`  | Guardrails GitHub controls may generate errors with a `forbids accessResource not accessible by personal access token`                            | Check the required permissions at [Importing GitHub Organization Required Permissions](#required-permissions) & more details at [Permissions required for fine-grained personal access tokens](https://docs.github.com/en/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens?apiVersion=2022-11-28) |
+| 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)                                                                                       |

docs/guides/github/index.md

@@ -0,0 +1,22 @@
+---
+title: Governing GitHub
+sidebar_label: Governing GitHub
+---
+
+# Governing GitHub
+
+Turbot Guardrails provides comprehensive governance for [GitHub](https://github.com/), enabling secure, compliant, and efficient management of your GitHub resources.
+
+Guardrails ensures effective management and real-time visibility into your GitHub organizations with the following capabilities:
+
+- **Policy Management**: Offers a variety of GitHub mods with policies and controls to manage repositories, and organizations.
+- **Real-Time Event Handling**: Updates the Guardrails CMDB as repositories, are created, modified, or deleted, enabling immediate policy enforcement.
+- **Activity Visibility**: Provides insights into all activity within GitHub organizations, including who made changes, what was changed, and when it occurred.
+
+| Section                                                                                   | Description                                                        |
+| ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
+| [Import a GitHub Organization](guides/github/import-organization)                  | Guide to importing a GitHub organization into a Guardrails folder. |
+| [Set Up GitHub Real-Time Events](guides/github/real-time-events)                          | How to configure Guardrails to process real-time GitHub events.    |
+| [Explore GitHub Mods](https://hub.guardrails.turbot.com/mods/github/mods)                 | A detailed list of available GitHub mods in Turbot Guardrails.     |
+| [Set Up GitHub Policies](https://hub.guardrails.turbot.com/policy-packs?providers=github) | Learn how to configure Guardrails policies for GitHub.             |
+| [Remove GitHub Organization](guides/github/remove-organization)                  | Guide to delete a GitHub organization from Guardrails. |

docs/guides/github/real-time-events/index.md

@@ -0,0 +1,76 @@
+---
+title: Real-Time Events
+sidebar_label: Real-Time Events
+---
+
+# Configuring Real-Time Event Handlers
+
+In this guide, you will:
+
+- Set up Event Handlers in the Guardrails workspace using the Guardrails console.
+- Monitor and troubleshoot the Event Handlers setup process.
+
+Guardrails enables organizations to selectively install policies, controls, and guardrails tailored to specific services. The [Event Handler](/guardrails/docs/reference/glossary#event-handler) simplifies cloud management by providing a unified framework for responding to and managing events, ensuring proactive governance and security across cloud environments. Event Handlers for GitHub are responsible for conveying events from GitHub back to Guardrails for processing.
+
+## Prerequisites
+
+- *Turbot/Operator* permissions at the Turbot level and familiarity with its interface.
+- The GitHub organization has been successfully [imported](/guardrails/docs/guides/github/import-organization) into Guardrails.
+- A GitHub personal access token with the necessary permissions to create [webhooks](https://docs.github.com/en/webhooks/about-webhooks).
+
+## Step 1: Grant Permission
+
+The personal access token used for importing an organization requires the `Organization Webhooks: Read and write` permission. This permission enables Guardrails to manage webhooks for capturing real-time events at the organization level.
+
+This permission is already granted during the [Required Permissions](/guardrails/docs/guides/github/import-organization#required-permissions) step of [Importing GitHub Organization](/guardrails/docs/guides/github/import-organization).
+
+## Step 2: Log in to Guardrails Console
+
+Log into the Guardrails console with provided local credentials or by using any SAML based login.
+
+![Guardrails Console Login](/images/docs/guardrails/guides/github/real-time-events/guardrails-console-login.png)
+
+## Step 3: Set Up Event Handlers Policy
+
+The GitHub Event Handlers are configured using the `GitHub > Organization > Event Handlers` control for each organization. This control sets up the required [webhooks](https://docs.github.com/en/webhooks/about-webhooks) components for the organization.
+
+Select the **Policies** tab. Search for `GitHub > Organization > Event Handlers` and select **New Policy Setting**.
+
+![Create Event Handler](/images/docs/guardrails/guides/github/real-time-events/create-event-handler.png)
+
+Select the `Resource` for the imported organization, set the policy to `Enforce: Enabled`, and select **Create**.
+
+![Set Policy to Enforced](/images/docs/guardrails/guides/github/real-time-events/create-policy-setting.png)
+
+## Step 4: Check Control Status
+
+Select the **Controls** tab. Search for `GitHub > Organization > Event Handlers` and check that the control status is `OK`.
+
+![Check Control Status](/images/docs/guardrails/guides/github/real-time-events/organization-event-handlers-control-status.png)
+
+## Step 5: Review
+
+- [ ] Check that the control status for the respective organization is `OK` with the message `Configured`.
+
+![Check Control Configured](/images/docs/guardrails/guides/github/real-time-events/control-configured-ok.png)
+
+- [ ] Verify that the webhook has been created in the GitHub organization.
+
+![GitHub Webhook](/images/docs/guardrails/guides/github/real-time-events/validate-github-org-webhook.png)
+
+## Next Steps
+
+Please see the following resources to learn more about Turbot Guardrails:
+
+- Learn more about [Managing GitHub Organizations](guides/github/manage-organizations).
+- Explore the GitHub supported use cases in Guardrails with [Policy Packs](https://hub.guardrails.turbot.com/policy-packs?providers=github).
+
+## Troubleshooting
+
+| **Issue**                                                           | **Description**                                                                                                                                                   | **Guide**                                                                                                                                                                                                     |
+|----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **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)                                                                                                                         |
+| **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)                                                           |
+| **Message: `forbids access via a personal access token with fine-grained permissions`** | Guardrails GitHub controls may generate this error when the personal token lacks the required permissions.                                                        | Check the required permissions at [Importing GitHub Organization Required Permissions](/guardrails/docs/guides/github/import-organization#required-permissions) & more details at [Permissions required for fine-grained personal access tokens](https://docs.github.com/en/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens?apiVersion=2022-11-28). |
+| **Message: `Resource not accessible by personal access token .. list-users-blocked-by-an-organization`** | Guardrails GitHub controls may generate this error if the personal token lacks required permissions for the organization.                                          | Check the required permissions at [Importing GitHub Organization Required Permissions](/guardrails/docs/guides/github/import-organization#required-permissions) & more details at [Permissions required for fine-grained personal access tokens](https://docs.github.com/en/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens?apiVersion=2022-11-28). |
+| **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)                                                                                                                                                            |