Skip to content

ansible-operator : State default value for reconcilePeriod  #6391

@daezaa

Description

@daezaa

What is the URL of the document?

https://sdk.operatorframework.io/docs/building-operators/ansible/reference/advanced_options/#ansiblesdkoperatorframeworkioreconcile-period-custom-resource-annotation
https://sdk.operatorframework.io/docs/building-operators/ansible/reference/watches/

Which section(s) is the issue in?

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. 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.

What needs fixing?

Both of above documents are not explicitly stating default value for reconcilePeriod.
It sounds like the operator will not reconcile unless there is a change in watched Custom Resource. However if a user doesn't configure reconcilePeriod by any methods, the operator takes 10h from default of command-line flag.

I think it would be good to state the default value somewhere..

Additional context

Note that ansible-operator binary help prints out the default value.

ansible-operator run -h | grep reconcile-period
      --reconcile-period duration            Default reconcile period for controllers (default 10h0m0s)

Metadata

Metadata

Assignees

Labels

kind/documentationCategorizes issue or PR as related to documentation.

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions