Ansible Operator Watches
The Watches file contains a list of mappings from custom resources, identified
by it’s Group, Version, and Kind, to an Ansible Role or Playbook. The Operator
expects this mapping file in a predefined location:
These resources, as well as child resources (determined by owner references) will
be monitored for updates and cached.
- group: The group of the Custom Resource that you will be watching.
- version: The version of the Custom Resource that you will be watching.
- kind: The kind of the Custom Resource that you will be watching.
- role (default): Specifies a role to be executed. This field is mutually exclusive with the
“playbook” field. This field can be:
- an absolute path to a role directory.
- a relative path within one of the directories specified by
ANSIBLE_ROLES_PATHenvironment variable or
- a relative path within the current working directory, which defaults to
- a fully qualified collection name of an installed Ansible collection. Ansible collections are installed to
/usr/share/ansible/collectionsby default. If they are installed elsewhere, use the
ANSIBLE_COLLECTIONS_PATHenvironment variable or the
- playbook: This is the playbook name that you have added to the container. This playbook is expected to be simply a way to call roles. This field is mutually exclusive with the “role” field. When running locally, the playbook is expected to be in the current project directory.
- vars: This is an arbitrary map of key-value pairs. The contents will be
extra_varsto the playbook or role specified for this watch.
- reconcilePeriod (optional): The reconciliation interval, how often the role/playbook is run, for a given CR.
- manageStatus (optional): When true (default), the operator will manage the status of the CR generically. Set to false, the status of the CR is managed elsewhere, by the specified role/playbook or in a separate controller.
- blacklist: A list of child resources (by GVK) that will not be watched or cached.
An example Watches file:
--- # Simple example mapping Foo to the Foo role - version: v1alpha1 group: foo.example.com kind: Foo role: Foo # Simple example mapping Bar to a playbook - version: v1alpha1 group: bar.example.com kind: Bar playbook: playbook.yml # More complex example for our Baz kind # Here we will disable requeuing and be managing the CR status in the playbook, # and specify additional variables. - version: v1alpha1 group: baz.example.com kind: Baz playbook: baz.yml reconcilePeriod: 0 manageStatus: False vars: foo: bar # ConfigMaps owned by a Memcached CR will not be watched or cached. - version: v1alpha1 group: cache.example.com kind: Memcached role: /opt/ansible/roles/memcached blacklist: - group: "" version: v1 kind: ConfigMap # Example usage with a role from an installed Ansible collection - version: v1alpha1 group: bar.example.com kind: Bar role: myNamespace.myCollection.myRole
The advanced features can be enabled by adding them to your watches file per GVK.
They can go below the
Some features can be overridden per resource via an annotation on that CR. The options that are overridable will have the annotation specified below.
|Feature||Yaml Key||Description||Annotation for override||default||Documentation|
||time between reconcile runs for a particular CR||ansible.operator-sdk/reconcile-period||1m|
||Allows the ansible operator to manage the conditions section of each resource’s status section.||true|
|Watching Dependent Resources||
||Allows the ansible operator to dynamically watch resources that are created by ansible||true||dependent watches|
|Watching Cluster-Scoped Resources||
||Allows the ansible operator to watch cluster-scoped resources that are created by ansible||false|
|Max Runner Artifacts||
||Manages the number of artifact directories that ansible runner will keep in the operator container for each individual resource.||ansible.operator-sdk/max-runner-artifacts||20|
||Sets a finalizer on the CR and maps a deletion event to a playbook or role||finalizers|
--- - version: v1alpha1 group: app.example.com kind: AppService playbook: playbook.yml maxRunnerArtifacts: 30 reconcilePeriod: 5s manageStatus: False watchDependentResources: False finalizer: name: finalizer.app.example.com vars: state: absent