Linux自动化运维（Shell与Ansible）（微课版） 课件 项目10 Jinja2 模板与插件

Linux自动化运维项目10：Jinja2模板与插件

学习目标【知识目标】了解Jinja2模板的基本概念和语法。了解过滤器的类型和常见过滤器的基本概念。了解lookup插件的基本用法和常见的插件类型。【技能目标】掌握Jinja2模板语法规则，能够使用Jinja2模板对Ansible任务进行动态配置。掌握Ansible过滤器语法规则，能够使用过滤器对数据进行处理和转换。掌握lookup插件语法规则，能够使用lookup插件实现动态获取数据。【素质目标】培养读者职业道德素养，使其明确在自动化运维中的职业责任与义务，引导读者树立正确的职业态度。培养读者严谨的逻辑思维能力，使其在解决问题时使用逻辑思维，提高自主学习能力。Jinja2模板与插件任务1：Jinja2模板基本概念目录/Contents01020304Jinja2模板基本语法变量条件控制结构循环控制结构05部署Jinja2模板01Jinja2模板基本语法Jinja2模板基本语法Jinja2使用特定的分隔符来标记模板中的不同部分。分隔符用于将不同类型的模板部分标记出来，并告诉模板引擎在渲染数据时如何处理。Jinja2主要的分隔符如表所示。序号分隔符类型描述1{%...%}Statements（语句）用于控制流程以及执行操作2{{...}}Expressions（表达式）用于在模板中输出变量或表达式的值3{#...#}Comments（注释）用于在模板中添加注释或文档Jinja2模板基本语法Jinja可以生成基于文本的格式，其中包含变量、表达式和控制结构等，Jinja2模板可以用于创建动态配置文件、脚本文件等。以下是典型的Jinja2模板示例。---{%forcolourincolours%}Colournumber{{loop.index}}is{{}}.{%setcolour_count=0%}{%forpersoninpeopleifperson.fav_colour==%}{%setcolour_count=colour_count+1%}{%endfor%}Currently{{colour_count}}peoplecall{{}}theirfavourite.Andthefollowingareexamplesofthingsthatare{{}}:{%foritemincolour.things%}-{{item}}{%endfor%}{%endfor%}02变量变量在Jinja2模板中，变量通过双花括号“{{}}”标识的表达式来表示，这些表达式会在渲染模板时被替换为具体的值。比如Jinja2模板中有一个名为username的变量，可以通过以下方式在模板中显示该变量的值。{{username}}在上述示例中，会在渲染模板时将{{username}}替换为变量username的值。除了简单的变量名之外，变量表达式还可以使用点号“.”或方括号“[]”方式来访问变量的属性或元素。{{}}{{user.email}}{{user.address}}调用变量在上面的示例中，使用点号来访问user字典变量中的具体值。

将返回name键对应的值，user.email将返回email键对应的值，以此类推。{{user[‘name’]}}{{user[‘email’]}}{{user[‘address’]}}Thefirstiteminthelistis{{username[0]}}.比如在使用Jinja2模板时，username变量是一个包含用户名称的列表，可以通过索引访问列表中的元素。在使用Jinja2模板时，user变量是一个包含用户信息的字典，它包含用户的姓名、电子邮箱和地址等，可以通过以下方式引用这些值。如果字典中的键包含特殊字符，比如空格、连字符、下画线等，推荐使用方括号来引用变量中的属性或元素。03条件控制结构条件控制结构在Jinja2模板引擎中，if语句用于根据不同的条件执行不同的代码分支。if条件语句的基本语法如下。{%ifcondition%}...codeblockifconditionistrue...{%elifanother_condition%}...codeblockifanother_conditionistrue...{%else%}...codeblockifallconditionsarefalse...{%endif%}在上述示例中，condition和another_condition是不同的条件表达式，可以由比较运算符（例如==、<、>、<=、>=等）和逻辑运算符（例如and、or、not等）组合而成。在代码块中编写要执行的代码，当条件表达式为真时执行相应的代码块。04循环控制结构循环控制结构在Jinja2模板引擎中，for循环语句用于迭代遍历一个序列，比如列表、字典、生成器等，并在每次迭代中执行一个代码块。for循环语句的基本语法如下。{%forvariableinsequence%}...codeblock...{%endfor%}在上述示例中，variable表示在每次迭代中被赋予当前值的变量，sequence表示被遍历的序列对象。在代码块中可以使用variable来引用当前迭代的值。清单文件中已定义myhosts变量，此变量将包含要管理的主机的列表。使用下列for循环语句，将列出清单文件中myhosts组内的所有主机。{%formyhostingroups['myhosts']%}{{myhost}}{%endfor%}循环控制结构{%forkey,valueinmy_dict.items()%}Key:{{key}},Value:{{value}}{%endfor%}在上面的示例中，my_dict是一个字典对象，items方法返回一个可迭代的键值对列表。在for循环语句中使用key和value来同时迭代字典中的键和值，然后在代码块中使用{{key}}和{{value}}输出键和值的值。在Ansible中，使用Jinja2模板生成ApacheHTTP服务器的虚拟主机配置文件，配置文件中包含多个虚拟主机，每个虚拟主机的配置信息可以通过字典对象进行存储和遍历。05部署Jinja2模板部署Jinja2模板tasks:-name:templaterendertemplate:src:/tmp/j2-template.j2dest:/tmp/dest-config-file.txttemplate模块是Ansible的内置模块，其主要功能是将源文件中的Jinja2模板进行解析并渲染成最终的输出文件，然后将输出文件写入目标主机上指定的路径。在使用template模块时，需要创建一个包含Jinja2模板的模板文件，该文件将包含要生成的文本的结构和逻辑。template模块示例如下。在上述示例中，src和dest分别用来指定输入和输出文件的位置，与src键关联的值用于指定源Jinja2模板，而与dest键关联的值用于指定要在目标主机上创建的文件。部署Jinja2模板-name:GenerateNginxconfigurationfiletemplate:src:templates/nginx.conf.j2dest:/etc/nginx/nginx.confvars:ip_address:00hostname:www.opencloud.funport:80在上述示例中，使用了vars参数来传递3个变量给模板，即ip_address、hostname和port。当模板被渲染时，这些变量将被替换为它们表示的实际值，结果将写入目标文件。模板中使用的变量可以在Playbook的vars部分中指定，并使用vars参数传递变量给模板。谢谢Jinja2模板与插件任务2：过滤器简介目录/Contents0102过滤器基本概念

03数据类型转换过滤器04网络过滤器05Password_hash过滤器常见过滤器01过滤器基本概念过滤器基本概念过滤器是一种用于转换数据的机制，可在模板中使用。Ansible内置了大量的过滤器，可用于转换字符串、数字、列表、字典等数据。例如，使用过滤器可以对字符串进行大小写转换、去除空格，还可以对列表进行排序、去重、筛选等操作。在Jinja2模板中，过滤器是一种可以对变量进行修改或处理的机制。过滤器与变量用管道符（|）分隔，并且可以用圆括号传递可选参数，多个过滤器可以链式调用，即前一个过滤器的输出会作为后一个过滤器的输入。过滤器基本语法如下所示。在上述示例中，variable表示一个变量，可以是任何类型的，例如字符串、数字、字典、列表等。filter1、filter2、……、filterN表示一系列过滤器，它们会依次对variable变量的值进行处理，多个过滤器可以通过管道符号“|”串联起来，表示对变量进行一系列的转换和处理。每个过滤器的输出会作为下一个过滤器的输入，最终输出一个新的值。{{variable|filter1|filter2|...|filterN}}{{list|join(',')}}过滤器基本概念Jinja2内置了许多过滤器，包括字符串过滤器、数值过滤器、列表和字典过滤器等。常用的Jinja2内置过滤器如表所示。除了内置的过滤器，Ansible还可以使用Python编写自定义过滤器，以便更好地适应特定的场景和需求。Ansible过滤器可以在控制器上执行，以处理数据，并将结果传递回模板。这种机制可以大大提高模板的效率，并使模板可以更好地处理大量的数据。序号过滤器名称描述1abs取变量的绝对值2capitalize将字符串的首字母大写3default如果变量为None或者不存在，则使用默认值来替代4first返回列表或字符串的第一个元素5last返回列表或字符串的最后一个元素6int将变量转换为整数7join将列表元素用指定的分隔符连接成字符串8random从列表或字符串中随机选择一个元素9replace将字符串中的指定子字符串替换为另一个字符串10reverse翻转列表或字符串11sort对列表进行排序12string强制将变量转换为字符串13sum对列表中的元素求和14upper将字符串转换为大写字母15lower将字符串转换为小写字母16trim移除字符串两端的空格02常见过滤器mandatory过滤器mandatory过滤器用于检查变量是否已定义。如果变量未定义，mandatory过滤器将引发一个异常，以提醒用户必须定义这些变量。使用mandatory过滤器可以及时发现代码中可能存在的问题，从而提高代码的健壮性。mandatory过滤器基本示例如下。在上面的示例中，variable_name表示要检查的变量。如果该变量未定义，则mandatory过滤器将引发一个异常。{{variable_name|mandatory}}TASK[debugfiltermandatory]*****************************************************fatal:[localhost]:FAILED!=>{"msg":"Mandatoryvariable'variable_name'notdefined."}default过滤器default过滤器是一种用于提供默认值的Jinja2过滤器。如果在模板中使用了一个未定义的变量，且没有提供默认值，则Ansible将引发一个“未定义变量”错误并终止执行。使用default过滤器，可以为变量设置一个默认值，以避免这种情况的发生。default过滤器基本示例如下。{{some_variable|default(5)}}在上述示例中，如果变量some_variable未定义，将使用默认值5。如果想在变量的值为false或空字符串时使用默认值，可以传递一个可选的布尔值参数true给default过滤器。在上述示例中，如果variable_name的值为false或空字符串，则default过滤器将返回default_value；如果MY_USER环境变量未定义或为空字符串，则default过滤器将返回默认值admin。{{variable_name|default('default_value',true)}}{{lookup('env','MY_USER')|default('admin',true)}}default过滤器在Ansible中，omit是一个特殊变量。在default过滤器中使用omit，可以将变量设置为可选的，如果变量未定义，则不为其提供默认值。这样可以在某些情况下更加灵活地使用Ansible，例如只为特定任务指定变量，而不是强制要求所有变量在模板中都必须有值。在上述示例中，item.mode变量已经被设置为可选的，在第1个和第2个迭代中该变量未定义，因此debug模块不会使用mode参数。在第3个迭代中，item.mode被设置为0444，debug模块将使用mode参数。----name:defaultfilterhosts:localhosttasks:-name:debugfilterfaultdebug:msg:Thisis"{{item.path}}",This"{{item.mode|default(omit)}}"loop:-path:/tmp/foo-path:/tmp/bar-path:/tmp/bazmode:"0444"dict2items过滤器dict2items过滤器可以将一个字典转换为一个列表，以便进行循环迭代或其他操作。例如，给定以下字典数据：tags:Application:paymentEnvironment:dev使用dict2items过滤器将其转换为以下列表数据：-key:Applicationvalue:payment-key:Environmentvalue:devdict2items过滤器在转换后的列表中，每个字典项都被表示为一个包含key和value两个键的字典。可以使用这个列表进行循环迭代。----name:defaultfilterhosts:localhostvars:

tags:Application:paymentEnvironment:devtasks:

-name:Printkey-valuepairsdebug:msg:"Key:{{item.key}},Value:{{item.value}}"loop:"{{tags|dict2items}}"YAML和JSON数据格式化过滤器Ansible提供了一组用于处理数据结构的过滤器，其中包括to_json、to_yaml、to_nice_json、to_nice_yaml、from_json和from_yaml等。这些过滤器可以将数据结构从一种格式转换为另一种格式，并且可以进行格式化、缩进等各种操作，基本示例如下。{{some_variable|to_json}}{{some_variable|to_yaml}}{{some_variable|to_nice_json}}{{some_variable|to_nice_yaml}}{{some_variable|to_nice_json(indent=2)}}{{some_variable|to_nice_yaml(indent=8)}}03数据类型转换过滤器数据类型转换过滤器在Ansible中，变量的类型可能是字符串、数字、布尔值等，但在某些情况下需要将其转换为特定的类型。bool过滤器可以将变量强制转换为布尔值类型。例如，可以使用bool过滤器将一个字符串变量转换为布尔值类型，如下：-debug:msg:testwhen:some_string_value|bool在上面的示例中，如果some_string_value的值为字符串true，则bool过滤器会将其转换为布尔值true。数据类型转换过滤器在上面的示例中，如果ansible_facts['lsb']['major_release']的值为字符串9，则int过滤器会将其转换为整数9。string过滤器用于将输入的变量强制转换为字符串类型，如果传递给string过滤器的输入是一个整数、浮点数、布尔值或其他类型的变量，那么string过滤器会将其转换为字符串类型。-name:Convertintegertostringdebug:msg:"{{my_var|string}}"vars:my_var:123在上面的示例中，my_var变量的值为整数123。使用string过滤器将其转换为字符串类型后，输出的结果将是字符串123。-shell:echo"onlyonRedHat6,derivatives,andlater"when:ansible_facts['os_family']=="RedHat"andansible_facts['lsb']['major_release']|int>=9int过滤器可以将变量强制转换为整数类型。例如，可以使用int过滤器将一个字符串变量转换为整数类型，如下：04网络过滤器网络过滤器Ansible提供了一组用于网络相关操作的过滤器，这些过滤器可用于验证IP地址的格式、获取IP地址的信息等操作。在系统中需要使用pip3installnetaddr命令安装网络插件模块。common.ipaddr过滤器可以从IP地址中提取特定的信息。例如，要从CIDR（ClasslessInter-DomainRouting，无类别域间路由选择）中获取IP地址本身，具体示例如下。----name:networkfilterhosts:localhosttasks:-name:Printipaddresssdebug:msg:Thisipaddress{{'/24'|common.ipaddr('address')}}网络过滤器common.vlan_parser是Ansible提供的用于解析VLAN（VirtualLocalAreaNetwork，虚拟局域网）ID列表的过滤器。它的作用是将一个VLANID列表转换为一个包含一个字符串元素的列表.在示例中，首先使用common.vlan_parser过滤器将vlans列表转换为parsed_vlans列表，然后，通过parsed_vlans[0]获取VLAN列表的范围，并将其配置为交换机端口的允许VLAN列表；最后，使用一个循环将parsed_vlans列表中的其他VLAN列表范围添加到交换机端口的允许VLAN列表中。----name:defaultfilterhosts:localhostvars:vlans:-3003-3004-3005-100-1688-3002-3999tasks:-name:printipvlanmessagedebug:msg:>{%setparsed_vlans=vlans|common.vlan_parser%}switchporttrunkallowedvlan{{parsed_vlans[0]}}{%foriinrange(1,parsed_vlans|count)%}switchporttrunkallowedvlanadd{{parsed_vlans[i]}}{%endfor%}05password_hash过滤器password_hash过滤器password_hash过滤器是Ansible提供的用于生成密码哈希值的过滤器。它通常用于创建安全的密码文件，以便在配置系统时对密码进行加密。该过滤器有两个参数：哈希算法和盐值。哈希算法用于指定要使用的哈希函数，而盐值是一个可选的字符串，用于增加哈希值的强度。如果盐值未指定，则password_hash过滤器会使用随机生成的盐值。使用password_hash过滤器在Playbook中生成SHA512哈希密码的示例如下。-name:Createsecurepasswordfilehosts:localhostvars:my_password:"mysecretpassword"tasks:-name:Generatehashedpasswordset_fact:hashed_password:"{{my_password|password_hash('sha512','mysalt')}}"-name:Createpasswordfilecopy:content:"{{hashed_password}}"dest:/tmp/my_password_filemode:'0600'sudocat/tmp/my_password_file$6$mysalt$rBg6KE6n/pBt1eIXT/jrGWnpVqVAZOffl2TBMv3n8WZmYg5edyC0FbOyOFE3Px3WtnsqDgNgv/7Hmy3pBx在上述示例中，首先定义了一个名为my_password的变量来存储明文密码；其次使用password_hash过滤器将明文密码转换为SHA512哈希值，并将其存储在hashed_password变量中，同时指定了一个自定义的盐值mysalt，用于增加哈希值的强度；最后将生成的哈希密码写入/tmp/my_password_file文件，并设置文件权限为0600，以确保只有具有足够权限的用户才能读取此文件。谢谢Jinja2模板与插件任务3：插件目录/Contents010203插件简介查看插件帮助信息lookup插件01插件简介插件简介在Ansible中，插件是一种可扩展的机制，用于在Ansible执行过程中添加新的功能和行为。插件可以用来实现各种功能，例如操作系统管理、网络管理、云管理等。用户可以基于Ansible插件体系结构轻松地添加或删除插件，以满足不同的需求。Ansible内置了多种类型的插件，主要包括action插件、callback插件、filter插件、lookup插件、inventory插件、module插件、strategy插件等等。常见的插件类型如表所示。序号插件类型描述1action插件用于执行任务，例如复制文件、安装软件包、启动服务等。该插件通常是对Ansible模块的封装，可以通过调用模块来实现任务的执行2callback插件用于向用户提供反馈信息，例如任务的进度、执行结果等。该插件可以将输出格式化为不同的格式，并将其发送到不同的位置，例如终端、日志文件等3filter插件用于在模板中操作和转换数据，例如将JSON数据转换为YAML数据、提取URL的主机名、计算SHA1哈希等。该插件可以使用内置的Ansible过滤器，也可以使用标准的Jinja2过滤器4lookup插件用于在Playbook中查找数据，例如查找环境变量、获取远程主机的IP地址等。该插件可以将数据从不同的来源中提取出来，并将其传递给Playbook执行5inventory插件用于管理主机清单，例如使用INI文件、YAML文件、动态主机清单文件等。可以根据不同的需求选择不同的inventory插件6module插件用于定义Ansible模块，例如管理文件、用户、软件包等的模块。可以使用Python编写自定义的模块，并将其作为module插件添加到Ansible中。模块是插件的一个特殊实现，用于执行任务。虽然通常不使用“模块插件”这个术语，但模块是插件的一种特殊类型7strategy插件用于控制任务的执行策略，例如并发执行、串行执行、批量执行等。可以根据不同的场景选择不同的strategy插件。该插件通过处理任务和主机的调度来影响整个Playbook的执行流程02查看插件帮助信息查看插件帮助信息Ansible支持多种类型的插件，比如callback插件、connection插件、inventory插件、lookup插件、netconf插件、vars插件、filter插件等。在查看插件帮助信息之前，需要确定要查看的插件类型。使用以下命令可以查看当前Ansible版本中可用的所有插件列表。ansible-doc-t<plugin-type>-l使用以下命令可以查看可用的callback插件列表，-tcallback表示要查看的插件类型为callback插件，-l选项表示要列出所有可用的插件的名称。<plugin-type>表示要查看的插件类型，例如module、callback、inventory、vars、filter、connection、authentication、lookup等。ansible-doc-tcallback-l确定要查看的callback插件的名称后，可以使用以下命令查看其帮助信息。ansible-doc-tcallback<plugin-name>查看插件帮助信息其中，<pluginname>表示要查看的插件的名称。该命令将显示有关该插件的详细信息，包括用法示例、选项、参数和其他相关信息，以帮助用户理解如何使用该插件。使用以下命令查看jsoncallback插件的帮助信息。ansible-doc-tcallbackjson确定要查看的lookup插件的名称后，可以使用以下命令查看其帮助信息。使用以下命令可以查看可用的lookup插件列表，-tlookup表示要查看的插件类型为lookup插件，-l选项表示要列出所有可用的插件的名称。ansible-doc-tlookup-l其中，<pluginname>表示要查看的插件的名称。该命令将显示有关该插件的详细信息，包括用法示例、选项、参数和其他相关信息，以帮助用户理解如何使用该插件。ansible-doc-tlookup<plugin-name>使用以下命令查看filelookup插件的帮助信息。ansible-doc-tlookupfile03lookup插件lookup插件Ansible的lookup插件是一种扩展了Jinja2模板语言的插件，它可以使Ansible从外部来源（如文件、命令输出、API等）中获取数据。通过lookup插件，Ansible可以在运行时动态获取数据，从而实现更灵活的配置和自动化。lookup插件的基本语法与过滤器的非常相似。在调用lookup插件时，需要指定函数的名称、需要调用的lookup插件的名称以及插件需要的参数。lookup插件的基本语法如下。{{lookup('<plugin-name>','<parameter>')}}其中，<plugin-name>表示要使用的lookup插件的名称，而<parameter>则表示传递给插件的参数。某些lookup插件不需要参数，例如env插件可以用于获取环境变量，它不需要任何参数。lookup插件在Playbook中使用file插件从文件path/to/file.txt中读取数据，并将其分配给file_contents变量，然后使用debug模块输出变量的值，以验证数据已成功获取。catpath/to/file.txtThisislookuppluginfile----name:Exampleplaybookwithlookuppluginhosts:localhostbecome:truevars:file_contents:"{{lookup('file','path/to/file.txt')}}"tasks:-name:Displayfilecontentsdebug:var:file_contents在Playbook中使用file插件从本地文件中读取数据，并将其复制到远程主机上的/remote/path/to/file.txt文件中。-name:Copyfilecontentstoremotehostcopy:content:"{{lo