playbook简单使用

最新推荐文章于 2024-07-04 16:22:55 发布

J.Reno

最新推荐文章于 2024-07-04 16:22:55 发布

阅读量1k

点赞数

分类专栏：云计算 Linux云计算文章标签： ansible playbook

本文链接：https://blog.youkuaiyun.com/JReno/article/details/91882533

版权

Linux云计算同时被 2 个专栏收录

59 篇文章

订阅专栏

云计算

36 篇文章

订阅专栏

本文介绍了Ansible的七种武器，重点讲解了playbook的使用，包括其定义、为何使用以及基本语法。同时，文章涵盖了JSON、YAML和Jinja2模板的基础知识，并展示了如何创建和使用playbook，包括任务调度、错误处理、标签和处理程序等功能。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

ansible七种武器

第一种武器
ansible 命令,用于执行临时性的工作
第二种武器
ansible-doc是ansible模块的文档说明,针对每个模块都有详细的说明及应用案例介绍,功能和Linux系统man命令类似
第三种武器
ansible-console是ansible为用户提供的交互式工具,用户可以在ansible-console虚拟出来的终端上像Shell一样使用ansible内置的各种命令,这为习惯使用Shell交互方式的用户提供了良好的使用体验
第四种武器
ansible-galaxy从github上下载管理Roles的一款工具,与python的pip类似
第五种武器
ansible-playbook是日常应用中使用频率最高的命令,工作机制:通过读取先编写好的playbook文件实现批量管理,可以理解为按一定条件组成的ansible任务集
第六种武器
ansible-vault主要用于配置文件加密,如编写的playbook文件中包含敏感信息,不想其他人随意查看,可用它加密/解密这个文件
第七种武器

ansible-pull
ansible有两种工作模式pull/push ,默认使用push模式工作,pull和push工作模式机制刚好相反

适用场景:有大批量机器需要配置,即便使用高并发线程依旧要花费很多时间
通常在配置大批量机器的场景下使用,灵活性稍有欠缺,但效率几乎可以无限提升,对运维人员的技术水平和前瞻性规划有较高要求

JSON简介

JSON是什么

JSON是JavaScript对象表示法,它是一种基于文本独立于语言的轻量级数据交换格式
JSON中的分隔符限于单引号" ’ " 、小括号" () " 、中括号" [ ] " 、大括号" { } " 、冒号 " : " 和逗号 " , "

JSON 特性

JSON是纯文本
JSON具有"自我描述性"(人类可读)
JSON具有层级结构(值中存在值)
JSON可通过JavaScript进行解析

JSON 语法规则

数据在名称/值对中
数据由逗号分隔
大括号保存对象
中括号保存数组

JSON 数据的书写格式是:名称/值对

名称/值对包括字段名称(在双引号中),后面写一个冒号,然后是值

YAML简介

YAML是什么

是一个可读性高,用来表达数据序列的格式
YAML(YAML Ain’t Markup Language)
YAML参考了多种语言,如:C语言、Python、Perl等,并从XML、电子邮件的数据格式中获得灵感,Clark Evans在2001年首次发表了这种语言,目前已有数种编程语言或脚本语言支持这种语言

YAML基础语法

YAML的结构通过空格来展示
数组使用"- "来表示
键值对使用": "来表示
YAML使用一个固定的缩进风格表示数据层级结构关系
一般每个缩进级别由两个以上空格组成
# 表示注释

注意:

不要使用tab,缩进是初学者容易出错的地方之一
同一层级缩进必须对齐

YAML的键值表示方法

采用冒号分隔
: 后面必须有一个空格

YAML 数组表示方法

使用一个短横杠加一个空格-

Jinja2模版简介

Jinja2是什么

Jinja2是基于Python的模板引擎,包含变量和表达式两部分,两者在模板求值时会被替换为值,模板中还有标签,控制模板的逻辑

为什么要学习Jinja2模版

因为playbook的模板使用Python的Jinja2模块来处理

Jinja2模版基本语法

模板的表达式都是包含在分隔符"{{ }}"内的
控制语句都是包含在分隔符"{% %}"内的
模板支持注释,都是包含在分隔符"{# #}"内,支持块注释
调用变量 {{varname}}
计算 {{2+3}}
判断 {{1 in [1,2,3]}}

Jinja2模版控制语句

{% if name == '诗仙' %}
李白
{% elif name == '诗圣' %}
杜甫
{% elif name == '诗魔' %}
白居易
{% else %}
李贺
{% endif %}

{% if name == ... ... %}
... ...
{% elif name == '于谦' %}
{% for method in [抽烟, 喝酒, 烫头] %}
{{do method}}
{% endfor %}
... ...
{% endif %}

Jinja2过滤器

变量可以通过过滤器修改。过滤器与变量用管道符号( | )分割,也可以用圆括号传递可选参数,多个过滤器可以链式调用,前一个过滤器的输出会被作为后一个过滤器的输入

例如

加密一个字符串:{{ ‘astr’|password_hash(‘sha512’)}}
过滤器这里不再一一列举,需要的可以查询在线文档
http://docs.jinkan.org/docs/jinja2/templates.html

playbook

playbook是什么

playbook是ansible用于配置,部署和管理托管主机剧本,通过playbook的详细描述,执行其中的一系列tasks,可以让远端主机达到预期状态
也可以说,playbook字面意思即剧本,现实中由演员按剧本表演,在ansible中由计算机进行安装,部署应用,提供对外服务,以及组织计算机处理各种各样的事情

为什么要使用playbook

执行一些简单的任务,使用ad-hoc命令可以方便的解决问题,但有时一个设施过于复杂时,执行ad-hoc命令是不合适的,最好使用playbook
playbook可以反复使用编写的代码,可以放到不同的机器上面,像函数一样,最大化的利用代码,在使用ansible的过程中,处理的大部分操作都是在编写playbook

playbook语法基础

playbook语法格式

playbook由YAML语言编写,遵循YAML标准
在同一行中,#之后的内容表示注释
同一个列表中的元素应该保持相同的缩进
playbook由一个或多个play组成
play中hosts,variables,roles,tasks等对象的表示方法都是键值中间以": "分隔表示
YAML还有一个小的怪癖,它的文件开始行都应该是 —,这是YAML格式的一部分,表明一个文件的开始

playbook构成

hosts: 定义将要执行playbook的远程主机组
vars: 定义playbook运行时需要使用的变量
tasks: 定义将要在远程主机上执行的任务列表
handlers: 定义task执行完成以后需要调用的任务

playbook执行结果

使用ansible-playbook运行playbook文件,输出内容为JSON格式,由不同颜色组成便于识别
绿色代表执行成功
***代表系统代表系统状态发生改变
红色代表执行失败

第一个playbook

[root@ansible ~]# vim ping.yml

---		# 第一行,表示开始
- hosts: all
  remote_user: root
  tasks:
    - ping:

[root@ansible ~]# ansible-playbook ping.yml -f 5

-f 并发进程数量,默认是5
hosts行内容是一个(多个)组或主机的patterns,以逗号为分隔符
remote_user 账户名

tasks

命令的集合
每一个play包含了一个task列表(任务列表)
一个task在其所对应的所有主机上(通过 host pattern匹配的所有主机)执行完毕之后,下一个task才会执行

hosts

主机的集合
定义要执行任务的主机

playbook执行命令

给web主机添加用户z3,设置默认密码123
使用 user 模块

[root@ansible ~]# vim webuseradd.yml

---
- hosts: web1,web2
  remote_user: root
  tasks:
    - name: create user z3		#task下的name都表示注释
      user:
        name=z3
    - name: change password		#task下的name都表示注释
      shell:
        echo 123 | passwd --stdin z3

[root@ansible ~]# ansible-playbook webuseradd.yml

使用ansible-doc 模块名 查看使用帮助

给web组下的主机安装httpd

安装Apache
修改配置文件的监听端口为8080
设置默认主页 hello world
启动服务
设置开机自启

[root@ansible ~]# echo "hello world" > index.html
[root@ansible ~]# vim installHttpd.yml
---
- hosts: web
  tasks:
    - name: install the latest version of Apache
      yum:
        name: httpd
        state: latest
    - name: change listen port
      lineinfile: 
        path: /etc/httpd/conf/httpd.conf
        regexp: '^Listen '
        insertafter: '^#Listen '
        line: 'Listen 8080'
    - name: copy index.html
      copy:
        src: /root/index.html
        dest: /var/www/html/
        owner: apache
        group: apache
        mode: 0644
    - name: start and enable apache
      service:
        name: httpd
        state: restarted
        enabled: yes

[root@ansible ~]# ansible-playbook installHttpd.yml

playbook进阶

语法进阶

变量

添加用户
给 db 主机添加用户l4,设置默认密码456

[root@ansible ~]# vim dbuseradd.yml
---
- hosts: db
  remote_user: root
  vars:
    username: l4
  tasks:
    - name: create user "{{username}}"
      user:
        name: "{{username}}"
    - name: change password
      shell:
        echo 456 | passwd --stdin "{{username}}"
[root@ansible ~]# ansible-playbook dbuseradd.yml

设密码

解决密码明文问题
user模块的password为什么不能设置密码呢
经过测试发现,password是把字符串直接写入shadow,并没有改变,而Linux的shadow密码是经过加密的,所以不能使用

解决方案

变量过滤器password_hash
{{ 'urpassword' | password_hash('sha512')}}

变量过滤器

给db主机添加用户w5,设置默认密码123

[root@ansible ~]# vim user01.yml
---
- hosts: db
  remote_user: root
  vars:
    username: w5
  tasks:
    - name: create user "{{username}}"
      user:
        name: "{{username}}"
        password: "{{'123'|password_hash('sha512')}}"
[root@ansible ~]# ansible-playbook user01.yml

变量参数

传递参数
-e 参数
参数格式必须是 json 或 yaml
yaml 格式可以使用参数文件,例如
args.yml

---
username:
nb
– -e @args.yml

定义yml配置文件,默认创建用户是w5,默认创建密码是123,默认的组是db组

[root@ansible ~]# vim user01.yml
---
- hosts: '{{host}}'
  remote_user: root
  vars:
    username: w5
    pwd: '123'
    host: db
  tasks:
    - name: create user "{{username}}"
      user:
        name: "{{username}}"
        password: "{{ pwd |password_hash('sha512')}}"


(1)//传入json格式的参数,创建www用户的密码是www,如果不传入参数,则以默认参数创建
[root@ansible ~]# ansible-playbook user01.yml -e '{"username": "www","pwd": "www"}'
//给web组主机创建ccc用户,密码是ccc
[root@ansible ~]# ansible-playbook user01.yml -e '{"username": "ccc","pwd": "ccc","host": "web"}'
(2)创建yml参数文件

[root@ansible ~]# vim aa.yml

---
 username: plj
 pwd: dddd
 host: cache

(3)调用yml参数文件创建用户

[root@ansible ~]# ansible-playbook user01.yml -e @aa.yml

error

ansible-playbook对错误的处理
默认情况判断$?,如果值不为0就停止执行
但某些情况我们需要忽略错误继续执行
例如创建缓存目录,然后重启 apache

---
- hosts: cache
  remote_user: root
  tasks:
    - shell: mkdir /tmp/cache
    - name: ReStart service httpd
  service:
    name: httpd
    state: restarted

错误处理方法

ignore_errors: 对错误的处理方式
True 表示忽略错误继续执行
False 表示遇到错误就停止执行
默认 False
处理方式:

 name: run some command
 shell: /usr/bin/somecommand
 ignore_errors: True

playbook 调用方式

-t TAGS, --tags=TAGS
--skip-tags=SKIP_TAGS
--start-at-task=START_AT

[root@ansible ~]# vim installHttpd.yml 

...	...
    - name: copy index.html
      copy:
        src: /root/index.html
        dest: /var/www/html/
        owner: apache
        group: apache
        mode: 0644
      tags: defindex      #给copy模块加个标签
    - name: start and enable apache
...	...

只执行copy模块

[root@ansible ~]# ansible-playbook installHttpd.yml -t defindex

handlers

当关注的资源发生变化时采取的操作
notify这个action可用于在每个play的最后被触发,这样可以避免有多次改变发生时每次都执行指定的操作,取而代之仅在所有的变化发生完成后一次性地执行指定操作
在notify中列出的操作称为handler,即notify调用handler中定义的操作
前面安装了Apache,修改httpd的配置文件,重新载入配置文件让服务生效
使用handlers来实现

创建本地httpd.conf文件,修改web监听端口为808,批量修改web主机并重启服务

[root@ansible ~]# vim httpd.conf
...	...
Listen 808
...	...

创建yml文件

[root@ansible ~]# vim web1.yml
---
- hosts: web
  remote_user: root
  tasks:
    - copy:
        src: /root/httpd.conf
        dest: /etc/httpd/conf/httpd.conf
        owner: root
        group: root
        mode: 0644
      tags: httpconf
      notify:
        - restart httpd
  handlers:
     - name: restart httpd
       service:
         name: httpd
         state: restarted

执行配置

[root@ansible ~]# ansible-playbook web1.yml -t httpconf

注:在远程批量copy本地文件的时候,只有本地的文件跟远程的文件内容有区别,notify后面的动作才会执行

注意事项:

notify调用的是handler段的name定义的串,必须一致,否则达不到触发的效果
多个task触发同一个notify的时候,同一个服务只会触发一次
notify可以触发多个条件,在生产环境中往往涉及到某一个配置文件的改变要重启若干服务的场景,handler用到这里非常适合
结合vars可以写出非常普适的服务管理脚本

when

有些时候需要在满足特定的条件后再触发某一项操作,或在特定的条件下终止某个行为,这个时候需要进行条件判断,when正是解决这个问题的最佳选择,远程中的系统变量facts作为when的条件,可以通过setup模块查看
when 的样例

tasks:
name: somecommand
command: somecommand
when: expr

一个使用when的例子

---
- name: Install VIM
hosts: all
tasks:
- name: Install VIM via yum
yum: name=vim-enhanced state=installed
when: ansible_os_family == "RedHat"
- name: Install VIM via apt
apt: name=vim state=installed
when: ansible_os_family == "Debian"

register

有时候我们还需要更复杂的例子,如判断前一个命令的执行结果去处理后面的操作,这时候就需要register模块来保存前一个命令的返回状态,在后面进行调用

- command: test command
register: result
- command: run command
when: result

变量注册进阶

针对运行命令结果的返回值做判定
当系统负载超过一定值的时候做特殊处理

监控web主机,当某台机器的一分钟的负载大于0.7时,就关闭该主机的apache服务

[root@ansible ~]# vim uptime.yml
---
- hosts: web
  remote_user: root
  tasks:
    - shell: uptime | awk '{printf("%.2f",$(NF-2))}'
      register: result
    - service:
        name: httpd
        state: stopped
      when: result.stdout|float > 0.7
[root@ansible ~]# ansible-playbook uptime.yml

with_items

with_items是playbook标准循环,可以用于迭代一个列表或字典,通过{{ item }}获取每次迭代的值

例如创建多个用户

[root@ansible ~]# vim user02.yml
---
- hosts: '{{host}}'
  remote_user: root
  vars: 
    host: cache
  tasks:
    - name: create user "{{item}}"
      user:
        name: "{{item.name}}"
        group: "{{item.group}}"
        password: "{{ item.pwd |password_hash('sha512')}}"
      with_items:
         -
           name: nb
           group: ftp
           pwd: dachui
         -
           name: wk
           group: man
           pwd: xiangj

         -
           name: yy
           group: lp
           pwd: hh
         -
           name: tt
           group: games
           pwd: uj

[root@ansible ~]# ansible-playbook user02.yml

include and roles

注: 在新的ansible软件中,将可能废弃include的使用,请替换成import_tasks,用法不变

在编写playbook的时候随着项目越来越大,playbook越来越复杂,修改也很麻烦。这时可以把一些play、task 或handler放到其他文件中,通过include指令包含进来是一个不错的选择

tasks:
- include: tasks/setup.yml
- include: tasks/users.yml user=plj #users.yml 中可以通过
{{ user }}来使用这些变量
handlers:
- include: handlers/handlers.yml

roles像是加强版的include,它可以引入一个项目的文件和目录
一般所需的目录层级有

vars:变量层
tasks:任务层
handlers:触发条件
files:文件
template:模板
default:默认,优先级最低

假如有一个play包含了一个叫"x"的role,则

---
- hosts: host_group
  roles:
     -x

x/tasks/main.yml
x/vars/main.yml
x/handler/main.yml
x/… …/main.yml
都会自动添加进这个 play

根据参数文件,创建组,创建用户名,添加密码

(1)创建工作目录

[root@ansible ~]#  mkdir ansibles
[root@ansible ~]#  cd ansibles/
[root@ansible ansibles]#  mkdir vars tasks handlers files template default

(2)创建主文件,引入工作目录

[root@ansible ~]# vim user02.yml

---
- hosts: '{{host}}'
  remote_user: root
  roles:
    - /root/ansibles

(3)编辑tasks文件

[root@ansible ~]# vim ansibles/tasks/main.yml
    - import_tasks: /root/ansibles/tasks/addGroup.yml
    - import_tasks: /root/ansibles/tasks/addUser.yml

(4)创建添加组的任务文件

[root@ansible ~]# vim ansibles/tasks/addGroup.yml
- name: create group
  group:
    name: "{{item.group}}"
    state: present
  with_items: "{{userlists}}"

(5) 创建添加用户的任务文件

[root@ansible ~]# vim ansibles/tasks/addUser.yml
    - name: create user "{{item.name}}"
      user:
        name: "{{item.name}}"
        group: "{{item.group}}"
        password: "{{ item.pwd |password_hash('sha512')}}"
      with_items: "{{userlists}}"

(6)创建变量文件

[root@ansible ~]# vim ansibles/vars/main.yml
  vars:
    host: cache
    userlists:
       -
         name: nb
         group: ftp
         pwd: dachui

(7)创建参数文件

[root@ansible ~]# vim useradd.json

{"host":"cache",
  "userlists":[
       {"name":"123",
        "group":"sgs",
        "pwd":"fbnafnas"
           },
       {"name":"789",
        "group":"vnmsaij",
        "pwd":"qrjqwoi"
           },
      {"name":"vf",
        "group":"fhfhhf",
        "pwd":"qrwjqwp"
           },
      {"name":"ttg",
        "group":"gjpkw",
        "pwd":"terypo"
          },
      {"name":"yui",
        "group":"gmmsvs",
        "pwd":"lllll"
          }
   ]
}

(8)测试

[root@ansible ~]# ansible-playbook user02.yml -e @useradd.json

调试

debug

对于Python语法不熟悉的,playbook书写起来容易出错,且排错困难,这里介绍几种简单的排错调试方法
检测语法
ansible-playbook --syntax-check playbook.yaml
测试运行
ansible-playbook -C playbook.yaml
显示受到影响的主机 --list-hosts
显示工作的task --list-tasks
显示将要运行的tag --list-tags

[root@ansible ~]# ansible-playbook user02.yml --list-hosts

[root@ansible ~]# ansible-playbook user02.yml --list-tasks

[root@ansible ~]# ansible-playbook user02.yml --list-tags

debug模块可以在运行时输出更为详细的信息,帮助我们排错

debug使用样例

---
- hosts: web
remote_user: root
tasks:
- shell: uptime |awk '{printf("%.2f\n",$(NF-2))}'
register: result
- shell: touch /tmp/isreboot
when: result.stdout|float > 0.7
- name: Show debug info
debug: var=result

输出的result是个Json格式的数据