Ansible Based Operator Scaffolding

    The new project directory has many generated folders and files. For further information check the Project Layout doc.

    The default Deployment manifest generated for the operator can be found in the file. By default, the Deployment is named as ‘controller-manager’. It contains a single container named ‘manager’, and it may pick up a sidecar patch from the config/default directory. The Deployment will create a single Pod.

    For the container in the Pod, there are a few things to note. The default Deployment contains a placeholder for the container image to use, so you cannot create a meaningful operator using the YAML file directly. To deploy the operator, you will run make deploy IMG=<IMG>. The image name and tag are then patched using kustomize.

    The default EmptyDir volume mounted at /tmp/ansible-operator/runner is used to serve the in ansible-runner’s terms. The mount path can NOT be changed to other paths, or else the Operator will fail to communicate with ansible-runner.

    The Environment Variables

    You can customize the behavior of the Ansible operator by specifying the environment variables for the container. Please refer to the for a list of environment variables that can be used to tune the behavior of the Ansible engine.

    • This value overrides the setting from the ansible-roles-path flag.

    • ANSIBLE_COLLECTIONS_PATH: The base path for the Ansible collections which defaults to ~/.ansible/collections or /usr/share/ansible/collections when ANSIBLE_COLLECTIONS_PATH is not explicitly specified. When a fully qualified collection name in the watches file, the Ansible operator checks if the specified collection can found under the base path that can be customized using this variable. Suppose you have set to /foo and the fully qualified collection name set to example.com.bar, the Ansible operator searches for the roles under /foo/ansible_collections/example/com/roles/bar.

      This value takes precedence over the --ansible-collections-path flag.

    • MAX_CONCURRENT_RECONCILES_<kind>_<group>: This specifies the maximum number of concurrent reconciliations for the operator. It defaults to the number of CPUs. You can adjust this based on the cluster resources.