Skip to content

Commit 429cf8a

Browse files
Merge branch 'main' into add-guide-associate-policypack-resource-232
2 parents f246428 + f42c8da commit 429cf8a

File tree

164 files changed

+1136
-23
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

164 files changed

+1136
-23
lines changed

docs/getting-started/getting-started-aws/connect-an-account/index.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: Connect an AWS Account
55

66
# Connect an AWS Account to Guardrails
77

8-
In this guide, you will deploy the Guardrails IAM access role to your AWS account using a CloudFormation template and then connect that account to Guardrails.
8+
In this guide, you will deploy the Guardrails IAM access role to your AWS account using a CloudFormation template and then connect that account to Guardrails.
99

1010
This is the second guide in the *Getting started with AWS* series.
1111

@@ -40,21 +40,25 @@ Wait for the progress bar to complete. The time this takes will depend on how ma
4040

4141
## Step 5: View Controls by state
4242

43-
Select **Reports** from the top navigation menu. Type `controls` into the **Search reports…** field to show only reports with the word "controls" in their name. Select the **Controls by State** report from the list.
43+
Select **Reports** from the top navigation menu. Type `controls` into the **Search reports…** field to show only reports with the word "controls" in their name. Select the **Controls by State** report from the list.
4444

4545
<p><img alt="search-for-controls-reports" src="/images/docs/guardrails/getting-started/getting-started-aws/connect-an-account/search-for-controls-reports.png"/></p>
4646

4747
## Step 6: Configure report filters
4848

4949
From the filter bar, expand the **Type** dropdown. Then select the checkbox next to **AWS** to limit the report to only show AWS controls.
50-
51-
Bookmark the **Controls by State** report, you’ll need it in subsequent guides.
50+
51+
Bookmark the **Controls by State** report, you’ll need it in subsequent guides.
5252

5353
<p><img alt="set-type-filter" src="/images/docs/guardrails/getting-started/getting-started-aws/connect-an-account/set-type-filter.png"/></p>
5454

5555
## Step 7: View the report
5656

57-
Review the status of your controls for AWS. `Alarm`, `OK`, `Skipped`, and `TBD` are all common and normal states to see in your account. If you see controls in `Error` or `Invalid` states, those must be cleared before moving further into these guides.
57+
Review the status of your controls for AWS. `Alarm`, `OK`, `Skipped`, and `TBD` are all common and normal states to see in your account.
58+
59+
> [!IMPORTANT]
60+
> The controls in `Error` or `Invalid` states must be cleared before moving further into these guides.
61+
> It takes few mins depending on various factors. We suggest to wait and report to [Turbot support]([email protected]), in case these errors are not cleared up automatically.
5862
5963
<p><img alt="aws-controls-by-state" src="/images/docs/guardrails/getting-started/getting-started-aws/connect-an-account/aws-controls-by-state.png"/></p>
6064

-152 KB
Loading

docs/getting-started/getting-started-aws/prepare-account/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ This is the first guide in the *Getting started with AWS* series.
2020
2121
## Step 1: Login to Guardrails
2222

23-
Login to your Guardrails console and select the **CONNECT** option from the home page.
23+
Login to your Guardrails console and select the **CONNECT** option from the home page.
2424

2525
<p><img alt="locate-top-level-connect" src=" /images/docs/guardrails/getting-started/getting-started-aws/prepare-account/locate-top-level-connect.png"/></p>
2626

2727
## Step 2: Download the CloudFormation template
2828

2929
Guardrails needs an IAM role that grants permission to discover [resources](/guardrails/docs/reference/glossary#resource) in your account and to monitor changes via event handlers. The CloudFormation template downloaded in this step has the minimum permissions necessary to create that role.
3030

31-
Select **AWS Account** from the left navigation and then click the blue **Download CloudFormation Template** button to download the CloudFormation template you will use to create the required IAM role in your AWS account.
31+
Select **AWS Account** from the left navigation and then click the blue **Download CloudFormation Template** button to download the CloudFormation template you will use to create the required IAM role in your AWS account.
3232

3333
<p><img alt="initial-connect-screen" src=" /images/docs/guardrails/getting-started/getting-started-aws/prepare-account/initial-connect-screen.png"/></p>
3434

@@ -83,7 +83,6 @@ Select the **Outputs** tab and copy the ARN of the Guardrails IAM role.
8383

8484
In this guide you've learned how to deploy an AWS role that grants minimal permissions to Guardrails using the AWS CloudFormation service.
8585

86-
8786
## Next Steps
8887

8988
In the [next guide](/guardrails/docs/getting-started/getting-started-aws/connect-an-account) you will use the IAM role you just created to import an AWS account into Guardrails.
397 KB
Loading
638 KB
Loading
Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
---
2+
title: Apply a Quick Action
3+
sidebar_label: Apply a Quick Action
4+
---
5+
6+
# Apply a Quick Action
7+
8+
In this guide we’ll show how you can enable Guardrails to perform [Quick Actions](/guardrails/docs/guides/quick-actions) that fix misconfigurations. A Quick Action empowers an administrator to quickly fix misconfigurations by applying a change directly to an underlying Azure resource. In order to use this feature, the role used by Guardrails will need additional permissions to perform those actions. This guide will instruct you how to change the permissions specific to storage accounts, other types of quick actions will require different permission grants.
9+
10+
This is the ninth guide in the *Getting started with Azure series*.
11+
12+
## Prerequisites
13+
14+
- Completion of the previous guides in this series.
15+
- Access to the Guardrails console with administrative privileges.
16+
- Access to the Azure portal with administrative privileges to add permissions to the Guardrails role.
17+
18+
## Step 1: Locate the resource group
19+
20+
In the Azure portal, navigate to **Resource Groups** and select the storage accounts you’re using in this series.
21+
22+
<p><img alt="permissions 1" src="/images/docs/guardrails/getting-started/getting-started-azure/apply-quick-action/permissions-1.png"/></p>
23+
24+
## Step 2: Open Access Control (IAM)
25+
26+
<p><img alt="permissions 2" src="/images/docs/guardrails/getting-started/getting-started-azure/apply-quick-action/permissions-2.png"/></p>
27+
28+
## Step 3: Begin role assignment
29+
30+
Expand the **Add** dropdown and choose **Add role assignment**.
31+
32+
<p><img alt="permissions 3" src="/images/docs/guardrails/getting-started/getting-started-azure/apply-quick-action/permissions-3.png"/></p>
33+
34+
## Step 4: Search for the role
35+
36+
Seach for `storage account contributor`, select it, and select **Next**.
37+
38+
<p><img alt="permissions 4" src="/images/docs/guardrails/getting-started/getting-started-azure/apply-quick-action/permissions-4.png"/></p>
39+
40+
## Step 5: Search for registered app
41+
42+
Select **Select members**, search for the name of your registered app, and **Select** it.
43+
44+
<p><img alt="permissions 5" src="/images/docs/guardrails/getting-started/getting-started-azure/apply-quick-action/permissions-5.png"/></p>
45+
46+
## Step 6: Review and assign
47+
48+
<p><img alt="permissions 6" src="/images/docs/guardrails/getting-started/getting-started-azure/apply-quick-action/permissions-6.png"/></p>
49+
50+
## Step 7: Find Quick Actions
51+
52+
Select **Policies** from the top-level navigation. In the search box, type `quick actions`, then select the **Turbot > Quick Actions > Enabled** policy type.
53+
54+
<p><img alt="find_quick_actions_policies" src="/images/docs/guardrails/getting-started/getting-started-aws/apply-quick-action/find-quick-actions-policies.png"/></p>
55+
56+
Select the green **New Policy Setting** button.
57+
58+
<p><img alt="view-quick-actions-enabled-policy-type" src="/images/docs/guardrails/getting-started/getting-started-aws/apply-quick-action/view-quick-actions-enabled-policy-type.png"/></p>
59+
60+
## Step 8: Enable Quick Actions
61+
62+
Choose **Sandbox** as the **Resource**, and then select **Enabled**, and select the green **Create** button.
63+
64+
<p><img alt="aws-enable-quick-actions" src="/images/docs/guardrails/getting-started/getting-started-aws/apply-quick-action/aws-enable-quick-actions.png"/></p>
65+
66+
## Step 9: Find a storage account in Alarm
67+
68+
Use your bookmark to navigate back to the **Controls by State** report and filter on **Azure > Storage > Storage Account > Minimum TLS Version**.
69+
70+
<p><img alt="find_storage_account_in_alarm_for_quick_action" src="/images/docs/guardrails/getting-started/getting-started-azure/apply-quick-action/find-storage-account-in-alarm-for-versioning.png"/></p>
71+
72+
## Step 10: Select a storage account in Alarm
73+
74+
Select a storage account in `Alarm` state from the list of storage accounts.
75+
76+
<p><img alt="select_storage account_in_alarm_for_quick_action" src="/images/docs/guardrails/getting-started/getting-started-azure/apply-quick-action/select-storage-account-in-alarm-for-versioning.png"/></p>
77+
78+
## Step 11: Use a Quick Action
79+
80+
Select the **Actions** dropdown, and choose *Set Minimum TLS Version*.
81+
82+
<p><img alt="expand-quick-actions-dropdown" src="/images/docs/guardrails/getting-started/getting-started-azure/apply-quick-action/expand-quick-actions-dropdown.png"/></p>
83+
84+
## Step 12: Observe the change
85+
86+
Guardrails reports that the action was successful, and the control goes to the `OK` state.
87+
88+
<p><img alt="observe-updated-control" src="/images/docs/guardrails/getting-started/getting-started-azure/apply-quick-action/observe-updated-control.png"/></p>
89+
90+
![alt text](image.png)
91+
92+
## Step 13: Check if it worked
93+
94+
Open a tab to the Azure portal and navigate to the storage account. Confirm the Guardrails `Quick Action` has correctly set the minimum TLS version.
95+
96+
<p><img alt="observe-azure-console-result" src="/images/docs/guardrails/getting-started/getting-started-azure/apply-quick-action/raw-observe-azure-console-result.png"/></p>
97+
98+
## Step 14: Review
99+
100+
In this guide you enabled Guardrails Quick Actions and used a Quick Action to change a storage account's policy for minimum TLS version.
101+
102+
## Next Steps
103+
104+
In the [next guide](/guardrails/docs/getting-started/getting-started-azure/enable-enforcement) we’ll set Guardrails to automatically enforce these actions continuously.
105+
106+
107+
## Progress tracker
108+
109+
- [x] Prepare an Azure Subscription for Import to Guardrails
110+
- [x] Connect an Azure Subscription to Guardrails
111+
- [x] Observe Azure Resource Activity
112+
- [x] Enable Your First Guardrails Policy Pack
113+
- [x] Review Subscription-Wide Governance
114+
- [x] Create a Static Exception to a Guardrails Azure Policy
115+
- [x] Create a Calculated Exception to a Guardrails Azure Policy
116+
- [x] Send an Alert to Email
117+
- [x] **Apply a Quick Action**
118+
- [ ] Enable Automatic Enforcement
362 KB
Loading
158 KB
Loading
324 KB
Loading
158 KB
Loading

0 commit comments

Comments
 (0)