Ansible 自定义模块开发 – 第一部分:接受参数的美好人生
因为在尝试使用Ansible时发现没有相应的命名管道(makefifo),所以我决定自己编写一个模块来解决这个问题。
请参考下列网站
Ansibleのモジュール開発(Python実装編)
すっごい分かりやすくて好き!
ansible コマンドでモジュール引数 ( パラメータ ) を複数渡す方法
ansibleコマンド実行時に複数の引数を与える方法
环境
$ cat /etc/redhat-release
CentOS Linux release 7.7.1908 (Core)
$ ansible --version
ansible 2.9.7
config file = /etc/ansible/ansible.cfg
configured module search path = [u'/home/ansi/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
ansible python module location = /usr/lib/python2.7/site-packages/ansible
executable location = /bin/ansible
python version = 2.7.5 (default, Aug 7 2019, 00:51:29) [GCC 4.8.5 20150623 (Red Hat 4.8.5-39)]
制作原型
同时查看参考网站
#!/usr/bin/python
# -*- coding: utf-8 -*-
from ansible.module_utils.basic import AnsibleModule
module = AnsibleModule(
dict=(
message=dict()
)
)
print '{"message_key":"%s"}' % (module.params['message'])
嗯,这样子应该可以吧。我们快点试试吧。
$ ansible -i test_grp 192.168.56.104 -m makefifo -M library -u root -a message=test
192.168.56.104 | FAILED! => {
"msg": "Unable to import makefifo due to invalid syntax"
}
哎呀!真糟糕,我突然跌了一跤。
我想知道 Ansible 的版本是否有差异,所以我决定解构现有模块并尝试重建。
$ find /usr/lib/python2.7/site-packages -type f -name ping.py
/usr/lib/python2.7/site-packages/ansible/modules/system/ping.py
将这个东西复制并粘贴到 pong.py 文件中,然后首先进行正常运行确认。
$ ansible -i test_grp 192.168.56.104 -m pong -M library -u root -a data=hoge
192.168.56.104 | SUCCESS => {
"ansible_facts": {
"discovered_interpreter_python": "/usr/bin/python"
},
"changed": false,
"ping": "hoge"
}
嗯,它在运动。
经过删除这段的不必要的部分,我能削减到以下内容。
#!/usr/bin/python
# -*- coding: utf-8 -*-
from ansible.module_utils.basic import AnsibleModule
# メイン処理
#-----------------------------------------------------------
def main():
# AnsibleModuleクラス: moduleを作成
module = AnsibleModule(
# 引数受け取り
argument_spec=dict(
# 引数: data(str型,def:pong)
data=dict(type='str', default='pong'),
),
# 引数チェックを有効
supports_check_mode=True
)
# 結果dict: resultを作成
result = dict(
# key: ping に引数で与えられたkey: data のvalueを格納
ping=module.params['data'],
)
# resultの中身を key=value,の形で出力
module.exit_json(**result)
if __name__ == '__main__':
main()
$ ansible -i test_grp 192.168.56.104 -m pong -M library -u root -a data=hoge
192.168.56.104 | SUCCESS => {
"ansible_facts": {
"discovered_interpreter_python": "/usr/bin/python"
},
"changed": false,
"ping": "hoge"
}
让这个成为我们的模板。
接收参数
我认为需要的makefifo参数如下。
パラメータ変数名(key名)型必須ファイルパスpathstr○所有者(ユーザ)ownerstr○所有者(グループ)groupstr○パーミッションmodestr○
首先,我们尝试创建一个模块,只需要接收它们并返回结果。
#!/usr/bin/python
# -*- coding: utf-8 -*-
from ansible.module_utils.basic import AnsibleModule
# メイン処理
#-----------------------------------------------------------
def main():
# AnsibleModuleクラス: moduleを作成
module = AnsibleModule(
# 引数受け取り
argument_spec=dict(
# 引数: path(str型, 必須)
path=dict(type='str', required=True),
# 引数: owner(str型, 必須)
owner=dict(type='str', required=True),
# 引数: group(str型, 必須)
group=dict(type='str', required=True),
# 引数: mode(str型, 必須)
mode=dict(type='str', required=True),
),
# 引数チェックを有効
supports_check_mode=True
)
# 結果dict: resultを作成
result = dict(
path=module.params['path'],
owner=module.params['owner'],
group=module.params['group'],
mode=module.params['mode'],
)
# resultの中身を key=value,の形で出力
module.exit_json(**result)
if __name__ == '__main__':
main()
可以参考Ansible的模块开发(Python实现部分)来完成required等。
现在要进行操作确认,那如何给多个参数呢?在查询之后找到了以下答案。
- ansible コマンドでモジュール引数 ( パラメータ ) を複数渡す方法
太感谢了,太感谢了。
$ ansible -i test_grp 192.168.56.104 -m makefifo -M library -u root -a "path=/tmp/hoge owner=root group=root mode=0644"
192.168.56.104 | SUCCESS => {
"ansible_facts": {
"discovered_interpreter_python": "/usr/bin/python"
},
"changed": false,
"group": "root",
"mode": "0644",
"owner": "root",
"path": "/tmp/hoge"
}
做到了!好棒好棒,剩下的就是用Python实现了。
暂时就到这里吧,今天工作完成。