Thanks to visit codestin.com
Credit goes to github.com

Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/concepts/policies/values-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ sidebar_label: Values & Settings

Each policy type may have many settings for different resources.

<div className="example"> The policy type <code>AWS > S3 > Bucket > Approved</code> may be set to `Enforce: Delete unapproved if new & empty` for development accounts, but deliberately limited to `Check: Approved` for production accounts.
<div className="example"> The policy type <code>AWS > S3 > Bucket > Approved</code> may be set to <code>Enforce: Delete unapproved if new & empty</code> for development accounts, but deliberately limited to <code>Check: Approved</code> for production accounts.
</div>

**Policy Settings** are inherited down through the hierarchy of resources.

<div className="example"> <code>AWS > S3 > Bucket > Approved</code> may be set
to `Enforce: Delete unapproved if new & empty` at Turbot level - ensuring all buckets are deleted if they don't meet the approval criteria (e.g. in approved region).
to <code>Enforce: Delete unapproved if new & empty</code> at Turbot level - ensuring all buckets are deleted if they don't meet the approval criteria (e.g. in approved region).
</div>

Policy settings are only valid for target resources and their ancestors.
Expand Down Expand Up @@ -44,7 +44,7 @@ policy values exist only on the target.
<strong>AWS > S3 > Bucket > Approved</strong>
<ul>
<li> A <strong>Policy Setting</strong> for <code>AWS > S3 > Bucket > Approved</code> can be made on an AWS Account, Region, or individual bucket.</li>
<li> <strong>Every</strong> S3 bucket has a <strong>Policy Value</strong> for <code>AWS > S3 > Bucket > Approved</code>. The policy value may have been set at the AWS account, region, and/or individual bucket - this is the effective value for this instance.</li>
<li> <strong>Every</strong> S3 bucket that has a <strong>Policy Setting</strong> for <code>AWS > S3 > Bucket > Approved</code> will have a corresponding <strong>Policy Value</strong> for <code>AWS > S3 > Bucket > Approved</code>. The policy value represents the effective setting for this instance, which may have been inherited from the AWS account, region, or set directly on the individual bucket.</li>
</ul>
</div>

Expand Down
30 changes: 29 additions & 1 deletion docs/faq/workspace-faq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,51 @@ sidebar_label: "Workspace FAQ"
* [When do Guardrails API keys expire?](#when-do-guardrails-api-keys-expire)
* [Is it possible to get an event stream out of Guardrails?](#is-it-possible-to-get-an-event-stream-out-of-guardrails)
* [Can I make mods available for only part of the workspace?](#can-i-make-mods-available-for-only-part-of-the-workspace)
* [Why don't I see all controls for my resources?](#why-dont-i-see-all-controls-for-my-resources)
* [Why do some policy types have no values?](#why-do-some-policy-types-have-no-values)

---

## Can I rotate the keys embedded in Guardrails' event handlers?

Sure! Regular key rotation is a part of any strong security stance. Configuration and troubleshooting instructions can be found on the [key rotation](workspace-faq/key_rotation) page.

## The Guardrails console session expires at 12 hours. Can it be shorter?

The Guardrails console session timeout period can be adjusted with the [Turbot > Workspace > Console Session Timeout](mods/turbot/turbot-iam/policy#turbot--workspace--console-session-timeout) to as little as 15 minutes. Keep in mind that this is a global change that affects all users in the Guardrails console. Guardrails API keys are not affected by this change.

## When do Guardrails API keys expire?

By default, Guardrails API keys do not expire. Guardrails admins can set the [Turbot > IAM > Access Key > Expiration](mods/turbot/turbot-iam/policy#turbot--iam--access-key--expiration) policy to deactivate or delete Guardrails API keys to a range of expiration periods ranging up to 90 days. Ensure that Guardrails console access can be recovered if access keys expire for any break-glass users. A calculated policy could be written for the `Turbot > IAM > Access Key > Expiration` policy to identify and preserve the API keys for break-glass users but deactivate/destroy keys for other users.

Note that this policy does not affect AWS IAM Access Keys.

## Is it possible to get an event stream out of Guardrails?

The Guardrails Firehose provides a user configurable event stream of cloud environment change, Guardrails control state, and Guardrails permission assignments. Full details on how to configure the Firehose can be found in the [Firehose guide](guides/firehose).

## Can I make mods available for only part of the workspace?
Installing a Guardrails mod makes the resource types, controls and policies available to the entire workspace.

Installing a Guardrails mod makes the resource types, controls and policies available to the entire workspace.

## Why don't I see all controls for my resources?

**Note**: This applies when the `Turbot > Materialization` policy is set to `Automatic`. If set to `Always`, all controls will appear regardless of policy settings.

Most controls are only created when policy settings exist for the primary policy that drives that control.

For example, the `AWS > S3 > Bucket > Approved` control will only appear on your S3 buckets when you have policy settings for the `AWS > S3 > Bucket > Approved` policy type. If you only create policy settings for sub-policies, like `AWS > S3 > Bucket > Approved > Regions`, the control will **not** be created.

CMDB and configuration controls, like `AWS > EC2 > Instance > Discovery` and `AWS > Turbot > Event Handlers`, are always created with their related policy values.

You can view all available control types for a resource by navigating to a specific resource, and then selecting the `Controls` tab.

## Why do some policy types have no values?

**Note**: This applies when the `Turbot > Materialization` policy is set to `Automatic`. If set to `Always`, all policy values will be created regardless of whether policy settings exist.

Most policy types only create policy values when you explicitly set a policy setting somewhere in the resource hierarchy. These are typically policies that drive specific controls like `AWS > S3 > Bucket > Approved` or `AWS > EC2 > Instance > Active`.

For example, if you set the `AWS > S3 > Bucket > Approved` policy at the AWS account level, Guardrails will create policy values for this policy type and all of its sub-policies, like `AWS > S3 > Bucket > Approved > Regions` for all S3 buckets in that account. Without a policy setting somewhere in the hierarchy, no policy value exists for these policy types.

Some policy types always have values created automatically when resources are discovered, using default values. These CMDB and configuration policies include settings like CMDB, event handlers, and account notification recipients.
13 changes: 7 additions & 6 deletions docs/getting-started/7-minute-labs/set-policy/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,20 +33,21 @@ values in the Turbot Guardrails Console.

## View a Policy Value

1. In the Turbot Guardrails Console, navigate to the test bucket that you created in the
[prerequisite step](set-policy#prerequisites). Our test bucket name is
_turbot-bucket-version_, which we can search for at the main Turbot Guardrails screen.
Click on the bucket once it is found.
1. In the Turbot Guardrails Console, search for the test bucket called _turbot-bucket-version_ that you created in the [prerequisite step](set-policy#prerequisites).
![](/images/docs/guardrails/search-bucket-step1.png)

2. Click on the bucket once it is found.
![](/images/docs/guardrails/search-bucket-step2.png)

3. Next, you'll see the bucket's details.
![](/images/docs/guardrails/search-bucket-step3.png)

2. Click the **Policies** tab. It shows both
4. Click the **Policies** tab. It shows both
[Policy Settings](concepts/policies/values-settings#policy-settings) and
[Policy Values](concepts/policies/values-settings#policy-values).
![](/images/docs/guardrails/settings-values.png)

3. From the list of Policy Values for this bucket, click on the **Template
5. From the list of Policy Values for this bucket, click on the **Template
(Bucket > Tags > Template)** item to bring up the policy value.
![](/images/docs/guardrails/default-policy-value.png)

Expand Down