Ansible进阶

Posted 陈乾

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Ansible进阶相关的知识,希望对你有一定的参考价值。

YAML

YAML简介

  YAML是一个可读性高,并用来表达资料序列的格式。YAML参考了其它多种语言,包括:XML、C语言、Python、Perl以及电子邮件格式RFC2822等

  它是一种直观的能够被电脑识别的数据序列化格式,是一个可读性高并且容易被人类阅读,容易和脚本语言交互,用来表达资料序列的编程语言

 

YAML特性

  YAML的可读性好

  YAML和脚本语言的交互性好

  YAML使用实现语言的数据类型

  YAML有一个一致的信息模型

  YAML易于实现

  YAML可以基于流来处理

  YAML表达能力强、扩展性好

 

YAML语法

  YAML的语法与其他高级语言类似,并且可以简单表达清单、散列表、标量等数据结构,其结构通过空格来展示,序列里的每一项开头用"-"来代表,Map里的键值对应":"分隔 

name: chen qian 
age: 18
gender: Male
brother:
    name: LAG
    age: 88
    gender: Male
parent:
    -   name: Father
        age: xx
        gender: Male
    -   name: Mother
        age: xx
        gender: Female

 

文件命名

  xxx.yml

 

官方文档

  http://www.yaml.org

  http://docs.ansible.com

 

Ansible基础元素

 

变量

变量命名

  和其它高级语言命名相同

 

facts 由正在通信的远程目标主机发回的信息,这些信息被保存在ansible变量中,可直接引用

  facts变量使用

- hosts: webserver
    remote_user: root
    tasks:
    - name: copy file
    copy: content="{{ ansible_all_ipv4_addresses }}" dest=/tmp/vars.ans

register

  把任务的输出定义为变量,然后用于其它任务

tasks:
    - name: register
    - shell: /usr/bin/foo
        register: foo_result
        ignore_error: True

通过命令行传递的变量

  在运行playbook的时候也可以出传递一些变量供playbook使用

  ansible-playbook test.yml --extra-vars "hosts=www domain=example.com"

 

通过roles传递的变量

  当给一个主机应用角色的时候可以传递变量,然后在角色内使用这些变量

- hosts: webserver
    roles:
    - common
    - { role: foo_app_instence, dir: /web/htdocs/a.com, port: 8000 }

 

vars变量

vars:
- command=/sbin/shutdown
tasks:
    - name: "shutdown Debian flavored systems"
    command: {{ command }} -h now 
    when ansible_os_family == "Debian"

 

Inventory

  ansible的主要功能在于批量主机操作,为了便捷地使用其中的部分主机,可以在inventory file中将其分组命名

  默认file文件路径 /etc/ansible/hosts

  inventory file可以有多个,且也可以通过Dynamic Inventory来动态生成

 

inventory文件格式

  遵循INI文件风格,中括号中的字符为组名,可以将同一个主机同时归并到多个不同的组中,如果目标主机适用非默认的SSH端口,还可以追加[:PORT]标明

  [webserver]
  192.168.180.130:54321
  192.168.180.131:54321

  [dbserver]
  192.168.180.132:54321

  如果主机名称遵循相似的命名模式,还可以适用列表的方式标识各主机

  [appserver]
  www[01:50].example.com

  [databases]
  db-[a:f].exmaple.com

 

inventory参数

技术分享图片
ansible_ssh_host

ansible_ssh_port

ansible_ssh_user

ansible_ssh_pass

ansible_sudo_pass

ansible_connection

ansible_ssh_private_key_file

ansible_shell_type

ansible_python_interpreter

ansible\_\*\_interpreter

使用

    [webserver]
    www.example.com ansible_ssh_user=root ansible_ssh_pass=123546
View Code

 

主机变量

  可以在inventory中定义主机时为其添加主机变量以便于在playbook中使用

  [webserver]
  www.example.com http_port=8000 maxRequestPerChild=111

  # 可以通过{{ maxRequestPerChild }}引用

 

组变量

  指定组内所有主机在playbook中可用的变量

  [webservers]
  www1.example.com
  www2.example.com

  [webservers:vars]
  ntp_server=ntp.example.com
  nfs_server=nfs.example.com

 

组嵌套

  inventory中,组还可以包含其他组,并且也可以向组中的主机指定变量。不过,这些变量只能在ansible-playbook中使用,而ansible不支持   [apache]

  httpd1.example.com
  httpd2.example.com

  [nginx]
  nginx1.example.com
  nginx2.example.com

  [webservers:children]
  apache
  nginx

  [webservers:vars]
  nfs_server=nfs.example.com

 

条件测试

  如果需要根据变量、facts或此前任务的执行结果来为某task执行与否的前提时,要用到条件测试

 when语句

在task后添加when子句即可使用条件测试,when语句支持Jinja2表达式语法

tasks:
    - name: "shutdown Debian flavored systems"
        command: /sbin/shutdown -h now 
        when ansible_os_family == "Debian"

when语句中还可以使用Jinja2的大多filter,例如要忽略此前某语句的错误并基于其结果运行后面指定的语句

tasks:
    - command: /bin/false
        register: result
        ignore_errors: True
    - command: /bin/something
        when: result|failed
    - command: /bin/something_else
        when: result|success
    - command: /bin/still/something_else
        when: result|skipped

此外when语句中还可以使用facts或playbook中定义的变量

 

迭代

当有需要重复性执行的任务时,可以使用迭代机制

使用格式  将需要迭代的内容定义为item变量引用,并通过with_items语句来指明迭代的元素列表即可

- name: add serveral users
    user: name={{ item }} state=present groups=whell
    with_items: 
    - testuser1
    - testuser2

上面的语句等同于(将items中的元素迭代取出,并执行一遍)

    - name: add user testuser1
        user: name=testuser1 state=present groups=whell
    - name: add user testuser2
        user: name=testuser2 state=present groups=whell

事实上with_items中使用的元素可以是hashes

- name: add serveral users
    user:name={{ item.user }} state=present groups={{ item.groups }}
    with_items:
    - { name: testuser1, groups: wheel }
    - { name: testuser2, groups: root }

 

算术运算

技术分享图片
加法运算

    把两个对象加到一起,通常对象是数字,但是如果两者是字符串或列表,你可以用这种方式衔接它们,无论如何这都不是首选的连接字符串的方式(连接符~)

    {{ 1 + 1 }}

减法运算

    用第一个数减去第二个数

    {{ 2 - 1 }}

除法运算

    对两个数做除法,返回浮点数

    {{ 20 / 7 }}

扫地除法

    对两个数做除法,返回整数

    {{  20 / 7 }} = 2

取余运算

    计算整除后的余数

    {{ 3 % 2 }}

乘法运算

    {{ 2 * 2 }}

    {{ "-" * 80 }}  # 80个"-"

幂乘运算

    {{ 2 ** 2 }}
View Code

 

比较操作符

技术分享图片
==  判断等

!=  判断非等

>   左操作数比右操作数大,返回true

<   左操作数比右操作数小,返回true

>= 左操作数大于等于右操作数,返回true

<= 左操作数小于等于右操作数,返回true
View Code

 

PlayBook

  文档 http://docs.ansible.com/ansible/latest/user_guide/playbooks.html

 

组成

  hosts 主机组

  users 远程登录用户

  tasks 任务,调用模块完成某操作

  variables 变量

  templates 模板

  handlers 处理器,由某事件触发执行的操作

  roles 角色

 

Hosts和Users

  playbook中的每一个play的目的都是为了让某个或某些主机以某个指定的身份执行任务。hosts用于指定要执行指定任务的主机,其可以是一个或多个由冒号分隔主机组
- hosts: webserver
    remote_user: root
    tasks: 
    - name: test connection
        ping:
        remote_user: admin
        sudo: yes

 

任务列表和action

  play的主体部分是task list

  task list中的各任务按次序逐个在hosts中指定的所有主机上执行,即在所有主机上完成第一个任务以后再开始第二个

  在运行自上而下某个playbook时,如果中途发生错误,所有执行任务都将可能回滚

  task的目的是使用指定的参数执行模块,而在模块参数中还可以使用变量,模块是幂等的,这意味着多次执行得到的结果是一致的

  每个task都应该有其name,用于playbook执行输出。如果未提供name,那么action的结果将用于输出

  定义task的可以使用"action: module options"或"module: options",建议使用后者向后兼容
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

 

Handlers

  用于当关注的资源发生变化时采取一定的操作

  "notify"这个action可用于在每个paly的最后被触发,这样可以避免多次有改变发生时每次都执行指定的操作,取而代之,仅在所有的变化发生完成后一次性地执行指定操作

  在notify中列出的操作称为handler,也即notify中调用handler中定义的操作

tasks:
- name: configuration httpd.conf
    copy: path:/etc/httpd/conf/httpd.conf dest:/etc/httpd/conf/httpd.conf
    notify: 
    - restart httpd

handler是task列表,这些task与前述的task本质上没有什么区别

handlers:
- name: restart httpd
    service: name=httpd state=restarted

 

Templates

使用Jinja2语法,将定义好的模板渲染

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

vim /etc/httpd/conf/httpd.conf.j2

    ServerName {{ ansible_fqdn }}

    ...

tasks:
- name: configuration httpd.conf
    copy: /etc/httpd/conf/httpd.conf.j2 dest:/etc/httpd/conf/httpd.conf
    notify: 
    - restart httpd

handlers:
- name: restart httpd
    service: name=httpd state=restarted

 

Tag

  tags用于让用户选择运行playbook中的部分代码,ansible具有幂等性,因此会自动跳过没有变化的部分。即便如此,有些代码为测试其确实没有发生变化的时间也依旧非常长

  此时,如果确信其没有发生变化,就可以通过tags跳过此代码片段

- hosts: webserver
        remote_user: root
        tasks: 
        - name: test connection
            ping:
            remote_user: admin
            sudo: yes
        - name: installation httpd
            yum: name=httpd state=latest
            remote_user: admin
            sudo: yes
        - name: configuration httpd
            copy: path=/root/templates/httpd.conf dest=/etc/httpd/conf/httpd.conf
            remote_user: admin
            sudo: yes
            tags:
            - conf

# 执行

ansible-playbook xxx.yml --tags="conf"

# 结果只运行copy模块操作

 

Roles

  ansible自1.2版本引入的新特性,用于层次性、结构化地组织playbook,roles能够根据层次型结构自动装载变量文件、tasks以及handlers等

  简单来讲,roles就是通过分别将变量、文件、任务、模块以及处理器放置于单独的目录中,并可以便捷地include它们的一种机制

  角色一般用于基于主机构建服务的场景中,但也可以用于构建守护进程等场景中

  要使用roles只需要在palybook中使用include关键字即可

创建role

    step1:

        创建一个以roles命名的目录

    step2:

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

    step3:

        在每个角色命名的目录中分别创建files、handlers、meta、tasks、templates和vars目录,用不到的目录可以创建为空,也可以不创建

    step4:

        在playbook文件中,调用各角色

role各文件的初始化

    tasks目录

        至少应该包含一个名为main.yml的文件,其定义了此角色任务列表。此文件可以使用include包含其它的位于此目录中的tasks文件

    files目录

        存放用copy和script等模块调用的文件

    templates目录

        template模块会自动在此目录中寻找Jinja2模板文件

    handlers目录

        至少应该包含一个名为main.yml的文件,用于定义此角色用到的各handler。在handlers中使用include包含的其它的handlers文件也应该位于此目录中

    vars目录

        至少应该包含一个名为main.yml的文件,用于定义此角色用到的变量

    meta目录

        至少应该包含一个名为main.yml的文件,用于定义此角色的特殊定义及其依赖关系,ansible 1.3及其以后的版本才支持

    default目录

        为当前用户设定默认变量时使用此目录,应该包含一个名为main.yml的文件

 

roles实例

技术分享图片
mkdir -pv ansible_playbook/roles/{webserver,dbserver}/{files,handlers,meta,tasks,templates,vars}

tree

site.yml
webservers.yml
fooservers.yml
roles/
    common/
        files/
        templates/
        tasks/
        handlers/
        vars/
        meta/
    webserver/
        files/
        templates/
        tasks/
        handlers/
        vars/
        meta/

架构

    1台ansible主机

    1台httpd服务器

    1台php服务器

    1台database服务器

配置ansible文件

    step1:

        cp /etc/httpd/conf/httpd.conf ./webserver/files/

    step2:

        vim ./webserver/tasks/main.yml

            - name: install httpd package
                yum: name=httpd
            - name: install configuration file
                copy: src=httpd.conf dest=/etc/httpd/conf/httpd.conf
                tags:
                - conf
                notify:
                - restart httpd
            - name: start httpd
                service: name=httpd state=started

    step3:

        vim ./webserver/handlers/main.yml

            - name: restart httpd
                service: name=httpd state=restarted

    step4:

        vim ./webserver/vars/main.yml

            - httpd_port: 80
            - maxClient: 200

    # 其它两种服务配置类似

    step5:

        vim ../site.yml

            - hosts: webserver
                remote_user: root
                roles:
                - webserver

            - hosts: phpserver
                remote_user: root
                roles:
                - phpserver

            - hosts: dbserver
                remote_user: root
                roles:
                - dbserver
    step6:

        ansible-playbook site.yml
View Code

 

roles其它常用方式

技术分享图片
- hosts: webserver
    roles:
    - commom
    - { role: foo_app_instence, dir: /opt/a, port: 5000 }
    - { role: foo_app_instence, dir: /opt/b, port: 5001 }
    - { role: some_role, when: "ansible_os_family == ‘RedHat‘"  }
View Code

 

执行playbook

  ansible-playbook xxx.yml

 





















以上是关于Ansible进阶的主要内容,如果未能解决你的问题,请参考以下文章

Ansible Inventory指北进阶

我的Android进阶之旅NDK开发之在C++代码中使用Android Log打印日志,打印出C++的函数耗时以及代码片段耗时详情

Ansible 进阶 | facts 缓存

ansible应用进阶playbook--LNMP+WordPress

Ansible进阶

Ansible进阶之roles详解