关于 AWX 执行 ansible 的原理不解的地方

2021-11-04 18:19:00 +08:00
 firejoke

最近一直在写一个给小白用的运维工具,使用 django+ansible 。
红帽本身有一个这样的项目,收费的是 Tower ,开源的版本叫 AWX 。
既然有现成的,就想看看他是怎么做的。

首先因为 ansible 核心功能 play 是基于文件和 role 目录来执行可复用的任务,而目标机器组( inventory )也是记录在文件内的。
最简单办法,就是文件读取和解析,然后映射到界面上,但这其中还涉及 play 文件内的各种变量和关键词,还有频繁的文件操作,不认为是一个最佳的解决方案。 比较合理的办法,是自行开发 ansible 模块或插件,以实现从你的 web api 获取资源。


inventory 的解决办法比较简单,写一个 inventory 插件,从你的 api 接口获取主机列表,然后组装成 ansible 能识别的数据结构,实际上 AWX 的源码里也是写了这样的插件InventoryModule(BaseInventoryPlugin)
这个插件使用了 awx 写的另一个 module_util:ControllerModule(AnsibleModule),用来从他的 web api 里获取资源。

...
module = ControllerAPIModule(argument_spec={}, direct_params=module_params,        error_callback=handle_error, warn_callback=self.warn_callback)
...
inventory = module.get_endpoint(inventory_url, data={'hostvars': '1', 'towervars': '1', 'all': '1'})['json']

而 play 的执行,awx 则是使用了ansible-runner这个库,这个库可以通过读取一个固定结构的目录直接执行 play ,也提供 python 接口可以传递 play 的必要参数来执行 play 。
awx 是让用户自行提供一个 play 文件,然后保存到固定的目录下,inventory 也是保存到固定位置的文件里,然后调用 ansible-runner 执行。

params = {
    'ident': self.instance.id,
    'private_data_dir': private_data_dir,
    'playbook': self.build_playbook_path_relative_to_cwd(
        self.instance, private_data_dir
        ),
    'inventory': self.build_inventory(self.instance, private_data_dir),
    'passwords': expect_passwords,
    'envvars': env,
    'settings': {
        'job_timeout': self.get_instance_timeout(self.instance),
        'suppress_ansible_output': True,
    },
}
...
if isinstance(self.instance, SystemJob):
    res = ansible_runner.interface.run(
        project_dir=settings.BASE_DIR,
        event_handler=self.event_handler,
        finished_callback=self.finished_callback,
        status_handler=self.status_handler,
        **params,
    )
...

这个 task 的执行是通过 Job 模型保存时的信号来决定,task 的执行是维护在另一个线程内(这里还没摸透,只大致知道是通过信号引发执行)


不解的地方在于:

  1. 既然已经写了一个 Inventory 插件,为什么这里还要把 inventory 保存到文件内呢?
  2. 为什么不把 play 以及 task ,role ,handler ,block 这些 Play 里的功能也设计成模型保存到数据库里呢?而是要用户自己写?
1510 次点击
所在节点    Ansible
4 条回复
julyclyde
2021-11-05 13:26:29 +08:00
1 保存的是“这一次”执行的 inventory ,在 play 比较长的时候可以保证前后一致。要不然执行一半的时候上有 inventory 列表更新了咋办?
firejoke
2021-11-05 15:10:33 +08:00
@julyclyde #1 在 inventory 插件里,也是只从 api 里获取一次,中途不会在执行这个动作,所以不存在这个情况。
julyclyde
2021-11-05 16:08:30 +08:00
@firejoke 存档
firejoke
2021-11-05 16:18:14 +08:00
@julyclyde #3 嗯,按这里 ansible-runner 调用方法来看,是根据指定根目录的目录结构来执行一个任务,可以认为是为单一指定的 project 保存一个 inventory 存档,这样就能理解。
但为了这个目的的话,专门为这个 project 建一个 inventory group 不就行了,不管整个 inventory 怎么更新,只要这个 inventory group 不变就行了,每次执行这个 project 都使用这个 group 。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/813100

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX