深入了解 ansible 中 tags 使用方式

我們先新增一個 role

包含了四個檔案 main.yml, all.yml, deploy.yml, other.yml

每個 task 檔 都會執行 3 個 task 分別是 無 tag(all tag) deploy tag, other tag

並且 main.yml 會用 include 的方式載入剩餘三個 task 檔

為了方便說明我用 ABC DEF GHI JKL 取名 task

main.yml

```yaml
---

- name: A
debug:
msg: 'all tag in main.yml'

- name: B
debug:
msg: 'deploy tag in main.yml'
tags:
- deploy

- name: C
debug:
msg: 'other tag in main.yml'
tags:
- other

- name: X
include: all.yml

- name: Y
include: deploy.yml
tags:
- deploy

- name: Z
include: other.yml
tags:
- other

```

all.yml

```yaml
---

- name: D
debug:
msg: 'all in all.yml'

- name: E
debug:
msg: 'deploy in all.yml'
tags:
- deploy

- name: F
debug:
msg: 'other in all.yml'
tags:
- other

```

deploy.yml

```yaml
---

- name: G
debug:
msg: 'all in deploy.yml'

- name: H
debug:
msg: 'deploy in deploy.yml'
tags:
- deploy

- name: I
debug:
msg: 'other in deploy.yml'
tags:
- other

```

other.yml

```yaml
---

- name: J
debug:
msg: 'all in other.yml'

- name: K
debug:
msg: 'deploy in other.yml'
tags:
- deploy

- name: L
debug:
msg: 'other in other.yml'
tags:
- other

```

playbook則是用不同方式上 tags

```yaml
#!/usr/bin/env ansible-playbook
---

- hosts: localhost
gather_facts: no
roles:
- { role: role-tags }

- hosts: localhost
gather_facts: no
tags:
- deploy
roles:
- { role: role-tags }

- hosts: localhost
gather_facts: no
roles:
- { role: role-tags, tags: [ "deploy" ] }


```

執行 playbook 時也加入 tags 參數看看結果如何

1. playbook 完全不加 tags

```bash
ansible-playbook site.tags.yml # 結果:ABCDEFGHIJKL全部執行
ansible-playbook site.tags.yml --tags=deploy # 結果:BEGHIK
ansible-playbook site.tags.yml --tags=other # 結果:CFIJKL
ansible-playbook site.tags.yml --tags=gg # 結果:全部不會執行
```

2. 在 playbook 加 deploy tag

```bash
ansible-playbook site.tags.yml # 結果:ABCDEFGHIJKL全部執行
ansible-playbook site.tags.yml --tags=deploy # 結果:ABCDEFGHIJKL全部執行
ansible-playbook site.tags.yml --tags=other # 結果:CFIJKL
ansible-playbook site.tags.yml --tags=gg # 結果:全部不會執行
```

3. 在 playbook 的 role 上加 deploy tag

```bash
ansible-playbook site.tags.yml # 結果:ABCDEFGHIJKL全部執行
ansible-playbook site.tags.yml --tags=deploy # 結果:ABCDEFGHIJKL全部執行
ansible-playbook site.tags.yml --tags=other # 結果:CFIJKL
ansible-playbook site.tags.yml --tags=gg # 結果:全部不會執行
```

23的 --tags=deploy 結果跟我預想的不太一樣

我原本以為加在 playbook 上的 tag 是用來過濾我要執行哪些 roles/tasks

很顯然的他也是上 tag 而且是對以下所有 roles/tasks 標記

如此一來, 就可以了解如果你真的要過濾的話 在執行 playbook 加上 --tags 才會是過濾, 其他加在檔案的都為了之後過濾用的標記



補充:

可以在執行 playbook 時加上 --list-tasks 去看哪些 task 被加了什麼標記例如
```shell
$ ansible-playbook site.tags.yml --list-tasks

playbook: site.tags.yml

play #1 (localhost): localhost TAGS: []
tasks:
role-tags : A TAGS: [deploy]
role-tags : B TAGS: [deploy]
role-tags : C TAGS: [deploy, other]
role-tags : D TAGS: [deploy]
role-tags : E TAGS: [deploy]
role-tags : F TAGS: [deploy, other]
role-tags : G TAGS: [deploy]
role-tags : H TAGS: [deploy]
role-tags : I TAGS: [deploy, other]
role-tags : J TAGS: [deploy, other]
role-tags : K TAGS: [deploy, other]
role-tags : L TAGS: [deploy, other]
```