redhat-cop/automation-good-practices
GitHub: redhat-cop/automation-good-practices
Stars: 339 | Forks: 76
= Ansible 最佳实践指南 - GPA
include::_style/render.adoc[]
== 引言
https://www.redhat.com/en/ansible-collaborative[Ansible] 简单、灵活且强大。与任何强大的工具一样,使用它的方法多种多样,其中一些方法优于其他方法。
本文档旨在汇集来自 Red Hat 的 Ansible 实践者、顾问、开发人员等领域的良好实践。
因此,它力求为任何 Red Hat 员工、合作伙伴或客户(或任何 Ansible 用户)提供一个指南,使他们能够在良好的条件下开启自动化之旅。
这些是基于多人经验的带有明确倾向性的指导方针。
如果它们不适合读者的特定用例、组织或需求,则不意味着必须盲目遵循;
它们被称为 _良好_ 而非 _最佳_ 实践是有原因的。
本文档的读者应具备 Ansible 的实际操作经验。
如果读者是 Ansible 新手,那么 https://docs.ansible.com/[Ansible 官方文档] 中的 https://docs.ansible.com/ansible/latest/user_guide/index.html#getting-started[入门指南] 部分是更好的起点。
本文档分为六个主要部分。
每一部分涵盖使用 Ansible(更广义地说是整个 https://www.redhat.com/en/technologies/management/ansible[Red Hat Ansible Automation Platform],包括 Ansible Tower)进行自动化的不同方面:
. 结构:在深入细节之前,我们需要了解使用什么来实现什么目的,本节将对此进行解释。
. 角色:由于我们建议使用角色来存放最核心的 Ansible 代码,因此我们也会在此涵盖更底层的代码方面(任务、变量等)。
. 集合
. Playbooks
. 清单
. 插件
// TODO 一旦我们确定了各节内容,再添加一些关于每部分内容的说明...
每一部分由若干指南组成:一条易于记忆的简短说明,后跟描述、原理和示例。
本文档的 HTML 版本使内容可以折叠,以便所有指南能以一目了然的方式同时呈现,读者可以展开他们感兴趣的指南内容。
每项良好实践都应附带原理说明,如果适用,还需提供参考文献。
不仅了解如何做某些事情,还要了解为什么以这种方式做,这非常有帮助。
这也有助于标准的后续修订,因为某些条款可能会过时或不再适用。
如果不包含原因,则存在保留不再适用条款的风险,或者反之,盲目删除本应保留的条款。
它对于理解事物实际如何运作(或如何不运作)也具有重要的教育价值。
=== 获取与维护本文档
本文档发布于 https://redhat-cop.github.io/automation-good-practices/,它是开源的,其源代码维护在 https://github.com/redhat-cop/automation-good-practices/。
include::structures/README.adoc[leveloffset=1]
include::roles/README.adoc[leveloffset=1]
include::collections/README.adoc[leveloffset=1]
include::playbooks/README.adoc[leveloffset=1]
include::inventories/README.adoc[leveloffset=1]
include::plugins/README.adoc[leveloffset=1]
include::coding_style/README.adoc[leveloffset=1]
标签:Ansible Tower, Ansible自动化, IT自动化, Red Hat, 代码规范, 剧本, 技术文档, 插件, 最佳实践, 清单, 管理, 自动化平台, 自动化指南, 角色, 部署, 集合