ansible笔记(38):jinja2模板(一)

  • A+
所属分类:Ansible  运维技术

在本博客中,ansible是一个系列文章,我们会尽量以通俗易懂的方式总结ansible的相关知识点。

ansible系列博文直达链接:ansible轻松入门系列

"ansible系列"中的每篇文章都建立在前文的基础之上,所以,请按照顺序阅读这些文章,否则有可能在阅读中遇到障碍。

 

当安装完redis以后,redis默认配置的监听地址为"127.0.0.1",这样是安全的,但是,如果我需要让redis监听在非"127.0.0.1"的IP地址上,以便让其他主机也能够使用本机上的redis服务,那么我就需要修改默认的配置,没错,修改redis配置文件中的bind设置,即可将redis绑定在指定的IP上,假设,现在需要一次性在10台主机上安装redis,并且让安装后的redis都监听在redis所在主机的非"127.0.0.1"的IP地址上,我们该怎么办呢?通过ansible在10台主机上安装redis很容易,但是安装完成后,10台主机中的redis都是使用默认的监听地址"127.0.0.1"的,难道我们要在安装完成后,挨个的手动修改这10台主机中的redis配置文件吗?显然,应该有更加方便的方法能够解决这个问题,没错,这个方法就是使用"模板"。

 

此处,先大致的描述一下"模板"的用法,以便先在脑海中形成概念方便理解,我们会在之后进行具体的示例和解释,到时候我们自然会更加清晰的理解"模板"。

如果想要解决上述问题,我们可以先创建一个"模板"文件,ansible会根据"模板"文件,为每一台主机生成对应的配置文件,大致步骤如下:

1、找一个现成的redis配置文件,作为"模板"文件,你可以从之前安装过redis的主机中拷贝一份,也可以从redis的rpm包中提取一份。

2、修改模板文件,将IP设置部分使用变量进行替换。

3、使用ansible调用"template"模块,对"模板文件"进行渲染,根据模板生成每个主机对应的配置文件,并将最终生成的配置文件拷贝到目标主机中。

 

了解完上述步骤,你可能已经初步的有了一个大致的概念,那么现在,我们来看看具体该怎样实现。

首先,就是准备一个redis配置文件作为模板文件,所有主机的redis配置文件都是根据这个模板文件生成的,此处,我已经从之前安装过redis的主机中拷贝了一个redis.conf文件到ansible控制机中,打开这个配置文件,可以看到,默认监听的地址为"127.0.0.1",如下图所示

ansible笔记(38):jinja2模板(一)

按照要求,每个主机上的redis都应该监听在自己的非本地回环地址上,但是,每个主机的IP地址都不一样,我们怎样才能获取到每个机器的IP地址呢?你肯定已经想到了,我们在使用ansible连接到对应主机时,就已经获取到了对应主机的IP地址,对应的IP就存放在"ansible_host"变量中(在配置ansible清单时也是将远程主机的IP地址写入到ansible_host变量中,如果你忘记了,情回顾前文,但是需要注意,ansible控制机对应的ansible_host变量的值并不是自己的IP,而是在清单中配置的主机别名),所以,我们只要在bind设置中使用"ansible_host"变量进行替换即可,修改redis.conf文件,如下图所示:

ansible笔记(38):jinja2模板(一)

完成上述修改后,模板配置文件就算准备好了,那么,我们就来编写一个playbook,来完成上述工作场景,示例playbook如下:

如上例所示,先使用yum模块安装了redis,然后调用template模块,上例template模块使用了两个参数,src参数和dest参数,src参数对应的文件就是ansible主机中的模板文件,即我们刚才修改过的redis.conf配置文件模板,dest参数表示将最终生成的配置文件拷贝到目标主机的所在路径,也就是说,上例playbook会调用template模块,使用ansible主机中的/testdir/ansible/redis.conf 文件作为模板文件,根据模板文件,对目标主机test70生成最终的配置文件,最终的配置文件会被拷贝到test70主机的/etc目录中,并且文件名为redis.conf,通过yum安装redis后默认的配置文件路径即为 /etc/redis.conf,我们使用template模块生成了最终的配置文件后,覆盖了yum默认配置文件,如上例所示,template模块不仅能够根据模板文件生成文件,还会自动将生成的文件拷贝到远程主机中的指定位置,那么我们来运行一下上例playbook

playbook执行完毕后,我们到目标主机test70上查看/etc/redis.conf文件,redis.conf中的bind配置如下图所示

ansible笔记(38):jinja2模板(一)

可以看到,test70中的redis.conf文件中的bind配置对应的IP地址为10.1.1.70,这个IP正是test70主机的IP地址,这种效果完全符合我们的预期,在test70主机中安装完redis以后,并没有手动的修改配置文件,而是利用"模板",自动生成了对应配置文件,并拷贝到了远程主机中的指定位置,上例中,为了演示方便,目标主机只指定了test70一台主机,你也可以在上例playbook中一次性的指定多台目标主机试试,最终的效果就是每台主机中的redis都监听在自己的IP地址上。

 

经过上述描述,你一定已经明白了模板的作用和用法,模板功能可以帮助我们灵活的生成配置文件,我们只需要先选择一个文件作为模板文件,然后修改模板文件中需要灵活生成的部分,使用变量进行替换(对应的变量必须提前定义好或者能够在运行时获取),模板文件中不需要灵活生成的部分保持不变即可,当需要为各个目标主机生成配置文件时,只需调用template模块,templdte模块会在ansible控制机中对模板文件进行渲染,最终生成各个主机对应的配置文件,然后拷贝到远程主机的指定位置中。

 

除了在playbook中能够使用template模块,在ad-hoc命令中也可以直接调用templdate模块,在ad-hoc命令中使用templdate模块比较方便我们测试模板文件的最终生成效果,示例如下:

直接在ansible主机中执行上述ad-hoc命令,执行完成后,即可在目标主机中的对应位置获取到最终生成的文件。

 

由于template模块还负责将最终生成的文件拷贝到远程主机上,所以还有一些常用的参数,可以用于设置配置文件的权限,如下:

owner参数: 指定最终生成的文件拷贝到远程主机后的属主。

group参数: 指定最终生成的文件拷贝到远程主机后的属组。

mode参数: 指定最终生成的文件拷贝到远程主机后的权限,如果你想将权限设置为"rw-r--r--",则可以使用mode=0644表示,如果你想要在user对应的权限位上添加执行权限,则可以使用mode=u+x表示。

 

除了上述参数,还有如下参数也很常用

force参数: 当远程主机的目标路径中已经存在同名文件,并且与最终生成的文件内容不同时,是否强制覆盖,可选值有yes和no,默认值为yes,表示覆盖,如果设置为no,则不会执行覆盖拷贝操作,远程主机中的文件保持不变。

backup参数: 当远程主机的目标路径中已经存在同名文件,并且与最终生成的文件内容不同时,是否对远程主机的文件进行备份,可选值有yes和no,当设置为yes时,会先备份远程主机中的文件,然后再将最终生成的文件拷贝到远程主机。

 

上述参数的具体示例就不再多写了,有了前文中总结的模块作为基础,搞定上述参数自然不在话下。

 

前文中我们提到过,ansible使用的是jinja2模板引擎,你肯定早就想到了,当templdate模块对模板文件进行渲染时,使用的就是jinja2模板引擎,所以,如果想要更加灵活的编辑模板文件,最好还要了解一些与jinja2有关的基本知识点,其实,我们一直都在使用jinja2的语法,当我们在playbook中引用变量时,会将变量用双括号"{{  }}"括起,这就是jinja2的语法,在jinja2中,使用"{{  }}"装载变量,除了"{{  }}",还有一些其他的jinja2基本语法,我们一起来了解一下,如下:

{{      }}  :用来装载表达式,比如变量、运算表达式、比较表达式等。

{%   %}   :用来装载控制语句,比如 if 控制结构,for循环控制结构。

{#    #}   :用来装载注释,模板文件被渲染后,注释不会包含在最终生成的文件中。

 

单单靠嘴描述,不够清晰,不如我们一起来动手熟悉一下上述基础语法吧,在ansible主机中准备一个测试文件,我的测试文件名为test.j2

仍然从我们最熟悉的变量操作开始测试,test.j2中写入如下内容:

 

然后在ansible主机中执行如下测试命令:

如上例所示,我们在渲染模板时传入了变量testvar1,其变量值为teststr,上述命令执行完成后,登录目标主机,即test70主机,查看渲染后的文件内容,如下:

上述示例中,"{{  }}"中包含的就是一个变量,当模板被渲染后,变量的值被替换到了最终的配置文件中,当然,既然在模板中定义了变量,那么就要保证在渲染模板时,可以调用到对应的变量,否则就会报错,"{{  }}"中除了能够包含变量,还能够包含哪些东西呢?如后文所示。

 

注:为了方便示例,之后的示例会直接给出模板文件内容与最终生成文件的内容,省略对应渲染模板的过程,渲染模板过程参考上述示例即可。

上文中提到过,除了变量,"{{  }}"中还可以包含一些表达式,那么我们一起来看看那些常用的表达式在"{{  }}"中的示例。

 

比较表达式的相关示例如下:

   

逻辑运算的相关示例如下:

   

算数运算的相关示例如下:

   

成员运算的相关示例如下:

 

在上述成员运算的示例中,in运算符后面对应的是一个"列表",所以你一定已经想到了,一些基础的数据类型,都可以包含在"{{  }}"中,jinja2本身就是基于python的模板引擎,所以,python的基础数据类型都可以包含在"{{  }}"中,这也是再自然不过的了,相关示例如下:

 

从上述示例模板文件可以看出,字符串、数值、列表、元组、字典、布尔值等数据类型均可在"{{  }}"使用,但是,通常我们不会像上述示例那样使用它们,因为通常我们会通过变量将对应的数据传入,而不是将数据直接写在"{{  }}"中,即使直接将数据写在"{{  }}"中,也会配合其他表达式或者函数进行处理,所以,我们可以把上述模板文件的内容改为如下内容进行测试:

 

此处我们使用如下playbook对上述模板文件进行测试,而不是使用ad-hoc命令,原因稍后解释,测试playbook如下:

 

运行上例playbook以后,最终生成的文件如下

刚才之所以用playbook进行测试,而不是使用ad-hoc命令,是因为在使用ad-hoc命令时,把列表、数字、字典等数据类型当做参数传入后,这些参数会被默认当做字符串进行处理,所以上例没有通过ad-hoc命令直接进行测试,而是通过playbook的方式渲染模板。

 

除了变量和各种常用的运算符,过滤器也可以直接在"{{  }}"中使用,与前文示例中的用法没有任何区别,示例如下:

 

当然,jinja2的tests自然也能够在"{{  }}"中使用,与前文中的用法也是一样的,如下:

 

说了"过滤器"和"tests",怎么能缺了"lookup",示例如下:

 

经过上述描述,你肯定已经发现了,前文中总结的很多知识点都能用上,而且经过上述描述,"{{  }}"的用法你肯定也已经掌握了,说完"{{  }}",顺势来聊聊"{#   #}",上文中提到过,在jinja2中,使用"{#   #}"包含注释信息,所以,如果我们需要在模板文件中对某些配置进行注释,则可以将注释信息写入到"{#   #}"中
,示例如下:

 

"{{  }}"和"{#   #}"的用法就先总结到这里,下一篇文章中,我们再来总结一下"{%  %}"的用法,希望这篇文章能够对你有所帮助~~

   

weinxin
我的微信公众号
关注"实用运维笔记"微信公众号,当博客中有新文章时,可第一时间得知哦~
朱双印

发表评论取消回复

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

目前评论:10   其中:访客  7   博主  3

    • avatar wangwei@ 1

      博主你好,看了您的模版写得非常好,但还是有一个实际需求需要请教一下,望解惑,谢谢。
      我如果修改每个服务器上的配置文件(每个配置的参数都不相同,有时候需要还得增减一些配置),我该怎么做?
      主要考虑有两点:配置文件项比较多,而且需要修改的项不连续的情况(传统方法是放在一个模版文件里会变得很长,不连续的修改项需要多写一个判断语句)。
      能否使用两个模版文件,一个是copy的配置文件任务模版,需要修改的地方设置为变量,另一个是加了if判断的模版。(我尝试过不行)
      下面是具体的:
      1、playbook.yaml
      – hosts: abc #web组三台服务器,hosts文件配置
      remote_user: root #远端服务器以root权限执行
      vars:
      Listen: [‘30032′,’31308’]
      ListenPprof: [‘30101′,’30111’]
      data_port: [‘3306′,’3259’]
      DBName: [‘xy’,’xy2′]
      server1: controller2
      server2: k8s-master3
      tasks:
      – name: “copy_file2” #任务2,将本地的redis.conf文件复制到远端服务器
      template: dest=/data/MiniGame/buss_config.json src=/root/template/buss_config.json.j2
      tags: copy2
      – name: “copy_file3” #任务2,将本地的redis.conf文件复制到远端服务器
      template: dest=/data/MiniGame/buss_config.json src=/root/template/buss_config.json_if.j2
      tags: copy3

      2、配置文件模版/root/template/buss_config.json.j2
      1,1 All
      {
      “Listen”: “0.0.0.0:{{ Listen }}”,
      “ListenPprof”: “0.0.0.0:{{ ListenPprof }}”,
      “CertFile”: “cert.pem”,
      “KeyFile”: “key.key”,
      “RedisServer”:{
      “Addr”: “127.0.0.1:399”
      },
      “DBServer”: {
      “Addr”: “{{ Addr }}:{{ data_port }}”,
      “DBName”: “{{ DBName }}”,
      “Account”: “Ga”,
      “Password”: “{{ Password }}”
      },

      3、if判断模版文件:/root/template/buss_config.json_if.j2

      {% if ansible_hostname == server1 %}
      Listen[0]
      ListenPprof[0]
      DBName[0]
      {% elif ansible_hostname == server2 %}
      Listen[1]
      ListenPprof[1]
      DBName[1]
      {% endif %}

      这样的结果是只有一个模版会生效。

        • avatar 朱双印 Admin

          @wangwei@ 你如果不想写在一个文件里,可以尝试模板的include试试,至少不会显得一个文件那么长,不知道能不能满足你的要求,这是模板的第一篇,不知道模板的后几篇你看了没,说不定有你需要的

            • avatar wangwei@ 1

              @朱双印 后面的我也看了,include那个只是优化而已。我的思路是判断模版与配置文件模版能不能不写到一起。比如,我有一个配置文件是100行,其中2,6,8,9,53,63,75行等需要修改,如果里面加了if判断语句,这个模版文件变成了150行(大部分是if判断语句)。所以考虑把它分开,配置文件的格式也不需要怎么修改,也不会增加很多行。

              • avatar wangwei@ 1

                @朱双印 后面的也看了,include只是优化而已。我的思路是将传统的配置文件模版与条件判断分开。按传统的写法,假如我一个配置文件有100行,其中20行需要修改,而且修改的地方不连续,每修改一个部分就需要多加一个判断,这样的最终的配置文件将变成180行。而分开就不需要对应用的配置文件做大的改动,毕竟每个配置文件都不同的格式。
                我这样说,不知道你是否明白

                  • avatar 朱双印 Admin

                    @wangwei@ 明白,就是跟我一样,有点强迫症,其实你应该这样想,使用模板的初衷就是用一个文件尽量通用的适用大多数情况,如果你分开,反而与这个初衷相悖,不要在乎有多少行,写进去就好了

                      • avatar wangwei@ 1

                        @朱双印 这个适合大部分情况啊,只不过是判断与配置文件分开了,这样更加灵活,配置文件格式不用调整。这个没办法实现是么

                    • avatar 一个不愿露面的网友 0

                      @朱双印 写的非常棒

                  • avatar mua 0

                    可以分享朋友圈么☺ ☺

                      • avatar 朱双印 Admin

                        @mua 可以啊,超欢迎的~

                          • avatar 创业板 0

                            @朱双印 你好,问一下原理,基于这个场景:在playbook文件用template模块定义模板文件和目标文件,然后执行剧本,jinja2模板引擎如何与template模块协作完成工作的呢?能描述以下流程吗