hualinux 进阶 2-1.12：ansible 剧本Playbooks（九） 模板template

最新推荐文章于 2023-12-21 22:49:43 发布
原创 最新推荐文章于 2023-12-21 22:49:43 发布 · 527 阅读 · 1 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#hualinu ansible #ansible #ansible模板 #hualinux自动化 #ansibl剧本

本文介绍如何在Ansible中使用Jinja2模板引擎来动态生成配置文件，通过实例展示了如何修改nginx配置，包括域名、网站目录路径和日志名。

 目录

 一、说明

1.1 template模板格式

1.2 template模板语法

二、例子

2.1 编写模板

2.2 添加变量名

2.3 修改task相关内容

2.3.1 修改siteFiles.yml

2.3.2 修改配置文件conf.yml 

2.4 执行playbook看一下效果

附录一、修改后新的目录结构及配置文件

1.目录结构

2. 相关任务tasks

3 涉及的变量vars

4.涉及的handler

5. 涉及的配置模板templates

6. 涉及的文件

7. playbook配置文件

Ansible 是借由 Jinja2 来写作 template 系统，所以请使用 *.j2 格式 在模板中我们就可以使用前篇讲的Jinja2的东西了。

 一、说明

1.1 template模板格式

Ansible 是借由 Jinja2 来写作 template 系统，所以请使用 *.j2 格式

在模板中我们就可以使用上面讲的Jinja2的东西了。

在playbook用“template”来定义模板，具体用法可以使用文档说明帮助

ansible-doc template

1.2 template模板语法

一般格式为：

template：src=/Jinja2模板路径/xxx.j2 dest=/目录路径/名字 [options]

下面是一般选项说明

选项

必要

说明

backup

no

建立个包括timestamp在内的文件备份，以备不时之需.

dest

yes

远程节点上的绝对路径，用于放置template文件。

group

no

设置远程节点上的的template文件的所属用户组

mode

no

设置远程节点上的template文件权限。类似Linux中chmod的用法

owner

no

设置远程节点上的template文件所属用户

src

yes

本地Jinjia2模版的template文件位置。

Ansible 很容易的传输文件到远端系统上面，但是它经常需要替换一些变量在其它的文件里面。变量可以来自 清单文件，Host Vars， Group Vars,或者 Facts。Templates 使用 Jinja2 模板引擎同样可以包含逻辑控制像循环和 if 语句。

我们只需事先定义变数和模板 (Templates)，即可用它动态产生远端的 Shell Scripts、设定档 (Configure) 等。换句话说，我们可以用一份 template 来产生开发 (Development)、测试 (Test) 和正式环境 (Production) 等不同的环境设定。

 

二、例子

我在《ansible 剧本Playbooks（六）角色roles》文章中，以nginx为角色，配置了nginx自动化安装，但是模板部分并没有使用，这章在此基础上补上。

其实nginx配置修改的就是那几个地方，域名、网站目录路径、日志名，暂时就修改三处吧

为了看到效果我把hua主机组和vm821安装的nginx卸载，网站目录删除，再从0弄一下，我就直接基于《ansible 剧本Playbooks（六）角色roles》例子的nginx角色基础上进行修改即可

2.1 编写模板

把这前nginx角色的配置文件移到模板中，并修改后缀为.j2

cd /etc/ansible/
mv roles/nginx/files/default.conf roles/nginx/templates/default.conf.j2

对 roles/nginx/templates/default.conf.j2 模板文件进行修改如下：我只修改粉色部分

[root@vm82 ansible]# cat roles/nginx/templates/default.conf.j2
server {
    listen       80;
    server_name  {{ server_name }};

    #charset koi8-r;
    access_log  /var/log/nginx/{{ log_name }}.access.log  main;

    location / {
        root   {{ site_dir }};
        index  index.html index.htm;
    }

    #error_page  404              /404.html;

    # redirect server error pages to the static page /50x.html
    #
    error_page   500 502 503 504  /50x.html;
    location = /50x.html {
        root   /usr/share/nginx/html;
    }

    # proxy the PHP scripts to Apache listening on 127.0.0.1:80
    #
    #location ~ \.php$ {
    #    proxy_pass   http://127.0.0.1;
    #}

    # pass the PHP scripts to FastCGI server listening on 127.0.0.1:9000
    #
    #location ~ \.php$ {
    #    root           html;
    #    fastcgi_pass   127.0.0.1:9000;
    #    fastcgi_index  index.php;
    #    fastcgi_param  SCRIPT_FILENAME  /scripts$fastcgi_script_name;
    #    include        fastcgi_params;
    #}

    # deny access to .htaccess files, if Apache's document root
    # concurs with nginx's one
    #
    #location ~ /\.ht {
    #    deny  all;
    #}
}

2.2 添加变量名

#在角色中添加2个变量名 server_name  site_dir log_name
[root@vm82 ansible]# cat roles/nginx/vars/main.yml 
install_dir: /disk1/tools
# 网站配置名
nginx_conf_name: hualinux
# 域名
server_name: "hualinux.com www.hualinux.com"
# 日志名
log_name: hualinux.com
# 网站目录
site_dir: /disk1/www/hualinux.com

2.3 修改task相关内容

2.3.1 修改siteFiles.yml

因为我这里使用变量了，所以也要采用变量的方式

[root@vm82 ansible]# cat roles/nginx/tasks/siteFiles.yml 
# 创建目录并把权限修改为nginx,yum安装默认用户是nginx
- name: create site dir
  file: 
    path: "{{ site_dir }}"
    state: directory
    recurse: yes
    owner: nginx
    group: nginx
- copy: 
    src: /etc/ansible/roles/nginx/files/index.html
    dest: "{{ site_dir }}"

2.3.2 修改配置文件conf.yml 

之前是使用复制的方式，我这里不使用复制，使用模板了

[root@vm82 ansible]# cat roles/nginx/tasks/conf.yml 
# 使用模板，以域名为配置名
- name: nginx configure file
  template: 
    src: /etc/ansible/roles/nginx/templates/default.conf.j2
    dest: /etc/nginx/conf.d/{{ nginx_conf_name }}.conf 
  notify: restart nginx

2.4 执行playbook看一下效果

所有的都修改完成了，修改完之后的目录结构和配置文件内容，可以看附录一、修改后新的目录结构及配置文件，接下来执行一下playbooks就行了

[root@vm82 ansible]# ansible-playbook yaml-conf/nginx_roles.yml

PLAY [hua,h1] *******************************************************************************************************

TASK [Gathering Facts] **********************************************************************************************
ok: [192.168.3.76]
ok: [192.168.3.21]

TASK [nginx : create /disk1/tools] **********************************************************************************
ok: [192.168.3.76]
ok: [192.168.3.21]

TASK [nginx : copy] *************************************************************************************************
skipping: [192.168.3.21]
changed: [192.168.3.76]

TASK [nginx : copy] *************************************************************************************************
skipping: [192.168.3.76]
ok: [192.168.3.21]

TASK [yum install nginx on centos7] *********************************************************************************
skipping: [192.168.3.21]
changed: [192.168.3.76]

TASK [yum install nginx on centos8] *********************************************************************************
skipping: [192.168.3.76]
changed: [192.168.3.21]

TASK [nginx : create site dir] **************************************************************************************
changed: [192.168.3.76]
changed: [192.168.3.21]

TASK [nginx : copy] *************************************************************************************************
changed: [192.168.3.76]
changed: [192.168.3.21]

TASK [nginx configure file] *****************************************************************************************
changed: [192.168.3.76]
changed: [192.168.3.21]

TASK [restart nginx] ************************************************************************************************
changed: [192.168.3.76]
changed: [192.168.3.21]

RUNNING HANDLER [start nginx] ***************************************************************************************
changed: [192.168.3.76]
changed: [192.168.3.21]

PLAY RECAP **********************************************************************************************************
192.168.3.21               : ok=9    changed=6    unreachable=0    failed=0    skipped=2    rescued=0    ignored=0   
192.168.3.76               : ok=9    changed=7    unreachable=0    failed=0    skipped=2    rescued=0    ignored=0

我在本的的win上绑定打开hosts文件，目录位置 C:\Windows\System32\drivers\etc\hosts 做如下绑定

#文件路径 C:\Windows\System32\drivers\etc\hosts
#添加如下条目并保存生效
192.168.3.21 www.hualinux.com hualinux.com

打开浏览器，输入 www.hualinux.com看一下效果

 

附录一、修改后新的目录结构及配置文件

1.目录结构

[root@vm82 ansible]# pwd
/etc/ansible
[root@vm82 ansible]# tree roles/nginx
roles/nginx
├── default
├── files
│   ├── index.html
│   ├── nginx-1.18.0-1.el7.ngx.x86_64.rpm
│   └── nginx-1.18.0-1.el8.ngx.x86_64.rpm
├── handlers
│   └── main.yml
├── meta
├── tasks
│   ├── conf.yml
│   ├── install.yml
│   ├── main.yml
│   └── siteFiles.yml
├── templates
│   └── default.conf.j2
└── vars
    └── main.yml

2. 相关任务tasks

[root@vm82 ansible]# cat roles/nginx/tasks/main.yml 
# 复制文件文件,如果对应的目录不存在此ansible版本会自动创建
# 如果不自动创建的请手工创建一下/disk1/www/hualinux.com
#
# 1.复制对应的rpm并使用yum安装rpm
- include: install.yml
# 2.复制网站文件
- include: siteFiles.yml
# 3.复制配置文件并重启
- include: conf.yml

[root@vm82 ansible]# cat roles/nginx/tasks/install.yml 
# 创建放软件的目录
- name: create {{ install_dir }}
  file:
    path: "{{ install_dir }}"
    state: directory
    recurse: yes
    owner: root
    group: root

# when和模块是同级的，判断系统版本及主版本
# 判断是否来centos7
- copy:
    src: /etc/ansible/roles/nginx/files/nginx-1.18.0-1.el7.ngx.x86_64.rpm
    dest: "{{ install_dir }}"
  when: (ansible_distribution=="CentOS") and (ansible_distribution_major_version=="7")
# 判断是否为centos8
- copy:
    src: /etc/ansible/roles/nginx/files/nginx-1.18.0-1.el8.ngx.x86_64.rpm
    dest: "{{ install_dir }}"
  when: (ansible_distribution=="CentOS") and (ansible_distribution_major_version=="8")

# yum安装
- name: yum install nginx on centos7
  yum: 
    name: /disk1/tools/nginx-1.18.0-1.el7.ngx.x86_64.rpm
    state: present
  notify: start nginx  
  when: (ansible_distribution=="CentOS") and (ansible_distribution_major_version=="7")

- name: yum install nginx on centos8
  yum:
    name: /disk1/tools/nginx-1.18.0-1.el8.ngx.x86_64.rpm
    state: present
  notify: start nginx
  when: (ansible_distribution=="CentOS") and (ansible_distribution_major_version=="8")

[root@vm82 ansible]# cat roles/nginx/tasks/siteFiles.yml 
# 创建目录并把权限修改为nginx,yum安装默认用户是nginx
- name: create site dir
  file: 
    path: "{{ site_dir }}"
    state: directory
    recurse: yes
    owner: nginx
    group: nginx
- copy: 
    src: /etc/ansible/roles/nginx/files/index.html
    dest: "{{ site_dir }}"

[root@vm82 ansible]# cat roles/nginx/tasks/conf.yml 
# 使用模板，以域名为配置名
- name: nginx configure file
  template: 
    src: /etc/ansible/roles/nginx/templates/default.conf.j2
    dest: /etc/nginx/conf.d/{{ nginx_conf_name }}.conf
- name: restart nginx
  service: 
    name: nginx
    state: restarted

3 涉及的变量vars

[root@vm82 ansible]# cat roles/nginx/vars/main.yml 
install_dir: /disk1/tools
# 网站配置名
nginx_conf_name: hualinux
# 域名
server_name: "hualinux.com www.hualinux.com"
# 日志名
log_name: hualinux.com
# 网站目录
site_dir: /disk1/www/hualinux.com

4.涉及的handler

[root@vm82 ansible]# cat roles/nginx/handlers/main.yml 
# 暂时没有调用到这个重启服务
- name: restart nginx
  service: 
    name: nginx
    state: restarted

- name: start nginx
  service:
    name: nginx
    state: started
    enabled: yes

5. 涉及的配置模板templates

[root@vm82 ansible]# cat roles/nginx/templates/default.conf.j2 
server {
    listen       80;
    server_name  {{ server_name }};

    #charset koi8-r;
    access_log  /var/log/nginx/{{ log_name }}.access.log  main;

    location / {
        root   {{ site_dir }};
        index  index.html index.htm;
    }

    #error_page  404              /404.html;

    # redirect server error pages to the static page /50x.html
    #
    error_page   500 502 503 504  /50x.html;
    location = /50x.html {
        root   /usr/share/nginx/html;
    }

    # proxy the PHP scripts to Apache listening on 127.0.0.1:80
    #
    #location ~ \.php$ {
    #    proxy_pass   http://127.0.0.1;
    #}

    # pass the PHP scripts to FastCGI server listening on 127.0.0.1:9000
    #
    #location ~ \.php$ {
    #    root           html;
    #    fastcgi_pass   127.0.0.1:9000;
    #    fastcgi_index  index.php;
    #    fastcgi_param  SCRIPT_FILENAME  /scripts$fastcgi_script_name;
    #    include        fastcgi_params;
    #}

    # deny access to .htaccess files, if Apache's document root
    # concurs with nginx's one
    #
    #location ~ /\.ht {
    #    deny  all;
    #}
}

6. 涉及的文件

[root@vm82 ansible]# ll roles/nginx/files/
总用量 1584
-rw-r--r-- 1 root root     29 9月  11 21:20 index.html
-rw-r--r-- 1 root root 790284 4月  21 23:19 nginx-1.18.0-1.el7.ngx.x86_64.rpm
-rw-r--r-- 1 root root 825436 9月  11 21:12 nginx-1.18.0-1.el8.ngx.x86_64.rpm

#index文件里的内容
[root@vm82 ansible]# cat roles/nginx/files/index.html 
<h2>Welcome to hualinux</h2>

7. playbook配置文件

#playbooks配置文件内容
[root@vm82 ansible]# cat yaml-conf/nginx_roles.yml 
---
- hosts:
  - hua
  - h1
  roles:
  - nginx

#ansible hosts配置文件内容
[root@vm82 ansible]# egrep -v '^$|^#' hosts
[hua]
192.168.3.21  http_port=80
[h1]
192.168.3.76

Linux——ansible剧本
Xinan_____的博客
06-14 715
现在，可以写各种临时命令但如果，想把所有步骤，集合到一起，写到同一个文件里让ansible自动按顺序执行就必须要写“剧本”剧本里面，也可以写临时命令，但是剧本有规范的文本格式一个剧本里（playbook）1.可以写多个“剧集”，每一集是一个“play”2.每个play里指明，对哪些客户机操作，操作什么，顺序。
Linux- ansible的playbook剧本的使用
qq_44212783的博客
08-21 676
ansible的playbook剧本
Ansible playbook 实例 1（template）
MarvinChen003的专栏
04-13 1487
==========================***  前置文章  ***Ansible FundamentalAnsible的安装配置及基本用法Ansible Playbook 实践==========================Playbooks can declare configurations, but they can also orchestrate steps of an...
ansible批量管理软件部署及剧本
weixin_30349597的博客
12-13 209
服务器版本信息： Centos6.9 [root@db02 ~]# uname -a Linux db02 2.6.32-696.el6.x86_64 #1 SMP Tue Mar 21 19:29:05 UTC 2017 x86_64 x86_64 x86_64 GNU/Linux ansible软件介绍 ansible是一个基于Python开发的自动化运维工具！ 其功能实现...
Linux：ansible-playbook配置文件（剧本）
鲍海超
08-30 1328
我们完成一个任务，例如安装部署一个httpd服务，我们需要多个模块（一个模块也可以称之为task）提供功能来完成。而playbook就是组织多个task的容器，他的实质就是一个文件，有着特定的组织格式，它采用的语法格式是YAML（Yet Another Markup Language）。YAML语法能够简单的表示散列表，字典等数据结构。playbook是由一个或多个模块组成的，使用多个不同的模块，完成一件事情。编写剧本-脚本(playbook)---针对重复性的操作。
wcs-env-tutorial-ansible-playbooks:Ansible剧本，用于设置Web Center网站环境
05-24
在“wcs-env-tutorial-ansible-playbooks”这个项目中，我们可以期待找到一系列剧本，这些剧本将指导我们如何逐步设置Web Center的服务器环境，包括但不限于： 1. **基础环境准备**：这可能包括安装必要的操作系统...
fedora-ansible-playbooks:Ansible剧本，用于设置Fedora
03-17
ansible-galaxy用于管理Ansible依赖项。 pipenv run roles 设置Fedora工作站（本地） 运行local-workstation pipenv脚本 pipenv run local-workstation 设置Fedora服务器（本地） 运行local-server pipenv脚本 ...
ansible-playbooks:Ansible 剧本集
06-09
ansible-剧本 Ansible 剧本集 对于每个剧本，您需要编辑变量和主机文件 aws-cloudwatch 设置您的 AWS EC2 实例以每 5 分钟将系统信息（内存、交换、磁盘空间）发送到 CloudWatch ( )。 ansible-playbook -i hosts...
ansible-playbooks:Ansible剧本
05-12
在`ansible-playbooks-master`这个压缩包中，你可能会找到以下文件和目录： - `playbooks/`：包含各种Ansible剧本，如`wildfly-ci-agent-deploy.yml`用于部署Wildfly CI代理。 - `roles/`：可能有预定义的角色，...
hualinux 进阶 2-1.6：ansible 剧本Playbooks（三）输出详情和调试
hualinux（阿华的linux）
09-11 827
目录 一、说明 二、输出详情（-v /-vvv /-vvvv） 三、check模式和pause模块 3.1 check模式（-C, --check） 3.2 pause模块 四、使用debug模块调试 上篇写了ansible条件选择，现在本章写一个剧本的输出详情和调试。 输了详细可以使用-v/-vv/-vvv 调试可以使用debug模块 一、说明 用ansible-playbook命令执行剧本知道，只会显示执行结果成功或失败，如果是错误则报错。如果你们playbook中有...
Linux Ansible ——playbook剧本应用、批量部署http、Role角色详解及应用
weixin_55985097的博客
05-29 1233
Playbook介绍 playbook是ansible用于配置、部署、和管理被控节点的剧本。通过playbook的详细描述，执行其中的tasks，可以让远端主机达到预期的状态。playbook是由一个或多个”play”组成的列表。 当对一台机器做环境初始化的时候往往需要不止做一件事情，这时使用playbook会更加适合。通过playbook你可以一次在多台机器执行多个指令。通过这种预先设计的配置保持了机器的配置统一，并很简单的执行日常任务。 ansible通过不同的模块实现相应的管理，管理的方式通过定义的清
Linux6.21 ansible playbook 剧本
wfwj_的博客
07-31 605
ansible playbook概述，ansible playbook应用示例
linux学习27-Ansible（三）剧本
weixin_39562300的博客
03-04 735
Ansible的剧本简单入门
教你在Linux上使用ansible写“剧本”，定义一个“剧本”模板后，让控制集群自动执行我们剧本中所写的“剧情”，几个自动化运维的简单实例
weixin_67259816的博客
08-11 972
在设置了serial: 2 的上一个场景中，如果出现问题并且处理的前2个主机的play失败，则playbook将中止，其余3个主机将不会通过play运行。block, rescue, always: 在block定义两个任务，在rescue中定义两个任务，在always中定义两个任务，去执行让rescue中的任务可以执行。在所有受管主机上执行第一个任务后，Ansible将继续一次在5受管主机的组中的所有受管主机上执行下一个任务。理论上，Ansible可以同时连接到play中的所有主机以执行每项任务。....
ansible剧本（playbook）
m0_73460681的博客
02-20 897
ansible剧本（playbook）
Ansible详解（十）——Ansible Template模板基础
永远是少年
03-16 5389
今天继续给大家介绍Linux运维相关知识，本文主要内容是Ansible的Template模板基础。 一、Ansible Template概念 二、Ansible Template模板简单运用 三、Ansible Tmeplate模板迭代
ansible------playbook多样化编写：Templates、Tags、Roles
IvyXYW的博客
04-08 1629
Templates、Tags、Roles一、Templates模块二、tags模板2.1 tags脚本2.2 tags执行2.2.1 直接执行2.2.2 tags执行2.2.3 always执行三、Roles3.1 roles内各目录含义解释3.2 在一个playbook中使用roles的步骤3.3 实验：安装搭建LAMP架构3.3.1 创建文件3.3.2 编写httpd模块3.3.3 编写MySQL模块3.3.4 编写PHP模块3.3.5 编写roles总脚本 一、Templates模块 ansible的
Ansible之playbook剧本编写
最新发布
pupcarrot的博客
12-21 1384
playbook是 一个不同于使用Ansible命令行执行方式的模式，其功能更强大灵活。简单来说，playbook是一个非常简单的配置管理和多主机部署系统，不同于任何已经存在的模式，可作为一个适合部署复杂应用程序的基础。Playbook可以定制配置，可以按照指定的操作步骤有序执行，支持同步和异步方式。我们完成一个任务，例如安装部署一个httpd服务，我们需要多个模块（一个模块也可以称之为task）提供功能来完成。
Ansible的脚本之playbook剧本概念与实操（图文示例）
weixin_52269501的博客
05-03 1374
Ansible playbook 剧本
Vagrant-ansible-playbooks: 简化多项目盒子构建的Ansible剧本
资源摘要信息: "vagrant-ansible-playbooks:适用于不同类型项目的 Ansible 剧本" 知识点详细说明： 1. Vagrant 和 Ansible 的介绍 Vagrant 是一款开源的虚拟化软件，它允许用户创建和配置轻量级、可复制的开发环境...
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值