ansible的脚本-----playbook剧本

目录

  • 一、主机清单
    • 主机
    • Inventory变量
  • 二、YAML
    • 基本语法规则:
    • YAML支持的数据结构:
    • yaml示例:
  • 三、playbook剧本
    • playbooks本身由以下各部分组成
    • playbook示例
    • playbook命令
    • hosts和users介绍
    • 指定远程主机 sudo 切换用户
    • tasks列表和action
    • Handlers
    • playbook使用变量的方法
    • 条件测试

一、主机清单

ansible默认的主机清单是/etc/ansible/hosts文件
主机清单可以手动设置,也可以通过Dynamic Inventory动态生成
一般主机名使用FQDN

主机

vim /etc/ansible/hosts
[webserver]          //设置组名
www1.example.org     //定义被监控主机
www2.example.org:2222     //冒号后定义远程连接端口,默认是ssh的22端口
#如果是名称类似的主机,可以使用列表的方式标记各个主机
[webserver]
www[01:50].example.org ansible_ssh_user=root ansible_ssh_pass=123123

[dbbservers]
db-[a:f].example.org    //支持配置abc...f

Inventory变量

下面是Inventory中变量

(1)主机变量

[webserver]
www1.magedu.com http_port=80 maxRequestsChild=808
www2.magedu.com http_port=8080 maxRequestsChild=909

(2)组变量

[servers:vars]
ntp_server=ntp.example.org 
nts_server=nts.example.org 

(3)组嵌套

[apache]
http1.example.org 
http2.example.org

[nginx]
ngx1.example.org
ngx2.example.org

[webservers:children]
apache
nginx

(4)inventory变量参数

参数 说明
ansible_ssh_host 将要连接的远程主机名,与你想要设定的主机的别名不同的话,可以通过此变量设置。
ansible_ssh_port ssh端口号如果不是默认端口号,通过此变量设置。
ansible_ssh_user 默认的ssh用户名。
ansible_ssh_pass ssh密码(这种方式并不安全,我们建议使用 --ask-pass 或SSH密钥)。
ansible_ssh_private_key_file ssh使用的私钥文件,适用于有多个密钥,但你不想使用 SSH 代理的情况。
ansible_ssh_common_args 此设置附加到sftp,scp和ssh的缺省命令行。
ansible_sftp_extra_args 此设置附加到默认sftp命令行。
ansible_scp_extra_args 此设置附加到默认scp命令行。
ansible_ssh_extra_args 此设置附加到默认ssh命令行。
ansible_ssh_pipelining 确定是否使用SSH管道。这可以覆盖ansible.cfg中的设置。
ansible_shell_type 目标系统的shell类型。默认情况下,命令的执行使用 ’ sh ’ 语法,可设置为 ’ csh ’ 或 ’ fish '。
ansible_python_interpreter 目标主机的 python路径.适用于的情况: 系统中有多个 Python , 或者命令路径不是"/usr/bin/python",比如 *BSD, 或者 /usr/bin/python。
ansible_*_interpreter 这里的"*"可以是 ruby 或 perl 或其他语言的解释器,作用和 ansible_python_interpreter 类似。
ansible_shell_executable 这将设置 ansibie 控制器将在目标机器上使用的 shell ,覆盖 ansible.cfg 中的配置,默认为 /bin/sh。

二、YAML

YAML:另一种标记语言。是用来写配置文件的语言,非常简洁和强大。
YAML语法和其他语言类似,也可以表达散列表、标量等数据结构。
结构通过空格来展示;序列里配置项通过-来代表;Map里键值用:来分隔;YAML的扩展名为yaml

基本语法规则:

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

YAML支持的数据结构:

1.对象:键值对的集合,又称为映射(mapping)/ 哈希(hashes) / 字典(dictionary)
例如:name:Example Developer

2.数组:一组按次序排列的值,又称为序列(sequence) / 列表(list)
例如:-Apple
-Orange

3.纯量:单个的、不可再分的值
例如:number:12.30
sure:true

yaml示例:

name:zhangsan
age:20
name:lisi
age:22

people:
-name:zhangsan
age:20
-name:lisi
age:22

三、playbook剧本

通过tesk调用ansible的模板将多个play组织在一个playbook中运行。

playbooks本身由以下各部分组成

(1)Tasks:任务,即调用模块完成的某个操作
(2)Variables:变量
(3)Templates:模板
(4)Handlers:处理器,当某条件满足时,触发执行的操作
(5)Roles:角色

playbook示例

每个“ - ”后接空格,“ : ”后接空格,注意层次的区分

- hosts: webserver    //定义的主机
  vars:     //自定义变量(格式都是键值对)
    http_port: 80
    max_clients: 200
  user: root     //指定用户
  tasks:     //执行的任务
  - name: ensure apache is at the latest version
    yum: pkg=httpd state=latest
  - name: write the apache config file
    template: src=/srv/httpd.j2 dest=/etc/httpd.conf
    notify:     //调用下面具体操作
    - restart apache
  - name: ensure apache is running
    service: name=httpd state=started
  handlers:     //处理器
    - name: restart apache
      service: name=httpd state=restarted

playbook命令

#执行playbook
ansible-playbook [yaml文件名]

#补充:
ansible-playbook [yaml文件] --syntax-check    //检查yaml文件语法格式
ansible-playbook [yaml文件] --list-task    //检查tasks任务
ansible-playbook [yaml文件] --list-hosts    //检查生效的主机
ansible-playbook [yaml文件] --start-at-task='[yaml文件中具体的任务名]'    //表示从这行任务开始,可看作检查具体任务

hosts和users介绍

#hosts和users介绍

- hosts: webserver    //指定主机
  remote_user: root     //指定远程主机执行的用户

参数:-k(- ask-pass) 用来交互输入ssh密码
-K(-ask-become-pass)用来交互输入sudo密码
-u 指定用户

#为每个任务定义远程执行用户(mysql先创建mysql用户)

- hosts: mysql
  remote_user: root
  tasks:
   - name: test connection
     ping:
     remote_user: mysql		

执行playbook时:  ansible-playbook ping.yml -k

指定远程主机 sudo 切换用户

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

 - hosts: mysql
   remote_user: root
   become: yes        
   become_user: mysql
  

执行playbook时: ansible-playbook ping.yml -K

tasks列表和action

1、Play的主体部分是task列表,task列表中的各任务按次序逐个在hosts中指定的主机上执行,即在所有主机上完成第一个任务后再开始。在运行playbook时 (从上到下执行),如果一个host执行task失败, 整个tasks都会回滚,请修正playbook中的错误,然后重新执行,即Task的目的是使用指定的参数执行模块,而在模块参数中可以使用变量,模块执行时幂等的,这意味着多次执行是安全的,因为其结果一定的。
2、每一个task必须有一个名称 name,这样在运行playbook时,从其输出的任务执行信息中可以很好的辨别出是属于哪一个task的。
3、定义一个task,常见的格式: ”module: options" 例如: yum: name =httpd
4、ansible的自带模块中,command模块和shell模块无需使用key=value格式

#tasks列表和action

- hosts: mysql
  remote_user: root
  tasks:
   - name: disable selinux
     command: '/usr/sbin/setenforce 0'
   - name: install httpd
     yum: name=httpd
   - name: start httpd
     service: name=httpd state=started
- hosts: webserver
  remote_user: root
  tasks:
  - name: create nginx group
    group: name=nginx system=yes gid=208
  - name: create nginx user
    user: name=nginx uid=208 group=nginx system=yes

- hosts: mysql
  remote_user: root
  tasks:
  - name: copy file to mysql
    copy: src=/etc/inittab dest=/opt/inittab.back

Handlers

Handlers也是一些task的列表, 和一般的task并没有什么区别。
是由通知者进行的notify,如果没有被notify,则Handlers不会执行,假如被notify了 ,则Handlers被执行不管有多少个通知者进行了notify,等到play中的所有task执行完成之后,handlers也只会被执行一次

#Handlers

- hosts: mysql
  remote_user: root
  tasks:
   - name: install httpd package
     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
#也可以引入变量
- hosts: mysql
  remote_user: root
  vars:
  - package: httpd
  - service: httpd
  tasks:
  - name: install configuration file for httpd
    yum: name={{package}} 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={{service}} state=started
  handlers:
  - name: restart httpd
    service: name={{service}} state=restarted

playbook使用变量的方法

1、通过ansible命令传递

vi a.yaml

 - hosts: mysql
   remote_user: root
   vars:
   - user:
   tasks:
   - name: add new user 
     user: name={{user}}


然后执行命令: ansible-playbook a.yml -e "user=testvar"

可以执行命令查看: ansible mysqI -m command -a 'tail /etc/passwd'

2、直接在yamI中定义变量,如上面的handlers

 - hosts: mysql
   remote_user: root
   vars:
   - user: lisi
   tasks:
   - name: add new user 
     user: name={{user}}

3、直接引用一些变量

: 引用ansible 的固定变量

 - hosts: mysql
   remote_user: root
   tasks:
   - name: copy file
     copy: content="{{ansible_all_ipv4_addresses}}" dest=/opt/vars.txt
     

4、引用主机变量

vim  /etc/ansible/hosts
#在mysq|组的主机后面添加如下
[mysql]
192.168.109.88 testvar="8080"
#定义testvar变量的值为8080

vi test.yaml     #添加{{testvar}}主机变量
 - hosts: mysql
   remote_user: root
   tasks:
   - name: copy file
     copy: content="{{ansible_all_ipv4_addresses}},{{testvar}}" dest=/opt/vars.txt

执行命令: ansible-playbook test.yaml

条件测试

如果需要根据变量、facts (setup) 或此前任务的执行结果来作为某task执行与否的前提时要用到条件测试,在Playbook中条件测试使用。在task后添加when子句即可使用条件测试: when子句支持 jinjia2 表达式或语法。

1、单条件判断

vi when.yml
 - hosts: mysql
   remote_user: root
   tasks:
     - name: "shutdown CentOS"
       command: /sbin/shutdown -h now
       when: ansible_distribution == "CentOS"    //满足条件就关闭

2、多条件判断

vi when.yml
 - hosts: mysql
   remote_user: root
   tasks:
   - name: "shut down CentOS 7 systems"
     command: /sbin/shutdown -r now
     when:
     - ansible_distribution == "CentOS"
     - ansible_distribution_major_version == "7"     //且关系(需要满足两个条件)

3、组条件判断

vi when.yml
 - hosts: mysql
   remote_user: root
   tasks:
    - name: "shut down CentOS 6 and Debian 7 systems"
      command: /sbin/shutdown -t now
      when: (ansible_distribution == "CentOS" and ansible_distribution_major_version == "6") or (ansible_distribution == "Debian" and ansible_distribution_major_version == "7")    //and是“且”关系,or是“或”关系

4、自定义变量进行条件测试 (version2.9版本后被移出,无法使用)

vi when.yml
 - hosts: all 
   vars:
    exist: "True" 
   tasks:
   - name: creaet file
     command: touch /tmp/test.txt
     when: exist | match("True")
     
   - name: delete file
     command: rm -rf /tmp/test.txt
     when: exist | match("False")

5、迭代

当有需要重复性执行的任务时,可以使用迭代机制。其使用格式为将需要迭代的内容定义为item变量引用,并通过with_items语句指明迭代。

 - hosts: webserver
   remote_user: root
   tasks:
   - name: "Install Packages"
     yum: name={{ item }} state=latest
     with items:
     - httpd
     - mysql-server
     - php

也可以自己定义
 - hosts: webserver
   remote_user: root
   tasks:
   - name: "Add users"
     user: name={{ item.name }} state=present groups={{ item.groups }}
     with_items:
      - { name: 'test1', groups: 'wheel'}
      - { name: 'test2', groups: 'root'}

你可能感兴趣的:(ansible)