• Ansible Playbook tags用法


    你写了一个很长的playbook,其中有很多的任务,这并没有什么问题,不过在实际使用这个剧本时,你可能只是想要执行其中的一部分任务而已,或者,你只想要执行其中一类任务而已,而并非想要执行整个剧本中的全部任务,这个时候我们该怎么办呢?我们可以借助tags实现这个需求。

    见名知义,tags可以帮助我们对任务进行打标签的操作,当任务存在标签以后,我们就可以在执行playbook时,借助标签,指定执行哪些任务,或者指定不执行哪些任务了,这样说可能不够直观,我们来看一个小示例(为了方便示例此处只写3个任务进行举例)。

    ---
    - hosts: test181
      remote_user: root
      tasks:
      - name: task1
        file:
          path: /testdir/t1
          state: touch
        tags: t1
      - name: task2
        file: path=/testdir/t2
              state=touch
        tags: t2
      - name: task3
        file: path=/testdir/t3
              state=touch
        tags: t3
    

    如上例所示,上例的play中有3个task,每个task都有对应的tags,为了方便示例,我只是简单的把tags的值写成了t1、t2、t3,在实际的使用中,我们应该让tags的值能够见名知义,现在每个task都有了标签,假如在执行上述playbook时,我们只想执行task2,该怎样执行呢?我们可以使用如下命令:

    $ ansible-playbook --tags=t2 test.yaml
    

    如你所见,可以使用--tags选项指定某个标签,当指定标签后,只有标签对应的任务会被执行,其他任务都不会被执行,执行上述命令后,只有task2会执行,因为task2的标签值为t2,task1和task3都不会执行,这样就达到了只执行playbook中部分任务的目的。

    借助标签,除了能够指定需要执行的任务,还能够指定不执行的任务,示例命令如下:

    $ ansible-playbook --skip-tags='t2' test.yaml
    

    我们可以使用--skip-tags选项指定不执行的任务,执行上述命令后,task1和task3会执行,task2不会执行,因为我们已经在命令中指定了跳过标签t2所对应的任务,相当于使用了排除法,t2对应的任务被排除了,其他任务都会执行。

    除了使用上例中的语法指定标签,还能够使用下例中的两种语法指定标签的值!

    ---
    - hosts: test181
      remote_user: root
      tasks: 
      - name: task1
        file: 
          path: /testdir/t1
          state: touch
        tags:
          - t1
      - name: task2
        file: path=/testdir/t2
              state=touch
        tags: ['t2']
    

    之前描述的三种语法都可以指定标签,不过上例中,每个任务只有一个标签,其实,我们可以为每个任务添加多个标签,三种语法添加多个标签的示例如下:

    # 语法一:
    tags:
     - testtag
     - t1
     
    # 语法二:
    tags: tag1,t1
     
    # 语法三:
    tags: ['tagtest','t2']
    

    上述示例的语法一使用了YAML块序列的语法格式指定多个标签,语法二与语法三都是在原来语法的基础上,使用逗号隔开多个标签。

    如下例所示,不同的任务可以使用相同的标签:

    ---
    - hosts: test181
      remote_user: root
      tasks:
      - name: install httpd package
        tags: httpd,package
        yum:
          name=httpd
          state=latest
     
      - name: start up httpd service
        tags: httpd,service
        service:
          name: httpd
          state: started
    

    上例中每个任务都有多个标签,而且上例中两个任务都有一个共同的标签,就是httpd标签,所以,当我们执行ansible-playbook –tags=httpd test.yaml,上述两个任务都会执行。

    上例的play中的所有任务都有共同的httpd标签,像这种情况,我们可以把httpd标签提取出来,写在play中,示例如下:

    ---
    - hosts: test181
      remote_user: root
      tags: httpd
      tasks:
      - name: install httpd package
        tags: ['package']
        yum:
          name=httpd
          state=latest
     
      - name: start up httpd service
        tags:
          - service
        service:
          name: httpd
          state: started
    

    当tags写在play中而非task中时,play中的所有task会继承当前play中的tags,而上例中,两个任务都会继承httpd标签,同时还有拥有自己的标签!

    在调用标签时,也可以一次性指定多个标签,调用多个标签需要用逗号隔开,命令如下:

    $ ansible-playbook --tags package,service test.yaml
    

    在调用标签之前,如果你想要概览一下playbook中都有哪些标签,可以使用 --list-tags选项,示例如下:

    $ ansible-playbook --list-tags test.yaml
    

    其实,ansible还预置了5个特殊tag,这5个特殊tag分别为:

    • always
    • never(2.5版本中新加入的特殊tag)
    • tagged
    • untagged
    • all

    当我们把任务的tags的值指定为always时,那么这个任务就总是会被执行,除非你使用--skip-tags选项明确指定不执行对应的任务,这样说可能不容易理解,不如看个小示例,示例如下:

    ---
    - hosts: test181
      remote_user: root
      tasks:
      - name: task1
        file:
          path: /testdir/t1
          state: touch
        tags:
          - t1
      - name: task2
        file: path=/testdir/t2
              state=touch
        tags: ['t2']
      - name: task3
        file: path=/testdir/t3
              state=touch
        tags: t3,always
    

    上例中,task3的标签有两个,t3和always,那么我们来执行一下这个playbook,假设,我只想运行上述playbook中标签为t1的任务,那么我会执行如下图中的命令:

    image

    如图所示,在执行上述playbook时,我只指定了t1,正常情况下应该只执行t1对应的任务,也就是应该只执行task1,但是实际上执行了task1和task3,这是因为task3的标签的值包含always关键字,所以即使task3对应的标签没有被调用,task3也会执行,这就是always的作用。
    如果你不想执行标签中包含always的任务,你可以使用--skip-tags选项明确指定跳过它们,仍然以上例的playbook为例,假设我们就是不想执行task3,我们可以执行如下命令:

    $ ansible-playbook --skip-tags always test.yaml
    

    但是需要注意,如果上述play中有多个任务都有always标签,那么上述命令将会跳过所有包含always标签的任务,如果上例中的play中的多个任务都有always标签,则可以使用如下命令只跳过task3,其他带有always标签的任务不会跳过,前提是task3有除了always以外的自定义标签。

    $ ansible-playbook --skip-tags t3 test.yaml
    

    在2.15版本的ansible中,引入了新的特殊标签never,从字面上理解,never的作用应该与always正好相反,由于我当前使用的ansible版本为2.4(还没有引入never标签),所以当指定任务的标签为never时,貌似被ansible当做了自定义标签,所以如果你安装了2.5版本的ansible,可以尝试一下never标签的作用,由于还没有实际使用过2.5版本,所以此处暂时不进行示例。

    剩余的三个特殊标签分别为 tagged、untagged、all

    这三个特殊标签并非像always一样,always作为标签值存在,而这三个特殊标签则是在调用标签时使用,示例如下:

    $ ansible-playbook --tags tagged test.yaml
    

    上述命令表示只执行有标签的任务,没有任何标签的任务不会被执行。

    $ ansible-playbook --skip-tags tagged test.yaml
    

    上述命令表示跳过包含标签的任务,即使对应的任务包含always标签,也会被跳过。

    $ ansible-playbook --tags untagged test.yaml
    

    上述命令表示只执行没有标签的任务,但是如果某些任务包含always标签,那么这些任务也会被执行。

    $ ansible-playbook --skip-tags untagged test.yaml
    

    上述命令表示跳过没有标签的任务。

    特殊标签all表示所有任务会被执行,不用指定,默认情况下就是使用这个标签。

  • 相关阅读:
    join
    PS1-4
    tftp + bras
    awk调用shell
    curl
    ssh
    查看cp进度,使用watch
    tftp
    scp 链接文件的问题 + tar
    mysql必知必会(三、使用mysql)
  • 原文地址:https://www.cnblogs.com/lvzhenjiang/p/16100514.html
Copyright © 2020-2023  润新知