Skip to content

Commit 8c944cc

Browse files
committed
docs(secure-policy): cross-reference managed_ruleset from custom/managed_policy
Adds note callouts to secure_custom_policy.md and secure_managed_policy.md pointing users at secure_managed_ruleset.md for customer-owned policies that inherit a Sysdig-managed ruleset (isDefault: false, templateId != 0). Also expands the secure_managed_ruleset.md intro to explain when to use it. The three policy resources are partitioned by the API's isDefault and templateId fields, but until now the docs did not make that taxonomy visible from the two most-discovered resources, leading users to assume the customer-owned + template-inheriting case was unsupported. Refs #736
1 parent e80d224 commit 8c944cc

3 files changed

Lines changed: 11 additions & 1 deletion

File tree

website/docs/r/secure_custom_policy.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ description: |-
1010

1111
Creates a Sysdig Secure Custom Policy.
1212

13+
-> **Note:** Use `sysdig_secure_custom_policy` only for policies you author from scratch (where you own the rule list). For a customer-owned policy that inherits a Sysdig-managed ruleset (e.g. created via "Copy Policy" on a Sysdig-managed policy in the UI), use [`sysdig_secure_managed_ruleset`](secure_managed_ruleset.md) instead. For tweaking a Sysdig-shipped default policy in place, use [`sysdig_secure_managed_policy`](secure_managed_policy.md). The three resources are distinguished by the API's `isDefault` and `templateId` fields: `managed_policy` for `isDefault: true`, `custom_policy` for `templateId: 0`, and `managed_ruleset` for `templateId != 0` with `isDefault: false`.
14+
1315
-> **Note:** Sysdig Terraform Provider is under rapid development at this point. If you experience any issue or discrepancy while using it, please make sure you have the latest version. If the issue persists, or you have a Feature Request to support an additional set of resources, please open a [new issue](https://github.com/sysdiglabs/terraform-provider-sysdig/issues/new) in the GitHub repository.
1416

1517
## Example Usage

website/docs/r/secure_managed_policy.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ Manages configuration of a Sysdig Secure Managed Policy.
1313
-> **Note:** Sysdig managed policies are not resources that you create. They are provided by Sysdig. This resource
1414
allows you to identify and configure a managed policy. The managed policy is looked up by its name and type.
1515

16+
-> **Note:** Use `sysdig_secure_managed_policy` only for Sysdig-shipped default policies (`isDefault: true` in the API). For a customer-owned policy that inherits a Sysdig-managed ruleset (e.g. created via "Copy Policy" on a Sysdig-managed policy in the UI), use [`sysdig_secure_managed_ruleset`](secure_managed_ruleset.md) instead. For fully customer-authored policies, use [`sysdig_secure_custom_policy`](secure_custom_policy.md).
17+
1618
-> **Note:** Sysdig Terraform Provider is under rapid development at this point. If you experience any issue or discrepancy while using it, please make sure you have the latest version. If the issue persists, or you have a Feature Request to support an additional set of resources, please open a [new issue](https://github.com/sysdiglabs/terraform-provider-sysdig/issues/new) in the GitHub repository.
1719

1820
## Example Usage

website/docs/r/secure_managed_ruleset.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,13 @@ description: |-
88

99
# Resource: sysdig_secure_managed_ruleset
1010

11-
Creates a Sysdig Secure Managed Ruleset
11+
Creates a Sysdig Secure Managed Ruleset.
12+
13+
-> **Note:** A "managed ruleset" is the Sysdig term for a customer-owned policy whose rule list is inherited from a Sysdig-provided template (in the API, `isDefault: false` and `templateId != 0`). Use this resource when:
14+
15+
* You want to keep Sysdig's curated rule list but customize scope, notifications, actions, severity, or which rules are enabled.
16+
* You can disable individual rules via `disabled_rules`, but you cannot add new rules or modify rule definitions. To gain full control over the rule list, use [`sysdig_secure_custom_policy`](secure_custom_policy.md) instead.
17+
* For tweaking a Sysdig-shipped default policy in place (without making a customer-owned copy), use [`sysdig_secure_managed_policy`](secure_managed_policy.md).
1218

1319
-> **Note:** Sysdig Terraform Provider is under rapid development at this point. If you experience any issue or discrepancy while using it, please make sure you have the latest version. If the issue persists, or you have a Feature Request to support an additional set of resources, please open a [new issue](https://github.com/sysdiglabs/terraform-provider-sysdig/issues/new) in the GitHub repository.
1420

0 commit comments

Comments
 (0)