From d5220faafc7b1d981fd3f278d67a3dc05db502b9 Mon Sep 17 00:00:00 2001 From: raj Date: Thu, 16 Jan 2025 18:05:07 +0530 Subject: [PATCH] Updates --- docs/guides/github/decommission/index.md | 6 +++--- docs/guides/github/import-github-organization/index.md | 3 +++ .../{event-pollers => event-handler}/index.md | 2 ++ docs/guides/index.md | 1 + 4 files changed, 9 insertions(+), 3 deletions(-) rename docs/guides/github/real-time-events/{event-pollers => event-handler}/index.md (99%) diff --git a/docs/guides/github/decommission/index.md b/docs/guides/github/decommission/index.md index 87b682c8..2749fad1 100644 --- a/docs/guides/github/decommission/index.md +++ b/docs/guides/github/decommission/index.md @@ -3,6 +3,8 @@ title: Decommission GitHub Organization sidebar_label: Decommission GitHub Organization --- +CHANGES TODO + # Decommission GitHub Organization In this guide, you will: @@ -12,9 +14,7 @@ Guardrails allows administrators to remove a GitHub organization from a workspac Before starting the process, administrators should determine whether Guardrails-managed resources (e.g., webhooks, event subscriptions) 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**. -1. `GitHub > Turbot > Permissions` set to `Enforce: None`. This removes Guardrails-managed roles and permissions in the organization. -2. `GitHub > Turbot > Event Handlers > Webhooks` set to `Enforce: Not Configured`. This removes Guardrails-configured webhooks. -3. `GitHub > Turbot > Event Poller` set to `Disabled`. This disables the polling of events into Guardrails. +1. `GitHub > Turbot > Event Handlers > Webhooks` set to `Enforce: Not Configured`. 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. You can customize these policies to target specific resources while retaining essential audit data. diff --git a/docs/guides/github/import-github-organization/index.md b/docs/guides/github/import-github-organization/index.md index 2d28e35b..127fc7f7 100644 --- a/docs/guides/github/import-github-organization/index.md +++ b/docs/guides/github/import-github-organization/index.md @@ -3,6 +3,9 @@ title: Import GitHub Organization sidebar_label: Import GitHub Organization --- +CHANGES TODO + + # Import GitHub Organization In this guide, you will: diff --git a/docs/guides/github/real-time-events/event-pollers/index.md b/docs/guides/github/real-time-events/event-handler/index.md similarity index 99% rename from docs/guides/github/real-time-events/event-pollers/index.md rename to docs/guides/github/real-time-events/event-handler/index.md index fb4ae80e..b2e744e5 100644 --- a/docs/guides/github/real-time-events/event-pollers/index.md +++ b/docs/guides/github/real-time-events/event-handler/index.md @@ -6,6 +6,8 @@ nav: order: 20 --- +CHANGES TODO + # GCP Event Pollers Turbot Guardrails offers a polling mechanism for obtaining relevant events from GCP and diff --git a/docs/guides/index.md b/docs/guides/index.md index 89a96783..dab8a76c 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -11,6 +11,7 @@ This section provides detailed step-by-step instructions on how to use Guardrail | [Governing AWS](guides/aws) | Guides to import AWS accounts and configure AWS-specific Guardrails features. | [Governing Azure](guides/azure) | Guides to import Azure accounts and configure Azure-specific Guardrails features. | [Governing GCP](guides/gcp) | Guides to import GCP projects and configure GCP-specific Guardrails features. +| [Governing GitHub](guides/github) | Guides to import GitHub organization and configure GitHub-specific Guardrails features. | [Governing Kubernetes](guides/kubernetes) | Guides to import Kubernetes clusters and configure Kubernetes-specific Guardrails features. | [Hosting Guardrails](guides/hosting-guardrails) | How to install and maintain the Enterprise version of Turbot Guardrails running in your own AWS account. | [Integrating ServiceNow](guides/servicenow) | How to install and manage Guardrail's ServiceNow CMDB sync.