Skip to content

Commit 1f711f5

Browse files
authored
state default reconcilePeriod value in ansible docs (#6449)
Signed-off-by: jberkhahn <[email protected]>
1 parent 5347d93 commit 1f711f5

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

website/content/en/docs/building-operators/ansible/reference/advanced_options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ If you want more control over the logs that are outputted, consider using the [Z
268268
## `ansible.sdk.operatorframework.io/reconcile-period` Custom Resource Annotation
269269
270270
You can specify the reconcile period for an Ansible Operator by adding the ansible.sdk.operatorframework.io/reconcile-period key to the custom resource annotations.
271-
This feature specifies the maximum interval in which a cluster will get reconciled. If changes are detected in the desired state, the cluster may be reconciled sooner than the specified interval.
271+
This feature specifies the maximum interval in which a cluster will get reconciled, and defaults to 10 hours if not manually set. If changes are detected in the desired state, the cluster may be reconciled sooner than the specified interval.
272272
273273
The reconcile period can be specified in the custom resource's annotations in the following manner:
274274

website/content/en/docs/building-operators/ansible/reference/watches.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ be monitored for updates and cached.
2727
current project directory.
2828
* **vars**: This is an arbitrary map of key-value pairs. The contents will be
2929
passed as `extra_vars` to the playbook or role specified for this watch.
30-
* **reconcilePeriod** (optional): The maximum interval that the operator will wait before beginning another reconcile, even if no watched events are received. When an operator watches many resources, each reconcile can become expensive, and a low value here can actually reduce performance. Typically, this option should only be used in advanced use cases where `watchDependentResources` is set to `False` and when is not possible to use the watch feature. E.g To manage external resources that don’t emit Kubernetes events. The format for the duration string is a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms", "1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
30+
* **reconcilePeriod** (optional): The maximum interval that the operator will wait before beginning another reconcile, even if no watched events are received. When an operator watches many resources, each reconcile can become expensive, and a low value here can actually reduce performance. Typically, this option should only be used in advanced use cases where `watchDependentResources` is set to `False` and when is not possible to use the watch feature. E.g To manage external resources that don’t emit Kubernetes events. The format for the duration string is a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms", "1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". Defaults to 10 hours.
3131
* **manageStatus** (optional): When true (default), the operator will manage
3232
the status of the CR generically. Set to false, the status of the CR is
3333
managed elsewhere, by the specified role/playbook or in a separate controller.
@@ -97,7 +97,7 @@ Some features can be overridden per resource via an annotation on that CR. The o
9797

9898
| Feature | Yaml Key | Description| Annotation for override | default | Documentation |
9999
|---------|----------|------------|-------------------------|---------|---------------|
100-
| Reconcile Period | `reconcilePeriod` | time between reconcile runs for a particular CR | ansible.sdk.operatorframework.io/reconcile-period | | |
100+
| Reconcile Period | `reconcilePeriod` | time between reconcile runs for a particular CR | ansible.sdk.operatorframework.io/reconcile-period | 10h | |
101101
| Manage Status | `manageStatus` | Allows the ansible operator to manage the conditions section of each resource's status section. | | true | |
102102
| Watching Dependent Resources | `watchDependentResources` | Allows the ansible operator to dynamically watch resources that are created by ansible | | true | [dependent watches](../dependent-watches) |
103103
| Watching Cluster-Scoped Resources | `watchClusterScopedResources` | Allows the ansible operator to watch cluster-scoped resources that are created by ansible | | false | |

0 commit comments

Comments
 (0)