Skip to content

Commit 6215a89

Browse files
author
hadar-co
authored
add docs for customizable warnings (#212)
* add customizable warnings docs * add customizable warnings docs * add customizable warnings docs * add customizable warnings docs
1 parent 587c25d commit 6215a89

File tree

2 files changed

+25
-5
lines changed

2 files changed

+25
-5
lines changed

Diff for: docs/configuration/behavior/index.mdx

+25-5
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,18 @@ The following options (Helm chart parameters) are available for configuring Datr
3939
| `configFromHelm` | Determines whether the options listed [here](/configuration/behavior#dashboard-vs-helm-chart-configuration) are managed from Helm chart or from the dashboard (default: false) | boolean |
4040
| `enforce` | Block resources that fail the policy check from being applied to the cluster.<br/>*Relevant only if `configFromHelm` is `true`* | boolean |
4141
| `policy` | The name of the policy to check, e.g: "Argo".<br/>*Relevant only if `configFromHelm` is `true`* | string |
42-
| `bypassPermissions` | Users/groups/ServiceAccounts that are able to bypass a failing policy check. See [bypass permissions](/configuration/behavior#bypass-permissions) for details.<br/>*Relevant only if `configFromHelm` is `true`* | Object |
43-
| `customSkipList` | Skip resources by namespace/kind/name. See [custom skipping](/configuration/behavior#custom-skipping) for details.<br/>*Relevant only if `configFromHelm` is `true`* | Object |
42+
| `bypassPermissions` | Users/groups/ServiceAccounts that are able to bypass a failing policy check. See [bypass permissions](/configuration/behavior#bypass-permissions) for details.<br/>*Relevant only if `configFromHelm` is `true`* | object |
43+
| `customSkipList` | Skip resources by namespace/kind/name. See [custom skipping](/configuration/behavior#custom-skipping) for details.<br/>*Relevant only if `configFromHelm` is `true`* | object |
44+
| `enabledWarnings` | The types of warnings (logs) to be printed. See [Customize warnings](/configuration/behavior#customize-warnings-logs) for details and possible values. | string[] |
4445
| `clusterName` | The name of the cluster to be displayed in your dashboard | string |
4546
| `scanIntervalHours` | The number of hours between cluster scans | number |
46-
| `existingSecret` | A reference to a `Secret` object containing a Datree token | Object |
47+
| `existingSecret` | A reference to a `Secret` object containing a Datree token | object |
4748
| `token` | The token used to link the CLI to your dashboard | string |
4849
| `verbose` | Display 'How to Fix' link for failed rules in output | boolean |
4950
| `output` | The format output of the policy check results: yaml, json, xml, simple, JUnit, sarif | string |
5051
| `noRecord` | Don’t send policy checks metadata to the dashboard | boolean |
51-
| `affinity` | Offers more expressive syntax for fine-grained control of how Pods are scheduled to specific nodes | Object |
52-
| `nodeSelector` | Used to select on which node a pod is scheduled to run | Object |
52+
| `affinity` | Offers more expressive syntax for fine-grained control of how Pods are scheduled to specific nodes | object |
53+
| `nodeSelector` | Used to select on which node a pod is scheduled to run | object |
5354

5455
ℹ️ *For the full list of configurable parameters in the Datree helm chart, click [here](https://github.com/datreeio/admission-webhook-datree#values)*
5556

@@ -228,6 +229,25 @@ metadata:
228229
For more information, see the [Kubernetes docs](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set)
229230
:::
230231

232+
---
233+
234+
## Customize warnings (logs)
235+
236+
By default, Datree prints a warning for all types of events, as described in the table below.
237+
238+
The Helm chart parameter `datree.enabledWarnings` allows you to customize which types of warnings are printed, simply delete the ones you do not wish to see, and apply your `values.yaml` file.
239+
240+
| **Warning** | **Description** | **Helm chart value** |
241+
|-------------|-----------------|--------------------------|
242+
| Passed policy checks | Resources that passed the policy check | `passedPolicyCheck` |
243+
| Failed policy checks | Resources that failed the policy check | `failedPolicyCheck` |
244+
| RBAC-bypassed | Resources that were [bypassed](/configuration/behavior#bypass-permissions) | `RBACBypassed` |
245+
| Skipped resources | Resources that were [skipped](/configuration/behavior#custom-skipping) | `skippedBySkipList` |
246+
247+
An example of a failed policy check warning:
248+
![failed_policy_check](/img/configuration/behavior/warning-example.png)
249+
250+
231251
---
232252

233253
## Update
178 KB
Loading

0 commit comments

Comments
 (0)