ansible 模块

2eew

一.什么是ansible

    什么是ansible？官方的title是“Ansibleis Simple IT Automation”—>简单的自动化IT工具。ansible功能：自动化部署APP；自动化管理配置项；自动化的持续交付；自动化的（AWS）云服务管理。其本质就是在一个台或者几台服务器上，批量的执行命令。

       fabric和ansible有什么差别呢？简单来说fabric像是一个工具箱，提供了很多好用的工具，用来在Remote执行命令，而ansible则是提供了一套简单的流程，你要按照它的流程来做，就能轻松完成任务。当然，它们之间也是有共同点的——都是基于paramiko 开发的。paramiko是什么呢？它是一个纯Python实现的ssh协议库。因此fabric和ansible还有一个共同点就是不需要在远程主机上安装client/agent，因为它们是基于ssh来和远程主机通讯的。

Ansible的执行过程如下图所示，暖色调带便已经模块化。






ansible 模块



Ansible通过模块的方式来完成一些远程的管理工作。可以通过ansible-doc -l查看所有模块，可以使用ansible-doc -s module来查看某个模块的参数，也可以使用ansible-doc help module来查看该模块更详细的信息。下面列出一些常用的模块：


1. setup

可以用来查看远程主机的一些基本信息：

ansible -i /etc/ansible/hosts test -m setup


2.ping

可以用来测试远程主机的运行状态：

ansible test -m ping


3.file
设置文件的属性

file模块包含如下选项：

    force：需要在两种情况下强制创建软链接，一种是源文件不存在但之后会建立的情况下；另一种是目标软链接已存在,需要先取消之前的软链，然后创建新的软链，有两个选项：yes|no

    group：定义文件/目录的属组

    mode：定义文件/目录的权限

    owner：定义文件/目录的属主

    path：必选项，定义文件/目录的路径

    recurse：递归的设置文件的属性，只对目录有效

    src：要被链接的源文件的路径，只应用于state=link的情况

    dest：被链接到的路径，只应用于state=link的情况

    state：

            directory：如果目录不存在，创建目录

            file：即使文件不存在，也不会被创建

            link：创建软链接

            hard：创建硬链接

            touch：如果文件不存在，则会创建一个新的文件，如果文件或目录已存在，则更新其最后修改时间

            absent：删除目录、文件或者取消链接文件

示例：

    ansible test -m file -a "src=/etc/fstab dest=/tmp/fstab state=link"

    ansible test -m file -a "path=/tmp/fstab state=absent"

    ansible test -m file -a "path=/tmp/test state=touch"


4.copy

复制文件到远程主机

copy模块包含如下选项：

    backup：在覆盖之前将原文件备份，备份文件包含时间信息。有两个选项：yes|no

    content：用于替代"src",可以直接设定指定文件的值

    dest：必选项。要将源文件复制到的远程主机的绝对路径，如果源文件是一个目录，那么该路径也必须是个目录

    directory_mode：递归的设定目录的权限，默认为系统默认权限

    force：如果目标主机包含该文件，但内容不同，如果设置为yes，则强制覆盖，如果为no，则只有当目标主机的目标位置不存在该文件时，才复制。默认为yes

    others：所有的file模块里的选项都可以在这里使用

    src：要复制到远程主机的文件在本地的地址，可以是绝对路径，也可以是相对路径。如果路径是一个目录，它将递归复制。在这种情况下，如果路径使用"/"来结尾，则只复制目录里的内容，如果没有使用"/"来结尾，则包含目录在内的整个内容全部复制，类似于rsync。

    validate ：The validation command to run before copying into place. The path to the file to validate is passed in via '%s' which must be present as in the visudo example below.

示例：

    ansible test -m copy -a "src=/srv/myfiles/foo.conf dest=/etc/foo.conf owner=foo group=foo mode=0644"

    ansible test -m copy -a "src=/mine/ntp.conf dest=/etc/ntp.conf owner=root group=root mode=644 backup=yes"

    ansible test -m copy -a "src=/mine/sudoers dest=/etc/sudoers validate='visudo -cf %s'"


5.command

在远程主机上执行命令

command模块包含如下选项：

    creates：一个文件名，当该文件存在，则该命令不执行

    free_form：要执行的linux指令

    chdir：在执行指令之前，先切换到该指定的目录

    removes：一个文件名，当该文件不存在，则该选项不执行

    executable：切换shell来执行指令，该执行路径必须是一个绝对路径

示例：

    ansible test -a "/sbin/reboot"


6.shell

切换到某个shell执行指定的指令，参数与command相同。

示例：

    ansible test -m shell -a "somescript.sh >> somelog.txt"


7.service

用于管理服务

该模块包含如下选项：

    arguments：给命令行提供一些选项

    enabled：是否开机启动  yes|no

    name：必选项，服务名称

    pattern：定义一个模式，如果通过status指令来查看服务的状态时，没有响应，就会通过ps指令在进程中根据该模式进行查找，如果匹配到，则认为该服务依然在运行

    runlevel：运行级别

    sleep：如果执行了restarted，在则stop和start之间沉睡几秒钟

    state：对当前服务执行启动，停止、重启、重新加载等操作（started,stopped,restarted,reloaded）

示例：

    ansible test -m service -a "name=httpd state=started enabled=yes"

    ansible test -m service -a "name=foo pattern=/usr/bin/foo state=started"

    ansible test -m service -a "name=network state=restarted args=eth0"


8.cron

用于管理计划任务

包含如下选项：

    backup：对远程主机上的原任务计划内容修改之前做备份

    cron_file：如果指定该选项，则用该文件替换远程主机上的cron.d目录下的用户的任务计划

    day：日（1-31，*，*/2,……）

    hour：小时（0-23，*，*/2，……）

    minute：分钟（0-59，*，*/2，……）

    month：月（1-12，*，*/2，……）

    weekday：周（0-7，*，……）

    job：要执行的任务，依赖于state=present

    name：该任务的描述

    special_time：指定什么时候执行，参数：reboot,yearly,annually,monthly,weekly,daily,hourly

    state：确认该任务计划是创建还是删除

    user：以哪个用户的身份执行

示例：

    ansible test -m cron -a 'name="check dirs" hour="5,2" job="ls -alh > /dev/null"'

    ansible test -m cron -a 'name="a job for reboot" special_time=reboot job="/some/job.sh"'

    ansible test -m cron -a 'name="yum autoupdate" weekday="2" minute=0 hour=12 user="root" job="YUMINTERACTIVE=0 /usr/sbin/yum-autoupdate" cron_file=ansible_yum-autoupdate'

    ansilbe test -m cron -a 'cron_file=ansible_yum-autoupdate state=absent'


9.filesystem

在块设备上创建文件系统

选项：

    dev：目标块设备

    force：在一个已有文件系统的设备上强制创建

    fstype：文件系统的类型

    opts：传递给mkfs命令的选项


10.yum

使用yum包管理器来管理软件包

选项：

    config_file：yum的配置文件

    disable_gpg_check：关闭gpg_check

    disablerepo：不启用某个源

    enablerepo：启用某个源

    list

    name：要进行操作的软件包的名字，也可以传递一个url或者一个本地的rpm包的路径

    state：状态（present，absent，latest）

示例：

    ansible test -m yum -a 'name=httpd state=latest'

    ansible test -m yum -a 'name="@Development tools" state=present'

    ansible test -m yum -a 'name=http://nginx.org/packages/centos/6/noarch/RPMS/nginx-release-centos-6-0.el6.ngx.noarch.rpm state=present'

     

11.user

管理用户

    home:

    groups:

    uid

    password:

    name:

    createhome:

    system:

    remove:

    state:

    shell:

    需要特别说明的是，password后面指定的密码不能是明文，后面这一串密码会被直接传送到被管理主机的/etc/shadow文件中，而登陆的时候输入的密码会被hash加密以后再去与/etc/shadow中存放的密码去做对比，会出现不一致的现象。所以需要先将密码字符串进行加密处理：openssl passwd -salt -1 "123456"，然后将得到的字符串放到password中即可。


12.group

管理组


13.synchronize

使用rsync同步文件

    archive

    checksum

    delete

    dest

    src

    dest_port

    existing_only: skip createing new files on receiver

    links

    owner

    mode:(push, pull)

    recursive

    rsync_path

    times:Preserve modification times

示例：

    src=some/relative/path dest=/some/absolute/path rsync_path="sudo rsync"

    src=some/relative/path dest=/some/absolute/path archive=no links=yes

    src=some/relative/path dest=/some/absolute/path checksum=yes times=no

    src=/tmp/helloworld dest=/var/www/helloword rsync_opts=--no-motd,--exclude=.git mode=pull


14.mount

配置挂载点

选项：

    dump

    fstype：必选项，挂载文件的类型

    name：必选项，挂载点

    opts：传递给mount命令的参数

    passno

    src：必选项，要挂载的文件

    state：必选项

            present：只处理fstab中的配置

            absent：删除挂载点

            mounted：自动创建挂载点并挂载之

            umounted：卸载

示例：

    name=/mnt/dvd src=/dev/sr0 fstype=iso9660 opts=ro state=present

    name=/srv/disk src='LABEL=SOME_LABEL' state=present

    name=/home src='UUID=b3e48f45-f933-4c8e-a700-22a159ec9077' opts=noatime state=present


    ansible test -a 'dd if=/dev/zero of=/disk.img bs=4k count=1024'

    ansible test -a 'losetup /dev/loop0 /disk.img'

    ansible test -m filesystem 'fstype=ext4 force=yes opts=-F dev=/dev/loop0'

    ansible test -m mount 'name=/mnt src=/dev/loop0 fstype=ext4 state=mounted opts=rw'


15.raw

类似command，但可以传递管道



ansible-playbook简单使用


ansbile-playbook是一系统ansible命令的集合，其利用yaml 语言编写，运行过程，ansbile-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变量的值。具体执行结果如下



    playbooks]# ansible-playbook user.yml

    PLAY [create user] ************************************************************

    TASK: [create  user ] **********************************************

    changed: [10.212.52.252]

    changed: [10.212.52.14]

    changed: [10.212.52.16]

    PLAY RECAP ********************************************************************

    10.212.52.14               : ok=1    changed=1    unreachable=0    failed=0

    10.212.52.16               : ok=1    changed=1    unreachable=0    failed=0

    10.212.52.252              : ok=1    changed=1    unreachable=0    failed=0  


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

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



二、一键修补bash shellcode示例

再给出一个稍微复杂的示例，通过ansible-playbook实现对N台主机同时修补bash shellcode 漏洞。需要注意的是，可能现网主机分布着不同的系统版本。这里假设现网同时存在centos5和6版本，具体playbook内容如下：


# cat update_bash.yml
- hosts: all
  remote_user: root
  gather_facts: True
  tasks:
  - name: update bash in redhat 6 version
    yum: name=http://mirrors.aliyun.com/centos/6.6/os/x86_64/Packages/bash-4.1.2-29.el6.x86_64.rpm.rpm state=present
    when: ansible_os_family == "RedHat" and ansible_distribution_version|int >=6
  - name: update bash in redhat 5 version
    yum: name=http://mirrors.hustunique.com/centos/5/updates/x86_64/RPMS/bash-3.2-33.el5.1.x86_64.rpm state=present
    when: ansible_os_family == "RedHat" and ansible_distribution_version|int <=5

上面使用了when语句，同时也开启了gather_facts setup模块，这里的ansible_os_family变量和ansible_distribution_version变量就是直接使用的setup模块获取的信息。

如果有大量主机，就在运行的时候加上-f然后选择一个合适的并发主机数量即可，我这里使用了这个，很快的就升级完成bash了。
三、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 模板

下面介绍下构成playbook 的四层结构。
1、Hosts和Users

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

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

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

示例：


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

2、任务列表和action

play的主体部分是task list。

task list中的各任务按次序逐个在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
   
   
apachehandler是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
      with_items:
        - centos
        - admin
  handlers:
    - name: restart httpd
      service: name=httpd state=restart
注：上面的代码没有考虑ubuntu平台，仅仅考虑centos/redhat平台。

注：上面的代码没有考虑ubuntu平台，仅仅考虑centos/redhat平台。