运维配置管理后端【免费下载链接】saltSoftware to automate the management and configuration of infrastructure and applications at scale.项目地址https://gitcode.com/gh_mirrors/sa/salt点击查看免费下载导读本文围绕 Salt 官方 API 参考文档中的salt.renderers.mako模块展开系统讲解如何在 State、Pillar 等 SLS 文件中启用 Mako 模板引擎、可用的上下文变量salt、grains、pillar、opts等、如何与其他渲染器组成渲染管线如#!mako|yaml并从源码层面剖析渲染器入口、模板查找SaltMakoTemplateLookup与错误处理机制。读完本文你将能在 Salt 项目中熟练使用 Mako 渲染器并理解其底层实现原理。一、Mako 渲染器是什么Mako 是一个基于 Python 的高性能模板引擎Salt 将其作为可选渲染器接入渲染体系。官方参考页 salt.renderers.mako 是对 salt/renderers/mako.py 模块的 automodule 自动生成文档而该模块本身就是一个标准的 Salt 渲染器它接收一个模板文件路径把 Salt 提供的上下文变量注入 Mako 模板并完成渲染。渲染器的入口函数定义在 salt/renderers/mako.pydef render(template_file, saltenvbase, sls, contextNone, tmplpathNone, **kws): Render the template_file, passing the functions and grains into the Mako rendering system. :rtype: string tmp_data salt.utils.templates.MAKO( template_file, to_strTrue, salt__salt__, grains__grains__, opts__opts__, pillar__pillar__, saltenvsaltenv, slssls, contextcontext, tmplpathtmplpath, **kws, ) if not tmp_data.get(result, False): raise SaltRenderError( tmp_data.get(data, Unknown render error in mako renderer) ) return io.StringIO(tmp_data[data])要点前置依赖该渲染器要求环境中已安装 Mako 库。官方文档给出的安装方式是salt-pip install mako返回类型render返回io.StringIO对象而不是普通字符串方便上层渲染管线继续以文件对象方式读取。错误处理当底层渲染结果result为False时抛出SaltRenderError异常信息取data字段未知错误则使用默认文案。二、如何在 SLS 文件中启用 MakoSalt 渲染器的选择由 SLS 文件第一行的 shebang 风格注释shebang line决定。在文件首行写上#!mako即可让该文件先经过 Mako 渲染。若模板渲染结果还需要进一步解析为 YAML 数据结构则使用渲染管线#!mako|yaml这是最常见的组合——先用 Mako 生成文本再把文本交给 YAML 渲染器解析成 State/Pillar 数据结构。2.1 渲染管线Render Pipeline原理渲染管线由|连接多个渲染器从左到右依次求值前一个渲染器的输出成为后一个渲染器的输入。官方文档 doc/ref/renderers/index.rst 中给出了与 Mako 相关的典型组合mako|yaml先经 Mako 渲染输出交给 YAML 渲染器jinja|mako|yaml同一文件同时使用 Jinja 与 Mako 语法最终解析为 YAML。该文档还提供了一个混合示例#!jinja|mako|yaml An_Example: cmd.run: - name: | echo Using Salt ${grains[saltversion]} \ from path {{grains[saltpath]}}. - cwd: / %doc ${...} is Makos notation, and so is this comment. /%doc {# Similarly, {{...}} is Jinjas notation, and so is this comment. #}其中${...}是 Mako 的取值语法{{...}}是 Jinja 的取值语法二者可以共存于同一管线中。重要约束并非所有渲染器都能随意串联。文本类渲染器如mako、jinja输出的是字符串管线必须以数据渲染器如yaml结尾反过来把数据渲染器放在文本渲染器之前如yaml|jinja通常没有意义因为数据渲染器输出的是 Python 数据结构而文本渲染器只接受文本输入。详见 doc/ref/renderers/index.rst。2.2 设置全局默认渲染器Salt 主配置master/minion 均可设置中的renderer选项控制默认渲染管线默认值为jinja|yaml见 salt/config/init.py。如需全局改用 Makorenderer: mako|yaml当 SLS 文件没有 shebang 行时就会使用该默认管线。三、Mako 模板中可用的上下文变量Mako 渲染器把 Salt 的核心运行时对象注入模板上下文。从 salt/renderers/mako.py 可以看到传入的变量包括变量名含义典型用法salt当前可用的执行模块函数集合__salt__${saltcmd.run}grainsminion 的 grains 信息__grains__${grains[os]}optsminion/master 的配置选项__opts__${opts[cachedir]}pillarminion 的 pillar 数据__pillar__${pillar[nginx][port]}saltenv当前使用的 Salt 环境默认base${saltenv}sls当前渲染的 SLS 名称${sls}context调用方传入的附加上下文—tmplpath模板文件路径—在wrap_tmpl_func封装层salt/utils/templates.py中还有一层额外的处理若上下文中存在sls会调用generate_sls_context生成tplpath、tplfile、tpldir、slspath、slsdotpath、slscolonpath、sls_path等派生变量这些变量同样可以在 Mako 模板中使用例如${tpldir}表示当前 SLS 所在目录。此外需要注意wrap_tmpl_func会把cmd.run别名为cmd.shell使模板中的cmd.run默认以python_shellTrue方式执行这是模板场景下的安全相关设计。3.1 一个完整的 State 示例结合 Mako 与 YAML 编写 State#!mako|yaml %for pkg in [vim, htop, curl]: install_${pkg}: pkg.installed: - name: ${pkg} %endfor ${grains[id]}_timezone: timezone.system: - name: ${pillar.get(timezone, UTC)}%for ... %endfor是 Mako 的循环控制流语法${...}用于插值渲染后得到多个 State 声明。3.2 官方测试用例佐证仓库的功能测试 tests/pytests/functional/modules/state/test_mako_renderer.py 验证了 Mako 渲染器在state.sls中的实际行为sls_contents #!mako|yaml %for a in [1,2,3]: echo ${a}: cmd.run %endfor with pytest.helpers.temp_file(issue-55124.sls, sls_contents, state_tree): ret state.sls(issue-55124) for state_return in ret: assert state_return.result is True assert echo in state_return.id该测试断言渲染后生成的每个 State ID 都包含echo且执行结果成功。这从侧面印证了 Mako 渲染器在真实 State 执行链路中的可用性。四、底层实现渲染函数与模板查找Mako 渲染器的核心渲染逻辑并不在salt/renderers/mako.py中而是复用模板工具层的render_mako_tmpl见 salt/utils/templates.pydef render_mako_tmpl(tmplstr, context, tmplpathNone): import mako.exceptions from mako.template import Template from salt.utils.mako import SaltMakoTemplateLookup saltenv context[saltenv] lookup None if not saltenv: if tmplpath: # i.e., the template is from a file outside the state tree from mako.lookup import TemplateLookup lookup TemplateLookup(directories[os.path.dirname(tmplpath)]) else: lookup SaltMakoTemplateLookup( context[opts], saltenv, pillar_rendcontext.get(_pillar_rend, False) ) try: return Template( tmplstr, strict_undefinedTrue, uricontext[sls].replace(., /) if sls in context else None, lookuplookup, ).render(**context) except Exception: raise SaltRenderError(mako.exceptions.text_error_template().render()) finally: if lookup and isinstance(lookup, SaltMakoTemplateLookup): lookup.destroy()几个关键实现细节严格未定义检查strict_undefinedTrue意味着模板中引用了未定义的变量会直接报错而不是静默输出空值有助于尽早发现拼写错误。双模式模板查找无saltenv模板来自 State 树之外的文件时使用 Mako 自带的TemplateLookup以模板所在目录为搜索根有saltenv时使用 Salt 自定义的SaltMakoTemplateLookup支持salt://与file://协议拉取模板。异常包装任何异常都被包装成SaltRenderError并使用mako.exceptions.text_error_template()生成带源码上下文的可读错误信息。该函数被wrap_tmpl_func包装后注册进模板注册表TEMPLATE_REGISTRYsalt/utils/templates.pymako键对应MAKO这就是render入口中salt.utils.templates.MAKO(...)的真正指向。4.1 SaltMakoTemplateLookup支持 salt:// 与 file:// 的模板查找器salt/utils/mako.py 中定义了SaltMakoTemplateLookup它继承 Mako 的TemplateCollection专门处理%include/与%namespace/中的模板引用file://前缀直接从本地文件系统加载模板例如%include filefile:///etc/salt/lib/templates/sls-parts.mako/ %namespace filefile:///etc/salt/lib/templates/utils.mako importhelper/salt://前缀或裸相对/绝对路径通过 Salt 的 file client 从 master 拉取模板文件并缓存到本地。相对路径以当前 SLS 所在目录为基准绝对路径如/lib/templates/...按salt://处理。例如%include filetemplates/sls-parts.mako/ %include filesalt://lib/templates/sls-parts.mako/ %include file/lib/templates/sls-parts.mako/不支持的 URL scheme如http://会抛出ValueError。查找逻辑区分file_client为local使用file_roots与远程使用cachedir/files/saltenv缓存目录两种模式salt/utils/mako.py。destroy()方法负责销毁内部的 file client避免资源泄漏。利用该能力可以把可复用的 Mako 片段放在 State 树中统一管理再通过%include/引入实现模板层面的组件化复用。五、与其他渲染器的协同Salt 内置了 Jinja、Mako、Wempy、Genshi、Cheetah、Python 等多种渲染器注册表见 salt/utils/templates.py。Mako 与 Jinja 功能重叠但语法不同Jinja{{ var }}、{% for %}、{# 注释 #}Mako${var}、% for、%doc 注释 /%doc。官方参考文档中Mako 的独立参考页位于 doc/ref/renderers/all/salt.renderers.mako.rst渲染器总索引见 doc/ref/renderers/all/index.rst。值得注意的还有stateconf渲染器对 Mako 的特殊处理在 doc/ref/renderers/all/salt.renderers.stateconf.rst 中明确说明stateconf是数据渲染器不能写成#!mako|yaml|stateconf这样的管线而应使用渲染器参数语法#!stateconf mako . yaml。此外Salt 还提供了基于版本的依赖声明在 salt/version.py 中Mako被列入依赖信息(Mako, mako, __version__)相关约束文件可参考 requirements/base.txt 与 requirements/constraints.txt。六、常见问题与排查提示缺少 Mako 库渲染时抛出ImportError说明未安装依赖执行salt-pip install mako后重试。模板变量未定义由于strict_undefinedTrue任何未定义变量都会导致渲染失败。请检查变量名是否与上下文salt、grains、pillar、opts等中的键一致。渲染错误信息不直观SaltRenderError内部使用mako.exceptions.text_error_template()生成带行列信息的错误文本建议先查看异常消息中的模板源码片段定位问题行。%include/拉不到文件确认 URL 前缀为salt://或file://相对路径将基于当前 SLS 目录解析远程模式下模板会被缓存在cachedir/files/saltenv下必要时清理缓存重试。管线顺序错误确保 Mako 等文本渲染器在前、YAML 等数据渲染器在管线末尾否则会出现输入类型不匹配的问题。小结Mako 渲染器是 Salt 渲染体系中功能完整的文本渲染器之一通过#!mako、#!mako|yaml即可在 SLS 中启用。其实现横跨三个关键模块渲染器入口 salt/renderers/mako.py、模板渲染函数render_mako_tmplsalt/utils/templates.py、以及支持salt:///file://的模板查找器 salt/utils/mako.py。理解这些源码细节能帮助你在实际项目中更高效地编写、调试与复用 Mako 模板。赞分享运维配置管理后端【免费下载链接】saltSoftware to automate the management and configuration of infrastructure and applications at scale.项目地址https://gitcode.com/gh_mirrors/sa/salt点击查看免费下载相关推荐Flask 模板引擎深入指南Jinja 集成、上下文变量、过滤器注册与流式渲染Flask 模板引擎深入指南Jinja 集成、上下文变量、过滤器注册与流式渲染 本篇以 Flask 官方文档 docs/templating.rst Te后端Web框架Hugo 菜单模板完全指南递归渲染、页面上下文、本地化与源码级原理剖析Hugo 菜单模板完全指南递归渲染、页面上下文、本地化与源码级原理剖析 Hugo 的菜单Menu是站点导航的基石但菜单本身只是一份数据由条目entr开发工具前端CLISalt 安全模板渲染实战深入理解 Jinja 沙箱环境与 jinja|yaml 渲染器的安全推荐Salt 安全模板渲染实战深入理解 Jinja 沙箱环境与 jinja|yaml 渲染器的安全推荐 导读 在 Salt 的自动化配置管理体系中SLS 状态文运维配置管理后端上一篇告别手速焦虑用Python自动化脚本轻松搞定B站会员购抢票终极指南下一篇解锁外语影视新体验PotPlayer字幕实时翻译插件全攻略创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
