Skip to content

Commit

Permalink
Add guide - How to check Turbot > Mod > Health. Closes #241
Browse files Browse the repository at this point in the history
  • Loading branch information
RahulSrivastav14 committed Jan 3, 2025
1 parent f42c8da commit 7574ab0
Show file tree
Hide file tree
Showing 8 changed files with 56 additions and 1 deletion.
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,54 @@
---
title: How to check Turbot Mod Health
sidebar_label: How to check Turbot Mod Health
---

# How to check Turbot Mod Health

In this guide, you will:
- Use Guardrails console to check the health of a installed mod.

A Mod in Guardrails is a collection of Resource, Policy, and Control types associated with a specific cloud platform service. Installing a Mod (e.g., azure-iam) deploys Controls and initiates the discovery process for all Resource types defined within the Mod. For the Mod’s functionalities and features to work as intended, its health must be in an OK state. Addressing any Mod installation errors promptly is essential to maintain its proper functionality.

## Prerequisites

- **Turbot/Admin** 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/hosting-guardrails/monitoring/check-mod-health/guardrails-console-login.png)

## Step 2: Navigate to Mods

Choose **Admin** from the top right corner.

![Navigate to Reports](/images/docs/guardrails/guides/hosting-guardrails/monitoring/check-mod-health/guardrails-navigate-to-reports.png)

Select **Mods**.

![Mods](/images/docs/guardrails/guides/hosting-guardrails/monitoring/check-mod-health/guardrails-navigate-mods.png)

## Step 3: Select Mod

From the mods list, select the desired mod—for example, the azure-iam mod.

![Select Mod](/images/docs/guardrails/guides/hosting-guardrails/monitoring/check-mod-health/guardrails-select-mod.png)

## Step 3: Check Mod Health

In the **Overview** tab of the mod page, a healthy Mod is indicated by an OK status with the message "Mod is healthy."

> [!NOTE] Mod health is determined by its Installed Control Types. If any installed control type is in an error state, the Mod will be marked as unhealthy with an Error status.
![Mod Overview](/images/docs/guardrails/guides/hosting-guardrails/monitoring/check-mod-health/guardrails-mod-overview.png)

Alternatively, click on the message to navigate to the Mod Health control and verify its status.

![Mod Health Page](/images/docs/guardrails/guides/hosting-guardrails/monitoring/check-mod-health/guardrails-mod-health.png)

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 mod health in error.
3 changes: 2 additions & 1 deletion docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,8 @@
"guides/hosting-guardrails/monitoring/investigate-event-flood",
"guides/hosting-guardrails/monitoring/diagnose-control-error",
"guides/hosting-guardrails/monitoring/workspace-health-check",
"guides/hosting-guardrails/monitoring/monitoring-alarms"
"guides/hosting-guardrails/monitoring/monitoring-alarms",
"guides/hosting-guardrails/monitoring/check-mod-health"
]
},
{
Expand Down

0 comments on commit 7574ab0

Please sign in to comment.