Skip to main content

8.变量之fact

简介​

ansible有一个模块叫setup，用于获取远程主机的相关信息，并可以将这些信息作为变量在playbook里进行调用。而setup模块获取这些信息的方法就是依赖于fact。

能获取非常多的信息。

示例：

# ansible localhost -m setup
locahost | SUCCESS => {
 "ansible_facts": {
 "ansible_all_ipv4_addresses": [
 "10.1.61.187"
 ],
 "ansible_all_ipv6_addresses": [
 "fe80::f816:3eff:fe4f:6611"
 ],
 "ansible_apparmor": {
 "status": "disabled"
 },
 "ansible_architecture": "x86_64",
 "ansible_bios_date": "04/01/2014",
 "ansible_bios_version": "Ubuntu-1.8.2-1ubuntu1~cloud0",

 ...output omitted...
}

setup获取的这些信息，都是可用于该主机的变量。

setup模块其他用法示例：

# 查看主机内存信息
ansible localhost -m setup -a 'filter=ansible_*_mb'

# 查看地接口为eth0-2的网卡信息
ansible localhost -m setup -a 'filter=ansible_eth[0-2]'

# 将所有主机的信息输入到/tmp/facts目录下，每台主机的信息输入到主机名文件中（/etc/ansible/hosts里的
ansible all -m setup --tree /tmp/facts

示例：

ansible localhost -m setup -a 'filter=ansible_*_mb'
localhost | SUCCESS => {
    "ansible_facts": {
        "ansible_memfree_mb": 317,
        "ansible_memory_mb": {
            "nocache": {
                "free": 1029,
                "used": 737
            },
            "real": {
                "free": 317,
                "total": 1766,
                "used": 1449
            },
            "swap": {
                "cached": 0,
                "free": 0,
                "total": 0,
                "used": 0
            }
        },
        "ansible_memtotal_mb": 1766,
        "ansible_swapfree_mb": 0,
        "ansible_swaptotal_mb": 0
    },
    "changed": false
}


ansible localhost -m setup -a 'filter=ansible_eth[0-2]'
localhost | SUCCESS => {
    "ansible_facts": {},
    "changed": false
}

自定义fact​

手动设置fact​

ansible除了能获取到预定义的fact的内容,还支持手动为某个主机定制fact。称之为本地fact。本地fact默认存放于被控端的 /etc/ansible/facts.d 目录下，如果文件为 ini 格式或者 json 格式，ansible会自动识别。以这种形式加载的fact是key为 ansible_local 的特殊变量。

下面是一个简单的示例，在ansibler主控端定义一个custom.fact文件（扩展名必须是 .fact）内容如下：

vim custom.fact
#粘贴以下内容
[general]
package = httpd
service = httpd
state = started

然后我们编写一个playbook文件名为setup_facts.yml内容如下：

---
- name: Install remote facts
  hosts: localhost
  vars:
    remote_dir: /etc/ansible/facts.d
    facts_file: custom.fact		#fact文件
  tasks:
    - name: Create the remote directory
      file:
        state: directory
        recurse: yes
        path: "{{ remote_dir }}"
    - name: Install the new facts
      copy:
        src: "{{ facts_file }}"
        dest: "{{ remote_dir }}"

输出：

sudo ansible-playbook setup_facts.yml 

PLAY [Install remote facts] ***************************************************************************************************************************

TASK [Gathering Facts] ********************************************************************************************************************************
ok: [localhost]

TASK [Create the remote directory] ********************************************************************************************************************
ok: [localhost]

TASK [Install the new facts] **************************************************************************************************************************
changed: [localhost]

PLAY RECAP ********************************************************************************************************************************************
localhost                  : ok=3    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

此时，我们可以在被控端看到新的facts已经生成：

ansible localhost -m setup 
....
 "ansible_local": {
 "custom": {
 "general": {
 "package": "httpd",
 "service": "httpd",
 "state": "started"
 }
 }
 },
 ...output omitted...

}

我们可以写一个简单的playbook来使用这些facts：

vim facts.yml
#粘贴以下内容
- name: Install Apache and starts the service
  hosts: localhost
  tasks:
    - name: Install the required package
      yum:
        name: "{{ ansible_facts.ansible_local.custom.general.package }}"
        state: latest
    - name: Start the service
      service:
        name: "{{ ansible_facts.ansible_local.custom.general.service }}"
        state: "{{ ansible_facts.ansible_local.custom.general.state }}"

执行playbook

sudo ansible-playbook facts.yml
#输出，服务无法启动，yml应该是没问题的。
PLAY [Install Apache and starts the service] **********************************************************************************************************

TASK [Gathering Facts] ********************************************************************************************************************************
ok: [localhost]

TASK [Install the required package] *******************************************************************************************************************
ok: [localhost]

TASK [Start the service] ******************************************************************************************************************************
fatal: [localhost]: FAILED! => {"changed": false, "msg": "Unable to start service httpd: Job for httpd.service failed because the control process exited with error code.\nSee \"systemctl status httpd.service\" and \"journalctl -xeu httpd.service\" for details.\n"}

PLAY RECAP ********************************************************************************************************************************************
localhost                  : ok=2    changed=0    unreachable=0    failed=1    skipped=0    rescued=0    ignored=0

使用set_fact模块定义新的变量​

set_fact 模块可以自定义facts，这些自定义的facts可以通过template或者变量的方式在playbook中使用。如果你想要获取一个进程使用的内存的百分比，则必须通过set_fact来进行计算之后得出其值，并将其值在playbook中引用。

下面是一个set_fact模块的应用示例：

设置innodb_buffer_pool_size_mb这个变量大小

vim get_mem.yml
#复制以下内容
- name: set_fact example
  hosts: localhost
  tasks:
    - name: Calculate InnoDB buffer pool size
      set_fact: innodb_buffer_pool_size_mb="{{ ansible_memtotal_mb / 2 |int }}"	#手动设置变量

    - debug: var=innodb_buffer_pool_size_mb

执行

ansible-playbook get_mem.yml 

#输出
PLAY [set_fact example] *******************************************************************************************************************************

TASK [Gathering Facts] ********************************************************************************************************************************
ok: [localhost]

TASK [Calculate InnoDB buffer pool size] **************************************************************************************************************
ok: [localhost]

TASK [debug] ******************************************************************************************************************************************
ok: [localhost] => {
    "innodb_buffer_pool_size_mb": "883.0"
}

PLAY RECAP ********************************************************************************************************************************************
localhost                  : ok=3    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

手动采集fact​

通常情况下，我们在运行play的时候，ansible会先尝试ssh到被控端采集fact，如果此时，被控制端的ssh还没有完全启动，就会导致整个play执行失败。这个时候，我们可以先显式的关闭fact采集，然后在task中通过wait_for等待被控端ssh端口被正常监听，再在task中使用setup模块来手动采集fact：

- name: Deploy apps
  hosts: webservers
  gather_facts: False		#关闭fact自动采集
  tasks：
    - name: wait for ssh to be running
      local_action: wait_for port=22 host="{{ inventory_hostname }}" search_regex=OpenSSH
    - name: gather facts
      setup:
      ......

启用fact缓存​

如果在play中需要引入fact，则可以开启fact缓存。fact缓存目前支持三种存储方式，分别为JSON、memcached、redis。

Json文件fact缓存后端​

使用JSON文件作为fact缓存后端的时候，ansible将会把采集的fact写入到控制主机的文件中。ansible.cfg配置如下：

[defaults]
gathering = smart
#缓存时间，单位为秒
fact_caching_timeout = 86400
fact_caching = jsonfile
#指定ansible包含fact的json文件位置，如果目录不存在，会自动创建
fact_caching_connection = /tmp/ansible_fact_cache

选项说明：

  • gathering： 是否启用fact，有三个选项：
    • smart：默认收集facts，但在facts已有的情况下就不收集，即使用facts缓存
    • implicit：默认收集facts，要禁止收集，必须显式的申明：gather_facts: false
    • explicit：默认不收集，要收集，必须显示的申明： gather_facts: true
  • fact_cacheing_meout：缓存时间，单位为s
  • fact_caching：缓存的方式，支持jsonfile、redis、memcached
  • fact_caching_connecon：指定ansible缓存fact的连接方式，如果是jsonfile，则指定jsonfile的缓存路径

Redis fact缓存后端​

使用redis作为fact缓存后端，需要在控制主机上安装redis服务并保持运行。需要安装python操作redis的软件包。

ansible.cfg配置如下：

[defaults]
gathering = smart
fact_caching_timeout = 86400
fact_caching = redis
fact_caching_connection = 127.0.0.1:6379:0

Memcached fact缓存后端​

使用memcached作为fact缓存后端，需要在控制主机上安装Memcached服务并保持运行，需要安装python操作memcached的软件包。

ansible.cfg配置如下：

[defaults]
gathering = smart
fact_caching_timeout = 86400 
fact_caching = memcached
fact_caching_connection = 127.0.0.1:11211

关闭fact​

如果不想从fact中获取变量，或者说整个playbook当中都没有使用到fact变量，可以通过如下方法关闭fact以提升执行效率

- hosts: test
  gather_facts: no

也可以在ansible.cfg中添加如下配置：

[defaults]
gathering = explicit