大家好，我叫谢伟，是一名程序员。
本节的主题：Ansible + Reclass
如果你持续关注过我，应该知道我的本职工作是：PaaS 平台的安装部署，为了完成在多节点上部署组件的任务，会使用Ansible 。
如果你想要了解些Ansible 的基础知识，可以查看Ansible 官网。
或者：
通过官网的了解，我们知道，如果处理稍微复杂的动作，我们会将被管理节点的处理动作分解成roles, 每个 role 完成一个简单的任务。是一种将复杂任务分解成各个能处理的小问题的处理方式。
现在的问题是：一般我们可能会在/etc/ansible/hosts 文件内定义诸多节点的变量，比如节点的IP、节点的登录用户名或者密码等参数。
假如我们需要的节点的参数是动态的生成，或者节点的参数非常多。
这种在/etc/ansible/hosts 文件内写死的方式既不安全，也不友好。
reclass 就是为了完成对节点的信息组织的一个库，名词叫：节点分类器。
The purpose of an ENC is to allow a system administrator to maintain an inventory of nodes to be managed, completely separately from the configuration of the automation tool.
reclass 的目的是：允许系统管理员更好的管理节点的清单，同时完全独立于配置文件。
the external node classifier completely replaces the tool-specific inventory (such as site.pp for Puppet, ext_pillar/master_tops for Salt, or /etc/ansible/hosts).
那么如何使用reclass 呢？
- reclass 的安装
- reclass 的概念
- reclass 的命令行
- reclass 配置文件
- reclass 和 Ansible
下面我们一个个来看：
注：Ansible + reclass 演示是在Linux 系统下。
1. reclass 的安装
因为reclass 其实是一个 python 库，所以安装起来很简单。
pip install reclass
验证：终端内输入 reclass
reclass
出现提示，表示安装成功。
2. reclass 的概念
| reclass 概念 | 介绍 |
|---|---|
| node | 节点(就是你需要操作的主机) |
| class | A category, tag, feature, or role that applies to a node, 节点组 |
| application | 行为的集合(可以理解为role playbook) |
| parameter | 节点参数 |
这些概念中，class 可能稍微难理解点。
3. reclass 命令行
成功安装完 reclass， 终端内输入 reclass --help 即可。
reclass --help
常用的命令：
reclass -i
reclass --inventory
reclass -i -o json
其他不会的，等你需要的时候看帮助文档。
其实核心的命令就是这个：reclass -i
下文演示。
4. 配置文件
reclass-config.yml
reclass 命令默认查找 /etc/reclass , /etc/reclass/nodes 文件夹下的文件.
不使用默认则需要配置信息, 主要包括这些:
storage_type: yaml_fs
pretty_print: True
output: yaml
inventory_base_uri: ./reclass
主要注意这两个:
- output 指定命令回显的格式, 包括两种: json , yaml
- inventory_base_uri 配置文件和 reclass 文件同级, 定义为 reclass 即可
5. Reclass + Ansible
目录结构：
reclass
├── classes
│ ├── download.yml
│ ├── op-cli
│ │ └── init.yml
│ └── update.yml
└── nodes
└── localhost.yml
注意事项：
- reclass 文件夹名词不可变
- classes 文件夹名称不可变
- nodes 文件夹名称不可变
- 其他文件夹，任意命名、任意层级
各文件内的具体内容:
# download.yml
---
applications:
- download
parameters:
ssh:
info:
name: ssh-name
para: token
server: "127.0.0.1"
# op-cli/init.yml
---
applications:
- op-cli
parameters:
op_cli:
path:
name: "/home/xiewei/xiewei"
file: "/home/xiewei/xiewei.text"
# update.yml
---
applications:
- update
parameters:
info:
name:
Age: 18
LastName: wei
firstName: xie
# localhost.yml
---
classes:
- update
- download
- op-cli
parameters:
ip:
info:
info: localhost
net:
path: xiewei
可以看出, 基本是 reclass 的classes, applications, parameters的定义:
文件夹 classes 下主要定义是一组节点的参数.
比如上文,我们定义了: download, op-cli, update 三个组的参数
文件夹 nodes 下主要定义节点的参数.
比如上文节点的ip 是 localhost , 即 本机, 节点上的组包括download, op-cli, update, 还包括节点的一些参数.
配置好配置参数的情况下,现在的项目目录结构为:
├── reclass
│ ├── classes
│ │ ├── download.yml
│ │ ├── op-cli
│ │ │ └── init.yml
│ │ └── update.yml
│ └── nodes
│ └── localhost.yml
└── reclass-config.yml
执行命令(配置文件同层级): reclass -i 即可得到所有参数.
__reclass__:
timestamp: Sat May 26 00:30:57 2018
applications:
download:
- localhost
op-cli:
- localhost
update:
- localhost
classes:
download:
- localhost
op-cli:
- localhost
update:
- localhost
nodes:
localhost:
__reclass__:
environment: base
name: localhost
node: ./localhost
timestamp: Sat May 26 00:30:57 2018
uri: yaml_fs:///home/xiewei/golearn/src/gopher/Ansible-api/reclass/nodes/./localhost.yml
applications:
- update
- download
- op-cli
classes:
- update
- download
- op-cli
environment: base
parameters:
info:
name:
Age: 18
LastName: wei
firstName: xie
ip:
info:
info: localhost
net: null
path: xiewei
op_cli:
path:
file: /home/xiewei/xiewei.text
name: /home/xiewei/xiewei
ssh:
info:
name: ssh-name
para: token
server: 127.0.0.1
上述文件定义的参数,都被reclass 组织起来了.
6. reclass 结合 ansible
这两者怎么结合起来?
├── ansible
│ ├── hosts
│ ├── playbook
│ │ └── deploy.yml
│ └── roles
│ └── op-cli
│ ├── tasks
│ │ ├── deploy.yml
│ │ └── main.yml
│ └── vars
│ └── main.yml
├── ansible.cfg
├── reclass
│ ├── classes
│ │ ├── download.yml
│ │ ├── op-cli
│ │ │ └── init.yml
│ │ └── update.yml
│ └── nodes
│ └── localhost.yml
└── reclass-config.yml
为演示方便, ansible 内只编写一个 role
具体需要做这麽几件事:
- 拷贝 ansible.py 至 ansible 文件夹下幷命为 hosts
- 编写 roles 下的 role 比如 op-cli
- 在 ansible 同级目录下配置ansible 配置文件ansible.cfg (inventory 和 roles_path)
大概看下 op-cli 这个 role 都做些什么?
# tasks/deploy.yml
---
- name: echo hello world
shell: "echo hello world"
- name: is path exist
stat:
path: "{{ op_cli_path_name }}"
register: rt
- name: debug
debug:
msg: rt.stat.exists
- name: create path
file:
path: "{{ op_cli_create_path_file }}"
state: touch
mode: "u=rw,g=r,o=r"
when: not rt.stat.exists
判断文件是否存在,不存在则创建一个文件.
# vars/main.yml
---
op_cli_path_name: "{{ op_cli.path.name }}"
op_cli_create_path_file : "{{ op_cli.path.file }}"
vars 内 一般存放的是 role 任务内需要的参数,一般的操作, 我们会把所有的参数都组织在 vars/main.yml 文件内, 但是 结合 reclass 则可以把参数也定义为变量. 比如上文 op_cli_path_name. 具体变量的值上哪取?
上文我们已经讲过, relcass 是用来对节点进行分类的, 更好的组织参数. 所有 roles 内的每个 role 的参数来自于reclass 模型.
比如: reclass/classes/op-cli/init.yml
---
applications:
- op-cli
parameters:
op_cli:
path:
name: "/home/xiewei/xiewei"
file: "/home/xiewei/xiewei.text"
所以: op_cli_path_name 值为op_cli.path.name 等于 "/home/xiewei/xiewei"
这意味着参数都可以在reclass 模型内定义.
看下最终运行的playbook
# ansible/playbook/deploy.yml
- hosts: op-cli_hosts
roles:
- "op-cli"
如何知道得节点的hosts?
- nodes/localhost.yml 文件名指定localhost
- localhost.yml 包含classes: op-cli, download, update
其实运行下述命令即可知道节点信息:
ansible/hosts --list
#上文的ansible.py 重命名为hosts, 且放在ansible 文件夹下
结果:
download:
- localhost
download_hosts:
- localhost
op-cli:
- localhost
op-cli_hosts:
- localhost
update:
- localhost
update_hosts:
- localhost
配置ansible.cfg.
[defaults]
# some basic default values...
inventory = ansible/hosts
roles_path = ansible/roles
运行ansible-playbook
ansible-playbook ansible/playbook/deploy.yml
结果:
PLAY [op-cli_hosts] ********************************************************************************************************************************************************************
TASK [Gathering Facts] *****************************************************************************************************************************************************************
ok: [localhost]
TASK [op-cli : echo hello world] *******************************************************************************************************************************************************
changed: [localhost]
TASK [op-cli : is path exist] **********************************************************************************************************************************************************
ok: [localhost]
TASK [op-cli : debug] ******************************************************************************************************************************************************************
ok: [localhost] => {
"msg": "rt.stat.exists"
}
TASK [op-cli : create path] ************************************************************************************************************************************************************
changed: [localhost]
PLAY RECAP *****************************************************************************************************************************************************************************
localhost : ok=5 changed=2 unreachable=0 failed=0
即: home/xiewei/xiewei.text 文件被创建
7. 总结
- ansible 负责将问题且分为多个role, 每个role 完成一个系统任务
- reclass 负责节点inventory 的分类, 包括参数的组织
- reclass-config.yml 配置reclass 的一些信息
- ansible.cfg 配置 ansible 的一些信息
- hosts 查询节点信息
注: Linux 系统下使用 Ansible 和 reclass
注: 整个网络上都很少知识讲 relcass , 更别提 reclass 结合 ansible. 如果你平时是做的运维工作, 负责操作诸多服务器, 上面的方法希望对你有所启发.
注: 项目组织, 配置文件的路径都需要正确.
注：应对复杂系统的处理方式：自动化生成reclass/nodes 下的文件， 结合自动化生成 playbook . 这样hosts inventory 有了， playbook 有了， 就可以自动化完成任务了。
如果你在使用过程中存在问题, 可以查看下示例 Ansible + Reclass
