Ansible troubleshooting - Error only-builtins

How to Solve the Ansible Error only-builtins Avoid Non-Builtin Actions

November 7, 2023

Access the Complete Video Course and Learn Quick Ansible by 200+ Practical Lessons

#simplified #system-configuration #automation #infrastructure #ansible-playbooks #playbook-optimization #efficiency #ansible-best-practices #automation-strategy #ansible-configuration #built-in-actions #consistency #ansible-rules #playbook-structure #ansible-ecosystem #automation-simplification #ansible-ecosystem #builtin-modules #playbook-optimization #ansible-best-practices

Avoid Non-Builtin Actions in Your Ansible Playbooks

In the realm of Ansible playbooks, maintaining consistency and simplicity is key to a successful automation strategy. One way to achieve this is by adhering to the “only-builtins” rule, which emphasizes the usage of built-in actions from the ansible.builtin collection exclusively.

Keeping It Builtin

The “only-builtins” rule acts as a guardrail to ensure that you don’t inadvertently wander into using non-built-in collections, plugins, or modules within your Ansible playbooks. While Ansible’s ecosystem is rich with various extensions, sticking to the built-in collection can streamline your playbook’s structure and maintainability.

Enable the `only-builtins` Rule

You can enable this rule in your Ansible-lint configuration. By doing so, you instruct Ansible to validate only builtin modules.

Here’s how you can configure this rule:

enable_list:
  - only-builtins

Problematic Code

---
- name: Example playbook
  hosts: all
  tasks:
    - name: Deploy a Helm chart for Prometheus
      kubernetes.core.helm: # <- Uses a non-builtin collection.
        name: test
        chart_ref: stable/prometheus
        release_namespace: monitoring
        create_namespace: true

In the problematic code above, we can see a playbook that attempts to deploy a Helm chart for Prometheus but uses the kubernetes.core.helm module, which is not part of the built-in ansible.builtin collection.

Ansible Lint Output

WARNING  Listing 1 violation(s) that are fatal
only-builtins: Use only builtin actions. (warning)
only-bultin.yml:5 Task/Handler: Deploy a Helm chart for Prometheus

Read documentation for instructions on how to ignore specific rule violations.

                   Rule Violation Summary                   
 count tag           profile rule associated tags           
     1 only-builtins         opt-in, experimental (warning) 

Passed: 0 failure(s), 1 warning(s) on 1 files. Last profile that met the validation criteria was 'production'. Rating: 5/5 star

The Best Resources For Ansible

Certifications

The Linux Foundation Linux Performance Tuning - Build a broad toolkit to optimize Linux performance from the kernel up

Coursera Pro - Unlimited access to 7,000+ world-class courses, hands-on projects, and job-ready certificate programs—all included in your subscription

Video Course

Udemy: Learn Ansible Automation in 250+examples & practical lessons: Learn Ansible with some real-life examples of how to use the most common modules and Ansible Playbook

Printed Book

eBooks

Correcting the Code

To adhere to the “only-builtins” rule, you should rewrite the playbook as follows:

- name: Example playbook
  hosts: localhost
  tasks:
    - name: Run a shell command
      ansible.builtin.shell: echo This playbook uses actions from the builtin collection only.

In the corrected code, we replaced the non-built-in kubernetes.core.helm module with a simple ansible.builtin.shell module, ensuring that we are using only built-in actions.

The Advantages

Consistency: Relying solely on built-in actions maintains a consistent codebase and makes it easier for other team members to understand and work on your playbooks.
Reduced Dependencies: You won’t have to manage external collections or plugins, simplifying your playbook’s requirements and dependencies.
Enhanced Maintainability: Playbooks based on the “only-builtins” rule are less prone to breaking due to external collection updates, ensuring long-term maintainability.

By adopting the “only-builtins” rule, you’re setting yourself up for more effective and streamlined Ansible automation, which can lead to greater reliability and success in your infrastructure management tasks.

Conclusion

In conclusion, the “only-builtins” rule serves as a valuable guardrail in your Ansible playbook development. By adhering to this rule and using actions exclusively from the ansible.builtin collection, you ensure consistency and reliability in your automation scripts. This practice not only simplifies playbook maintenance but also reduces the chances of compatibility issues when upgrading Ansible or sharing your playbooks with others.

By focusing on using built-in Ansible modules, you harness the full power of the Ansible ecosystem and leverage features that are well-tested and supported. While external collections have their merits, this rule encourages the use of built-ins for a more streamlined and sustainable playbook development process.

To benefit from this rule, remember to enable it in your Ansible-lint configuration. Embracing “only-builtins” not only helps you write more robust playbooks but also contributes to the long-term stability and maintainability of your infrastructure automation.

Subscribe to the YouTube channel, Medium, and Website, X (formerly Twitter) to not miss the next episode of the Ansible Pilot.