ansible工具及语法介绍

Ansible是一种自动化部署工具，它使用SSH协议进行通信，无需在被控制端安装额外的客户端软件。本文将详细介绍ansible工具及其语法，包括安装、配置、常用模块、YAML语法、playbook的写法和应用、变量定义和引用、条件判断和循环、执行过程分析、异步模式、速度优化以及playbook杂项等。 一、基本配置和使用 1.1 安装Ansible Ansible可以通过多种方式安装，包括下载源码后编译安装、从Git上获取资源安装或使用rpm包安装。如果选择rpm包安装方式，需要先配置epel源。 1.2 配置ansible 配置ansible涉及环境配置、SSH互信配置和简单测试。 1.2.1 环境配置 环境配置是指设置ansible的配置文件，通常包括指定inventory文件的位置，配置文件一般位于/etc/ansible/ansible.cfg。 1.2.2 SSH互信配置 为了确保ansible能够无密码SSH连接到目标机器，需要配置SSH互信。这通常通过ssh-keygen生成SSH密钥，并将公钥复制到目标机器的~/.ssh/authorized_keys文件中。 1.2.3 简单测试 通过简单的ping模块测试ansible配置是否正确，确保ansible可以成功连接到目标机器。 1.3 inventory Inventory文件是ansible配置管理的服务器清单，其中定义了管理的主机和主机组。通常，这个文件位于/etc/ansible/hosts。 二、选项和常用模块 2.1 ansible命令解释 ansible命令是ansible的主要使用方式，它可以执行模块、运行playbook等。 2.2 常用模块 ansible提供了许多模块来执行不同类型的命令，包括但不限于以下模块： - shell和command：用于执行shell命令； - copy：用于复制文件到远程主机； - template：用于使用模板复制文件到远程主机； - file：用于管理文件系统； - fetch：用于从远程主机拉取文件到本地； - rsync模块synchronize：用于同步文件； - yum：用于管理RPM包； - service：用于管理服务； - user：用于管理用户； - authorized_key：用于管理SSH认证密钥； - debug：用于打印变量或信息； - cron：用于管理定时任务； - archive：用于归档文件； - unarchive：用于解压文件； - get_url：用于下载文件； - wait_for：用于等待特定条件； - script：用于在远程主机上执行脚本。 三、YAML语法和playbook写法 3.1 初步说明 Playbook是ansible的配置、部署和编排语言。它使用YAML格式编写，并由一个或多个plays组成。plays用来描述你想要使用的特定主机的特定任务。 3.2 列表 YAML中的列表用短横线“-”表示，例如： ```yaml - name: 第一个任务 command: echo hello ``` 3.3 字典 字典在YAML中用冒号“:”表示键值对，例如： ```yaml name: "value" ``` 3.4 分行写 在YAML中，一行可以写多个键值对，用逗号分隔。 3.5 向模块传递参数 传递参数给模块时，可以使用key=value的形式，也可以将参数封装在字典中。 3.6 playbook和play的关系 playbook是一系列plays的集合，而play是playbook的基本单元，用于指定一组主机和要执行的任务。 3.7 playbook中什么时候使用引号 在YAML中，如果键名、值或者列表元素中包含特殊字符或空格，需要用引号括起来。 四、playbook应用和示例 4.1 yaml简单示例 通过简单的YAML示例，演示如何编写playbook。 4.2 ansible-playbook命令说明及playbook书写简单示例 介绍ansible-playbook命令的使用，并给出简单的playbook书写示例。 4.3 playbook的内容 playbook的内容通常包括：指定目标主机和远程用户、定义任务列表、通知和处理程序、标签tag、包含其他playbook、roles等。 4.3.1 hosts和remote_user 在play中指定目标主机和远程用户，例如： ```yaml - hosts: webservers remote_user: root ``` 4.3.2 task list 定义任务列表，例如： ```yaml tasks: - name: 安装httpd yum: name: httpd state: present ``` 4.3.3 notify和handler 在playbook中使用notify可以触发handler，例如： ```yaml handlers: - name: 启动httpd服务 service: name: httpd state: started ``` ```yaml tasks: - name: 安装httpd yum: name: httpd state: present notify: 启动httpd服务 ``` 4.3.4 tags 通过标签（tag）可以运行playbook中的特定部分，例如： ```yaml tasks: - name: 安装httpd yum: name: httpd state: present tags: package ``` 执行playbook时，可以指定tags来仅执行特定标签的任务： ```bash ansible-playbook example.yml --tags=package ``` 4.4 include和roles 4.4.1 include include可以将一个或多个文件的内容插入当前文件中。 4.4.2 roles roles提供了一种结构化的、可重用的组织方式，包括多个预定义的文件和目录。roles可以用于批量自动化安装。 4.5 roles示例：批量自动化安装 例如，批量自动化安装httpd的角色结构可能如下： ```bash roles/ httpd/ tasks/ main.yml handlers/ main.yml templates/ httpd.conf.j2 files/ index.html vars/ main.yml meta/ main.yml ``` 五、各种变量定义方式和变量引用 5.1 ansiblefacts ansiblefacts是ansible自动收集的关于系统的信息，这些信息可以通过{{ ansible_facts }}引用。 5.2 变量引用json数据的方式 5.2.1 引用json字典数据的方式 例如，从json字典中引用数据： ```yaml - name: 引用json字典数据 debug: msg: "{{ my_dict['key'] }}" ``` 5.2.2 引用json数组数据的方式 例如，从json数组中引用数据： ```yaml - name: 引用json数组数据 debug: msg: "{{ my_list[0] }}" ``` 5.2.3 引用facts数据 从facts中引用数据，例如： ```yaml - name: 引用facts数据 debug: msg: "{{ ansible_facts['distribution'] }}" ``` 5.3 设置本地facts 可以通过在远程主机的/etc/ansible/facts.d/目录下创建以.fact结尾的文件来设置本地facts。 5.4 输出和引用变量 在ansible中可以使用debug模块来输出和引用变量： ```yaml - name: 输出变量 debug: msg: "变量值为：{{ var_name }}" ``` 5.5 注册和定义变量的各种方式 5.5.1 register注册变量 在执行任务时，可以使用register关键字注册输出结果到一个变量中，例如： ```yaml - name: 注册命令输出结果 command: /bin/ls register: result ``` 5.5.2 set_fact定义变量 set_fact模块可以用于定义新的变量，例如： ```yaml - name: 定义变量 set_fact: var_name: "值" ``` 5.5.3 vars定义变量 在playbook中，可以使用vars关键字定义变量： ```yaml vars: var_name: "值" ``` 5.5.4 vars_files定义变量 使用vars_files关键字可以引入外部YAML文件定义的变量，例如： ```yaml vars_files: - vars/main.yml ``` 5.5.5 roles中的变量 在roles中定义的变量会自动加载到playbook中。 5.5.6 命令行传递变量 在运行ansible-playbook时，可以通过-e选项传递变量： ```bash ansible-playbook example.yml -e "var_name=value" ``` 5.5.7 借助with_items叠加变量 在使用with_items时，可以叠加变量： ```yaml - name: 搭建多个web服务器 yum: name: "{{ item }}" state: present with_items: - httpd - memcached ``` 5.5.8 inventory中主机变量和主机组变量 在inventory文件中，可以为特定主机或主机组设置变量。 5.5.9 内置变量 ansible为所有任务提供内置变量，例如{{ inventory_hostname }}指的是当前处理的主机名。 六、条件判断和循环 6.1 循环 6.1.1 with_items迭代列表 例如，迭代列表： ```yaml - name: 安装多个软件包 yum: name: "{{ item }}" state: present with_items: - httpd - memcached ``` 6.1.2 with_dict迭代字典项 例如，迭代字典项： ```yaml - name: 配置多个用户 user: name: "{{ item.key }}" password: "{{ item.value.password }}" with_dict: user1: { password: '123' } user2: { password: '456' } ``` 6.1.3 with_fileglob迭代文件 例如，迭代文件： ```yaml - name: 复制多个文件 copy: src: "{{ item }}" dest: /tmp/ with_fileglob: - /etc/skel/* ``` 6.1.4 with_lines迭代行 例如，迭代文件的每一行： ```yaml - name: 输出文件的每一行 debug: msg: "{{ item }}" with_lines: cat /etc/hosts ``` 6.1.5 with_nested嵌套迭代 例如，嵌套迭代： ```yaml - name: 创建多个用户和用户组 user: name: "{{ item[0] }}" group: "{{ item[1] }}" with_nested: - [ user1, user2 ] - [ group1, group2 ] ``` 6.2 条件判断 条件判断可以使用when关键字实现，例如： ```yaml - name: 只在redhat系列系统上安装httpd yum: name: httpd state: present when: ansible_os_family == "RedHat" ``` 七、执行过程分析、异步模式和速度优化 7.1 ansible执行过程分析 ansible执行过程包括解析playbook、执行任务、收集facts等步骤。 7.2 ansible并发和异步 ansible默认情况下是顺序执行任务，如果要实现并发执行，可以使用async关键字。 7.3 ansible的-t选项妙用 ansible的-t选项可以指定执行任务时的工作目录。 7.4 优化ansible速度 7.4.1 设置ansible开启ssh长连接 开启ssh长连接可以减少ansible每次执行任务时的连接开销。 7.4.2 开启pipelining 开启pipelining可以将模块指令通过管道直接传递给bash执行，进一步优化性能。 7.4.3 修改ansible执行策略 修改ansible执行策略可以改善执行效率。 7.4.4 设置facts缓存 设置facts缓存可以避免重复收集facts信息，提高效率。 八、playbook杂项 8.1 指定运行play的主机delegate_to和local_action 使用delegate_to可以指定任务在本地执行，使用local_action可以在远程主机执行指定任务。 8.2 只运行一次run_once 设置run_once可以确保任务只在一台远程主机上执行一次。 8.3 分批执行play 可以使用serial关键字分批次执行play。 8.4 分批执行play时的最大失败百分比 在分批执行时，可以设置失败的百分比阈值，超过则停止执行。 8.5 错误处理——忽略错误 通过ignore_errors关键字可以忽略任务执行过程中的错误。 8.6 错误处理——自定义错误判断条件 可以自定义条件判断错误，例如： ```yaml - name: 自定义错误判断条件 debug: msg: "执行失败" failed_when: "result.rc != 0" ``` 九、playbook示例：编译安装httpd 通过实际的编译安装httpd的playbook示例，可以更直观地学习ansible的使用方法和playbook的编写技巧。 通过以上内容，可以掌握ansible工具及其语法的基本知识和使用技巧，进而在日常工作中应用ansible实现自动化部署和配置管理。