阿里云已经提供了动态 Inventory 文件,利用该文件可实现对指定过滤条件的主机信息的动态获取。
环境准备
# 直接使用 Pip 完成对 Ansible Alicloud Module Utils 的安装
$ sudo pip install ansible_alicloud_module_utils
在组件ansible_alicloud_module_utils的安装过程中,会自动安装 Ansible 和组件的依赖,如 footmark,阿里云 Python sdk等。完成安装后,通过命令 pip show footmark 来确保 footmark 的版本大于 1.9.0:
$ pip show footmark
DEPRECATION: Python 2.7 will reach the end of its life on January 1st, 2020. Please upgrade your Python as Python 2.7 won't be maintained after that date. A future version of pip will drop support for Python 2.7. More details about Python 2 support in pip, can be found at https://pip.pypa.io/en/latest/development/release-process/#python-2-support
Name: footmark
Version: 1.12.0
Summary: A Python interface to Aliyun Web Services
Home-page: https://github.com/alibaba/footmark
Author: xiaozhu
Author-email: [email protected]
License: MIT
Location: /usr/local/lib/python2.7/dist-packages
Requires: oss2, importlib, aliyun-python-sdk-ecs, aliyun-python-sdk-slb, aliyun-python-sdk-rds, aliyun-python-sdk-ess, aliyun-python-sdk-core, aliyun-python-sdk-vpc
Required-by: ansible-alicloud, ansible-alicloud-module-utils
如果,版本号为满足要求,可通过命令 sudo pip install footmark --upgrade 完成对 footmark 版本的升级。
显示地指定阿里云 Inventory
和其他 Inventory 一样,阿里云的动态 Inventory 也有两种使用方式:“显示指定” 和 “默认指定”。所谓“显示指定”,就是在执行 Ansible 命令时以参数 -i 显示地指定动态 Inventory 文件。
下载 Inventory
下载最新版本的阿里云动态 Inventory 文件,并为其赋予可执行权限:
$ wget https://raw.githubusercontent.com/alibaba/ansible-provider/master/contrib/inventory/alicloud.py
$ chmod +x alicloud.py
下载获取与阿里云动态 Inventory 配套的 alicloud.ini 配置文件,并将其放到 alicloud.py 所在到目录:
$ wget https://raw.githubusercontent.com/alibaba/ansible-provider/master/contrib/inventory/alicloud.ini
在配置文件 alicloud.ini 中,包含多种配置选项,包括缓存控制和目的地址变量,主机所在region,主机的属性等。基于该文件来实现对主机信息的自定义过滤。
访问预配置
在调用 Inventory 文件前,需要指定所使用的 AccessKey 和 SecretKey,他们可以直接定义在配置文件 alicloud.ini 中:
# 阿里云控制台创建
# 地址 https://usercenter.console.aliyun.com/#/manage/ak
alicloud_access_key = Abcd1234
alicloud_secret_key = Abcd2345
访问验证
如何知道配置是否正确,可通过执行 Inventory 文件来测试:
$ ./alicloud.py --list
你可以看到以 JSON 格式表示的覆盖所有 regions 的 inventory 信息。正如上文中展示的。
如果你只想获取部分 region 的信息,可以编辑 alicloud.ini,输入目标 Regions。除此之外,还可通过 alicloud.ini 中的 instance_filters过滤所有的主机信息。
阿里云的动态 Inventory 提供了一种从多个组到实例的映射:
- Global
所有的实例都属于 alicloud 这个组。如:
"alicloud": {
"children": [
"i_bp1i1aitghkkq*******",
"i_bp171m264ryt9*******"
]
},
- 实例ID
主机的ID。例如:
"i-bp171m264ryt9******": [
"i_bp171m264ryt9******"
],
"i-bp1i1aitghkkq******": [
"i_bp1i1aitghkkq*****"
],
- Region
属于一个阿里云 region 的所有实例构成的一个组。例如:
"cn-hangzhou": [
"i_bp1i1aitghkkq*******",
"i_bp171m264ryt9*******"
],
- 可用性Zone
属于同一个可用区的所有实例构成一个组。 例如:
"cn-hangzhou-g": [
"i_bp1i1aitghkkq*******",
"i_bp171m264ryt9c******"
],
- 安全组
实例可属于一个或多个安全组。每一个组的前缀都是 security_group_。例如:
"security_group_sg_bp1cp0behw74aa******": [
"i_bp1i1aitghkkqp******"
],
"security_group_sg_bp1dtemf7bv5******": [
"i_bp171m264ryt9******"
],
- 标签Tag
每一个实例有多个不同的 key/value 键值对。这些键值对被称为标签。标签名可以随意定义,每一个键值对是一个组。特殊字符已被转换为下划线,格式为 tag_KEY_VALUE 例如:
"tag_acsversion_1_0": [
"i_t4nd1ehd9umu5******",
"i_t4n6v8wv6jue5******"
],
"tag_env_dev": [
"i_bp171m264ryt9******"
],
除此之外,还有很多类似属性用于划分主机组,如 VPC ID,VSwitch ID,镜像ID等。
场景使用
一旦确认了阿里云的 Inventory 可以运行,便可将 alicloud.py 作为一个 inventory 应用在 Ansible 具体的使用场景中,如下所示:
$ ansible -i alicloud.py alicloud -m ping -u root -k
Refresh 主机信息
值得注意的是,阿里云的动态 Inventory 文件会将每次执行结果进行缓存,以避免重复的 API 调用。这个缓存的设置可通过编辑 alicloud.ini 文件中的 cache_path 进行配置。如果想要显式地清空缓存,可以在执行Inventory时加上 --refresh-cache:
$ ./alicloud.py --refresh-cache
默认地指定阿里云 Inventory
除了显示地指定阿里云的 Inventory 文件,还可将动态 Inventory 配置为默认的 Inventory。在安装完 ansible 之后,ansible inventory 默认为 /etc/ansible/hosts。
下载最新版本的阿里云动态 Inventory 文件,并为其赋予可执行权限,之后用其替换默认 Inventory:
$ wget https://raw.githubusercontent.com/alibaba/ansible-provider/master/contrib/inventory/alicloud.py
$ chmod +x alicloud.py
$ sudo cp alicloud.py /etc/ansible/hosts
下载阿里云动态 Inventory 的配置文件,并将其移动到默认 Inventory 所在的目录 /etc/ansible:
$ wget https://raw.githubusercontent.com/alibaba/ansible-provider/master/contrib/inventory/alicloud.ini
$ sudo cp alicloud.ini /etc/ansible
运行如下命令进行验证:
ansible alicloud -m ping
参考文档
https://yq.aliyun.com/articles/688092