Ansible——Playbook剧本

目录

一、Playbook概述

1.Playbook定义

2.Playbook组成

3.Playbook配置文件详解

4.运行Playbook

4.1Ansible-Playbook相关命令

4.2运行Playbook启动httpd服务

4.3变量的定义和引用

4.4指定远程主机sudo切换用户

4.5When——条件判断

4.6迭代

4.6.1创建文件夹

4.6.2创建文件

4.6.3创建文件夹并建立用户

4.7总结

二、Templates模块

1.准备模板文件并设置引用的变量

2.修改主机清单内的变量

3.编写Playbook剧本

三、Tags模块

四、Roles模块

1.Roles目录详解

2.在Playbook中使用Roles步骤

2.1环境准备

2.2修改yml文件 

2.3运行Ansible-Playbook 

3.Roles模块举例——LAMP

3.1编写httpd模块

3.1.1编写yml文件

3.1.2定义变量

3.2编写Mysql模块

3.2.1编写yml文件

3.2.2定义变量

3.3编写Php模块

3.3.1编写yml文件

3.3.2定义变量

3.4编写Roles实例并启动


一、Playbook概述

1.Playbook定义

Playbook其实是Ansible服务的一个配置文件,Ansible使用Playbook的YAML语言配置编写成操作需求,实现对远端主机或策略部署,实现对远端主机的控制与管理。

2.Playbook组成

  • Tasks:任务,即通过 task 调用 ansible 的模板将多个操作组织在一个 playbook 中运行
  • Variables:变量
  • Templates:模板
  • Handlers:处理器,当changed状态条件满足时,(notify)触发执行的操作
  • Roles:角色

3.Playbook配置文件详解

vim test1.yaml
---
#yaml文件以---开头,以表明这是一个yaml文件,可省略(但是如果两个YAML配置叠加的话,要以此为分割)
- name: first play
#定义一个play的名称,可省略
  gather_facts: false
#设置不进行facts信息收集,这可以加快执行速度,可省略
  hosts: webservers
#指定要执行任务的被管理主机组,如多个主机组用冒号分隔
  remote_user: root
#指定被管理主机上执行任务的用户
  tasks:
#定义任务列表,任务列表中的各任务按次序逐个在hosts中指定的主机上执行
   - name: test connection
#自定义任务名称
     ping:
#使用 module: [options] 格式来定义一个任务
   - name: disable selinux
     command: '/sbin/setenforce 0'
#command模块和shell模块无需使用key=value格式
     ignore_errors: True
#如执行命令的返回值不为0,就会报错,tasks停止,可使用ignore_errors忽略失败的任务
   - name: disable firewalld
     service: name=firewalld state=stopped
#使用 module: options 格式来定义任务,option使用key=value格式
   - name: install httpd
     yum: name=httpd state=latest
   - name: install configuration file for httpd
     copy: src=/opt/httpd.conf dest=/etc/httpd/conf/httpd.conf
#这里需要一个事先准备好的/opt/httpd.conf文件
     notify: "restart httpd"
#如以上操作后为changed的状态时,会通过notify指定的名称触发对应名称的handlers操作
   - name: start httpd service
     service: enabled=true name=httpd state=started
  handlers:
#handlers中定义的就是任务,此处handlers中的任务使用的是service模块
   - name: restart httpd
#notify和handlers中任务的名称必须一致
     service: name=httpd state=restarted
#Ansible在执行完某个任务之后并不会立即去执行对应的handler,而是在当前play中所有普通任务都执行完后再去执行handler,这样的好处是可以多次触发notify,但最后只执行一次对应的handler,从而避免多次重启。

4.运行Playbook

ansible-playbook test1.yaml
参数含义
-k(–ask-pass)用来交互输入ssh密码
-K(-ask-become-pass)用来交互输入sudo密码
-u指定用户

4.1Ansible-Playbook相关命令

命令含义
ansible-playbook test1.yaml --syntax-check检查yaml文件的语法是否正确
ansible-playbook test1.yaml --list-task检查tasks任务
ansible-playbook test1.yaml --list-hosts检查生效的主机
ansible-playbook test1.yaml --start-at-task='install httpd'指定从某个task开始运行

4.2运行Playbook启动httpd服务

cd /opt/
vim test01.yaml 


---
- name: install httpd
  gather_facts: false
  hosts: cxk
  remote_user: root
  tasks:
    - name: connection ceshi
      ping:
    - name: disable firewalld
      service: name=firewalld state=stopped
    - name: install apache
      yum: name=httpd state=latest
    - name: install config file
      copy: src=/opt/httpd.conf dest=/etc/httpd/conf/httpd.conf
      #整个任务完成才会运行notify的restart httpd
    - name: start httpd service
      service: enabled=true name=httpd state=started
    - name: write html
      copy: src=/opt/index.html dest=/var/www/html/index.html
      notify: "restart httpd"
  handlers:
    - name: restart httpd
      service: name=httpd state=restarted



[root@localhost opt]#vim index.html
[root@localhost opt]#cat index.html 
this is cxk ctrl
[root@localhost opt]#rz -E
rz waiting to receive.
[root@localhost opt]#ls
httpd.conf  index.html  rh  test01.yaml
ansible-playbook test01.yaml --syntax-check

playbook: test01.yaml




ansible-playbook test01.yaml --list-task

playbook: test01.yaml

  play #1 (cxk): install httpd	TAGS: []
    tasks:
      connection ceshi	TAGS: []
      disable firewalld	TAGS: []
      install apache	TAGS: []
      install config file	TAGS: []
      start httpd service	TAGS: []
      write html	TAGS: []



ansible-playbook test01.yaml --list-host

playbook: test01.yaml

  play #1 (cxk): install httpd	TAGS: []
    pattern: [u'cxk']
    hosts (1):
      192.168.241.22
ansible-playbook test01.yaml

4.3变量的定义和引用

vim test02.yaml



---
- name: variable
  hosts: cxk
  remote_user: root
  vars:
    - groupname: wyb
    - username: nginx
  tasks:
    - name: create group
      group: name={{groupname}} system=yes gid=222
    - name: create user
      user: name={{username}} uid=111 group={{groupname}}
    - name: copy file
      copy: content="{{ansible_default_ipv4}}" dest=/opt/cxk.txt


ansible cxk -m setup|grep ansible_default
        "ansible_default_ipv4": {
        "ansible_default_ipv6": {},


ansible-playbook test02.yaml -e "username=zj"

-e选项指定yaml配置文件中变量username,因为指定了在yaml文件中指定的username为"nginx",实际命令中指定为"zj"最终是以-e选项指定的username生效;

命令行中的变量优先级高于YAML配置文件中的变量优先级。

ansible cxk -a 'cat /opt/cxk.txt'
192.168.241.22 | CHANGED | rc=0 >>
{"macaddress": "00:0c:29:3e:a0:08", "network": "192.168.241.0", "mtu": 1500, "broadcast": "192.168.241.255", "alias": "ens33", "netmask": "255.255.255.0", "address": "192.168.241.22", "interface": "ens33", "type": "ether", "gateway": "192.168.241.2"}
ansible cxk -a 'grep "nginx" /etc/passwd'
192.168.241.22 | FAILED | rc=1 >>
non-zero return code


ansible cxk -a 'grep "zj" /etc/passwd'
192.168.241.22 | CHANGED | rc=0 >>
zj:x:111:222::/home/zj:/bin/bash


ansible cxk -a 'id zj'
192.168.241.22 | CHANGED | rc=0 >>
uid=111(zj) gid=222(wyb) 组=222(wyb)

4.4指定远程主机sudo切换用户

vim test03.yaml


---
- hosts: cxk
  remote_user: ghd            
  become: yes
  become_user: root

这里显示sudo提权失败,可以去远端主机的配置文件(/etc/sudoers)中修改ghd用户的权限 

vim /etc/sudoers


grep "ghd" /etc/sudoers
ghd	ALL=(ALL) 	ALL

4.5When——条件判断

在Ansible中,提供的唯一一个通用的条件判断是when指令,当when指令的值为true时,则该任务执行,否则不执行该任务。when一个比较常见的应用场景是实现跳过某个主机不执行任务或者只有满足条件的主机执行任务

vim test04.yaml


---
- name: reboot host
  hosts: cxk
  remote_user: root
  tasks:
  - name: shutdown host
    command: /sbin/shutdown -r now
    #shutdown命令必须是在绝对路径下  该任务是指让主机进行关机操作
    when: ansible_default_ipv4.address == "192.168.241.22"
    #判断条件为主机地址为192.168.241.22的主机




ansible-playbook test04.yaml

这里显示UNREACHABLE就表示已经将192.168.241.22主机进行关机 

vim test04.yaml

---
- name: reboot host
  hosts: cxk
  remote_user: root
  tasks:
  - name: shutdown host
    command: /sbin/shutdown -r now
    when: ansible_default_ipv4.address == "192.168.241.23"
    #将关机主机修改为其他判断条件 判断主机地址是否为192.168.241.23

ansible-playbook test04.yaml

由于判断条件为主机地址为192.168.241.23才执行Shutdown操作,所以主机地址为192.168.241.22的主机跳过Playbook

4.6迭代

Ansible提供了很多种循环结构,一般都命名为with_items,作用等同于 loop 循环。

4.6.1创建文件夹
vim test05.yaml



---
- name: dd1
  hosts: cxk
  tasks:
    - name: create dir
      file: path={{item}} state=directory
      with_items:
        - /opt/cxk
        - /opt/wyb
        - /opt/zs
        - /opt/zjl


ansible-playbook test05.yaml 

4.6.2创建文件
vim test05.yaml


---
- name: dd2
  hosts: cxk
  tasks:
    - name: create dir
      file: path={{item}} state=touch
      with_items:
        - /opt/cxk.txt
        - /opt/wyb.txt
        - /opt/zs.txt
        - /opt/zjl.txt


ansible-playbook test05.yaml 

4.6.3创建文件夹并建立用户
vim test06.yaml


---
- name: dd3
  hosts: wyb
  gather_facts: false
  tasks: 
    - name: create directories
      file:
        path: "{{item}}"
        state: directory
      with_items:
        - /tmp/test1
        - /tmp/test2
    - name: add users
      user: name={{item.name}} state=present groups={{item.groups}}
      with_items:
        - name: test1
          groups: wheel
        - name: test2
          groups: root

ansible-playbook test06.yaml 

4.7总结

  • 定义变量:Ansible-playbook 是一种定义的任务方式,在编写Playbook时,可以使用变量来传数据,Playbook引用变量时,指的是在Playbook中使用变量来代替静态常亮值,来实现动态的配置过程,通过引用变量可以使Playbook更具有灵活性和可重复性(Playbook使用{{name}} 来引用变量)
  • When——条件判断:用来进行条件判断的关键字,其作用只在你指定条件下会执行下面的任务,当条件为真时,任务就会被执行,否则任务将被跳过
  • 迭代:通常是指持续的对Ansible Playbook剧本进行修改、更改和改进的过程

二、Templates模块

Jinja是基于Python的模板引擎。Template类是Jinja的一个重要组件,可以看作是一个编译过的模板文件,用来产生目标文本,传递Python的变量给模板去替换模板中的标记。

1.准备模板文件并设置引用的变量

yum install -y httpd

cp /etc/httpd/conf/httpd.conf /opt/httpd.conf.j2

vim /opt/httpd.conf.j2

-42行修改-   Listen {{http_port}}
-95行修改-   ServerName {{server_name}}
-119行修改-  DocumentRoot "{{root_dir}}" 

2.修改主机清单内的变量

vim /etc/ansible/hosts 

-19- [cxk]
-20- 192.168.241.22 http_port=192.168.241.22:80 server_name=www.cxk.com:80 root_dir=/etc/httpd/htdocs
#注意  root_dir要和前面的server_name空格  不可另起一行,否则报错UNREACHABLE!

-34- [wyb]
-35- 192.168.241.23 http_port=192.168.241.23:80 server_name=www.wyb.com:80 root_dir=/etc/httpd/htdocs
#注意  root_dir要和前面的server_name空格  不可另起一行,否则报错UNREACHABLE!

3.编写Playbook剧本

vim apache.yaml


---
- hosts: all
  remote_user: root
  vars:
    - package: httpd
    - service: httpd
  tasks:
    - name: create dir
      file: path=/etc/httpd/htdocs state=directory
    - name: install httpd package
      yum: name={{package}} state=latest
    - name: install configure file
      template: src=/opt/httpd.conf.j2 dest=/etc/httpd/conf/httpd.conf
      notify: "restart httpd"
    - name: start httpd server
      service: name={{service}} enabled=true state=started
  handlers:
    - name: restart httpd
      service: name={{service}} state=restarted



ansible-playbook apache.yaml

vim /etc/httpd/conf/httpd.conf
#远端主机的配置文件

-42- Listen 192.168.241.22:80

-95- ServerName www.cxk.com:80

-119- DocumentRoot "/etc/httpd/htdocs"

三、Tags模块

可以在一个playbook中为某个或某些任务定义“标签”,在执行此playbook时通过ansible-playbook命令使用--tags选项能实现仅运行指定的tasks。
playbook还提供了一个特殊的tags为always。作用就是当使用always当tags的task时,无论执行哪一个tags时,定义有always的tags都会执行。

vim cxkhosts.yaml

---
- hosts: cxk
  remote_user: root
  tasks:
    - name: Copy hosts file
      copy: src=/etc/hosts dest=/opt/hosts
      tags: "ghd"
    - name: touch file
      file: path=/opt/testhost state=touch
      tags: "always"


ansible-playbook cxkhosts.yaml --tags="ghd"

vim wybhosts.yaml

---
- hosts: wyb
  remote_user: root
  tasks:
    - name: Copy hosts file
      copy: src=/etc/hosts dest=/opt/hosts
      tags: "ghd"
    - name: touch file
      file: path=/opt/testhost state=touch
      tags: "always"
      #定义有always的tags都会执行,如果不定义tags,则执行tags="ghd"即不执行下面的命令


ansible-playbook wybhosts.yaml --tags="ghd"

四、Roles模块

Ansible为了层次化、结构化地组织Playbook,使用了角色(roles),roles可以根据层次型结构自动装载变量文件、task以及handlers等。简单来讲,roles就是通过分别将变量、文件、任务、模块及处理器放置于单独的目录中,并可以便捷地include它们。roles一般用于基于主机构建服务的场景中,但也可以用于构建守护进程等场景中。

1.Roles目录详解

文件名含义
files用来存放由 copy 模块或 script 模块调用的文件
templates用来存放 jinjia2 模板,template 模块会自动在此目录中寻找 jinjia2 模板文件
tasks此目录应当包含一个 main.yml 文件,用于定义此角色的任务列表,此文件可以使用 include 包含其它的位于此目录的 task 文件
handlers此目录应当包含一个 main.yml 文件,用于定义此角色中触发条件时执行的动作
vars此目录应当包含一个 main.yml 文件,用于定义此角色用到的变量
defaults此目录应当包含一个 main.yml 文件,用于为当前角色设定默认变量
meta此目录应当包含一个 main.yml 文件,用于定义此角色的特殊设定及其依赖关系

2.在Playbook中使用Roles步骤

2.1环境准备

mkdir /etc/ansible/roles/ -p
#创建以 roles 命名的目录

mkdir /etc/ansible/group_vars/ -p
touch /etc/ansible/group_vars/all
#创建全局变量目录

mkdir /etc/ansible/roles/httpd
mkdir /etc/ansible/roles/mysql
#在 roles 目录中分别创建以各角色名称命令的目录

mkdir /etc/ansible/roles/httpd/{files,templates,tasks,handlers,vars,defaults,meta}
mkdir /etc/ansible/roles/mysql/{files,templates,tasks,handlers,vars,defaults,meta}
#在每个角色命令的目录中分别创建files、handlers、tasks、templates、meta、defaults和vars目录,用不到的目录可以创建为空目录,也可以不创建

touch /etc/ansible/roles/httpd/{defaults,vars,tasks,meta,handlers}/main.yml
touch /etc/ansible/roles/mysql/{defaults,vars,tasks,meta,handlers}/main.yml
#在每个角色的 handlers、tasks、meta、defaults、vars 目录下创建 main.yml 文件,千万不能自定义文件名

2.2修改yml文件 

vim /etc/ansible/site.yml
#修改 site.yml 文件,针对不同主机去调用不同的角色


---
- hosts: cxk
  remote_user: root
  roles:
     - httpd
- hosts: wyb
  remote_user: root
  roles:
     - mysql

2.3运行Ansible-Playbook 

cd /etc/ansible
ansible-playbook site.yml

3.Roles模块举例——LAMP

mkdir /etc/ansible/roles/httpd/{files,templates,tasks,handlers,vars,defaults,meta} -p
mkdir /etc/ansible/roles/mysql/{files,templates,tasks,handlers,vars,defaults,meta} -p
mkdir /etc/ansible/roles/php/{files,templates,tasks,handlers,vars,defaults,meta} -p

touch /etc/ansible/roles/httpd/{defaults,vars,tasks,meta,handlers}/main.yml
touch /etc/ansible/roles/mysql/{defaults,vars,tasks,meta,handlers}/main.yml
touch /etc/ansible/roles/php/{defaults,vars,tasks,meta,handlers}/main.yml

3.1编写httpd模块

3.1.1编写yml文件
vim /etc/ansible/roles/httpd/tasks/main.yml


- name: install apache
  yum: name={{pkg}} state=latest
- name: start apache
  service: enabled=true name={{svc}} state=started
3.1.2定义变量
vim /etc/ansible/roles/httpd/vars/main.yml
#可以定义在全局变量中,也可以定义在roles角色变量中,一般定义在角色变量中
pkg: httpd
svc: httpd

3.2编写Mysql模块

3.2.1编写yml文件
vim /etc/ansible/roles/mysql/tasks/main.yml


- name: install mysql
  yum: name={{pkg}} state=latest
- name: start mysql
  service: enabled=true name={{svc}} state=started
3.2.2定义变量
vim /etc/ansible/roles/mysql/vars/main.yml



pkg:
  - mariadb
  - mariadb-server
svc: mariadb

3.3编写Php模块

3.3.1编写yml文件
vim /etc/ansible/roles/php/tasks/main.yml



- name: install php
  yum: name={{pkg}} state=latest
- name: start php-fpm
  service: enabled=true name={{svc}} state=started
3.3.2定义变量
vim /etc/ansible/roles/php/vars/main.yml


pkg:
  - php
  - php-fpm
svc: php-fpm

3.4编写Roles实例并启动

vim /etc/ansible/site.yml


---
- hosts: wyb
  remote_user: root
  roles:
   - httpd
   - mysql
   - php



cd /etc/ansible
ansible-playbook site.yml

 五、总结

  • 定义变量:Ansible-playbook 是一种定义的任务方式,在编写Playbook时,可以使用变量来传数据,Playbook引用变量时,指的是在Playbook中使用变量来代替静态常亮值,来实现动态的配置过程,通过引用变量可以使Playbook更具有灵活性和可重复性(Playbook使用{{name}} 来引用变量)
  • When——条件判断:用来进行条件判断的关键字,其作用只在你指定条件下会执行下面的任务,当条件为真时,任务就会被执行,否则任务将被跳过
  • 迭代:通常是指持续的对Ansible Playbook剧本进行修改、更改和改进的过程
  • Template模块,是一种创建配置文件的工具,在配置文件中,会有一些数据会动态的改变,如IP地址、主机名、用户名、页面路径等,需要使用变量来表示;Template模块就是将变量和动态文件结合起来,最终会生成一个配置文件(你需要动态改变的),文件配置一定是j2结尾的
  • Tags是一种标记任务,或者一系列的任务的功能,通过任务或者一个命名的任务列表上定义标记,标记可以在运行Playbook时选择你需要执行的任务或者列表

简述Ansible的Roles角色

数据中心有各种不同类型的主机。如web服务器、数据库服务器,基于开发环境的服务器。随着时间的推移,具有处理所有这些情况的任务和人员的Ansible playbook将变得庞大而复杂。

  • 角色允许将复杂的剧本组织成独立的、更小的剧本和文件。
  • 角色提供了一种从外部文件加载任务、处理程序和变量的方法。
  • 角色也可关联和引用静态的文件和模板。
  • 角色可以编写成满足普通用途需求,并且能被重复利用。
  • 定义角色的文件具有特定的名称,并以严格的目录结构进行组织。

  • 20
    点赞
  • 24
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值