• 自动化运维：Ansible脚本之playbook剧本

    一、理论

    1、playbook

    （1）playbook 概念

    ansbile-playbook是一系统ansible命令的集合，其利用yaml 语言编写。

    运行过程，ansbile-playbook命令根据自上而下的顺序依次执行。同时，playbook开创了很多特性,它可以允许你传输某个命令的状态到后面的指令,如你可以从一台机器的文件中抓取内容并附为变量,然后在另一台机器中使用,这使得你可以实现一些复杂的部署机制,这是ansible命令无法实现的。

    （2）ansible的组成

    playbooks 本身由以下各部分组成
    （1）Tasks：任务，即通过 task 调用 ansible 的模板将多个操作组织在一个 playbook 中运行
    （2）Variables：变量
    （3）Templates：模板，即使用模板语法的文件
    （4）Handlers：处理器，当changed状态条件满足时，（notify）触发执行的操作
    （5）Roles：角色。可以组织 playbook。基于一个已知的文件结构，去自动的加载某些 vars_files，tas

    2.YAML

    （1）概念

    YAML是一个可读性高的用来表达资料序列的格式。YAML参考了其他多种语言，包括：XML、C语言、Python、Perl以及电子邮件格式RFC2822等。Clark Evans在2001年在首次发表了这种语言，另外Ingy döt Net与Oren Ben-Kiki也是这语言的共同设计者。

    （2）特性

    YAML Ain't Markup Language，即YAML不是XML。不过，在开发的这种语言时，YAML的意思其实是："Yet Another Markup Language"（仍是一种标记语言）。其特性：

    YAML的可读性好
     
    YAML和脚本语言的交互性好
     
    YAML使用实现语言的数据类型
     
    YAML有一个一致的信息模型
     
    YAML易于实现
     
    YAML可以基于流来处理
     
    YAML表达能力强，扩展性好

    （3）语法

    YAML的语法和其他高阶语言类似，并且可以简单表达清单、散列表、标量等数据结构。其结构（Structure）通过空格来展示，序列（Sequence）里的项用"-"来代表，Map里的键值对用":"分隔。下面是一个示例。

    1. ---.表明YAML一个文件的开始
    2. #表中的所有成员都开始于相同的缩进级别, 并且使用一个 "- " 作为开头(一个横杠和一个空格):如：
    3. ---
    4. # 一个美味水果的列表
    5. - Apple
    6. - Orange
    7. - Banana
    8. - Mango
    9.  
    10. #一个字典是由一个简单的 键: 值 的形式组成(这个冒号后面必须是一个空格):如
    11. ---
    12. # 一位职工的记录
    13. name: Example Developer
    14. job: Developer
    15. skill: Elite
    16.  
    17. #字典也可以写成一行，但要用大括号{}把它括起来
    18. ---
    19. # 一位职工的记录
    20. {name: Example Developer, job: Developer, skill: Elite}

    二、实验

    （1） 使用ansible批量安装apache服务

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

    运行playbook

    ansible-playbook test1.yaml

    补充参数

    1. -k（–ask-pass）：用来交互输入ssh密码
    2. -K（-ask-become-pass）：用来交互输入sudo密码
    3. -u：指定用户
    4.  
    5. ansible-playbook test1.yaml --syntax-check    #检查yaml文件的语法是否正确
    6. ansible-playbook test1.yaml --list-task       #检查tasks任务
    7. ansible-playbook test1.yaml --list-hosts      #检查生效的主机
    8. ansible-playbook test1.yaml --start-at-task='install httpd'     #指定从某个task开始运行

    （2）、定义、引用变量

    1. - name: second play
    2.   hosts: dbservers
    3.   remote_user: root
    4.   vars:                 #定义变量
    5.    - groupname: mysql   #格式为 key: value
    6.    - username: nginx
    7.   tasks:
    8.    - name: create group
    9.      group: name={{groupname}} system=yes gid=306    #使用 {{key}} 引用变量的值
    10.    - name: create user
    11.      user: name={{username}} uid=306 group={{groupname}} 
    12.    - name: copy file
    13.      copy: content="{{ansible_default_ipv4}}" dest=/opt/vars.txt    #在setup模块中可以获取facts变量信息
    14.  
    15.

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

    （3） 指定远程主机sudo切换用户
     

    1. ---
    2. - hosts: dbservers
    3.   remote_user: zhangsan            
    4.   become: yes                     #2.6版本以后的参数，之前是sudo，意思为切换用户运行
    5.   become_user: root              #指定sudo用户为root
    6. 执行playbook时：ansible-playbook test1.yml -K <密码>


    （4）when条件判断


    在Ansible中，提供的唯一一个通用的条件判断是when指令，当when指令的值为true时，则该任务执行，否则不执行该任务。

    //when一个比较常见的应用场景是实现跳过某个主机不执行任务或者只有满足条件的主机执行任务

    1. vim test3.yaml
    2. ---
    3. - hosts: all
    4.   remote_user: root
    5.   tasks:
    6.    - name: shutdown host 
    7.      command: /sbin/shutdown -r now
    8.      when: ansible_default_ipv4.address == "192.168.88.20"      #when指令中的变量名不需要手动加上 {{}}
    9. 或 
    10.      when: inventory_hostname == "<主机名>"
    11.     
    12. ansible-playbook tes3.yaml

    这里的报错是正常的，可以观察到20机器已经重启了


    （5） 迭代

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

    1. - name: play4
    2.   hosts: webservers
    3.   gather_facts: false
    4.   tasks:
    5.     - name: create dir
    6.       file: path={{item}} state=directory
    7.       with_items:
    8.         - /opt/t1
    9.         - /opt/t2
    10.         - /opt/t3

    可以看到webservers即192.168.88.20机器下的

    /opt目录下创建了指定文件夹

    （6） Templates 模块

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

    1.先准备一个以 .j2 为后缀的 template 模板文件，设置引用的变量

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

    vim /opt/httpd.conf.j2
    Listen {{http_port}}                #42行，修改
    ServerName {{server_name}}            #95行，修改
    DocumentRoot "{{root_dir}}"          #119行，修改

    2.修改主机清单文件，使用主机变量定义一个变量名相同，而值不同的变量
    vim /etc/ansible/hosts       


    [webservers]
    192.168.10.14 http_port=192.168.10.14:80 server_name=www.accp.com:80 root_dir=/etc/httpd/htdocs

    [dbservers]


    192.168.10.15 http_port=192.168.0.15:80 server_name=www.benet.com:80 root_dir=/etc/httpd/htdocs

    3.编写 playbook 
    vim apache.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     #使用template模板
          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

    ansible-playbook apache.yaml

     (7) tags 模块

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

    1. vim webhosts.yaml
    2. ---
    3. - hosts: webservers
    4.   remote_user: root
    5.   tasks:
    6.     - name: Copy hosts file
    7.       copy: src=/etc/hosts dest=/opt/hosts
    8.       tags:
    9.       - only     #可自定义
    10.     - name: touch file
    11.       file: path=/opt/testhost state=touch
    12.       tags:
    13.       - always    #表示始终要运行的代码
    14.  
    15. ansible-playbook webhosts.yaml --tags="only"
    16.  
    17. vim dbhosts.yaml
    18. ---
    19. - hosts: dbservers
    20.   remote_user: root
    21.   tasks:
    22.     - name: Copy hosts file
    23.       copy: src=/etc/hosts dest=/opt/hosts
    24.       tags:
    25.         - only
    26.     - name: touch file
    27.       file: path=/opt/testhost state=touch
    28.  
    29.  
    30. ansible-playbook dbhosts.yaml --tags="only"
    31. //分别去两台被管理主机上去查看文件创建情况

    到20机器上查看文件创建情况

    发现always标签是一定会执行的，同时指定的only也执行了


     (8) Roles 模块

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

    //roles 的目录结构：
    cd /etc/ansible/
    tree roles/
    roles/
    ├── web/
    │   ├── files/
    │   ├── templates/
    │   ├── tasks/
    │   ├── handlers/
    │   ├── vars/
    │   ├── defaults/
    │   └── meta/
    └── db/
        ├── files/
        ├── templates/
        ├── tasks/
        ├── handlers/
        ├── vars/
        ├── defaults/
        └── meta/


    //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 文件，用于定义此角色的特殊设定及其依赖关系。


    //在一个 playbook 中使用 roles 的步骤：
    （1）创建以 roles 命名的目录
    mkdir /etc/ansible/roles/ -p    #yum装完默认就有

    （2）创建全局变量目录（可选）
    mkdir /etc/ansible/group_vars/ -p
    touch /etc/ansible/group_vars/all     #文件名自己定义，引用的时候注意

    （3）在 roles 目录中分别创建以各角色名称命令的目录，如 httpd、mysql
    mkdir /etc/ansible/roles/httpd
    mkdir /etc/ansible/roles/mysql

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

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

    （6）修改 site.yml 文件，针对不同主机去调用不同的角色
    vim /etc/ansible/site.yml
    ---
    - hosts: webservers
      remote_user: root
      roles:
         - httpd
    - hosts: dbservers
      remote_user: root
      roles:
         - mysql


         

    （7）运行 ansible-playbook
    cd /etc/ansible
    ansible-playbook site.yml

    示例：
    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

    ------编写httpd模块------
    写一个简单的tasks/main.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


     
    //定义变量：可以定义在全局变量中，也可以定义在roles角色变量中，一般定义在角色变量中
    vim /etc/ansible/roles/httpd/vars/main.yml
    pkg: httpd
    svc: httpd

    -------编写mysql模块-------
    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


      
    vim /etc/ansible/roles/mysql/vars/main.yml
    pkg:
      - mariadb
      - mariadb-server
    svc: mariadb

    -------编写php模块-----
    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

    vim /etc/ansible/roles/php/vars/main.yml
    pkg:
      - php
      - php-fpm
    svc: php-fpm

    -----编写roles示例-----
    vim /etc/ansible/site.yml
    ---
    - hosts: webservers
      remote_user: root
      roles:
       - httpd
       - mysql
       - php


    cd /etc/ansible
    ansible-playbook site.yml

  • 相关阅读:
    分布式事务
    QT里使用sqlite的问题，好多坑
    【JavaEE】Java的前世今身
    如何选择适合的开源框架来构建微服务架构？
    是格式错了吗，为啥过不了啊
    类和对象（上）
    Stimulsoft Reports报告工具,Stimulsoft创建和构建报告
    尚硅谷Vue视频学习打卡-Vue组件化编程以及Vue脚手架的安装-简要介绍
    微软AI量化平台Qlib：你需要知道的核心知识点
    【毕业设计】深度学习 python opencv 实现人脸年龄性别识别
  • 原文地址：https://blog.csdn.net/manyulanlanlu/article/details/133840814