The Project | About Us | Contribute | Donations | License
HOME My courses Completed
◄ Previous
◄

Ansible Configuration

Next ►
►

In this section, we will cover the basics of configuring Ansible to suit your environment and needs. Proper configuration is essential for efficient and effective automation. We will explore the main configuration file, ansible.cfg, and its key settings.

Table of Contents

  1. Introduction to Ansible Configuration
  2. The ansible.cfg File
  3. Key Configuration Settings
  4. Practical Example
  5. Exercises
  6. Summary

Introduction to Ansible Configuration

Ansible configuration is managed through a file named ansible.cfg. This file allows you to customize various aspects of Ansible's behavior, such as inventory settings, logging, and connection parameters. Understanding how to configure Ansible properly can help you optimize performance and tailor the tool to your specific requirements.

The ansible.cfg File

The ansible.cfg file is a simple INI-style configuration file. It can be placed in several locations, with the following order of precedence:

  1. ANSIBLE_CONFIG environment variable
  2. ansible.cfg in the current directory
  3. .ansible.cfg in the user's home directory
  4. /etc/ansible/ansible.cfg

Ansible will use the first ansible.cfg file it finds based on this order.

Key Configuration Settings

Here are some of the most commonly used settings in the ansible.cfg file:

Inventory

Defines the default inventory file location.

[defaults]
inventory = /path/to/your/inventory

Remote User

Specifies the default user for SSH connections.

[defaults]
remote_user = your_user

Private Key File

Defines the private key file to use for SSH connections.

[defaults]
private_key_file = /path/to/your/private_key

Host Key Checking

Disables SSH host key checking (useful for dynamic environments).

[defaults]
host_key_checking = False

Retries

Sets the number of retries for failed tasks.

[defaults]
retry_files_enabled = True
retry_files_save_path = /path/to/retry/files

Timeout

Specifies the SSH connection timeout.

[defaults]
timeout = 30

Logging

Enables logging and sets the log file path.

[defaults]
log_path = /path/to/ansible.log

Roles Path

Defines the path to search for roles.

[defaults]
roles_path = /path/to/roles

Practical Example

Let's create a sample ansible.cfg file with some of the settings discussed above.

[defaults]
inventory = ./inventory
remote_user = ansible_user
private_key_file = ~/.ssh/id_rsa
host_key_checking = False
retry_files_enabled = True
retry_files_save_path = ./retry_files
timeout = 30
log_path = ./ansible.log
roles_path = ./roles

Explanation

  • inventory: Points to the inventory file in the current directory.
  • remote_user: Uses ansible_user for SSH connections.
  • private_key_file: Specifies the private key file for SSH authentication.
  • host_key_checking: Disables SSH host key checking.
  • retry_files_enabled: Enables retry files for failed tasks.
  • retry_files_save_path: Sets the path for saving retry files.
  • timeout: Sets the SSH connection timeout to 30 seconds.
  • log_path: Enables logging and sets the log file path.
  • roles_path: Defines the path to search for roles.

Exercises

Exercise 1: Create a Basic ansible.cfg File

  1. Create a new directory for your Ansible project.
  2. Inside this directory, create a file named ansible.cfg.
  3. Add the following settings to the file:
    • Set the inventory file to ./inventory.
    • Set the remote user to ansible_user.
    • Disable host key checking.

Solution:

[defaults]
inventory = ./inventory
remote_user = ansible_user
host_key_checking = False

Exercise 2: Enable Logging

  1. Modify the ansible.cfg file created in Exercise 1.
  2. Enable logging and set the log file path to ./ansible.log.

Solution:

[defaults]
inventory = ./inventory
remote_user = ansible_user
host_key_checking = False
log_path = ./ansible.log

Exercise 3: Set a Custom Roles Path

  1. Modify the ansible.cfg file created in Exercise 2.
  2. Set the roles path to ./roles.

Solution:

[defaults]
inventory = ./inventory
remote_user = ansible_user
host_key_checking = False
log_path = ./ansible.log
roles_path = ./roles

Summary

In this section, we covered the basics of Ansible configuration using the ansible.cfg file. We explored key settings such as inventory, remote user, private key file, host key checking, retries, timeout, logging, and roles path. We also provided practical examples and exercises to help you understand how to configure Ansible for your environment.

By mastering Ansible configuration, you can optimize your automation workflows and ensure that Ansible behaves as expected in your specific use case. In the next section, we will delve into using Ad-Hoc commands to perform quick tasks with Ansible.

◄ Previous
◄
Next ►
►
The Project | About Us | Contribute | Donations | License
© Copyright 2024. All rights reserved