Ansible Installation and Configuration: Creating the Configuration File

In the previous article, “Ansible Installation and Configuration: Configuring SSH Connections”, we explored how to configure Ansible’s SSH connections—an essential step to ensure seamless communication between Ansible and target hosts. Today, we’ll dive deeper into creating Ansible configuration files. A well-structured configuration file significantly enhances your efficiency in managing and using Ansible.

Overview of Ansible Configuration Files

The primary Ansible configuration file is ansible.cfg. It can reside in one of three locations:

• The current working directory,
• Your user’s home directory (~/.ansible.cfg), or
• The system-wide location /etc/ansible/ansible.cfg.

This file defines global settings that influence Ansible’s behavior and performance.

Creating ansible.cfg

1. Directory Structure
   First, it’s recommended to create a dedicated directory for your Ansible project to keep things organized. For example:

   mkdir my_ansible_project
   cd my_ansible_project
   

2. Creating the Configuration File
   Create an ansible.cfg file in this directory:

   touch ansible.cfg
   

3. Editing the Configuration File
   Open ansible.cfg with your preferred text editor—such as vim or nano—and add the following basic configuration:

   [defaults]
   inventory = hosts
   remote_user = your_user
   private_key_file = ~/.ssh/id_rsa
   host_key_checking = False
   

   Explanation of these settings:

• inventory: Specifies the name of the inventory file—in this case, hosts, which you’ll use to manage target hosts.
• remote_user: Sets the default SSH user for connecting to remote hosts.
• private_key_file: Points to the SSH private key file used for passwordless authentication.
• host_key_checking: When set to False, Ansible skips SSH host key verification—convenient for testing environments, but should remain True in production for security.

Example Configuration File

Below is a more comprehensive ansible.cfg example, including additional useful options:

[defaults]
inventory = hosts
remote_user = ansible_user
private_key_file = ~/.ssh/id_rsa
host_key_checking = False
retry_files_enabled = False
ssh_args = -o ControlMaster=auto -o ControlPersist=60s
timeout = 10
log_path = ansible.log

[privilege_escalation]
become = true
become_method = sudo
become_user = root

Key enhancements in this example:

• retry_files_enabled = False: Disables generation of .retry files after failed tasks.
• ssh_args: Configures SSH connection reuse via ControlMaster and ControlPersist, improving performance across multiple connections.
• log_path: Specifies where Ansible writes its log output.
• [privilege_escalation] section: Enables privilege escalation (e.g., sudo) to run tasks as root.

Testing the Configuration File

To verify that your configuration works correctly, run a simple ad-hoc command to test connectivity with your target hosts:

ansible all -m ping -i hosts

If your configuration is correct and SSH access is properly set up, you should see output similar to the following—indicating successful connection to the target host:

<192.168.1.100> => {
    "changed": false,
    "ping": "pong"
}

Summary

In this article, we covered how to create and configure Ansible’s ansible.cfg file to streamline management and improve operational efficiency. In the next article, “Fundamental Concepts: What Are Plays and Playbooks?”, we’ll explore core Ansible concepts—including the purpose and structure of Plays and Playbooks.

With thoughtful configuration, you can dramatically boost Ansible’s usability and effectiveness. We look forward to helping you wield this powerful automation tool with increasing flexibility and precision in the upcoming lessons.