-
Notifications
You must be signed in to change notification settings - Fork 2
Update workspace FAQ and policy values concepts with control/policy creation information #390
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 7 commits
2d53f2e
a72816c
93e71a8
e6aecbc
1274b03
c558d4c
762dcd1
c1bacd3
32b0ecd
5338a60
ffa9ba8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,17 +5,17 @@ sidebar_label: Values & Settings | |
|
||
# Policy Values & Settings | ||
|
||
### Policy Settings | ||
## Policy 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. | ||
|
@@ -25,10 +25,10 @@ Policy settings are only valid for target resources and their ancestors. | |
down to the specific S3 Bucket such as <code>Turbot > Folder A > AWS 1111 > us-east-1 > my-bucket</code>. | ||
</div> | ||
|
||
### Policy Values | ||
## Policy Values | ||
|
||
A **Policy Value** is the effective policy setting on an instance of a resource | ||
type. Every resource that is targeted by a given policy setting will have its | ||
type. A resource that is targeted by a given policy setting will have its | ||
own value for that policy, which will be the resultant calculated policy for the | ||
cbruno10 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
"winning" policy in the hierarchy. | ||
|
||
|
@@ -40,11 +40,18 @@ inherited by all resources below. | |
While policy settings can exist above the target in the resource hierarchy, | ||
policy values exist only on the target. | ||
|
||
Policy value creation is controlled by the `Turbot > Materialization` policy, which supports two modes: | ||
|
||
- **Always**: Policy values are created for all resources regardless of whether policy settings exist. This provides comprehensive coverage but may impact performance in large environments. | ||
- **Automatic**: Policy values are only created when you explicitly set a policy setting somewhere in the resource hierarchy. For example, if no policy setting exists for `AWS > S3 > Bucket > Approved` at the AWS account level, then S3 buckets in that account will not have policy values for `AWS > S3 > Bucket > Approved` or its sub-policies. | ||
|
||
|
||
Note that some policy types, such as those related to CMDB and event handler configuration, always create values when resources are discovered, regardless of the materialization mode. | ||
|
||
<div className="example"> | ||
<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> | ||
cbruno10 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
</ul> | ||
</div> | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From:
Controls are only created when you explicitly set a policy setting for the primary policy that drives that control somewhere in the resource hierarchy
To:
Controls are only created when you explicitly set the primary policy in the resource hierarchy