1 2 3 4 5 作者：李晓辉 微信联系：Lxh_Chat 联系邮箱: 939958092@qq.com
Ansible内容集合详解 内容集合介绍 Ansible内容集合（Collections）是什么？
Ansible 内容集合其实是一种很不错的方式来整理和分发自动化资源。它将模块、插件、角色、文档和其他相关文件打包在一起，变成一个可以独立管理、方便重用的单元。这样，用户就能轻松获取和使用需要的资源。
内容集合的核心组成部分：
模块（Modules） ：这些是执行特定任务的小脚本，比如管理文件、安装软件等。
插件（Plugins） ：这些是可插拔的组件，用来扩展 Ansible 的功能，比如回调插件、过滤器插件等。
角色（Roles） ：用来组织和重用自动化任务的目录结构。
文档与示例 ：这些帮助用户理解和使用内容集合的指南、YAML 示例文件等。
使用内容集合的优势 模块化与解耦 ：内容集合将资源与 Ansible 核心分离，可以单独更新，避免影响到整个系统。
便于分发和管理 ：通过 ansible-galaxy 命令，用户可以方便快捷地安装和管理集合，提升效率。
命名空间支持 ：使用 namespace.collection_name 结构，避免命名冲突，让不同团队或项目的内容不互相干扰。
社区驱动 ：开发者和组织可以共享自己的内容集合，推动开源社区的共同发展，大家都能从中受益。
使用内容集合与传统方式的区别 在内容集合（Collections）出现之前，Ansible依赖于角色目录结构和核心模块包。这种方式有以下不足：
模块更新困难 ：所有模块都绑定在Ansible核心版本中，更新模块需要升级整个Ansible版本。
缺乏灵活性 ：角色和模块是分离的，用户必须单独管理多个独立资源。
而内容集合统一了这些资源，将模块、插件、角色和文档打包到一起，作为一个独立的分发单元。这种设计消除了传统方式的局限性。
使用内容集合的好处 模块化和解耦 ：内容集合允许模块与Ansible核心独立更新，从而更快地响应需求变化。
统一的分发方式 ：通过ansible-galaxy命令，用户可以方便地安装、升级和管理内容集合，减少了手动管理的复杂性。
增强的代码可读性 ：引用内容集合资源时，命名空间提供了明确的上下文，例如community.general.ping，用户能快速知道资源的来源。
支持开源生态和社区贡献 ：开发者能够轻松发布和分享内容集合，推动社区更快地发展和创新。
内容集合的命名空间介绍 为什么需要命名空间？
命名空间（Namespace）的引入是为了在管理内容时避免冲突并增强组织性。在Ansible的发展初期，所有的模块、插件和角色是平面化的组织方式，容易出现以下问题：
命名冲突： 不同开发者创建的模块或角色可能使用相同的名称，导致冲突和混淆。
难以组织和管理： 随着Ansible生态系统的扩展，资源数量激增，缺乏层次结构会使资源管理变得复杂。
通过命名空间，Ansible可以为不同来源（如个人开发者或组织）创建独立的逻辑空间。例如，通过namespace.collection_name.module_name的结构，可以确保资源的唯一性，同时提升代码的可读性和可维护性。
命名空间是集合名称的第⼀部分
由 Ansible 社区维护的所有集合可能会放⼊community 命名空间中，名称类似于 community.crypto 由红帽维护和⽀持的集合则可能会放⼊ redhat 命名空间，名称类似于redhat.rhv 命名空间的名称仅可使⽤ ASCII ⼩写字⺟、数字和下划线，⻓度必须⾄少为两个字符，并且不得以下划线开头
查询Ansible内容集合⽂档 使⽤ ansible-navigator collections 命令，列出⾃动化执⾏环境中可⽤的集合，:数字回车打开打开第X行中可用的模块
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 [student@workstation ~]$ podman login hub.lab.example.com -u admin -p redhat Login Succeeded! [student@workstation ~]$ cat ansible-navigator.yml --- ansible-navigator: execution-environment: image: 'hub.lab.example.com/ee-supported-rhel8:latest' playbook-artifact: enable : false [student@workstation ~]$ ansible-navigator collections Name Version Shadowed Type Path 0│amazon.aws 3.2.0 False contained /usr/share/ansible/collections/ansible_collections/amazon/aws 1│ansible.builtin 2.13.4 False contained /usr/lib/python3.9/site-packages/ansible 2│ansible.controller 4.2.1 False contained /usr/share/ansible/collections/ansible_collections/ansible/controller 3│ansible.netcommon 3.1.1 False contained /usr/share/ansible/collections/ansible_collections/ansible/netcommon 4│ansible.network 1.2.0 False contained /usr/share/ansible/collections/ansible_collections/ansible/network 5│ansible.posix 1.3.0 False contained /usr/share/ansible/collections/ansible_collections/ansible/posix 6│ansible.security 1.0.0 False contained /usr/share/ansible/collections/ansible_collections/ansible/security 7│ansible.utils 2.6.1 False contained /usr/share/ansible/collections/ansible_collections/ansible/utils 8│ansible.windows 1.9.0 False contained /usr/share/ansible/collections/ansible_collections/ansible/windows 9│ansible.yang 1.0.0 False contained /usr/share/ansible/collections/ansible_collections/ansible/yang 10│arista.eos 5.0.0 False contained /usr/share/ansible/collections/ansible_collections/arista/eos 11│cisco.asa 3.0.0 False contained /usr/share/ansible/collections/ansible_collections/cisco/asa 12│cisco.ios 3.0.0 False contained /usr/share/ansible/collections/ansible_collections/cisco/ios
使⽤ansible-navigator doc ansible.builtin.user -m stdout 命令以纯⽂本形式呈现帮助⽂档
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 [student@workstation ~]$ ansible-navigator doc ansible.builtin.user -m stdout > ANSIBLE.BUILTIN.USER (/usr/lib/python3.9/site-packages/ansible/modules/user.py) Manage user accounts and user attributes. For Windows targets, use the [ansible.windows.win_user] module instead. ADDED IN: version 0.2 of ansible-core OPTIONS (= is mandatory): - append If `yes ', add the user to the groups specified in `groups' . If `no', user will only be added to the groups specified in `groups' , removing them from all other groups . [Default: False] type : bool - authorization Sets the authorization of the user. Does nothing when used with other platforms. Can set multiple authorizations using comma separation. To delete all authorizations, use `authorization='' '. Currently supported on Illumos/Solaris. [Default: (null)] type: str added in: version 2.8 of ansible-core
在 Playbook 中使⽤collecction 使用FQCN来使用集合中的模块或角色，例如使⽤ansible.builtin.user模块
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 --- - name: Manage users on the system hosts: servera.lab.example.com become: yes tasks: - name: Create a new user ansible.builtin.user: name: lixiaohui state: present shell: /bin/bash - name: Ensure user lixiaohui has a specific UID ansible.builtin.user: name: lixiaohui uid: 1234
运行一下看看
1 2 3 4 5 6 7 8 9 10 11 12 13 14 [student@workstation ~]$ ansible-navigator run playbook.yml -m stdout PLAY [Manage users on the system] ****************************************************************************************************************************************************** TASK [Gathering Facts] ***************************************************************************************************************************************************************** ok: [servera.lab.example.com] TASK [Create a new user] *************************************************************************************************************************************************************** changed: [servera.lab.example.com] TASK [Ensure user lixiaohui has a specific UID] **************************************************************************************************************************************** changed: [servera.lab.example.com] PLAY RECAP ***************************************************************************************************************************************************************************** servera.lab.example.com : ok=3 changed=2 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
去看看是否创建成功
1 2 3 [student@workstation ~]$ ansible servera.lab.example.com -m shell -a 'id lixiaohui' servera.lab.example.com | CHANGED | rc=0 >> uid=1234(lixiaohui) gid=1002(lixiaohui) groups =1002(lixiaohui)
以下 playbook 中的 play 将从 redhat.satellite 集合调⽤ organizations ⻆⾊
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 --- - name: Add the test organizations to Red Hat Satellite hosts: localhost tasks: - name: Ensure the organizations exist ansible.builtin.include_role: name: redhat.satellite.organizations vars: satellite_server_url: https://sat.example.com satellite_username: admin satellite_password: Sup3r53cr3t satellite_organizations: - name: test1 label: tst1 state: present
许多 Ansible 内容集合也使⽤此重定向机制将旧的短名称转译为 FQCN，例如acl 模块现在是 ansible.posix 集合的⼀部分，该集合使⽤ansible.posix.acl 作为其 FQCN。
内置的collections Ansible 总是带有一个特别的集合，叫做 ansible.builtin，它包含了一些常用的模块，比如 copy、template、file、yum、command 和 service 等等。你可以在 playbook 里直接用这些模块的简短名称，而不必每次都写全模块名。例如，使用 file 就等于使用 ansible.builtin.file 模块。这样可以让 playbook 看起来更简洁，使用起来也更方便。
1 2 3 4 5 6 7 8 9 --- - name: Install and start Apache HTTPD hosts: web tasks: - name: Ensure the httpd package is present ansible.builtin.yum: name: httpd state: present
查找和安装Collections Ansible 内容集合有两个主要来源：
红帽官⽅⽀持的⾃动化中⼼: https://console.redhat.com/ansible/automation-hub/ 开源社区提供的 Ansible Galaxy: https://galaxy.ansible.com/ 当然，除了这些，你还可以在本地搭建自己的私有自动化中心。
如果自动化执行环境中没有所需的集合，可以创建一个 collections 目录，并将集合安装到该子目录中。然后，运行 ansible-navigator 命令，Ansible 会从这个目录加载并使用集合。
从命令⾏安装collection 默认情况下，ansible-galaxy 命令会尝试从 Ansible Galaxy 下载，不过很明显，我们的虚拟机默认上不了网
1 [student@workstation ~]$ ansible-galaxy collection install community.general:9.0.0
从自定义的位置安装
1 2 3 [student@workstation ~]$ ansible-galaxy collection install /tmp/community-dns-1.2.0.tar.gz [student@workstation ~]$ ansible-galaxy collection install http://www.example.com/redhat-insights-1.0.5.tar.gz [student@workstation ~]$ ansible-galaxy collection install git@github.com:ansible-collections/community.mysql.git
我们可以手工从网站下载tar包
我从这里下的包：https://galaxy.ansible.com/ui/repo/published/community/general/?version=9.0.0
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 [student@workstation ~]$ ansible-galaxy collection list Collection Version ------------------------ ------- redhat.rhel_system_roles 1.16.2 [student@workstation ~]$ ansible-galaxy collection install /home/student/community-general-9.0.0.tar.gz Starting galaxy collection install process Process install dependency map Starting collection install process Installing 'community.general:9.0.0' to '/home/student/.ansible/collections/ansible_collections/community/general' community.general:9.0.0 was installed successfully [student@workstation ~]$ ansible-galaxy collection list Collection Version ------------------------ ------- redhat.rhel_system_roles 1.16.2 Collection Version ----------------- ------- community.general 9.0.0
当 Ansible 运⾏ playbook 时，它会在与 playbook 相同的⽬录下的 collections/ ⽬录中查找集合。 如果在该位置上找不到所需的集合，则使⽤ ansible.cfg 配置⽂件中的collections_paths 指令
注意
如果修改 Ansible 项⽬的 ansible.cfg ⽂件中的 collections_paths，请务必将 /usr/share/ansible/collections 保留为包> 含集合的⽬录之⼀。执⾏环境中包含的集合位于容器内的 /usr/share/ansible/collections ⽬录中
默认情况下，ansible-galaxy 命令将集合安装到 collections_paths 指令定义的第⼀个⽬录中，要将集合安装到其他⽬录，请使⽤ –collections-path（或 -p）选项：
1 [student@workstation ~]$ ansible-galaxy collection install community.postgresql -p ~/myproject/collections/
从Requirements安装collections collections/requirements.yml ⽂件列出了在 Ansible 项⽬中运⾏ playbook 所需安装的所有集合
1 2 3 4 5 6 7 8 --- collections: - name: community.crypto - name: ansible.posix version: 1.2 .0 - name: /tmp/community-dns-1.2.0.tar.gz - name: http://www.example.com/redhat-insights-1.0.5.tar.gz - name: git@github.com:ansible-collections/community.mysql.git
举例例子来说：
1 2 3 4 5 6 [student@workstation ~]$ mkdir collections [student@workstation ~]$ vim collections/requirements.yml [student@workstation ~]$ cat collections/requirements.yml --- collections: - name: /home/student/community-general-9.0.0.tar.gz
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 [student@workstation ~]$ ansible-galaxy collection list Collection Version ------------------------ ------- redhat.rhel_system_roles 1.16.2 Collection Version ----------------- ------- community.general 9.0.0 [student@workstation ~]$ rm -rf /home/student/.ansible/collections/ansible_collections/community/ [student@workstation ~]$ ansible-galaxy collection list Collection Version ------------------------ ------- redhat.rhel_system_roles 1.16.2 [student@workstation ~]$ ansible-galaxy collection install -r collections/requirements.yml Starting galaxy collection install process Process install dependency map Starting collection install process Installing 'community.general:9.0.0' to '/home/student/.ansible/collections/ansible_collections/community/general' community.general:9.0.0 was installed successfully [student@workstation ~]$ ansible-galaxy collection list Collection Version ------------------------ ------- redhat.rhel_system_roles 1.16.2 Collection Version ----------------- ------- community.general 9.0.0
从⾃动化中⼼安装集合 在server_list中定义的每个项目，必须在下方定义具体的galaxy_server.xxxx名称，并提供位置、验证信息
ansible.cfg ⽂件中的内容：
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 [student@workstation ~] $ cat > ansible.cfg <<-EOF[defaults] inventory = ./inventoryremote_user = student[privilege_escalation] become = true become_method = sudobecome_user = rootbecome_ask_pass = false [galaxy] server_list = automation_hub, galaxy[galaxy_server.automation_hub] url =https://hub.lab.example.com/api/galaxy/content/community/token =8 c3d6d94f7e28232492eb626fa75ede81c8bb83b[galaxy_server.galaxy] url =https://galaxy.ansible.com/EOF
这个token在https://hub.lab.example.com/ui/token
token被明文写进去可能不好，可以用变量来表示：
需要注意变量的名称中，AUTOMATION_HUB是你写在cfg文件中的名称
1 2 3 [galaxy_server.automation_hub] url =https://hub.lab.example.com/api/galaxy/content/community/[student@workstation ~] $ export ANSIBLE_GALAXY_SERVER_AUTOMATION_HUB_TOKEN ='eyJh...Jf0o'
不管你怎么处理的token，都这样安装
1 2 3 4 5 [student@workstation ~]$ ansible-galaxy collection install community.general Starting collection install process Downloading https://hub.lab.example.com/api/galaxy/v3/plugin/ansible/content/community/collections/artifacts/community-general-6.1.0.tar.gz to /home/student/.ansible/tmp/ansible-local-18606d1spqgn5/tmpysvlewtk/community-general-6.1.0-grqe0hj2 Installing 'community.general:6.1.0' to '/home/student/.ansible/collections/ansible_collections/community/general' community.general:6.1.0 was installed successfully
如果不想使用token，也可以用密码
1 2 3 4 [galaxy_server.automation_hub] url =https://console.redhat.com/api/automation-hub/username =operator1password =Sup3r53cR3t
列出已安装的集合 列出自动化执行环境中的collection
1 [student@workstation ~]$ ansible-navigator collections
列出控制节点上的collection
1 [student@workstation ~]$ ansible-galaxy collection list
选择执⾏环境 ⾃动化执⾏环境概述 自动化执行环境就像是 Ansible Playbook 的工作区，它其实是一个容器镜像，里面包含了 Ansible 内容集合、所有需要的软件依赖，还有一个运行 Playbook 的最小 Ansible 引擎。
红帽把这些自动化执行环境保存在它们的容器仓库里（registry.redhat.io），比如：
registry.redhat.io/ansible-automation-platform-22/ee-minimal-rhel8:latestregistry.redhat.io/ansible-automation-platform-22/ee-supported-rhel8:latestregistry.redhat.io/ansible-automation-platform-22/ee-29-rhel8:latest这让我们可以方便地拿来用，省去自己搭建环境的麻烦。
检查⾃动化执⾏环境 我们的课程的镜像是打lab带来的，比如说lab start manage-selecting
1 2 3 4 5 6 7 8 9 [student@workstation ~]$ cat ansible-navigator.yml --- ansible-navigator: execution-environment: image: 'hub.lab.example.com/ee-supported-rhel8:latest' pull: policy: missing playbook-artifact: enable : false
1 2 3 4 5 [student@workstation ~]$ ansible-navigator images Image Tag Execution environment Created Size 0│ee-29-rhel8 latest True 4 months ago 815 MB 1│ee-minimal-rhel8 latest True 4 months ago 265 MB 2│ee-supported-rhel8 latest True 4 months ago 1.05 GB
navigator选择自动化执行环境 当你想要在自动化执行环境中运行 Playbook 时，可以使用 ansible-navigator run 命令。这个命令会在指定的执行环境中运行 Playbook，默认情况下它会使用系统的默认环境。
如果你想使用一个非默认的自动化执行环境，可以通过 –eei 选项来指定。比如，假设你有一个自定义的执行环境，你可以这样指定它：
1 [student@workstation ~]$ ansible-navigator run oldplaybook.yml --eei ee-supported-rhel8
你可以通过使用 --pp 选项来控制 ansible-navigator 如何拉取容器镜像。这里有几个参数可以帮助你管理镜像的拉取方式：
选项 描述 always 每次都拉取镜像，无论镜像是否已经存在 missing 只在本地没有镜像时才拉取 never 永远不拉取镜像 tag 如果镜像标签是 latest 或者本地没有镜像，才会拉取（默认行为）
不过，如果你不想每次都在命令行使用这些选项，还可以创建一个 ansible-navigator.yml 配置文件，里面定义你默认使用的自动化执行环境。这样，你只需要在配置文件中设置一次，之后运行命令时就不需要每次都指定了，操作起来更方便。
微信
