Skip to content

Commit 65af7cb

Browse files
committed
Include notes about time pkg
1 parent 43eac5c commit 65af7cb

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

doc/ansible/dev/developer_guide.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,10 @@ the below section for Ansible Operator specifc annotations.
240240
#### Ansible Operator annotations
241241
This is the list of CR annotations which will modify the behavior of the operator:
242242

243-
**ansible.operator-sdk/reconcile-period**: Used to specify the reconciliation interval for the CR.
243+
**ansible.operator-sdk/reconcile-period**: Used to specify the reconciliation
244+
interval for the CR. This value is parsed using the standard Golang package
245+
[time][time_pkg]. Specifically [ParseDuration][time_parse_duration] is used
246+
which will use the default of `s` suffix giving the value in seconds.
244247

245248
Example:
246249
```
@@ -249,7 +252,7 @@ kind: "Foo"
249252
metadata:
250253
name: "example"
251254
annotations:
252-
ansible.operator-sdk/reconcile-period: 30s
255+
ansible.operator-sdk/reconcile-period: "30s"
253256
```
254257

255258
### Testing an Ansible operator locally
@@ -423,3 +426,5 @@ The structure is:
423426
[k8s_ansible_module]:https://docs.ansible.com/ansible/2.6/modules/k8s_module.html
424427
[openshift_restclient_python]:https://github.com/openshift/openshift-restclient-python
425428
[ansible_operator_user_guide]:../user-guide.md
429+
[time_pkg]:https://golang.org/pkg/time/
430+
[time_parse_duration]:https://golang.org/pkg/time/#ParseDuration

0 commit comments

Comments
 (0)