5.4 使用lookup生成变量

Clay2020年3月20日

自动化工具

Ansible

大约 6 分钟

5.4 使用lookup生成变量

简单说明

在通常情况下，所有的配置信息都会被作为ansible的变量保存了，而且可以保存在ansible允许定义变量的各种地方，诸如vars区段，vars_files加载的文件中，以及host_vars和group_vars目录中。

但在有些时候，我们希望从诸如文本文件或者.csv文件中收集数据作为ansible的变量，或者直接获取某些命令的输出作为ansible的变量，甚至从redis或者etcd这样的键值存储中取得相应的值作为ansible的变量。这个时候，我们就需要通过ansible的lookup插件来从这些数据源中读取配置数据，传递给ansbile变量，并在playbook或者模板中使用这些数据。

lookup()是Ansible的一个插件，可用于从外部读取数据，这里的"外部"含义非常广泛，比如：

(1).从磁盘文件读取(file插件)

(2).从redis中读取(redis插件)

(3).从etcd中读取(etcd插件)

(4).从命令执行结果读取(pipe插件)

(5).从Ansible变量中读取(vars插件)

(6).从Ansible列表中读取(list插件)

(7).从Ansible字典中读取(dict插件)

(8)....

具体可以从哪些"外部"读取以及如何读取，取决于Ansible是否提供了相关的读取插件。官方手册：https://docs.ansible.com/ansible/latest/plugins/lookup.html#plugin-list 中列出了所有支持的插件

lookup()语法

lookup('<plugin_name>', 'plugin_argument')

1. file/fileglob

使用file lookup可以从文本文件中获取数据，并在这些数据传递给ansible变量，在task或者jinja2模板中进行引用。下面是一个从文本文件中获取ssh公钥并复制到远程主机的示例：

- name: copy authorized_host file
  template: 
    src: authorized_keys.j2 
    dest: /home/deploy/.ssh/authrized_keys 
    owner: deploy
    group: deploy
    mode: 0600

authorized_keys.j2模板文件示例如下：

{{ lookup('file', '/users/breeze/.ssh/id_rsa.pub')}}

和file类似，支持通配符的fileglob插件，它使用通配符来通配Ansible本地端的文件名

---
- name: play1
  hosts: new
  gather_facts: false
  tasks:
    - name: task1
  debug:
    msg: "filenames: {{lookup('fileglob','/etc/*.conf')}}"

需注意的是，fileglob查询的是Ansible端文件，且只能通配文件而不能通配目录，且不会递归通配。如果想要查询目标主机上的文件，可以使用find模块。

如果lookup()查询出来的结果包含多项，则默认以逗号分隔各项的字符串方式返回，如果想要以列表方式返回，则传递一个lookup的参数wantlist=True。例如，fileglob通配出来的文件如果有多个，加上wantlist=True：

在Ansible 2.5中添加了一个新的功能query()或q()，后者是前者的等价缩写形式。query()在写法和功能上和lookup一致，其实它会自动调用lookup插件，并且总是以列表方式返回，而不需要手动加上wantlist=True参数。例如：

- name: task1
  debug:
  msg: "{{q('fileglob','/etc/*.conf')}}"

2. pipe

使用pipe lookup可以直接调用外部命令，并将命令执行的结果打印到标准输出，作为ansible变量。下面的例子通过pipe调用date指令拿到一个以时间数字组成的字串

- name: Flamingo | Get release version
  set_fact:
    flamingo_release_version: "{{ lookup('pipe', 'date +%Y%m%d%H%M%SZ') }}"

3. env

env lookup实际就是获取在控制主机上的某个环境变量的值。下面是一个读取控制机上$JAVA_HOME变量值的示例：

- name: get JAVA_HOME
  debug: msg="{{ lookup('env', 'JAVA_HOME')}}"

4. template

template lookup可以指定一个jinja2模板，然后返回这个模板中的变量被替换以后的结果。

假设我们有一个message.j2模板，内容如下：

This host runs {{ ansible_distribution }}

定义一个如下的task：

- name: print message from template
  debug: msg="{{ lookup('template', 'message.j2')}}"

输出的msg的结果如下：

This host runs CentOS

5. csvfile

csvfile可以从.csv文件中读取一个条目。假设我们有如下示例的名为users.csv的文件：

username,email
lorin,lorin@test.com
john,john@example.com
sue,sue@exmaple.com

下面是一个使用csvfile lookkup提取sue的电子邮件地址的task示例：

- name: get sue's email
  debug: msg="{{ lookup('csvfile','sue file=users.csv delimiter=, col=1')}}"

可以看到，一共向插件传递了四个参数：sue, file=users.csv, delimiter=,以及col=1。说明如下：

第一个参数指定一个名字，该名字必须出现在其所在行的第0列，需要说明的是，如果指定的第一个参数名字在文件中出现多次，则匹配第一次出现的结果
第二个参数指定csv文件的文件名
第三个参数指定csv文件的中条目的分隔符，
第四个参数指定要取得哪一列的值，这一列正是第一个参数所在行的那一列的值

如果我们想要查找的用户存储在名为username的变量中，则可以使用"+"符号来连接username字串和其他的参数字串，来构建完整的参数字符串：

lookup('csvfile', username+'file=users.csv' delimiter=, col=1)

6. redis_kv

redis_kv lookup可以直接从redis存储中来获取一个key的value，key必须是一个字符串，如同Redis GET指令一样。需要注意的是，要使用redis_kv lookup，需要在主控端安装python的redis客户端，在centos上，软件包为python-redis。

下面是一个在playbook中调用redis lookup的task，从本地的redis中取中一个key为weather的值：

- name: lookup value in redis
  debug: msg="{{ lookup('redis_kv', 'redis://localhost:6379,weather')}}"

其中URL部分如果不指定，该模块会默认连接到redis://localhost:6379，所以实际上在上面的实例中，调用可以直接写成如下：

{{ lookup('redis_kv', 'weather')}}

7. etcd

etcd是一个分布式的key-value存储，通常被用于保存配置信息或者被用于实现服务发现。可以使用etcd lookup来从etcd中获取指定key的value。

我们通过如下方法往一个etcd中写入一个key：

curl -L http://127.0.0.1:4001/v2/keys/weather -XPUT -d value=sunny

定义一个调用etcd插件的task：

- name: look up value in etcd
  debug: msg="{{ lookup('etcd','weather')}}"

默认情况下，etcd lookup会在http://127.0.0.1:4001上查找etcd服务器。但我们在执行playbook之前可以通过设置ANSIBLE_ETCD_URL环境变量来修改这个设置。

8. password

password lookup会随机生成一个密码，并将这个密码写入到参数指定的文件中。如下示例，创建一个名为bob的mysql用户，并随机生成该用户的密码，并将密码写入到主控端的bob-password.txt中：

- name: create deploy mysql user
  mysql_user: name=bob password={{ lookup('password', 'bob-password,txt')}} priv=*.*:ALL state=present

9. dnstxt

dnstxt lookup用于获取指定域名的TXT记录。需要在主控端安装python-dns。

使用方法如下：

- name: lookup TXT record
  debug: msg="{{ lookup('dnstxt', "aliyun.com") }}"

如果某一个主机有多个相关联的TXT记录，那么模块会把他们连在一起，并且每次调用时的连接顺序可能不同

参考链接：
https://www.cnblogs.com/breezey/p/9275799.html
https://blog.51cto.com/cloumn/blog/1544

5.4 使用lookup生成变量

# 5.4 使用lookup生成变量

# 简单说明

# 1. file/fileglob

# 2. pipe

# 3. env

# 4. template

# 5. csvfile

# 6. redis_kv

# 7. etcd

# 8. password

# 9. dnstxt

5.4 使用lookup生成变量

简单说明

1. file/fileglob

2. pipe

3. env

4. template

5. csvfile

6. redis_kv

7. etcd

8. password

9. dnstxt