Ansible_playbook_变量和变量引用

---

#
# Topic: playbook 基本语法和常用命令
# State:
# 1. Ansible playbook 脚本编写方法
# 2. Playbook是Ansible的最和兴的功能组件
# 3. Ansible 的配置管理和应用部署工作都是通过playbook来完成的
# Testing environment:
# OS: RHEL6.6
# Python: python2.7.5
# Ansible: ansible 2.3.1.0
# Nodes: 3
#
# 1. Playbook 基础语法

• 1. Playbook 基础语法:

  • 必备基础: YAML语法 #Playbook使用YAML语法编写的Ansible脚本

  • Playbook运行命令: ansible-playbook
    # 示例: ansible-playbook first_demo.yaml

  • Playbook语法检查: ansible-playbook playbook_name --syntax-check
    # 示例: ansible-playbook first_demo.yaml --syntax-check

  • 列出Playbook中的任务: ansible-playbook playbook_name --list-
    # 示例: ansible-playbook base_playbook1.yaml --list-task

  • 列出Playbook文件中任务的目标主机: ansible-playbook --list-hosts
    # 示例: ansible-playbook base_playbook1.yaml --list-

  • 运行Playbook某个特定的task: ansible-playbook --start-at-task="task_name"
    # 示例: ansible-project]# ansible-playbook -i /etc/ansible/hosts base_playbook2.yaml -f 10 --start-at-task="check if the httpd is running"

  • 其他命令选项:

    • -f: 指定任务运行的并发数
    • -i: 指定playbook运行使用的inventory

  • 完整示例:
    ...
    ######################## Example Start ##########################

---

# Install Nginx

• name: Install Nginx # play名称
  hosts: tomcat # 目标主机，支持patterns
  remote_user: root # 远程ssh认证主机
  sudo: yes # 是否启用sudo
  sudo_user: ansible # sudo权限用户
  gather_facts: no # 是否收集facts信息
  accelerate: no # 是否启用加速模式
  accelerate_port: 5999 # 如果启用加速模式，那么需要设置端口
  connection: local # 设置链接方式
  serial: 15 # 设置playbook的并发数
  vars: # 设置playbook变量
  nginx_port: 83
  vars_files:
  • "vars.yml"
  • [ "one.yml", "two.yml" ]
    vars_prompt:
  • name: "password vaes"
    # prompt: "Enter password"
    # default: "secret"
    # private: yes
    # encrypt: "md5_crypt"
    # confirm: yes
    # salt: 1234
    # salt_size: 8
    #
    pre_tasks: # 设置taks运行之前的task
  • name: pre_tasks
    shell: hostname
    roles: # 引入role
  • tomcat:
  • { role: tomcat, version: '9.0', when: "ansible_system =='linux', tags: [tomcat, install]"}
  • { role: tomcat, when: ansible_all_ipv4_addresses == "192.16.1.1" }
    tasks:
  • include: tasks.yaml
  • include: tasks.yaml ansible_distribution="CentOS" ansible_distribution_version='6.6'
  • { include: tasks.yaml, version: '1.1', package: [nginx, httpd] }
  • include: tasks_192.168.1.117.yaml
    when: ansible_all_ipv4_addresses == '192.168.1.117'
    post_tasks: # 设置运行之后的task
  • naem: post_tasks
    shell: hostname
    handlers: # 设置handler
  • include: handlers.yml

######################## Example End ############################
...

# Playbook 中的变量和变量引用

• 2. Playbook 中的变量和引用
  • 2.1 通过Inventory来定义host和group变量
    # 说明：
    # 1. host 变量只对当前host起作用
    # 2. group 变量对组内的所有host起作用

# 示例Inventory定义
#[tomat]
#ansible1
#ansible2
#ansible3
#
#[tomat:vars]
# inventory_name=michael_chacki
# 示例playbook:
# ---
# # show vars
# - name: the frist play
# hosts: tomat
# remote_user: root
# gather_facts: false
# tasks:
# - name: the first task
# debug: msg="The hostname is {{inventory_hostname}} and the key is {{ key }}, the inventory_name is {{ inventory_name }}"

• 2.2 通过/etc/ansible下的文件来定义host和group变量
  • host变量定义步骤
    • 1. 新建文件夹host_vars
    • 2. 创建以hostname命名的文件
    • 3. 在步骤2中创建的文件中定义变量
    • group变量定义
      • 1. 新建文件夹group_vars
      • 2. 创建以groupname命名的文件
      • 3. 在步骤2中创建的文件中定义变量
    • 变量引用
      {{变量名}}
      #说用： 1. 创建的变量文件名必须是在inventory中存在的host或是group
      # 2. 如果变量没有被覆盖，那么就可以引用到
      # 3. 变量文件内容必须以YAML的格式编写
      #
      #示例:
      # 文件结构:
      # group_vars
      # └── tomcat
      # host_vars
      # ├── ansible1
      # ├── ansible2
      # └── ansible3
      # 定义变量:
      # ---
      # group_key: michael.lin
      # ---
      # key: michael1
      # ---
      # key: michael2
      # ---
      # key: michae
      # ...
      # 引用变量:
      # ---
      # show_vars.yaml
      # - name: show the host ans group vars
      # remote_user: root
      # hosts: tomcat
      # gather_facts: false
      # tasks:
      # - name: show host vars
      # debug: msg="The current host {{ inventory_hostname }}''key value is {{ key }}"
      # - name: show group vars
      # debug: msg="The current group {{ current_group_name }} ''group name is {{ group_name }}"
      # ...
      #
• 2.3 使用ansible-playbook中引入变量
  • 2.3.1 在命令行定义变量传入
    • 例如：ansible-playbook show_vars.yaml -e "key='Hello world' group_key=ansible"
  • 2.3.2 在命令行通过文件的方式传入，支持json和YAML
    • 例如：ansible-playbook show_vars.yaml -e "@var.yaml"
      #
• 2.4 在playbook中通过vars定义变量
  # 示例如下：
  ...

---

# show_vars.yaml

• name: show the host ans group vars
  remote_user: root
  hosts: tomcat
  gather_facts: false
  vars:
  key: 'I am Jin ge'
  group_key: 'I am a group'
  tasks:
  • name: show host vars
    debug: msg="The current host {{ inventory_hostname }}''key value is {{ key }}"
  • name: show group vars
    debug: msg="The current group {{ group_key }} ''group name is {{ group_key }
    ...
    # Playbook 中的循环
• 2.5 通过vars_files来引用变量
  • 说明
    • 1. 变量列表是列表形式
  • 步骤
    • 1. 定义变量文件,yaml或是json格式
    • 2. 在playbook 中使用vars_files 引用变量文件
  • 示例
    ...

---

# show_vars.yaml

• name: show the host ans group vars
  remote_user: root
  hosts: tomcat
  gather_facts: false
  vars:
  key: 'I am Jin ge'
  group_key: 'I am a group'
  vars_files:
  • var.yaml
    tasks:
  • name: show host vars
    debug: msg="The current host {{ inventory_hostname }}''key value is {{ key }}"
  • name: show group vars
    debug: msg="The current group {{ group_key }} ''group name is {{ group_key }}"
    ...
• 2.6 使用register 在task之间传递变量
  • 功能：在不同的task之间传递变量
  • 使用场景：一个task需要根据上一个task的变量来决定是否运行
  • 定义步骤
    • 1. 在上一个任务运行完成后，使用register定义变量
    • 2. 当任务运行完成后会将运行结果保持到注册的变量中
    • 3. 返回的是一个字典格式的变量，可以通过python字典引用元素的方式引用
  • 示例

---

# show register vars

• name: show register vars
  hosts: tomcat
  remote_user: root
  gather_facts: false
  tasks:

  • name: register var
    shell: hostname
    register: info
  • name: show var from task above
    debug: msg={{info['stdout']}}
    ...

• 2.7 通过vars_prompt 交互的方式传入变量
  # 该方式不做介绍了

• 同名变量的优先级

  • 1. extra vars(命令中-e)最优先
  • 2. inventory 主机清单中连接变量(ansible_ssh_user 等)
  • 3. play 中 vars、vars_files 等
  • 4. 剩余的在 inventory 中定义的变量
  • 5. 系统的 facts 变量
  • 6. 角色定义的默认变量(roles/rolesname/defaults/main.yml)
• 3. Playbook 中的循环
  • 见其他文档
    # 4. Playbook 中条件分支
• 4. Playbook 中条件分支
  • 见其他文档
    # 5. Jinja2 过滤器
• 5. Jinja2 过滤器
  • 见其他文档
    # 6. Playbook中的内置变量
• 6. Playbook中的内置变量
  • 见其他文档
    # 总结

• 总结

  • 见其他文档