Ansible 最佳实践不重复共同角色

Question

在 Ansible 最佳实践页面上： http ://docs.ansible.com/ansible/playbooks_best_practices.html#top-level-playbooks-are-separated-by-role 它显示了一个示例，其中主 playbook site.yml 包含几个其他顶级剧本 webservers.yml 和 dbservers.yml。 在这些剧本中，它们每个都包含共同的角色。 有些清单文件我的所有组都在一台主机上运行。 另一个清单文件我每个组都有一个主机。 对于任何组都在一台主机上的情况，如果我运行 site.yml，您可以看到公共角色被扮演了两次，一个用于 webservers.yml，另一个用于 dbservers.yml。

避免这种情况的解决方案是什么？ 我想你可以从 webservers.yml 和 dbservers.yml 中取出 common 角色，而是在 site.yml 中有一个针对 common 角色的任务。 但是我不能单独配置一个带有 common.js 的 webserver 或 dbserver。

Answer 1

我使用角色目录中的meta文件确定角色依赖关系。 角色依赖允许您在使用角色时自动拉入其他角色。 角色依赖项存储在角色目录中包含的 meta/main.yml 文件中。

角色依赖总是在包含它们的角色之前执行，并且是递归的。 默认情况下，角色也只能作为依赖项添加一次 - 如果另一个角色也将其列为依赖项，则不会再次运行。 可以通过向 meta/main.yml 文件添加 allow_duplicates: yes 来覆盖此行为。

请参阅 Ansible 文档中的示例。

Answer 2

和其他人一样，我也有这个问题，即使角色是幂等的，执行也需要时间，所以我们可能只想执行一次。

我使用了与@Vor类似的方法，但我选择了事实而不是创建文件。

提醒：

在 Ansible 运行期间，事实在两次播放之间仍然存在，但即使您使用事实缓存，也不会在执行过程中保存。

例子

site.yml

---
- hosts: all
  roles: [common]
- include: db.yml
- include: web.yml

db.yml

---
- hosts: db
  roles:
    - { role: common, when: isdef_common_role is not defined }
    - db

web.yml

---
- hosts: web
  roles:
    - { role: common, when: isdef_common_role is not defined }
    - web

roles/common/tasks/main.yml

---
- debug: 'msg="{{ inventory_hostname }} common"'
- set_fact: isdef_common_role=1

这确实有点多余（因为您每次都必须进行条件包含），但具有以下优点：

• 适用于我能想到的大多数情况（ ansible-playbook site.yml ， ansible-playbook site.yml ansible-playbook site.yml -l common ， ansible-playbook site.yml -l db ， ansible-playbook db.yml ，...）
• 让您决定是否要重复执行公共

如果您不想重复{ role: common, when: isdef_common_role is not defined } ，您可以使用以下命令将条件放入 common 角色中：

site.yml : 没有变化

db.yml , web.yml ：从角色中删除条件

roles/common/tasks/main.yml

---
- include: tasks.yml
  when: isdef_common_role is not defined
- set_fact: isdef_common_role=1

roles/common/tasks/tasks.yml

---
- debug: 'msg="{{ inventory_hostname }} common"'

Answer 3

@user1087973 你在使用标签吗？ 如果您使用标签，具有不同标签的公共角色被视为不同：

例如 ：

role_common

role1 : 主机 SRV tag_role_1 依赖于 role_common

角色 2 ：主机 SRV tag_role_2 依赖于 role_common

你的共同角色会被执行两次，因为它被认为是因为标签不同

看看--list-tasks ，你会看到

不使用标签的正确解决方案是使用不同的 yml 文件并将其包含在您的 site.yml 中

http://docs.ansible.com/ansible/playbooks_best_practices.html#top-level-playbooks-are-separated-by-role

希望这可以帮助

Answer 4

我的方法是不在剧本中包含剧本。 至少在这样做会导致角色在单个作业中多次执行时不会。

我需要包含在超过 1 个剧本中的任何内容都会转换为角色，并且该角色可以包含在许多剧本中。 如果我最终得到几个包含一系列重复角色的剧本，我可以将这些角色组合成一个单独的角色，该角色仅依赖于其他角色以避免重复。

Answer 5

我的方法是在服务器上为每个角色创建一个lock文件。 这很好用。

例如，我有一个名为common的角色，这就是我的tasks/main.yml样子：

- name: check lock file exist
  stat: path=/tmp/ansible-common-role
  ignore_errors: true
  register: lock_file

- name: install apt packages
  apt: name={{ item }} state=present 
  with_items:
    - python-setuptools
  when: lock_file.stat.exists == false

.....
# other tasks with 
#    when: lock_file.stat.exists == false
.....

- name: Create lock file
  file: path=/tmp/ansible-common-role state=touch
  when: lock_file.stat.exists == false

正如你在上面的例子中看到的，如果剧本已经运行，它会跳过所有的任务。

Answer 6

您还可以使用 add_host 构建一个临时组，例如：

1. target: webservers--> add hosts to group "common_roles"
2. target: dbservers --> add hosts to gruop "common_roles"
3. Target: common_roles --> execute whatever common roles you need
4. regular group by group execution.

Answer 7

正如 Ansible 文档中所述：

Ansible 将只允许角色执行一次，即使定义了多次，如果在角色上定义的参数对于每个定义都没有不同。

（……）

要使角色多次运行，有两种选择：
1.在每个角色定义中传递不同的参数。
2. 将allow_duplicates: true 添加到角色的meta/main.yml 文件中。

还要考虑动态与静态内容重用的不同方面： 包括和导入

请记住，剧本是在库存项目的基础上运行的，所有角色模式和代码重用都是为了组织和简化作为代码的基础设施的维护。 并且对于每次运行，任务都应该在同一台主机上生效，并产生幂等的结果。

也就是说，一开始将同一组任务（即角色）运行两次是没有意义的，因为任何后续执行都没有实际效果（由于幂等性）。

例外情况是角色调用具有不同的参数（变量、标签等​​），因此在执行上存在实际差异，可能会影响幂等性并导致有些不同的结果。 在这些情况下，不止一次运行同一组任务是有意义的，这就是发生的事情。

根据经验，特别是对于静态内容，将执行的所有代码就像一个单独的自包含剧本（即使在包含两个或多个“子”剧本的“站点”剧本中），并且范围仍然是全局的。