如何构建您的清单
Ansible 使用称为清单的列表或列表组,在您基础架构中的托管节点或“主机”上自动执行任务。您可以在命令行中传递主机名,但大多数 Ansible 用户会创建清单文件。您的清单定义了您自动化的托管节点,并使用组以便您可以同时在多个主机上运行自动化任务。定义清单后,您可以使用模式来选择您希望 Ansible 针对其运行的主机或组。
最简单的清单是一个包含主机和组列表的单个文件。此文件的默认位置是 /etc/ansible/hosts
。您可以使用 -i <path>
选项在命令行中指定不同的清单文件,或在配置中使用 inventory
指定。
Ansible 清单插件 支持各种格式和来源,以使您的清单灵活且可自定义。随着清单的扩展,您可能需要多个文件来组织您的主机和组。以下是 /etc/ansible/hosts
文件之外的三个选项
您可以创建一个包含多个清单文件的目录。请参阅 在目录中组织清单。这些文件可以使用不同的格式(YAML、ini 等)。
您可以动态拉取清单。例如,您可以使用动态清单插件列出一个或多个云提供商中的资源。请参阅 使用动态清单。
您可以使用多个清单来源,包括动态清单和静态文件。请参阅 传递多个清单源。
注意
以下 YAML 代码段包含一个省略号,表示它们是更大 YAML 文件的一部分。您可以在 YAML 基础知识 中找到有关 YAML 语法的更多信息。
清单基础:格式、主机和组
您可以使用多种格式创建清单文件,具体取决于您拥有的清单插件。最常见的格式是 INI 和 YAML。一个基本的 INI /etc/ansible/hosts
文件可能如下所示
mail.example.com
[webservers]
foo.example.com
bar.example.com
[dbservers]
one.example.com
two.example.com
three.example.com
括号中的标题是组名,用于对主机进行分类并决定您在什么时间以及出于什么目的控制哪些主机。组名应遵循与 创建有效的变量名 相同的准则。
以下是 YAML 格式的相同基本清单文件
ungrouped:
hosts:
mail.example.com:
webservers:
hosts:
foo.example.com:
bar.example.com:
dbservers:
hosts:
one.example.com:
two.example.com:
three.example.com:
默认组
即使您没有在清单文件中定义任何组,Ansible 也会创建两个默认组:all
和 ungrouped
。all
组包含所有主机。ungrouped
组包含除 all
之外没有其他组的所有主机。每个主机始终至少属于 2 个组(all
和 ungrouped
或 all
和其他组)。例如,在上面的基本清单中,主机 mail.example.com
属于 all
组和 ungrouped
组;主机 two.example.com
属于 all
组和 dbservers
组。虽然 all
和 ungrouped
始终存在,但它们可以是隐式的,并且不会出现在 group_names
等组列表中。
多个组中的主机
您可以将每个主机放在多个组中。例如,位于亚特兰大数据中心的生产 Web 服务器可以包含在名为 [prod]
、[atlanta]
和 [webservers]
的组中。您可以创建跟踪以下内容的组
什么 - 应用程序、堆栈或微服务(例如数据库服务器、Web 服务器等)。
哪里 - 数据中心或区域,用于与本地 DNS、存储等进行通信(例如东部、西部)。
何时 - 开发阶段,以避免在生产资源上进行测试(例如 prod、test)。
扩展之前的 YAML 清单以包含什么、何时和何地,如下所示
ungrouped:
hosts:
mail.example.com:
webservers:
hosts:
foo.example.com:
bar.example.com:
dbservers:
hosts:
one.example.com:
two.example.com:
three.example.com:
east:
hosts:
foo.example.com:
one.example.com:
two.example.com:
west:
hosts:
bar.example.com:
three.example.com:
prod:
hosts:
foo.example.com:
one.example.com:
two.example.com:
test:
hosts:
bar.example.com:
three.example.com:
您可以看到 one.example.com
存在于 dbservers
、east
和 prod
组中。
对组进行分组:父/子组关系
您可以在组之间创建父/子关系。父组也称为嵌套组或组的组。例如,如果您的所有生产主机都已经在 atlanta_prod
和 denver_prod
等组中,则可以创建一个包含这些较小组的 production
组。这种方法减少了维护工作,因为您可以通过编辑子组来添加或删除父组中的主机。
要为组创建父/子关系
在 INI 格式中,使用
:children
后缀在 YAML 格式中,使用
children:
条目
以下是与上面相同的清单,使用 prod
和 test
组的父组进行了简化。这两个清单文件为您提供了相同的结果
ungrouped:
hosts:
mail.example.com:
webservers:
hosts:
foo.example.com:
bar.example.com:
dbservers:
hosts:
one.example.com:
two.example.com:
three.example.com:
east:
hosts:
foo.example.com:
one.example.com:
two.example.com:
west:
hosts:
bar.example.com:
three.example.com:
prod:
children:
east:
test:
children:
west:
子组有一些需要注意的属性
任何属于子组成员的主机都会自动成为父组的成员。
组可以有多个父级和子级,但不能是循环关系。
主机也可以位于多个组中,但在运行时只会有一个主机实例。Ansible 会合并来自多个组的数据。
添加主机范围
如果您有很多具有相似模式的主机,则可以将它们添加为一个范围,而不是单独列出每个主机名
在 INI 中
[webservers]
www[01:50].example.com
在 YAML 中
# ...
webservers:
hosts:
www[01:50].example.com:
您可以在定义主机数字范围时指定步长(序列号之间的增量)
在 INI 中
[webservers]
www[01:50:2].example.com
在 YAML 中
# ...
webservers:
hosts:
www[01:50:2].example.com:
上面的示例将使子域 www01、www03、www05、…、www49 匹配,但 www00、www02、www50 等不匹配,因为步长(增量)每步为 2 个单位。
对于数字模式,可以根据需要包含或删除前导零。范围是包含性的。您也可以定义字母范围
[databases]
db-[a:f].example.com
传递多个清单源
您可以通过从命令行提供多个清单参数或配置ANSIBLE_INVENTORY
,同时定位多个清单源(目录、动态清单脚本或清单插件支持的文件)。当您希望同时针对通常独立的环境(如暂存和生产)执行特定操作时,这将非常有用。
要从命令行定位两个清单源
ansible-playbook get_logs.yml -i staging -i production
在目录中组织清单
您可以在一个目录中整合多个库存来源。最简单的版本是使用包含多个文件的目录,而不是单个库存文件。当单个文件过长时,维护起来会很困难。如果您有多个团队和多个自动化项目,为每个团队或项目使用一个库存文件可以方便所有人轻松找到对他们重要的主机和组。
您还可以在一个库存目录中组合多种库存来源类型。这对于组合静态和动态主机并将其作为一个库存进行管理非常有用。以下库存目录组合了一个库存插件来源、一个动态库存脚本和一个包含静态主机的文件:
inventory/
openstack.yml # configure inventory plugin to get hosts from OpenStack cloud
dynamic-inventory.py # add additional hosts with dynamic inventory script
on-prem # add static hosts and groups
parent-groups # add static hosts and groups
您可以按如下方式定位此库存目录:
ansible-playbook example.yml -i inventory
您还可以在 ansible.cfg
文件中配置库存目录。有关更多详细信息,请参阅 配置 Ansible。
管理库存加载顺序
Ansible 按照文件名以 ASCII 顺序加载库存来源。如果您在一个文件或目录中定义父组,而在其他文件或目录中定义子组,则必须先加载定义子组的文件。如果先加载父组,您将看到错误消息 无法将 /path/to/source_of_parent_groups 解析为库存来源
。
例如,如果您有一个名为 groups-of-groups
的文件,其中定义了一个 production
组,并且该组的子组定义在一个名为 on-prem
的文件中,则 Ansible 将无法解析 production
组。为了避免此问题,您可以通过向文件添加前缀来控制加载顺序:
inventory/
01-openstack.yml # configure inventory plugin to get hosts from OpenStack cloud
02-dynamic-inventory.py # add additional hosts with dynamic inventory script
03-on-prem # add static hosts and groups
04-groups-of-groups # add parent groups
您可以在 库存设置示例 中找到有关如何组织库存和对主机进行分组的示例。
向库存添加变量
您可以存储与特定主机或组相关的变量值。首先,您可以将变量直接添加到主库存文件中的主机和组。
为了简单起见,我们记录了在主库存文件中添加变量的方法。但是,将变量存储在单独的主机和组变量文件中是描述系统策略的更可靠方法。在主库存文件中设置变量只是一种简写。有关在“host_vars”目录中的单个文件中存储变量值的指南,请参阅 组织主机和组变量。有关详细信息,请参阅 组织主机和组变量。
为一台机器分配变量:主机变量
您可以轻松地为单个主机分配一个变量,然后在剧本中使用它。您可以在库存文件中直接执行此操作。
在 INI 中
[atlanta]
host1 http_port=80 maxRequestsPerChild=808
host2 http_port=303 maxRequestsPerChild=909
在 YAML 中
atlanta:
hosts:
host1:
http_port: 80
maxRequestsPerChild: 808
host2:
http_port: 303
maxRequestsPerChild: 909
非标准 SSH 端口等唯一值适合用作主机变量。您可以通过在主机名后添加冒号和端口号,将它们添加到 Ansible 库存中:
badwolf.example.com:5309
连接变量也可以很好地用作主机变量:
[targets]
localhost ansible_connection=local
other1.example.com ansible_connection=ssh ansible_user=myuser
other2.example.com ansible_connection=ssh ansible_user=myotheruser
注意
如果在 SSH 配置文件中列出了非标准 SSH 端口,openssh
连接将查找并使用它们,但 paramiko
连接将不会。
库存别名
您还可以在库存中使用主机变量定义别名:
在 INI 中
jumper ansible_port=5555 ansible_host=192.0.2.50
在 YAML 中
# ...
hosts:
jumper:
ansible_port: 5555
ansible_host: 192.0.2.50
在此示例中,对主机别名“jumper”运行 Ansible 将连接到端口 5555 上的 192.0.2.50。请参阅 行为库存参数,以进一步自定义与主机的连接。
以 INI 格式定义变量
使用 key=value
语法以 INI 格式传递的值,其解释方式取决于声明它们的位置:
当与主机内联声明时,INI 值将被解释为 Python 字面量结构(字符串、数字、元组、列表、字典、布尔值、None)。主机行每行接受多个
key=value
参数。因此,它们需要一种方法来指示空格是值的一部分,而不是分隔符。包含空格的值可以用引号引起来(单引号或双引号)。有关详细信息,请参阅 Python shlex 解析规则。当在
:vars
部分中声明时,INI 值将被解释为字符串。例如,var=FALSE
将创建一个等于“FALSE”的字符串。与主机行不同,:vars
部分每行只接受一个条目,因此=
之后的所有内容都必须是该条目的值。
如果在 INI 库存中设置的变量值必须是某种类型(例如,字符串或布尔值),请始终在任务中使用过滤器指定类型。使用变量时,不要依赖于在 INI 库存中设置的类型。
请考虑对库存来源使用 YAML 格式,以避免混淆变量的实际类型。YAML 库存插件可以一致且正确地处理变量值。
为多台机器分配变量:组变量
如果一个组中的所有主机共享一个变量值,您可以一次将该变量应用于整个组。
在 INI 中
[atlanta]
host1
host2
[atlanta:vars]
ntp_server=ntp.atlanta.example.com
proxy=proxy.atlanta.example.com
在 YAML 中
atlanta:
hosts:
host1:
host2:
vars:
ntp_server: ntp.atlanta.example.com
proxy: proxy.atlanta.example.com
组变量是一种方便的方法,可以一次将变量应用于多个主机。但是,在执行之前,Ansible 始终会将变量(包括库存变量)扁平化到主机级别。如果一个主机是多个组的成员,Ansible 将读取所有这些组中的变量值。如果您在不同的组中为同一个变量分配不同的值,Ansible 将根据内部 合并规则 选择要使用的值。
继承变量值:组的组变量
您可以将变量应用于父组(嵌套组或组的组)以及子组。语法相同:INI 格式使用 :vars
,YAML 格式使用 vars:
。
在 INI 中
[atlanta]
host1
host2
[raleigh]
host2
host3
[southeast:children]
atlanta
raleigh
[southeast:vars]
some_server=foo.southeast.example.com
halon_system_timeout=30
self_destruct_countdown=60
escape_pods=2
[usa:children]
southeast
northeast
southwest
northwest
在 YAML 中
usa:
children:
southeast:
children:
atlanta:
hosts:
host1:
host2:
raleigh:
hosts:
host2:
host3:
vars:
some_server: foo.southeast.example.com
halon_system_timeout: 30
self_destruct_countdown: 60
escape_pods: 2
northeast:
northwest:
southwest:
子组的变量将比父组的变量具有更高的优先级(覆盖)。
组织主机和组变量
尽管您可以将变量存储在主库存文件中,但存储单独的主机和组变量文件可以帮助您更轻松地组织变量值。您还可以在主机和组变量文件中使用列表和哈希数据,而这在主库存文件中是无法做到的。
主机和组变量文件必须使用 YAML 语法。有效的文件扩展名包括“.yml”、“.yaml”、“.json”或不带扩展名。如果您不熟悉 YAML,请参阅 YAML 语法。
Ansible 通过搜索相对于库存文件或剧本文件的路径来加载主机和组变量文件。如果位于 /etc/ansible/hosts
的库存文件包含一个名为“foosball”的主机,该主机属于“raleigh”和“webservers”两个组,则该主机将使用以下位置的 YAML 文件中的变量:
/etc/ansible/group_vars/raleigh # can optionally end in '.yml', '.yaml', or '.json'
/etc/ansible/group_vars/webservers
/etc/ansible/host_vars/foosball
例如,如果您按数据中心对库存中的主机进行分组,并且每个数据中心都使用自己的 NTP 服务器和数据库服务器,则可以创建一个名为 /etc/ansible/group_vars/raleigh
的文件来存储 raleigh
组的变量:
---
ntp_server: acme.example.org
database_server: storage.example.org
您还可以创建以组或主机命名的_目录_。Ansible 将按字典顺序读取这些目录中的所有文件。以“raleigh”组为例:
/etc/ansible/group_vars/raleigh/db_settings
/etc/ansible/group_vars/raleigh/cluster_settings
“raleigh”组中的所有主机都可以使用在这些文件中定义的变量。当单个文件太大,或者您想对某些组变量使用 Ansible Vault 时,这对于保持变量井井有条非常有用。
对于 ansible-playbook
,您还可以在剧本目录中添加 group_vars/
和 host_vars/
目录。其他 Ansible 命令(例如,ansible
、ansible-console
等)将只在库存目录中查找 group_vars/
和 host_vars/
。如果希望其他命令从剧本目录加载组和主机变量,则必须在命令行中提供 --playbook-dir
选项。如果从剧本目录和库存目录加载库存文件,则剧本目录中的变量将覆盖在库存目录中设置的变量。
将库存文件和变量保存在 Git 存储库(或其他版本控制系统)中是跟踪库存和主机变量更改的绝佳方法。
变量如何合并
默认情况下,在运行剧本之前,变量会合并/扁平化到特定主机。这使得 Ansible 能够专注于主机和任务,因此组不会在库存和主机匹配之外存活。默认情况下,Ansible 会覆盖变量,包括为组和/或主机定义的变量(请参阅 DEFAULT_HASH_BEHAVIOUR)。顺序/优先级为(从低到高):
所有组(因为它是所有其他组的“父级”)
父组
子组
主机
默认情况下,Ansible 按 ASCII 顺序合并处于相同父/子级别的组,并且最后加载的组中的变量会覆盖先前组中的变量。例如,a_group
将与 b_group
合并,并且 b_group
中匹配的变量将覆盖 a_group
中的变量。
注意
Ansible 会合并来自不同来源的变量,并根据一组规则对某些变量赋予比其他变量更高的优先级。例如,出现在库存中较高位置的变量可以覆盖出现在库存中较低位置的变量。有关更多信息,请参阅 变量优先级:我应该在哪里放置变量?。
您可以通过设置组变量 ansible_group_priority
来更改此行为,以更改同一级别组的合并顺序(在解析父/子顺序之后)。数字越大,合并时间越晚,优先级越高。如果未设置,则此变量默认为 1
。例如
a_group:
vars:
testvar: a
ansible_group_priority: 10
b_group:
vars:
testvar: b
在本例中,如果两个组的优先级相同,则结果通常为 testvar == b
,但由于我们为 a_group
指定了更高的优先级,因此结果将为 testvar == a
。
注意
ansible_group_priority
只能在清单来源中设置,而不能在 group_vars/ 中设置,因为该变量用于加载 group_vars。
管理清单变量加载顺序
使用多个清单来源时,请记住,任何变量冲突都将根据 如何合并变量 和 变量优先级:我应该在哪里放置变量? 中描述的规则进行解决。您可以控制清单来源中变量的合并顺序,以获取所需的变量值。
当您在命令行传递多个清单来源时,Ansible 会按照您传递这些参数的顺序合并变量。如果 staging 清单中的 [all:vars]
定义了 myvar = 1
,而 production 清单定义了 myvar = 2
,则
传递
-i staging -i production
以使用myvar = 2
运行 playbook。传递
-i production -i staging
以使用myvar = 1
运行 playbook。
当您将多个清单来源放在一个目录中时,Ansible 会根据文件名按 ASCII 顺序合并它们。您可以通过向文件添加前缀来控制加载顺序
inventory/
01-openstack.yml # configure inventory plugin to get hosts from Openstack cloud
02-dynamic-inventory.py # add additional hosts with dynamic inventory script
03-static-inventory # add static hosts
group_vars/
all.yml # assign variables to all hosts
如果 01-openstack.yml
为组 all
定义了 myvar = 1
,02-dynamic-inventory.py
定义了 myvar = 2
,而 03-static-inventory
定义了 myvar = 3
,则 playbook 将使用 myvar = 3
运行。
连接到主机:行为清单参数
如上所述,设置以下变量可以控制 Ansible 如何与远程主机交互。
主机连接
注意
当使用 SSH 连接插件(默认)时,Ansible 不会公开通道以允许用户和 SSH 进程之间进行通信,以手动接受密码来解密 SSH 密钥。强烈建议使用 ssh-agent
。
- ansible_connection
到主机的连接类型。这可以是任何 Ansible 连接插件的名称。SSH 协议类型为
ssh
或paramiko
。默认值为ssh
。
所有连接的通用参数
- ansible_host
要连接的主机的名称,如果与您希望为其指定的别名不同。如果您使用委托,请永远不要将其设置为依赖于
inventory_hostname
。- ansible_port
连接端口号,如果不是默认值(SSH 为 22)
- ansible_user
连接到主机时使用的用户名
- ansible_password
用于向主机进行身份验证的密码(切勿以纯文本形式存储此变量;请始终使用 Vault。请参阅 安全地显示 Vault 变量)
SSH 连接特有的参数
- ansible_ssh_private_key_file
SSH 使用的私钥文件。如果您使用多个密钥并且不想使用 SSH 代理,则此选项很有用。
- ansible_ssh_common_args
此设置始终附加到 sftp、scp 和 ssh 的默认命令行。用于为某个主机(或组)配置
ProxyCommand
。- ansible_sftp_extra_args
此设置始终附加到默认的 sftp 命令行。
- ansible_scp_extra_args
此设置始终附加到默认的 scp 命令行。
- ansible_ssh_extra_args
此设置始终附加到默认的 ssh 命令行。
- ansible_ssh_pipelining
确定是否使用 SSH 流水线。这可以覆盖
ansible.cfg
中的pipelining
设置。- ansible_ssh_executable(版本 2.2 中新增)
此设置会覆盖使用系统 ssh 的默认行为。这可以覆盖
ansible.cfg
的ssh_connection
下的ssh_executable
设置。
权限提升(有关更多详细信息,请参阅 Ansible 权限提升)
- ansible_become
等效于
ansible_sudo
或ansible_su
,允许强制权限提升- ansible_become_method
允许设置权限提升方法
- ansible_become_user
等效于
ansible_sudo_user
或ansible_su_user
,允许您设置通过权限提升成为的用户- ansible_become_password
等效于
ansible_sudo_password
或ansible_su_password
,允许您设置权限提升密码(切勿以纯文本形式存储此变量;请始终使用 Vault。请参阅 安全地显示 Vault 变量)- ansible_become_exe
等效于
ansible_sudo_exe
或ansible_su_exe
,允许您设置所选提升方法的可执行文件- ansible_become_flags
等效于
ansible_sudo_flags
或ansible_su_flags
,允许您设置传递给所选提升方法的标志。这也可以在ansible.cfg
中的privilege_escalation
下的become_flags
选项中全局设置。
远程主机环境参数
- ansible_shell_type
目标系统的 shell 类型。除非您已将 ansible_shell_executable 设置为非 Bourne (sh) 兼容 shell,否则不应使用此设置。默认情况下,命令使用
sh
样式语法格式化。将其设置为csh
或fish
将导致在目标系统上执行的命令遵循这些 shell 的语法。
- ansible_python_interpreter
目标主机 Python 路径。这对于具有多个 Python 或未位于 /usr/bin/python 的系统(例如 *BSD)或 /usr/bin/python 不是 2.X 系列 Python 的系统很有用。我们不使用 /usr/bin/env 机制,因为这需要正确设置远程用户的路径,并且还假定 python 可执行文件名为 python,而可执行文件可能名为 python2.6 之类的名称。
- ansible_*_interpreter
适用于任何内容,例如 ruby 或 perl,并且工作方式与 ansible_python_interpreter 相同。这将替换将在该主机上运行的模块的 shebang。
版本 2.1 中的新增功能。
- ansible_shell_executable
这将设置 Ansible 控制节点将在目标机器上使用的 shell,覆盖
ansible.cfg
中默认为 /bin/sh 的executable
。仅当无法使用 /bin/sh 时(换句话说,如果目标机器上未安装 /bin/sh 或无法从 sudo 运行),才应更改此值。
Ansible-INI 主机文件中的示例
some_host ansible_port=2222 ansible_user=manager
aws_host ansible_ssh_private_key_file=/home/example/.ssh/aws.pem
freebsd_host ansible_python_interpreter=/usr/local/bin/python
ruby_module_host ansible_ruby_interpreter=/usr/bin/ruby.1.9.3
非 SSH 连接类型
如上一节所述,Ansible 通过 SSH 执行 playbook,但它不限于此连接类型。使用特定于主机的参数 ansible_connection=<connector>
,可以更改连接类型。有关可用插件和示例的完整列表,请参阅 插件列表。
清单设置示例
另请参阅 Ansible 示例设置,其中显示了清单以及 playbook 和其他 Ansible 项目。
示例:每个环境一个清单
如果您需要管理多个环境,有时最好每个清单只定义一个环境的主机。这样一来,例如,当您想更新某些“staging”服务器时,就很难意外地更改“test”环境中节点的状态。
对于上面提到的示例,您可以使用 inventory_test
文件
[dbservers]
db01.test.example.com
db02.test.example.com
[appservers]
app01.test.example.com
app02.test.example.com
app03.test.example.com
该文件仅包含属于“测试”环境的主机。在另一个名为 inventory_staging
的文件中定义“暂存”机器。
[dbservers]
db01.staging.example.com
db02.staging.example.com
[appservers]
app01.staging.example.com
app02.staging.example.com
app03.staging.example.com
要将名为 site.yml
的 playbook 应用于测试环境中的所有应用服务器,请使用以下命令
ansible-playbook -i inventory_test -l appservers site.yml
示例:按功能分组
在上一节中,您已经看到了使用组来集群具有相同功能的主机的示例。例如,这允许您在 playbook 或角色内部定义仅影响数据库服务器的防火墙规则。
- hosts: dbservers
tasks:
- name: Allow access from 10.0.0.1
ansible.builtin.iptables:
chain: INPUT
jump: ACCEPT
source: 10.0.0.1
示例:按位置分组
其他任务可能侧重于特定主机所在的位置。假设 db01.test.example.com
和 app01.test.example.com
位于 DC1 中,而 db02.test.example.com
位于 DC2 中。
[dc1]
db01.test.example.com
app01.test.example.com
[dc2]
db02.test.example.com
在实践中,您甚至可能最终会混合使用所有这些设置,因为您可能需要在某一天更新特定数据中心中的所有节点,而在另一天更新所有应用程序服务器,而不管它们的位置如何。
另请参阅
- 库存插件
从动态或静态源提取库存
- 使用动态清单
从动态源(例如云提供商)提取库存
- Ad Hoc 命令简介
基本命令示例
- 使用 Playbook
学习 Ansible 的配置、部署和编排语言。
- 邮件列表
有问题?需要帮忙?有想法?请访问 Google Groups 上的列表
- 实时聊天
如何加入 Ansible 聊天频道