Playbook简单使用

小鱼儿 2022-06-07 11:59 177阅读 0赞

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

playbook通过ansible-playbook命令使用,它的参数和ansible命令类似,如参数-k(–ask-pass) 和 -K (–ask-sudo) 来询问ssh密码和sudo密码,-u指定用户,这些指令也可以通过规定的单元写在playbook 。

ansible-playbook的简单使用方法: ansible-playbook example-play.yml 。

### 一、一个简单的示例 ###

下面是一个简单的ansible-playbook示例，可以了解其构成:

# cat user.yml
    - name: create user
      hosts: all
      user: root
      gather_facts: false
      vars:
       user:"test"
      tasks:
       - name: create  user
        user: name="{
      { user }}"

上面的playbook 实现的功能是新增一个用户：

name参数对该playbook实现的功能做一个概述，后面执行过程中，会打印 name变量的值 ；

hosts参数指定了对哪些主机进行参作；

user参数指定了使用什么用户登录远程主机操作；

gather\_facts参数指定了在以下任务部分执行前，是否先执行setup模块获取主机相关信息，这在后面的task会使用到setup获取的信息时用到；

vars参数，指定了变量，这里指定一个user变量，其值为test ，需要注意的是，变量值一定要用引号引住；

task指定了一个任务，其下面的name参数同样是对任务的描述，在执行过程中会打印出来。user提定了调用user模块，name是user模块里的一个参数，而增加的用户名字调用了上面user变量的值。

同样，如果想实现把这个新增的用户删除，只需将该playbook文件的最后一行替换为如下行再执行相应的playbook即可：

user: name="{
      { user }}" state=absent remove=yes

### 二、通过Playbook安装apache示例 ###

通过ansible-playbook实现对多台主机同时同时安装apache。需要注意的是，多台被管理主机的操作系统可能不相同，而导致apache包名不同，假设同时存在CentOS和Debian两种操作系统，具体playbook内容如下：

# cat install_apache.yml
    - hosts: all
      remote_user: root
      gather_facts:True
      tasks:
    - name: install apache on CentOS
      yum: name=httpd state=present
      when: ansible_os_family =="CentOS" 
    - name: install apache on Debian
      yum: name=apache2 state=present
      when: ansible_os_family =="Debian"

上面使用了when语句，同时也开启了gather\_facts setup模块，这里的ansible\_os\_family变量和就是直接使用的setup模块获取的信息。如果有大量主机，就在运行的时候加上-f然后选择一个合适的并发主机数量即可。

### 三、playbook的构成 ###

playbook是由一个或多个"play"组成的列表。play的主要功能在于将事先归并为一组的主机装扮成事先通过ansible中的task定义好的角色。从根本上来讲所谓task无非是调用ansible的一个module。将多个play组织在一个playbook中即可以让它们联同起来按事先编排的机制同唱一台大戏。其主要有以下四部分构成:

playbooks组成：
      Target section：   定义将要执行 playbook 的远程主机组
      Variable section： 定义 playbook 运行时需要使用的变量
      Task section：     定义将要在远程主机上执行的任务列表
      Handler section：  定义 task 执行完成以后需要调用的任务

而其对应的目录层为五个，如下：

一般所需的目录层有：(视情况可变化)
      vars     变量层
      tasks    任务层
      handlers 触发条件
      files    文件
      template 模板

#### 1、Hosts和Users ####

playbook中的每一个play的目的都是为了让某个或某些主机以某个指定的用户身份执行任务。

hosts：用于指定要执行指定任务的主机其可以是一个或多个由冒号分隔主机组。

remote\_user ：用于指定远程主机上的执行任务的用户。不过remote\_user也可用于各task中。也可以通过指定其通过sudo的方式在远程主机上执行任务其可用于play全局或某任务。此外甚至可以在sudo时使用sudo\_user指定sudo时切换的用户。

user：于remote\_user相同

sudo：如果设置为yes，执行该任务组的用户在执行任务的时候，获取root权限

sudo\_user：如果设置user为breeze，sudo为yes，sudo\_user为bernie时，则breeze用户在执行任务时会获得bernie用户的权限

connection：通过什么方式连接到远程主机，默认为ssh

gather\_facts：除非明确说明不需要在远程主机上执行setup模块，否则默认自动执行。如果确实不需要setup模块传递过来的变量，则可以将该选项设置为False

示例：

- hosts: webnodes
      tasks:
       - name: test ping connection:
        remote_user: test
        sudo: yes

#### 2、任务列表和action ####

play的主体部分是任务列表。

任务列表中的各任务按次序逐个在hosts中指定的所有主机上执行即在所有主机上完成第一个任务后再开始第二个。在自上而下运行某playbook时如果中途发生错误，所有已执行任务都将回滚因此在更正playbook后重新执行一次即可。

task的目的是使用指定的参数执行模块，而在模块参数中可以使用变量。模块执行是幂等的，这意味着多次执行是安全的，因为其结果均一致。每个task都应该有其name用于            playbook的执行结果输出，建议其内容尽可能清晰地描述任务执行步骤。如果未提供name则action的结果将用于输出。

定义task的可以使用"action: module options"或"module: options"的格式，推荐使用后者以实现向后兼容。如果action一行的内容过多也可使用在行首使用几个空白字符进行换行。

tasks:
      - name: make sure apache is running
       service: name=httpd state=running

#在众多模块中只有command和shell模块仅需要给定一个列表而无需使用“key=value”格式例如
    tasks:
      - name: disable selinux
       command: /sbin/setenforce 0

#如果命令或脚本的退出码不为零可以使用如下方式替代
    tasks:
      - name: run this command and ignore the result
       shell: /usr/bin/somecommand || /bin/true

#使用ignore_errors来忽略错误信息
    tasks:
      - name: run this command and ignore the result
       shell: /usr/bin/somecommand
       ignore_errors: True

#### 3、handlers  ####

用于当关注的资源发生变化时采取一定的操作。  
"notify"这个action可用于在每个play的最后被触发，这样可以避免多次有改变发生时每次都执行指定的操作，取而代之仅在所有的变化发生完成后一次性地执行指定操作。  
在notify中列出的操作称为handler也即notify中调用handler中定义的操作。

注意：在notify中定义内容一定要和tasks中定义的 - name 内容一样，这样才能达到触发的效果，否则会不生效。

- name: template configuration file
      template: src=template.j2 dest=/etc/foo.conf
      notify:
       - restart memcached
       - restart apache

#handler是task列表这些task与前述的task并没有本质上的不同。
    handlers:
      - name: restart memcached
       service: name=memcached state=restarted
      - name: restart apache
        service: name=apache state=restarted

#### 4、tags ####

tags用于让用户选择运行或略过playbook中的部分代码。ansible具有幂等性，因此会自动跳过没有变化的部分，即便如此，有些代码为测试其确实没有发生变化的时间依然会非常地长。此时如果确信其没有变化就可以通过tags跳过这些代码片断。

#### 5、示例 ####

一个安装httpd web服务的示例：

# cat /etc/ansible/playbook/install_web.yml
    - hosts: webservers
      remote_user: root
      gather_fasks:False
      vars:
        packages: httpd
      tasks:

- name:Install httpd

yum: name={
      { packages }} state=present

- name:Cofiguration httpd

copy: src=/root/httpd.conf dest=/etc/httpd/conf/httpd.conf

tags: httpd_conf   
          notify:

- restart httpd

- name:Start httpd

service: name=httpd state=started enabled=no

tags: start

- name:Add centos user

user: name={
      { item }} state=absent

tags: adduser