ansiblepalybook本地安装 ansible playbook实例

文章目录

• 一、playbook 剧本概述

• 1.playbook 格式
• 2.plaubooks 本身有这几个部分组成
• 3.yaml 基本语法规则
• 4.yaml支持的数据结构

• 二、示例

• 1.定义、引用变量
• 2. 指定远程主机sudo切换用户
• 3. when 条件判断
• 4. 迭代
• 5. Tmplates 模块
• 6. tags 模块
• 7. Roles 模块
• 7. Roles 模块

一、playbook 剧本概述

• playbook是ansible用于配置，部署，和管理被控节点的剧本。通过playbook的详细描述，执行其中的tasks，可以让远端主机达到预期的状态。playbook是由一个或多个”play”组成的列表。 当对一台机器做环境初始化的时候往往需要不止做一件事情，这时使用playbook会更加适合。通过playbook你可以一次在多台机器执行多个指令。通过这种预先设计的配置保持了机器的配置统一，并很简单的执行日常任务
• ansible通过不同的模块实现相应的管理，管理的方式通过定义的清单文件(hosts)所管理的主机包括认证的方式连接的端口等。所有的功能都是通过调用不同的模块(modules)来完成不同的功能的。不管是执行单条命令还是play-book都是基于清单文件

1.playbook 格式

• playbook由YMAL语言编写。YMAL格式是类似于JSON的文件格式，便于人理解和阅读，同时便于书写
• 一个剧本里面可以有多个play，每个play只能有一个tasks，每个tasks可以有多个name
• 通过 task 调用 ansible 的模块将多个 play 组织在一 个playbook中运行

2.plaubooks 本身有这几个部分组成

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

3.yaml 基本语法规则

1、大小写敏感
2、使用缩进表示层级关系
3、缩进时不允许使用tab键、只允许使用空格
4、缩进的空格数目不重要，只要相同层级的元素左侧对齐即可

yaml 里的参数解释

名称	解释
hosts	定义节点，可以是组
remote_user	是你以什么用户身份进行登陆
tasks	是你的任务
become:yes	表示切换用户
become_user: mysql	表示切换到mysql用户，配合上一条使用
- name:	为下面执行的操作起名

4.yaml支持的数据结构

1、对象：键值对的集合，又称为映射（mapping）/ 哈希（hashes）/ 字典（dictionary）

2、数组：一组按次序排列的值，又称为序列（sequence）/ 列表（list）

3、纯量：单个的、不可再分的值

二、示例

#以下操作的机器都是基于上一篇博客

vim test1.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，从而避免多次重启


————————————————————————————————————————————————————————————————————————
[root@localhost home]# pwd
/home
[root@localhost home]# vim q1.yaml
---
- name: first play
  gather_facts: false
  hosts: dbservers
  remote_user: root
  tasks:
   - name: test connection
     ping:
   - name: disable selinux
     command: '/sbin/setenforce 0'
     ignore_errors: true
   - name: disable firewalld
     service: name=firewalld state=stopped enabled=no
   - 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
     notify: "restart httpd"
   - name: start httpd service
     service: enabled=true name=httpd state=started
  handlers:
   - name: restart httpd
     service: name=httpd state=restarted

#把事先准备好的httpd.conf文件拖到opt目录下
[root@localhost home]# cd /opt
[root@localhost opt]# ls
 httpd.conf 
 
 #再次访问还是可以的，因为我改了httpd.conf文件里的端口号，改为了8080就是为了验证
 vim /opt/httpd.conf   #更改路径的配置文件

#1.运行playbook
[root@localhost home]# ansible-playbook q1.yaml 
常用参数：
-k (-ask-pass) :用来交互输入ssh密码
-K (-ask-become- pass) :用来交互输入sudo密码
u:指定用户




#检查yaml文件的语法是否正确
[root@localhost home]# ansible-playbook q1.yaml --syntax-check

#检查tasks任务
[root@localhost home]# ansible-playbook q1.yaml --list-task

#检查生效的主机
[root@localhost home]# ansible-playbook q1.yaml --list-hosts

#指定从某个task开始运行
[root@localhost home]# ansible-playbook q1.yaml --start-at-task='install httpd'

#在命令行里定义变量
ansible-playbook test1.yaml -e "username-nginx"

#把事先准备好的httpd.conf文件拖到opt目录下

#运行playbook，

#若有这个红色保错，可以不用理会，因为是你被管理的机器核心防护已经是关着的了，所有会报错

#再次访问还是可以的，因为我改了httpd.conf文件里的端口号，改为了8080就是为了验证，下图所示

vim /opt/httpd.conf

#检查yaml文件的语法是否正确

#检查tasks任务

#检查生效的主机

1.定义、引用变量

解释：
- name: second play
  hosts: dbservers
  remote_ user: root
  vars:                #定义变量
   - groupname:mysql   #格式为key: value
   - username: nginx
  tasks:
   - name: create mysql group
     group: name={{groupname}} system=yes gid=306     #使用{{key}} 引用变量的值
   - name: create nginx user
     user: name={{username}} uid=306 group={{groupname}}
   - name: copy info file
     copy: content="{{ansible_default_ipv4}}" dest=/opt/vars.txt    #在setup模块中可以获取facts变量信息

ansible-playbook test1.yaml -e "username=nginx"   #在命令行里定义变量

————————————————————————————————————————————————————————————————————————
例：
[root@localhost home]# pwd
/home
[root@localhost home]# vim q2.yaml
- name: second play
  hosts: dbservers
  remote_user: root
  vars:
   - groupname: mysql
   - username: nginx
  tasks:
   - name: create mysql group
     group: name={{groupname}} system=yes gid=1001
   - name: create nginx user
     user: name={{username}} uid=1001 group={{groupname}}
   - name: copy info file
     copy: content="{{ansible_default_ipv4}}" dest=/opt/vars.txt
     
     
#运行playbook
[root@localhost home]# ansible-playbook q2.yaml

#被管理机器查看dbservers组下的机器
[root@localhost conf]#  tail -3  /etc/passwd
qi:x:1000:1000:qi:/home/qi:/bin/bash
apache:x:48:48:Apache:/usr/share/httpd:/sbin/nologin
nginx:x:1001:1001::/home/nginx:/bin/bash

#在命令行里定义变量
[root@localhost home]# ansible-playbook q2.yaml -e "username=nginx"

#运行playbook

#被管理机器查看dbservers组下的机器

#在命令行里定义变量

2. 指定远程主机sudo切换用户

解释：目前设备不支持验证结果，此实验仅做了解
---
- hosts: dbservers
  remote user: root
  become: yes                #2.6版本以后的参数，之前是sudo，意思为切换用户运行
  become_ user: zhangsan     #指定sudo用户为zhangsan
执行playbook时: ansible-playbook test1.yml -K <密码

3. when 条件判断

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

解释：
---
- hosts: all
  remote user: root
  tasks:
  - name: shutdown host
    command: /sbin/shutdown -r now
    when: ansible_default_ipv4.address == "192.168.80.12"   #when指令中的变量名不需要手动加上{{}}
或
    when: inventory_hostname == "<主机名>"
————————————————————————————————————————————————————————————————————————

例：
[root@localhost home]# pwd
/home
[root@localhost home]# vim q3.yaml
---
- hosts: all     #指定所有主机
  remote_user: root   #下面图中此行少了个下滑线
  tasks:
  - name: shutdown host     
    command: /sbin/shutdown -r now
    when: ansible_default_ipv4.address == "192.168.113.126"    #判断若是192.168.113.126就给他关机，下面图片，可以看到192.168.113.128不配就直接略过了
 
 
#运行playbook
[root@localhost home]# ansible-playbook q3.yaml

#运行playbook

#机器以关机

4. 迭代

#Ansible提供了很多种循环结构，一般 都命名为with_items， 作用等同于loop循环
例：
[root@localhost home]# pwd
/home
[root@localhost home]# vim q4.yaml
- name: play1
  hosts: dbservers
  gather_facts: false
  tasks:
   - name: create directories
     file:
       path: "{{item}}"
       state: directory
     with_items:
       - /opt/m1
       - /opt/m2
   - name: add users
     user: name={{item.name}} state=present groups={{item.groups}}
     
     with_items:
       - name: m1
         groups: wheel
       - name: m2
         groups: root
————————————————————————————————————————————————————————————————————————
方法二：
     with items:
       - {name:'test1'，groups: 'wheel'}
       - {name:'test2'，groups: 'root'}
————————————————————————————————————————————————————————————————————————         
#运行playbook
[root@localhost home]# ansible-playbook q4.yaml

#去dbservers主机查看
[root@localhost ~]# cd /opt
[root@localhost opt]# ls
[root@localhost opt]# tail -3 /etc/passwd

5. Tmplates 模块

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

#1.先准备一个以.j2 为后缀的template 模板文件，设置引用的变量
[root@localhost opt]# cp /opt/httpd.conf /opt/httpd.conf.j2

#修改配置文件
[root@localhost opt]# vim /opt/httpd.conf.j2 
Listen {{http_port}}         #42行，修改
ServerName {{server_name}}    #95行，取消注释修改
DocumentRoot "{{root_dir}}"   #119行，修改

#2.修改主机清单文件


#3.编写playbook
[root@localhost home]# pwd
/home
[root@localhost home]# vim q5.yaml 
- hosts: all
  remote_user: root
  vars:
    - package: httpd
    - service: httpd
  tasks:
    - 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: create root dir
      file: path=/etc/httpd/htdocs state=directory
    - name: start httpd server
      service: name={{service}} enabled=true state=started
  handlers:
    - name: restart httpd
      service: name={{service}} state=restarted

#运行playbook
[root@localhost home]# ansible-playbook q5.yaml

#浏览器访问
192.168.113.128
192.168.113.126

#修改配置文件

#修改主机清单文件

#编写playbook

#运行playbook

#浏览器访问测试

6. tags 模块

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

例：
[root@localhost home]# pwd
/home
[root@localhost home]# vim webhosts.yaml
- hosts: webservers
  remote_user: root
  tasks:
   - name: copy hosts file
     copy: src=/etc/hosts dest=/opt/hosts
     tags:
      - xlh     #可自定义标签
   - name: touch file
     file: path=/opt/testhost state=touch
     tags:
     - always    #表示始终要运行的代码
     
#运行playbook，加标签
[root@localhost home]#ansible-playbook webhosts.yaml --tags="xlh"

#运行playbook，不加标签
[root@localhost home]#ansible-playbook webhosts.yaml

若不加标签运行会发现webservers opt目录下有两个文件

若加了标签运行会发现webservers opt目录下有一个文件

注：是在不加 下面的表示始终要运行的代码

tags:

always

7. Roles 模块

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

mg-dDxksdFm-1663847852517)]

若加了标签运行会发现webservers opt目录下有一个文件

注：是在不加 下面的表示始终要运行的代码

tags:

always

7. Roles 模块

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