linux 下ansible自动化运维系列教程2--主配置文件详解

ansible.cfg是Ansible自动化工具的主要配置文件，它包含了Ansible执行时的一些默认参数和设置。这个文件允许用户根据实际需求自定义Ansible的行为。以下是关于ansible.cfg配置文件的详细解释：

文件结构与格式

ansible.cfg文件遵循INI格式，其内容通常分为多个部分（或称为“块”），每个部分都以中括号括起来的名称开始，例如[defaults]、[inventory]、[ssh_connection]等。在这些部分下，用户可以设置与该部分相关的各种选项。

配置文件查找顺序

Ansible在运行时，会按照特定的顺序查找ansible.cfg配置文件：

1. ANSIBLE_CONFIG环境变量：如果设置了此环境变量，Ansible将使用该变量指向的配置文件。
2. 当前目录下的ansible.cfg：Ansible会检查执行命令的当前目录下是否存在ansible.cfg文件。
3. 用户家目录下的.ansible.cfg：Ansible会检查当前用户家目录下是否存在.ansible.cfg文件。
4. 全局配置文件：最后，Ansible会检查在安装时自动生成的全局配置文件，通常位于/etc/ansible/ansible.cfg。

如果在上述位置找到多个配置文件，Ansible将按照上述顺序使用第一个找到的配置文件，并忽略其他配置文件。

自定义配置

用户可以根据实际需求修改ansible.cfg文件中的配置项，以定制Ansible的行为。例如，可以增加新的模块路径、调整并发数、设置日志级别等。修改配置文件后，Ansible在下次执行命令时将使用新的配置。

文件结构与格式

ansible.cfg文件遵循INI格式，其内容通常分为多个部分（或称为“块”），每个部分都以中括号括起来的名称开始，例如[defaults]、[inventory]、[ssh_connection]等。在这些部分下，用户可以设置与该部分相关的各种选项。

常用配置项

以下是一些ansible.cfg中常见的配置项及其解释：

1. inventory：定义inventory文件的路径。Inventory文件包含了Ansible需要管理的目标主机列表。
2. library：定义自定义模块的存放目录。
3. remote_user：定义在目标主机上执行命令时使用的远程用户。
4. forks：指定同时操作的目标主机数。这有助于优化在多个主机上执行任务时的性能。
5. timeout：设置SSH连接的超时时间。对于较慢的网络或执行复杂的任务，可以适当调整此参数。
6. log_path：指定Ansible操作的日志文件路径和文件名。
7. host_key_checking：控制Ansible是否应检查SSH的host key。如果设置为False，Ansible将不会因未知的host key而退出。
8. sudo_user（或become_user）：定义在目标主机上执行命令时使用的sudo用户。
9. module_utils：定义模块工具库的路径。
10. remote_tmp：定义在远程主机上临时存储脚本和文件的路径。
11. local_tmp：定义在本地主机上临时存储脚本和文件的路径。

配置示例及解释

# ansible.cfg  
  
# 这是默认的ansible配置文件，它定义了一些Ansible操作的默认参数  
[defaults]  
# inventory文件的位置，定义了Ansible需要管理的目标主机列表  
inventory = /etc/ansible/hosts  
# 在目标主机上执行命令时使用的远程用户  
remote_user = your_remote_user  
#连接受管节点的管理端口，ssh22端口
remote_port    = 22 
# 同时操作的目标主机数，用于并行执行  
forks = 5  
# SSH连接的超时时间  
timeout = 10  
# Ansible操作的日志文件路径  
log_path = /var/log/ansible.log  
# 是否检查SSH的host key  
host_key_checking = False
#私钥密钥路径
private_key_file=/path/to/file   
# 自定义模块的存放目录  
library = /usr/share/ansible/  
# 在远程主机上临时存储脚本和文件的路径  
remote_tmp = $HOME/.ansible/tmp  
# 在本地主机上临时存储脚本和文件的路径  
local_tmp = /tmp/.ansible  
 #首次连接时是否检查ssh主机的密钥
host_key_checking=False 
# 模块工具库的路径  
module_utils = /usr/share/ansible/plugins/modules/utils/  

[persistent_connection]
connect_timeout = 30  
#持久链接超时时间，在这个值之前收到连接请求，连接才不会被关闭，默认30秒
command_timeout = 30  
#命令超时时间，意思是设置在连接超时前分配多少时间等待命令请求或RPC调用请求，需要小于等于持久连接超时时间


# 权限提升相关配置  
[privilege_escalation]  
# 是否启用权限提升  
become = True  
# 权限提升的方法，通常为sudo  
become_method = sudo  
# 权限提升后使用的用户，通常为root  
become_user = root  
  
# SSH连接相关配置  
[ssh_connection]  
# SSH连接时使用的参数  
ssh_args = -o ControlMaster=auto -o ControlPersist=60s  
# SSH连接的管道深度，用于控制嵌套SSH的数量  
pipelining = True  
scp_if_ssh = smart   
#设置传输机制，smart先尝试sftp后尝试scp，True只使用scp，False只使用sftp
transfer_method = smart 
#同scp_if_ssh，两者同时设置时后者覆盖前者，但在scp_if_ssh基础上新增了piped模式表示通过ssh的'dd'来传输，并且在smart模式下，尝试传输顺序为sftp-scp-piped
# 是否批处理模式来传输文件
sftp_batch_mode = False  
#是否启动管道传输
usetty = True
#重试与主机重连次数
retries = 3  

# 插件相关配置  
[callback_plugins]  
# 自定义的callback插件路径  
# callback_plugins = /path/to/custom/callback/plugins  
  
# 其他插件配置，如action_plugins, connection_plugins, lookup_plugins等  
# 可以根据需要添加更多的插件路径  
  
# 角色相关配置  
[roles]  
# 角色文件的路径  
# role_path = /path/to/roles

请注意，这个示例文件包含了大多数常用的配置项，并且注释了每个配置项的作用。实际使用时，你可能需要根据自己的环境和需求进行适当的修改。例如，你可能需要调整 inventory 的路径以指向你的主机清单文件，或者更改 remote_user 为你实际使用的远程用户。

另外，一些高级配置和特定于你环境的配置项可能并不包括在上面的示例中。如果需要进行更详细的配置，请参考 Ansible 的官方文档，那里包含了关于每个配置项的详细说明和最佳实践。