Skip to content

Commit

Permalink
Document the watch evaluation interval
Browse files Browse the repository at this point in the history
Signed-off-by: mprahl <[email protected]>
  • Loading branch information
mprahl committed Sep 20, 2024
1 parent d820f1d commit 903b9f9
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/policygenerator-reference.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,15 @@ policyDefaults:
# Optional. Determines whether the policy is enabled or disabled. A disabled policy will not be propagated to any
# managed clusters and will show no status as a result.
disabled: false
# Optional. This is how often a policy should be evaluated when in a particular compliance state. When managed
# clusters have low CPU resources, the evaluation interval can be increased to to reduce CPU usage on the Kubernetes
# API.
# Optional. Configures the minimum elapsed time before a configuration policy is reevaluated. The default value is
# `watch` to leverage Kubernetes API watches instead of polling the Kubernetes API server. If the policy spec is
# changed or if the list of namespaces selected by the policy changes, the policy might be evaluated regardless of the
# settings here.
evaluationInterval:
# These are in the format of durations (e.g. "1h25m3s"). These can also be set to "never" to avoid evaluating the
# policy after it has become a particular compliance state.
# policy after it has become a particular compliance state. Default is `watch`.
compliant: 30m
noncompliant: 45s
noncompliant: watch
# Optional. A list of objects that should be in specific compliance states before this policy is applied. These are
# added to each policy template (eg ConfigurationPolicy) separately from the dependencies list. Cannot be specified
# when policyDefaults.orderManifests is set to true.
Expand Down

0 comments on commit 903b9f9

Please sign in to comment.