词汇表
以下是 Ansible 文档中使用的术语定义列表(以及重新解释)。
请参阅文档首页以获取完整的文档并查看术语的上下文,但这应该是一个很好的资源来检查您对 Ansible 组件的了解并理解它们是如何组合在一起的。当您在 Ansible 论坛 上遇到某个术语时,您可能希望阅读一下这部分内容。
- 操作
操作是任务的一部分,它指定要运行的模块以及传递给该模块的参数。每个任务只能有一个操作,但它也可能具有其他参数。
- 临时操作
指使用 /usr/bin/ansible 运行 Ansible 来执行一些快速命令,而不是使用 编排 语言,也就是 /usr/bin/ansible-playbook。临时操作命令的示例可能是重新启动基础设施中的 50 台机器。任何您可以临时操作执行的操作都可以通过编写一个 剧本 来完成,并且剧本还可以将多个其他操作粘合在一起。
- Ansible(软件包)
包含 ansible-core 和一组精选集合的软件包(Python、deb、rpm 等)。与 Ansible 2.9 一起使用的剧本仍应与 Ansible 2.10 软件包一起使用。有关 Ansible 中包含的集合列表以及包含的
ansible-core
版本,请参阅 ansible-build-data 中特定于版本的目录下的ansible-<version>.build
文件。- ansible-base
仅在 2.10 中使用。从 ansible/ansible 存储库 生成的可安装软件包(RPM/Python/Deb 软件包)。请参阅
ansible-core
。- ansible-core
从 2.11 开始使用的名称。从 ansible/ansible 存储库 生成的可安装软件包(RPM/Python/Deb 软件包)。包含命令行工具以及基本功能的代码,例如将模块代码复制到受管节点。
ansible-core
包含一些模块和插件,并允许您通过安装集合添加其他模块和插件。- Ansible Galaxy
一个 在线分发服务器,用于查找和共享 Ansible 社区内容,有时被称为社区 Galaxy。此外,它还是一个命令行实用程序,允许用户安装单个 Ansible 集合,例如
ansible-galaxy collection install community.crypto
。- 异步
指在后台运行的任务,而不是等待其完成。如果您有一个长时间运行的进程,其运行时间将超过 SSH 超时时间,那么以异步模式启动该任务将很有意义。异步模式可以每隔几秒钟轮询一次以查看是否完成,也可以配置为“启动后就忘记”,在这种情况下,Ansible 甚至不会再次检查任务;它只启动任务,然后继续执行后续步骤。异步模式适用于 /usr/bin/ansible 和 /usr/bin/ansible-playbook。
- 回调插件
指一些用户编写的代码,它可以拦截来自 Ansible 的结果并对其进行处理。GitHub 项目中提供的一些示例执行自定义日志记录、发送电子邮件,甚至播放声音效果。
- 检查模式
指使用
--check
选项运行 Ansible,该选项不会在远程系统上进行任何更改,只会输出如果在没有此标志的情况下运行命令可能会发生的更改。这类似于其他系统中的所谓“试运行”模式,但用户应该注意,这不会考虑意外的命令失败或级联影响(这在其他系统的类似模式中也是如此)。使用此模式可以了解可能会发生什么,但不要将其替代良好的预发布环境。- 集合
用于捆绑和分发 Ansible 内容(包括插件、角色、模块等)的打包格式。集合独立于其他集合或
ansible-core
发布,因此用户可以更早地使用新功能。一些集合与 Ansible(版本 2.10 或更高版本)一起打包。您可以使用ansible-galaxy collection install <namespace.collection>
安装其他集合(或其他版本的集合)。- 集合名称
完全限定的集合名称的第二部分。集合名称将集合命名空间划分开,通常反映集合内容的功能。例如,
cisco
命名空间可能包含cisco.ios
、cisco.aci
和cisco.nxos
,其中包含用于管理 Cisco 维持的不同网络设备的内容。- community.general(集合)
由 Ansible 社区团队管理的特殊集合,包含在 Ansible 2.9 中发布的所有没有自己专用集合的模块和插件。请参阅 Galaxy 上的 community.general。
- community.network(集合)
类似于
community.general
,专注于网络内容。Galaxy 上的 community.network。- 连接插件
默认情况下,Ansible 通过可插拔库与远程机器通信。Ansible 使用本机 OpenSSH (SSH(本机)) 或名为 paramiko 的 Python 实现。如果您使用的是最新版本,则首选 OpenSSH,并且它还支持 Kerberos 和跳跃主机等一些功能。这在 入门部分 中有所介绍。还有一些其他连接类型,例如
accelerate
模式,它必须通过 SSH 驱动的连接类型之一进行引导,但速度非常快;以及本地模式,它对本地系统起作用。用户还可以编写自己的连接插件。- 条件
条件是一个计算结果为真或假的表达式,它决定是否在给定的机器上执行给定的任务。Ansible 的条件由“when”语句驱动,这些语句在 使用剧本 中有介绍。
- 声明式
一种实现任务的方法,它使用对最终状态的描述,而不是对实现该状态的步骤序列的描述。举一个现实世界的例子,对任务的声明式规范是:“把我送到加利福尼亚”。根据您当前的位置,到达加利福尼亚的步骤序列可能会有所不同,如果您已经身在加利福尼亚,那么就不需要做任何事情。Ansible 的资源是声明式的;它会找出实现最终状态所需的步骤。它还会告诉您是否需要采取任何步骤才能达到最终状态。
- 差异模式
可以将
--diff
标志传递给 Ansible,以显示支持它的模块的更改内容。您可以将其与--check
结合使用,以获得良好的“试运行”。文件差异通常采用统一差异格式。- 分发服务器
一个服务器,例如 Ansible Galaxy 或 Red Hat Automation Hub,您可以在其中分发您的集合并允许其他人访问这些集合。请参阅 分发集合,了解分发服务器类型的列表。某些 Ansible 功能仅在特定分发服务器上可用。
- 执行器
Ansible 的核心软件组件,它是 /usr/bin/ansible 直接运行背后的力量——对应于在 剧本 中调用每个任务。执行器是 Ansible 开发人员可能会谈论的东西,但它不是真正的用户级词汇。
- 事实
事实只是关于远程节点发现的信息。虽然它们可以在 剧本 和模板中像变量一样使用,但事实是推断出来的,而不是设置的。当 Ansible 运行剧本时,通过在远程节点上执行内部 setup 模块,Ansible 会自动发现事实。您不必显式调用 setup 模块,它会自动运行,但如果不需要,可以禁用它以节省时间,或者可以使用
gather_subset:
选项告诉 Ansible 只收集完整的某些事实。为了方便从其他配置管理系统切换的用户,如果安装了 ohai 和 facter 工具,fact 模块也会从这些工具中获取事实。它们分别是 Chef 和 Puppet 的事实库。(这些也可以通过gather_subset:
禁用)- 过滤器插件
过滤器插件是大多数用户永远不需要理解的东西。它们允许创建新的 Jinja2 过滤器,这些过滤器或多或少只对知道 Jinja2 过滤器是什么的人有用。如果您需要它们,可以在 API 文档部分 学习如何编写它们。
- 并行进程
Ansible 并行地与远程节点通信,并且可以通过传递
--forks
或在配置文件中编辑默认值来设置并行级别。默认值是保守的五个 (5) 并行进程,但如果您有足够的内存,可以轻松地将其设置为 50 等值以提高并行性。- 完整限定集合名称 (FQCN)
集合中托管的模块、插件或角色的完整定义,格式为 <namespace.collection.content_name>。允许剧本以明确的方式引用特定来源中的特定模块或插件,例如
community.grafana.grafana_dashboard
。当您想指定插件的确切来源时,需要使用 FQCN。例如,如果多个集合包含一个名为user
的模块插件,FQCN 会指定要为给定任务使用的哪个插件。当您安装了多个集合时,FQCN 始终是明确且权威的指标,指示要搜索哪个集合才能找到每个任务的正确插件。- 收集事实 (布尔值)
事实 如上所述。有时在运行多剧本 剧本 时,如果不需要使用这些值,最好让某些剧本不必进行事实计算。在剧本上设置
gather_facts: False
可以跳过这种隐式事实收集。- 通配符
通配符是一种根据通配符而不是主机本身的名称或它们所属组的名称来选择多个主机的方法。例如,可以选择
ww*
来匹配所有以www
开头的主机。这个概念直接来自 Michael DeHaan(Ansible 创始人之一)的早期项目 Func。除了基本通配符外,还可以执行各种集合操作,例如“此组中的主机而不包括另一个组中的主机”等。- 组
组由分配给池的多个主机组成,这些主机可以方便地一起作为目标,还可以分配他们共享的变量。
- 组变量a
group_vars/
文件是与清单文件一起位于目录中的文件,并且可以有一个可选的文件名,该文件名以每个组的名称命名。这是一个方便的地方,可以将变量提供给给定组,尤其是复杂的数据结构,这样这些变量就不必嵌入到 清单 文件或 剧本 中。- 处理程序
处理程序就像 Ansible 剧本 中的常规任务一样(请参见 任务),但只有在任务包含
notify
关键字并还指示它更改了某些内容时才会运行。例如,如果配置文件发生更改,那么引用配置文件模板化操作的任务可能会通知服务重启处理程序。这意味着服务只有在需要重启时才会重启。处理程序可以用于除服务重启之外的事情,但服务重启是最常见的用法。- 主机
主机只是 Ansible 管理的远程机器。它们可以有分配给它们的单独变量,也可以组织成组。所有主机都有一个可以到达的名称(它是 IP 地址或域名),并且可以选择使用端口号,如果它们不使用默认 SSH 端口进行访问。
- 主机指定符
Ansible 中的每个 剧本 将一系列 任务(定义系统的角色、目的或顺序)映射到一组系统。
每个剧本中的
hosts:
关键字通常称为主机指定符。它可以选择一个系统、多个系统、一个或多个组,甚至可以选择一个组中的某些主机,而明确不包括另一个组中的主机。
- 主机变量
就像 组变量 一样,与清单文件一起位于名为
host_vars/
的目录中,可以包含一个以清单文件中每个主机名称命名的文件,以 YAML 格式显示。这提供了一个方便的地方,可以将变量分配给主机,而无需将它们嵌入到 清单 文件中。主机变量文件还可以用于定义无法在清单文件中表示的复杂数据结构。- 幂等性
如果执行操作一次的结果与在没有任何中间操作的情况下反复执行该操作的结果完全相同,则该操作是幂等的。
- 包含
剧本 文件(只不过是 剧本 列表)可以包含其他剧本列表,任务列表可以在其他文件中外部化 任务 列表,处理程序也可以这样做。包含可以进行参数化,这意味着加载的文件可以传递变量。例如,用于设置 WordPress 博客的包含剧本可能会使用名为
user
的参数,并且该剧本可以包含多次,以分别为alice
和bob
创建博客。- 清单
一个文件(默认情况下,Ansible 使用简单的 INI 格式),描述 Ansible 中的 主机 和 组。清单也可以通过 清单脚本(有时称为“外部清单脚本”)提供。
- 清单脚本
一个非常简单的程序(或一个复杂的程序),它从外部资源查找 主机、组 成员资格以及变量信息,无论该资源是 SQL 数据库、CMDB 解决方案还是 LDAP 等。这个概念是从 Puppet(它被称为“外部节点分类器”)改编而来的,并且工作方式几乎完全相同。
- Jinja2
Jinja2 是 Ansible 模板模块的首选模板语言。它是一种非常简单的 Python 模板语言,通常易于阅读和编写。
- JSON
Ansible 使用 JSON 来接收来自远程模块的返回数据。这允许模块用任何语言编写,而不仅仅是 Python。
- 关键字
构成 Ansible 的主要表达式,它们适用于剧本对象(剧本、块、角色和任务)。例如,“vars:” 是一个关键字,它允许您在应用它的剧本对象的范围内定义变量。
- 延迟求值
一般来说,Ansible 会在最后时刻评估 剧本 内容中的所有变量,这意味着如果您定义了一个数据结构,该数据结构本身可以在其中定义变量值,并且所有内容都会按照您的预期“正常工作”。这也意味着变量字符串可以在这些字符串内包含其他变量。
- 库
提供给 /usr/bin/ansible 或 Ansible 剧本 的模块集合。
- 限制组
通过将
--limit somegroup
传递给 ansible 或 ansible-playbook,可以将命令限制为 主机 的子集。例如,这可以用来运行一个通常针对一组服务器的 剧本,而只针对一台特定的服务器。- 本地操作
此关键字是
delegate_to: localhost
的别名。当您想要将从远程执行的操作重定向到控制节点本身执行时使用。- 本地连接
通过在 剧本 中使用
connection: local
,或者将-c local
传递给 /usr/bin/ansible,这表示我们正在执行本地分叉,而不是在远程机器上执行。您可能需要local_action
或delegate_to: localhost
,因为这只会更改连接,而不会更改其他执行上下文。- 查找插件
查找插件是一种从外部世界获取数据到 Ansible 的方式。查找插件是 Jinja2 的扩展,可以在模板中访问,例如
{{ lookup('file','/path/to/file') }}
。这就是with_items
等实现的方式。还有一些查找插件,如file
,它从文件加载数据,以及用于查询环境变量、DNS 文本记录或键值存储的插件。- 循环
通常,Ansible 不是一种编程语言。它更喜欢声明性,尽管像
loop
这样的各种构造允许特定任务针对列表中的多个项目重复执行。某些模块,如 yum 和 apt,实际上直接接受列表,并且可以在单个事务中安装这些列表中给出的所有包,从而显着加快配置的总时间,因此它们可以在没有循环的情况下使用。- 模块
模块是 Ansible 分发到远程机器的工作单元。模块是由 /usr/bin/ansible 或 /usr/bin/ansible-playbook(其中多个任务联合使用多个不同模块)启动的。模块可以用任何语言实现,包括 Perl、Bash 或 Ruby,但如果用 Python 编写,可以利用一些有用的通用库代码。模块只需要返回 JSON。模块在远程机器上执行后,就会被删除,因此不会使用任何长时间运行的守护进程。Ansible 将可用的模块集合称为 库。
- 多层
IT 系统不是一次管理一个系统,而是通过多个系统和系统组以定义明确的顺序进行交互来管理的概念。例如,Web 服务器可能需要在数据库服务器之前更新,而 Web 服务器上的部分可能需要在该数据库服务器之后更新,并且可能需要联系各种负载均衡器和监控服务器。Ansible 对整个 IT 拓扑结构和工作流进行建模,而不是从“一次一个系统”的角度来看待配置。
- 命名空间
完全限定的集合名的第一部分,命名空间通常反映功能内容类别。例如:在
cisco.ios.ios_config
中,cisco
是命名空间。命名空间由 Red Hat 保留并由 Red Hat 自行决定分配。许多但并非所有命名空间将对应于供应商名称。有关命名空间要求,请参阅 Galaxy 文档网站上的 Galaxy 命名空间。- 通知
一个 任务 注册更改事件并通知一个 处理程序 任务,另一个 操作 需要在 剧本 结束时运行。如果处理程序被多个任务通知,它仍然只会运行一次。处理程序的运行顺序与其列出的顺序相同,而不是其被通知的顺序。
- 编排
许多软件自动化系统使用这个词来表示不同的意思。Ansible 使用它就像指挥家指挥乐团一样。数据中心或云架构充满了许多系统,扮演着许多角色——Web 服务器、数据库服务器,也许还有负载均衡器、监控系统、持续集成系统等等。在执行任何流程时,需要以特定顺序触碰系统,通常是为了模拟滚动更新或正确部署软件。某些系统可能执行一些步骤,然后其他系统执行,然后已经处理过的先前系统可能需要执行更多步骤。在此过程中,可能需要发送电子邮件或联系 Web 服务。Ansible 编排就是关于对这类流程进行建模的。
- paramiko
Ansible 可以使用名为
paramiko
的 Python SSH 实现。paramiko 库通常速度快且易于管理。要使用 paramiko,您需要在您的 剧本 中指定连接类型,或者使用-c paramiko
标志。- 剧本
剧本是 Ansible 编排、配置、管理或部署系统的语言。它们被称为剧本,部分原因是这是一个体育类比,使用它们应该很有趣。它们不是工作簿 :)
- 剧本
一个 剧本 是一个剧本列表。一个剧本至少是主机规范符(通常由 组 选择,但有时由主机名 通配符 选择)选择的一组 主机 与在这些主机上运行的任务之间的映射,以定义这些系统将执行的角色。一个剧本中可以有一个或多个剧本。
- 拉取模式
默认情况下,Ansible 在 推送模式 下运行,这使其能够对何时与每个系统通信进行非常细粒度的控制。拉取模式是为当您希望节点每隔 N 分钟按特定计划进行检查时提供的。它使用一个名为 ansible-pull 的程序,也可以使用推送模式的 剧本 进行设置(或重新配置)。大多数 Ansible 用户使用推送模式,但拉取模式包含在内是为了多样性和提供选择。
ansible-pull 通过在 crontab 中检查配置顺序并从 Git 中提取,然后使用 本地连接 插件在本地管理机器。
- Pulp 3 Galaxy
一个基于 GalaxyNG 代码库 的自托管分发服务器,基于 Pulp 版本 3。使用它来查找和共享您自己精心策划的内容集。您可以使用
ansible-galaxy collection
命令访问您的内容。- 推送模式
推送模式是 Ansible 的默认模式。事实上,它并不是真正的模式——它只是 Ansible 在您没有考虑它的情况下工作的方式。推送模式允许 Ansible 细粒度地执行,并在不等待节点进行检查的情况下,引导节点完成复杂的编排流程。
- 注册变量
在 Ansible 中运行任何 任务 的结果可以存储在一个变量中,以便在模板或条件语句中使用。用于定义变量的关键字称为
register
,它借鉴了汇编编程中寄存器的概念(尽管 Ansible 永远不会感觉像汇编编程)。您可以使用无数个变量名称进行注册。- 资源模型
Ansible 模块以资源为单位工作。例如,file 模块 会选择一个特定的文件,并确保该资源的属性与特定的模型相匹配。例如,我们可能希望将
/etc/motd
的所有者更改为root
(如果它尚未设置为root
),或将其模式设置为0644
(如果它尚未设置为0644
)。资源模型是 幂等的,这意味着只有在需要时才会运行更改命令,Ansible 会将系统恢复到所需状态,无论实际状态如何 - 而不是您必须告诉它如何达到该状态。- 角色
角色是 Ansible 中的组织单位。将角色分配给一组 主机(或一组 组,或 主机模式 等)意味着它们应该实现特定行为。角色可能包括应用某些变量值、某些 任务 和某些 处理器 - 或者仅仅是这些东西中的一个或多个。由于与角色相关联的文件结构,角色成为可再分配的单元,允许您在 剧本 之间共享行为 - 甚至与其他用户共享。
- 滚动更新
一次更新一组节点 N 中的多个节点的行为,以避免一次性更新所有节点并使系统脱机。例如,在处理大量流量的 500 个节点的 Web 架构中,一次更新 10 或 20 台机器可能是合理的,在完成时再继续下一个 10 或 20 台机器。Ansible 剧本 中的
serial:
关键字控制滚动更新池的大小。默认情况下,一次性处理批次大小,因此这是您必须选择加入的内容。操作系统配置(例如确保配置文件正确)通常不需要使用滚动更新模型,但可以在需要时这样做。- 串行
另请参见
- Sudo
Ansible 不需要 root 登录,并且因为它没有守护进程,所以肯定不需要 root 级别的守护进程(这在敏感环境中可能是一个安全问题)。Ansible 可以登录并执行许多用 sudo 命令包装的操作,并且可以与无密码和基于密码的 sudo 协同工作。一些通常无法使用 sudo 执行的操作(例如 scp 文件传输)可以通过 Ansible 的 copy、template 和 fetch 模块在 sudo 模式下运行来实现。
- SSH(原生)
使用
-c ssh
(或配置文件,或 剧本 中的关键字)指定原生 OpenSSH 作为 Ansible 传输,如果想要通过 Kerberized SSH 登录或使用 SSH 跳板主机等,这很有用。在 1.2.1 中,如果控制机器上的 OpenSSH 二进制文件足够新,则默认使用ssh
。以前,Ansible 选择paramiko
作为默认值。建议使用支持ControlMaster
和ControlPersist
的客户端以获得最佳性能 - 如果您没有它,并且不需要 Kerberos、跳板主机或其他功能,paramiko
是一个不错的选择。如果 Ansible 未检测到 ControlMaster/ControlPersist 功能,它会发出警告。- 标签
Ansible 允许在 剧本 中使用任意关键字标记资源,然后仅运行与这些关键字相对应的剧本部分。例如,可以有一个完整的操作系统配置,并将某些步骤标记为
ntp
,然后仅运行ntp
步骤来重新配置远程主机上的时间服务器信息。- 任务
剧本 存在于运行任务。任务将 操作(模块及其参数)与名称组合在一起,并可选地包含其他一些关键字(例如 循环关键字)。处理器 也是任务,但它们是一种特殊的任务,只有在任务报告远程系统上的底层更改时,它们才会按名称通知才会运行。
- 任务
一列 任务。
- 模板
Ansible 可以轻松地将文件传输到远程系统,但通常需要在其他文件中替换变量。变量可能来自 清单 文件、主机变量、组变量 或 事实。模板使用 Jinja2 模板引擎,还可以包含循环和 if 语句等逻辑结构。
- 传输
Ansible 使用 :term:
连接插件
来定义可用传输的类型。这些只是 Ansible 如何联系受管系统。包含的传输有 paramiko、ssh(使用 OpenSSH)和 本地。- 当
附加到 任务 的可选条件语句,用于确定是否应运行该任务。如果
when:
关键字后面的表达式计算结果为假,则该任务将被忽略。- Vars(变量)
与 事实 相反,变量是值的名称(它们可以是简单的标量值 - 整数、布尔值、字符串)或复杂的值(字典/哈希、列表),它们可以在模板和 剧本 中使用。它们是声明的东西,而不是从远程系统的当前状态或性质推断出来的东西(这就是事实)。
- YAML
Ansible 不希望强迫人们编写编程语言代码来自动化基础设施,因此 Ansible 使用 YAML 来定义 剧本 配置语言以及变量文件。YAML 很棒,因为它语法最少,非常简洁易懂,方便人们浏览。它是一种适合配置文件和人类的良好数据格式,但也适合机器阅读。Ansible 使用 YAML 源于 Michael DeHaan 大约在 2006 年在 Cobbler 中首次使用它。YAML 在动态语言社区中相当流行,这种格式在许多语言(Python、Perl、Ruby 等)中都有用于序列化的库。
另请参见
- 常见问题解答
常见问题解答
- 使用剧本
剧本介绍
- Ansible 技巧和窍门
剧本的技巧和窍门
- 沟通
有问题?需要帮助?想分享你的想法?访问 Ansible 沟通指南