Add table turbot_policy_value closes #14 #31

ParthaI · 2022-01-06T04:28:43Z

Example query results

Results

> select
  id,
  state,
  is_default,
  is_calculated,
  policy_type_id,
  policy_value_type_mod_uri
from
  turbot_policy_value
where
  policy_type_id = 190630193572596;
+-----------------+-------+------------+---------------+-----------------+---------------------------+
| id              | state | is_default | is_calculated | policy_type_id  | policy_value_type_mod_uri |
+-----------------+-------+------------+---------------+-----------------+---------------------------+
| 243392852690564 | ok    | true       | false         | 190630193572596 | tmod:@turbot/gcp-iam      |
| 243392852612714 | ok    | true       | false         | 190630193572596 | tmod:@turbot/gcp-iam      |
| 197439793364380 | ok    | true       | false         | 190630193572596 | tmod:@turbot/gcp-iam      |
+-----------------+-------+------------+---------------+-----------------+---------------------------+

> select
  id,
  state,
  is_default,
  is_calculated,
  resource_id,
  policy_value_type_mod_uri
from
  turbot_policy_value
where
  resource_id = 243392852451917;
+-----------------+-------+------------+---------------+-----------------+---------------------------+
| id              | state | is_default | is_calculated | resource_id     | policy_value_type_mod_uri |
+-----------------+-------+------------+---------------+-----------------+---------------------------+
| 243392852558428 | ok    | true       | false         | 243392852451917 | tmod:@turbot/gcp-iam      |
| 243392852610665 | ok    | true       | false         | 243392852451917 | tmod:@turbot/gcp-cisv1    |
| 243392852586083 | ok    | true       | false         | 243392852451917 | tmod:@turbot/gcp-iam      |
| 243392852612714 | ok    | true       | false         | 243392852451917 | tmod:@turbot/gcp-iam      |
| 243392852590180 | ok    | true       | false         | 243392852451917 | tmod:@turbot/gcp-iam      |
| 243392852597350 | ok    | true       | false         | 243392852451917 | tmod:@turbot/gcp-cisv1    |
| 243392852602472 | ok    | true       | false         | 243392852451917 | tmod:@turbot/gcp-cisv1    |
| 243392852576866 | ok    | true       | false         | 243392852451917 | tmod:@turbot/gcp-iam      |
+-----------------+-------+------------+---------------+-----------------+---------------------------+

> select
  id,
  state,
  is_default,
  is_calculated,
  resource_type_id,
  policy_value_type_mod_uri
from
  turbot_policy_value
where
  resource_type_id = 190630180698932;
+-----------------+-------+------------+---------------+------------------+---------------------------+
| id              | state | is_default | is_calculated | resource_type_id | policy_value_type_mod_uri |
+-----------------+-------+------------+---------------+------------------+---------------------------+
| 243392852686466 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-cisv1    |
| 243392852586083 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-iam      |
| 243392852690564 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-iam      |
| 243392852688515 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-cisv1    |
| 243392852576866 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-iam      |
| 243392852558428 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-iam      |
| 243392852610665 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-cisv1    |
| 243392852646514 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-iam      |
| 197439793404331 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-cisv1    |
| 243392852612714 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-iam      |
| 243392852674176 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-cisv1    |
| 197439793401256 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-cisv1    |
| 243392852665974 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-iam      |
| 243392852590180 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-iam      |
| 197439793397157 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-cisv1    |
| 243392852670072 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-iam      |
| 243392852602472 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-cisv1    |
| 197439793357209 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-iam      |
| 243392852660851 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-iam      |
| 243392852597350 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-cisv1    |
| 197439793364380 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-iam      |
| 197439793371551 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-iam      |
| 197439793393058 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-iam      |
| 197439793345941 | ok    | true       | false         | 190630180698932  | tmod:@turbot/gcp-iam      |
+-----------------+-------+------------+---------------+------------------+---------------------------+

cbruno10

@ParthaI Please see comments, thanks!

cbruno10 · 2022-01-26T22:04:05Z

docs/tables/turbot_policy_value.md

@@ -0,0 +1,93 @@
+# Table: turbot_resource


Suggested change

# Table: turbot_resource

# Table: turbot_policy_value

cbruno10 · 2022-01-26T22:04:12Z

docs/tables/turbot_policy_value.md

@@ -0,0 +1,93 @@
+# Table: turbot_resource
+
+Resources in Turbot represent cloud configuration items such as users,


This is the wrong description

Removed the description.

cbruno10 · 2022-01-26T22:04:27Z

docs/tables/turbot_policy_value.md

+Resources in Turbot represent cloud configuration items such as users,
+networks, servers, etc.
+
+It is recommended that queries to this table should include (usually in the `where` clause) at least one


I don't think this is relevant to this table?

cbruno10 · 2022-01-26T22:04:52Z

docs/tables/turbot_policy_value.md

+It is recommended that queries to this table should include (usually in the `where` clause) at least one
+of these columns: `id`, `resource_type_id`, `resource_type_uri` or `filter`.
+
+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 own value for that policy, which will be the resultant calculated policy for the "winning" policy in the hierarchy.


Suggested change

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 own value for that policy, which will be the resultant calculated policy for the "winning" policy in the hierarchy.

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 own value for that policy, which will be the resultant calculated policy for the "winning" policy in the hierarchy.

cbruno10 · 2022-01-26T22:06:30Z

docs/tables/turbot_policy_value.md

+
+## Examples
+
+### List policy values by policy type id


Suggested change

### List policy values by policy type id

### List policy values by policy type ID

cbruno10 · 2022-01-26T22:08:58Z

docs/tables/turbot_policy_value.md

+  filter = 'policyTypeId:123456789';
+```
+
+### Extract all policy values from Turbot


I don't believe we should include this example - policy values are set for every policy type on every applicable resource. I find it extremely rare that I'd want to see all policy values (policy settings or resources make more sense).

Removed this example

docs/tables/turbot_policy_value.md

turbot/table_turbot_policy_value.go

cbruno10 · 2022-01-26T22:11:18Z

turbot/table_turbot_policy_value.go

+			{Name: "policy_type_title", Type: proto.ColumnType_STRING, Transform: transform.FromField("Type.Title"), Description: "Title of the policy type."},
+			{Name: "poliy_type_trunk_title", Type: proto.ColumnType_STRING, Transform: transform.FromField("Type.Trunk.Title"), Description: "Title with full path of the policy type."},
+			{Name: "is_default", Type: proto.ColumnType_BOOL, Transform: transform.FromField("Default"), Description: "Defines the policy value is default or not."},
+			{Name: "is_calculated", Type: proto.ColumnType_BOOL, Description: "True if this is a policy setting will be calculated for each value."},


Similar to is_default, and other columns in this table, the description does not have correct grammar, what description does our GraphQL API have?

The description for is_calculated is If true this value is derived from calculated setting inputs e.g. templateInput and template. in GraphQL API.

Similarly for is_default it is If true this value is derived from the default value of the type.

@ParthaI Let's copy those descriptions, they read OK in a description context here, and being able to re-use them is an easy way to get accurate, grammatically correct descriptions.

Updated the description for is_default and is_calculated columns

cbruno10 · 2022-01-26T22:11:28Z

turbot/table_turbot_policy_value.go

+			{Name: "id", Type: proto.ColumnType_INT, Transform: transform.FromField("Turbot.ID"), Description: "Unique identifier of the policy value."},
+			{Name: "policy_type_title", Type: proto.ColumnType_STRING, Transform: transform.FromField("Type.Title"), Description: "Title of the policy type."},
+			{Name: "poliy_type_trunk_title", Type: proto.ColumnType_STRING, Transform: transform.FromField("Type.Trunk.Title"), Description: "Title with full path of the policy type."},
+			{Name: "is_default", Type: proto.ColumnType_BOOL, Transform: transform.FromField("Default"), Description: "Defines the policy value is default or not."},


This description does not have correct grammar, what description does our GraphQL API have?

ParthaI added 4 commits January 5, 2022 14:29

Add table turbot_policy_value closes #14

e6682eb

Added spaces between the line

9309d70

Removed the extra spaces

c2a7c15

Added doc and removed the unused util function

b3b7394

ParthaI requested review from misraved and bigdatasourav January 6, 2022 04:28

ParthaI self-assigned this Jan 6, 2022

Update the comun name

21552dc

ParthaI linked an issue Jan 6, 2022 that may be closed by this pull request

Add table turbot_policy_value #14

Closed

rajlearner17 requested review from rajlearner17 and removed request for misraved January 24, 2022 10:09

ParthaI added 2 commits January 24, 2022 16:43

Updated the column name

b14d6b7

Updated the column name and added resource_trunk_title column

a5b0940

cbruno10 suggested changes Jan 26, 2022

View reviewed changes

ParthaI and others added 4 commits January 27, 2022 08:37

made changes as per review comments

650ed1c

Updated the doc

bc72098

Updated the column ordering

dd3daf6

Update turbot_policy_value.md

e632d2f

cbruno10 approved these changes Jan 27, 2022

View reviewed changes

cbruno10 merged commit 7845880 into main Jan 27, 2022

cbruno10 deleted the issue-14 branch January 27, 2022 13:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add table turbot_policy_value closes #14 #31

Add table turbot_policy_value closes #14 #31

ParthaI commented Jan 6, 2022

cbruno10 left a comment

cbruno10 Jan 26, 2022

cbruno10 Jan 26, 2022

ParthaI Jan 27, 2022

cbruno10 Jan 26, 2022

cbruno10 Jan 26, 2022

ParthaI Jan 27, 2022

cbruno10 Jan 26, 2022

ParthaI Jan 27, 2022

cbruno10 Jan 26, 2022

ParthaI Jan 27, 2022

cbruno10 Jan 26, 2022

ParthaI Jan 27, 2022 •

edited

Loading

cbruno10 Jan 27, 2022 •

edited

Loading

ParthaI Jan 27, 2022

cbruno10 Jan 26, 2022

		@@ -0,0 +1,93 @@
		# Table: turbot_resource

		Resources in Turbot represent cloud configuration items such as users,

	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 own value for that policy, which will be the resultant calculated policy for the "winning" policy in the hierarchy.
	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 own value for that policy, which will be the resultant calculated policy for the "winning" policy in the hierarchy.

	### List policy values by policy type id
	### List policy values by policy type ID

Add table turbot_policy_value closes #14 #31

Add table turbot_policy_value closes #14 #31

Conversation

ParthaI commented Jan 6, 2022

Example query results

cbruno10 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ParthaI Jan 27, 2022 • edited Loading

Choose a reason for hiding this comment

cbruno10 Jan 27, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ParthaI Jan 27, 2022 •

edited

Loading

cbruno10 Jan 27, 2022 •

edited

Loading