Skip to content

Commit

Permalink
fix merge conflicts
Browse files Browse the repository at this point in the history
  • Loading branch information
johnsmyth committed Jan 31, 2025
2 parents 91076b6 + d303bb8 commit 56e5deb
Show file tree
Hide file tree
Showing 10 changed files with 68 additions and 10 deletions.
6 changes: 3 additions & 3 deletions docs/guides/aws/import-aws-organization/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ In the **Choose your folder** dropdown, select the Guardrails [folder](/guardrai

To import your AWS Organization, Guardrails needs access to the [Organizations API](https://docs.aws.amazon.com/organizations/latest/APIReference/Welcome.html) from the management account or a [delegated account](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_delegate_policies.html). In this step, you will create a role in this account that trusts the guardrails master account and has the required permissions.

Enter the required information in the **Setup Access to your organization** section. After you fill in the required information, you will download and run a Cloudformation stack to create the role with options that you have selected. Alternatively, you may create the role manually and then enter the information about the role that you have created.
Enter the required information in the **Setup Access to your organization** section. After you fill in the required information, you will download and run a CloudFormation stack to create the role with options that you have selected. Alternatively, you may create the role manually and then enter the information about the role that you have created.

![Download Organization CFN Template](/images/docs/guardrails/guides/aws/import-aws-organization/download-management-account-iam-role-cfn-template.png)

Expand Down Expand Up @@ -200,7 +200,7 @@ Outputs:

In the previous step, you created a role in the Organizations account that is used to discover your Organization, OUs, and Accounts. Now you will create a role *in each of the member accounts* so that guardrails can manage them.

Enter the required information in the **Setup Access to Your Member Accounts** section. After you fill in the required information, you will download a Cloudformation template and run a stack set to create the role with options that you have selected. Alternatively, you may create the roles manually and then enter the information about the roles that you have created.
Enter the required information in the **Setup Access to Your Member Accounts** section. After you fill in the required information, you will download a CloudFormation template and run a stack set to create the role with options that you have selected. Alternatively, you may create the roles manually and then enter the information about the roles that you have created.

![Setup Member Account Access](/images/docs/guardrails/guides/aws/import-aws-organization/setup-member-accounts-access.png)

Expand All @@ -219,7 +219,7 @@ Enter the required information in the **Setup Access to Your Member Accounts** s
> [!IMPORTANT]
> Enabling [External ID Protection](/guardrails/docs/faq/general-faq#how-does-guardrails-protect-my-aws-account-from-the-confused-deputy-problem) is **strongly recommended**, especially for SaaS customers!
- After all the information has been entered, download the CloudFormation template to create the required IAM role in each member account.
- After all the information has been entered, download the CloudFormation template to create the required IAM role in each member account.

![Download Member CFN Template](/images/docs/guardrails/guides/aws/import-aws-organization/download-member-account-iam-role-cfn-template.png)

Expand Down
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,60 @@
---
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](https://turbot.com/guardrails/docs/reference/glossary#mod) in Guardrails is a collection of Resource, Policy, and Control types associated with a specific cloud platform service. [Installing a Mod](https://turbot.com/guardrails/docs/guides/configuring-guardrails/install-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 with provided local credentials or by using any SAML based login.

![Guardrails Console Login](/images/docs/guardrails/guides/hosting-guardrails/monitoring/check-mod-health/guardrails-console-login.png)

## Step 2: Navigate to Mods

Select **Admin** from the top right corner. Choose **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]
> The health of a mod is determined by its **Installed Control Types**. If any installed control type is in an error state, the mod will be marked as unhealthy and display 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)

## Next Steps

Please see the following resources to learn more about Turbot Guardrails Enterprise:

- Learn how to [Diagnose Control Errors](https://turbot.com/guardrails/docs/guides/hosting-guardrails/monitoring/diagnose-control-error).
- Learn how to [Investigate an Event Flood](https://turbot.com/guardrails/docs/guides/hosting-guardrails/monitoring/investigate-event-flood).

## Troubleshooting

| Issue | Description | Guide |
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|
| Further Assistance | If you continue to encounter issues, please open a ticket with us and attach the relevant information to assist you more efficiently. | [Open Support Ticket](https://support.turbot.com) |
7 changes: 4 additions & 3 deletions docs/guides/hosting-guardrails/monitoring/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Monitoring"
sidebar_label: "Monitoring"
title: Monitoring
sidebar_label: Monitoring
---

## Monitoring
Expand All @@ -12,4 +12,5 @@ The following guides provide detailed instructions for effectively monitoring Gu
| [Diagnose Control Error](/guardrails/docs/guides/hosting-guardrails/monitoring/diagnose-control-error) | Provides steps to identify and resolve control errors in Guardrails. |
| [Investigate Event Flood](/guardrails/docs/guides/hosting-guardrails/monitoring/investigate-event-flood) | Outlines the process for diagnosing and managing event floods. |
| [Monitoring and Alarms](/guardrails/docs/guides/hosting-guardrails/monitoring/monitoring-alarms) | Guides for assessing various CloudWatch metrics provided in TE and TED stack. |
| [Workspace Health Check](/guardrails/docs/guides/hosting-guardrails/monitoring/workspace-health-check) | Guides for assessing the health of your Guardrails workspace. |
| [Workspace Health Check](/guardrails/docs/guides/hosting-guardrails/monitoring/workspace-health-check) | Guides for assessing the health of your Guardrails workspace. |
| [Mod Health Check](/guardrails/docs/guides/hosting-guardrails/monitoring/check-mod-health) | Guides for checking the health of your Mod in workspace. |
5 changes: 1 addition & 4 deletions docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -200,10 +200,6 @@
"type": "placeholder",
"file": "guides/github/github-sidebar.json"
},
{
"type": "placeholder",
"file": "guides/github/github-sidebar.json"
},
{
"type": "category",
"id": "kubernetes",
Expand Down Expand Up @@ -444,6 +440,7 @@
"items": [
"guides/hosting-guardrails/monitoring/investigate-event-flood",
"guides/hosting-guardrails/monitoring/diagnose-control-error",
"guides/hosting-guardrails/monitoring/check-mod-health",
"guides/hosting-guardrails/monitoring/workspace-health-check",
"guides/hosting-guardrails/monitoring/monitoring-alarms"
]
Expand Down

0 comments on commit 56e5deb

Please sign in to comment.