Skip to content

Commit

Permalink
Add guide - How to Identify and Fix Invalid Controls. closes #221
Browse files Browse the repository at this point in the history
  • Loading branch information
RahulSrivastav14 committed Dec 18, 2024
1 parent 2ad6b26 commit 2beba95
Show file tree
Hide file tree
Showing 12 changed files with 96 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
title: Identify and Fix Invalid Controls
sidebar_label: Identify and Fix Invalid Controls
---

# Identify and Fix Invalid Controls

In this guide, you will:
- Use Guardrails console to identify and fix controls in an invalid state.

Controls enforce policies to ensure cloud resources remain compliant and Guardrails functions properly. Controls in OK, Alarm, or Skipped states indicate a healthy environment. Regularly resolving controls in an Invalid or error state helps maintain consistency and avoid errors.

## Prerequisites

- **Turbot/Operator** permissions at the Turbot resource level.
- Familiarity with Guardrails console.

## Step 1: Login to Guardrails Console

Log into the Guardrails console.

![Guardrails Console Login](/images/docs/guardrails/guides/using-guardrails/troubleshooting/identify-fix-invalid-controls/guardrails-console-login.png)

## Step 2: Navigate to Reports

Choose **Reports** from the top navigation menu.

![Navigate to Reports](/images/docs/guardrails/guides/using-guardrails/troubleshooting/identify-fix-invalid-controls/guardrails-navigate-to-reports.png)

## Step 3: View Control Alerts

From **Controls**, select **Alerts by Control Type**.

![Alerts by Control Type](/images/docs/guardrails/guides/using-guardrails/troubleshooting/identify-fix-invalid-controls/guardrails-select-controls-alerts.png)

Select **Invalid** from the **State** filter dropdown to display all invalid controls.

![Apply Filter](/images/docs/guardrails/guides/using-guardrails/troubleshooting/identify-fix-invalid-controls/guardrails-filter-invalid.png)

## Step 4: Select Invalid Control

Select the desired invalid control from the list to view detailed information and investigate further.

![Select Invalid Control](/images/docs/guardrails/guides/using-guardrails/troubleshooting/identify-fix-invalid-controls/guardrails-select-invalid-control.png)

The control page shows why it is in an invalid state. In this case, the issue is that the required sub-policies for the active control are set to Skipped.

![Control Page](/images/docs/guardrails/guides/using-guardrails/troubleshooting/identify-fix-invalid-controls/guardrails-controls-page.png)

## Step 5: Fix Control Issues

Select the **Policies** tab to display the list of sub-policies currently in a Skipped state.

![Select Policies Tab](/images/docs/guardrails/guides/using-guardrails/troubleshooting/identify-fix-invalid-controls/guardrails-sub-policy-page.png)

Select the sub-policy, choose the desired setting, and click **Create** to apply the changes.

![Apply Setting](/images/docs/guardrails/guides/using-guardrails/troubleshooting/identify-fix-invalid-controls/guardrails-apply-policy-setting.png)

The control re-evaluates the policies and transitions to an OK state if the settings are correctly applied.

![Control OK State](/images/docs/guardrails/guides/using-guardrails/troubleshooting/identify-fix-invalid-controls/guardrails-control-ok-state.png)

## Step 6: Optimizing Controls

*Review the controls in Invalid state* currently and take the necessary actions.

*If the state is due to policy misconfiguration*, carefully adjust the settings and apply the changes as required. Ensure that all configurations align with the workspace's needs to resolve the issue effectively.

*For product-related issues*, make sure to document and report them for further investigation.

Additionally, to maintain efficiency, resources or controls that are not a priority should be skipped to reduce noise and wastage.

If you encounter any issues, please [Open Support Ticket](https://support.turbot.com) and attach the relevant information to assist you more efficiently.

- A screenshot of the Guardrails control in Invalid state.
- A screenshot of the Guardrails Policy in an Invalid state.
11 changes: 11 additions & 0 deletions docs/guides/using-guardrails/troubleshooting/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Troubleshooting"
sidebar_label: "Troubleshooting"
---

## Troubleshooting

The following workflows will assist with rapid resolution of common problems. When the problem cannot be resolved, the instructions will include additional information to gather before escalating with Guardrails Customer Success.

- [AWS Console Troubleshooting](guides/troubleshooting/troubleshooting-event-handlers-aws-console)
- [Guardrails Console Troubleshooting](guides/troubleshooting/troubleshooting-event-handlers-guardrails-console)
8 changes: 8 additions & 0 deletions docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -355,6 +355,14 @@
"guides/using-guardrails/iam/advanced"
]
},
{
"type": "category",
"id": "troubleshooting",
"link": "guides/using-guardrails/troubleshooting",
"items": [
"guides/using-guardrails/troubleshooting/identify-fix-invalid-controls"
]
},

{
"type": "category",
Expand Down

0 comments on commit 2beba95

Please sign in to comment.