• Ansible---playbook 剧本

    目录

    一、playbook

    1.1 playbook的组成

    二、playbook的编写格式（示例）

    1、定义、引用变量

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

    3、when条件判断

    4、迭代

    5、Templates 模块

    6、tags 模块

    7、Roles 模块

    一、playbook

    • playbook是剧本的意思
    • 通过 task 调用 ansible 的模块将多个 play 组织在一 个playbook中运行。

    1.1 playbook的组成

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

    二、playbook的编写格式（示例）

    playbook基于yaml语言编写

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

    1、定义、引用变量

    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.  
    16. ansible-playbook test1.yaml -e "username=nginx"     #在命令行里定义变量

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

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

    3、when条件判断

    • 在Ansible中，提供的唯一一个通用的条件判断是when指令，当when指令的值为true时，则该任务执行，否则不执行该任务。
    • when一个比较常见的应用场景是实现跳过某个主机不执行任务或者只有满足条件的主机执行任务
    1. vim test2.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.247.23"      #when指令中的变量名不需要手动加上 {{}}
    9. 或 
    10.      when: inventory_hostname == "<主机名>"
    11.  
    12. ansible-playbook test2.yaml

    4、迭代

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

    1. vim test3.yaml
    2. ---
    3. - name: play1
    4.   hosts: dbservers
    5.   tasks: 
    6.     - name: create directories
    7.       file:
    8.         path: "{{item}}"
    9.         state: directory
    10.       with_items:          #等同于 loop:
    11.         - /tmp/test1
    12.         - /tmp/test2
    13.     - name: add users
    14.       user: name={{item.name}} state=present groups={{item.groups}}
    15.       with_items:
    16.         - name: test1
    17.           groups: wheel
    18.         - name: test2
    19.           groups: root
    20. 或
    21.       with_items:
    22.         - {name:'test1', groups:'wheel'}
    23.         - {name:'test2', groups:'root'}
    24.  
    25. ansible-playbook test3.yaml

    5、Templates 模块

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

    • 先准备一个以 .j2 为后缀的 template 模板文件，设置引用的变量
    1. cp /etc/httpd/conf/httpd.conf /opt/httpd.conf.j2
    2.  
    3. vim /opt/httpd.conf.j2
    4. Listen {{http_port}}				#42行，修改
    5. ServerName {{server_name}}			#95行，修改
    6. DocumentRoot "{{root_dir}}"          #119行，修改
    7.
    • 修改主机清单文件，使用主机变量定义一个变量名相同，而值不同的变量
    1. vim /etc/ansible/hosts       
    2. [webservers]
    3. 192.168.247.22 http_port=192.168.247.22:80 server_name=www.accp.com:80 root_dir=/etc/httpd/htdocs
    4.  
    5. [dbservers]
    6. 192.168.247.23 http_port=192.168.247.23:80 server_name=www.benet.com:80 root_dir=/etc/httpd/htdocs
    • 编写 playbook 
    1. vim apache.yaml
    2. ---
    3. - hosts: all
    4.   remote_user: root
    5.   vars:
    6.     - package: httpd
    7.     - service: httpd
    8.   tasks:
    9.     - name: install httpd package
    10.       yum: name={{package}} state=latest
    11.     - name: install configure file
    12.       template: src=/opt/httpd.conf.j2 dest=/etc/httpd/conf/httpd.conf     #使用template模板
    13.       notify:
    14.         - restart httpd
    15.     - name: create root dir
    16. 	  file: path=/etc/httpd/htdocs state=directory
    17.     - name: start httpd server
    18.       service: name={{service}} enabled=true state=started
    19.   handlers:
    20.     - name: restart httpd
    21.       service: name={{service}} state=restarted
    22.  
    23. ansible-playbook apache.yaml

    6、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    #表示始终要运行的代码
    1. vim dbhosts.yaml
    2. ---
    3. - hosts: dbservers
    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.  
    13. ansible-playbook dbhosts.yaml --tags="only"

    7、Roles 模块

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

    • 创建以 roles 命名的目录
    mkdir /etc/ansible/roles/ -p    #yum装完默认就有
    • 创建全局变量目录（可选）
    1. mkdir /etc/ansible/group_vars/ -p
    2. touch /etc/ansible/group_vars/all     #文件名自己定义，引用的时候注意
    • 在 roles 目录中分别创建以各角色名称命令的目录，如 httpd、mysql
    1. mkdir /etc/ansible/roles/httpd
    2. mkdir /etc/ansible/roles/mysql
    • 在每个角色命令的目录中分别创建

    files、handlers、tasks、templates、meta、defaults和vars目录，用不到的目录可以创建为空目录，也可以不创建
     

    1. mkdir /etc/ansible/roles/httpd/{files,templates,tasks,handlers,vars,defaults,meta}
    2. mkdir /etc/ansible/roles/mysql/{files,templates,tasks,handlers,vars,defaults,meta}
    • 在每个角色的 handlers、tasks、meta、defaults、vars 目录下创建 main.yml 文件，千万不能自定义文件名
    1. touch /etc/ansible/roles/httpd/{defaults,vars,tasks,meta,handlers}/main.yml
    2. touch /etc/ansible/roles/mysql/{defaults,vars,tasks,meta,handlers}/main.yml
    • 修改 site.yml 文件，针对不同主机去调用不同的角色
    1. vim /etc/ansible/site.yml
    2. ---
    3. - hosts: webservers
    4.   remote_user: root
    5.   roles:
    6.      - httpd
    7. - hosts: dbservers
    8.   remote_user: root
    9.   roles:
    10.      - mysql
    • 运行 ansible-playbook
    1. cd /etc/ansible
    2. ansible-playbook site.yml

    示例：

    （1）在 roles 目录中分别创建以各角色名称命令的目录

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

    （2）在每个角色的 handlers、tasks、meta、defaults、vars 目录下创建 main.yml 文件，千万不能自定义文件名

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

    （3）编写httpd模块

    • 写一个简单的tasks/main.yml
    1. vim /etc/ansible/roles/httpd/tasks/main.yml
    2. - name: install apache
    3.   yum: name={{pkg}} state=latest
    4. - name: start apache
    5.   service: enabled=true name={{svc}} state=started
    • 定义变量：可以定义在全局变量中，也可以定义在roles角色变量中，一般定义在角色变量中
    1. vim /etc/ansible/roles/httpd/vars/main.yml
    2. pkg: httpd
    3. svc: httpd

    （4）编写mysql模块

    1. vim /etc/ansible/roles/mysql/tasks/main.yml
    2. - name: install mysql
    3.   yum: name={{pkg}} state=latest
    4. - name: start mysql
    5.   service: enabled=true name={{svc}} state=started
    1. vim /etc/ansible/roles/mysql/vars/main.yml
    2. pkg:
    3.   - mariadb
    4.   - mariadb-server
    5. svc: mariadb

    （5）编写php模块

    1. vim /etc/ansible/roles/php/tasks/main.yml
    2. - name: install php
    3.   yum: name={{pkg}} state=latest
    4. - name: start php-fpm
    5.   service: enabled=true name={{svc}} state=started
    6.  
    7. vim /etc/ansible/roles/php/vars/main.yml
    8. pkg:
    9.   - php
    10.   - php-fpm
    11. svc: php-fpm

    （6）编写roles示例

    1. vim /etc/ansible/site.yml
    2. ---
    3. - hosts: webservers
    4.   remote_user: root
    5.   roles:
    6.    - httpd
    7.    - mysql
    8.    - php
    9.

    启动

    1. cd /etc/ansible
    2. ansible-playbook site.yml
  • 相关阅读:
    每日一题｜2022-11-7｜816. 模糊坐标｜字符串枚举｜Golang
    [附源码]Java计算机毕业设计SSM动漫周边e商城
    react 实战- 玩转 react 全家桶(进阶)学习
    Python爬虫数据存哪里|数据存储到文件的几种方式
    Ubuntu安装grafana并配置influxdb数据源
    ThreeJS-3D教学一：基础场景创建
    如何从 OpenVINO 的主分支构建 Python Wheel 包
    【matplotlib基础】--画布
    创建高性能的索引
    DBPack SQL Tracing 功能及数据加密功能详解
  • 原文地址：https://blog.csdn.net/weixin_46254171/article/details/133814738