为 Red Hat Developer Hub 使用 Ansible 插件
为 Red Hat Developer Hub 使用 Ansible 插件
摘要
前言 复制链接链接已复制到粘贴板!
感谢您对 Red Hat Ansible Automation Platform 的关注。Ansible Automation Platform 是一个商业产品,它可以帮助团队通过增加控制、知识、协调基于 Ansible 的环境来更好地管理多阶的复杂部署环境。
本指南论述了如何将 Ansible 插件用于 Red Hat Developer Hub。本文档已更新,以包含 Ansible Automation Platform 最新版本的信息。
对红帽文档提供反馈 复制链接链接已复制到粘贴板!
如果您对本文档有任何改进建议,或发现错误,请通过 https://access.redhat.com 联系技术支持来创建一个请求。
第 1 章 使用 Ansible 插件 复制链接链接已复制到粘贴板!
您可以使用 Red Hat Developer Hub (RHDH)的 Ansible 插件来学习 Ansible,创建自动化项目,以及访问建议的工作流和工具来开发和测试您的自动化代码。在 Red Hat Developer Hub UI 中,您可以进入到 Ansible Automation Platform 实例,您可以在其中配置和运行自动化作业。
本文档论述了如何将 Ansible 插件用于 Red Hat Developer Hub。它显示了开发一个 playbook 项目,以便在 RHEL 系统上自动更新到您的防火墙配置的工作示例。
1.1. 可选要求 复制链接链接已复制到粘贴板!
Red Hat Developer Hub 的 Ansible 插件链接到红帽开发人员门户上的学习路径 developer. redhat.com/learn。
要访问学习路径,您必须拥有红帽帐户,并且您必须能够登录 developer. redhat.com。
1.2. 仪表板导航 复制链接链接已复制到粘贴板!
当您登录到 Red Hat Developer Hub (RHDH)时,会显示主 RHDH 菜单和仪表板。
要查看 Red Hat Developer Hub Ansible 插件的仪表板,请在 Red Hat Developer Hub 导航面板中点 Ansible。
插件仪表板演示了您需要了解 Ansible 从 Ansible 部署 Ansible 的步骤:
- 概述 显示主仪表板页面。
- 学习红帽 提供介绍 Ansible 所需的资源的链接,并提供开始的逐步示例。有关更多信息,请参阅有关 Ansible 的学习。
- 发现到私有自动化中心的现有集合 链接,如果在插件中配置,或者在 Red Hat Hybrid Cloud Console 上托管的自动化中心。Automation Hub 存储您可以在项目中使用的现有集合和执行环境。如需更多信息,请参阅 发现现有集合。
- 在 配置的 Source Control Management 平台(如 GitHub)中创建新项目。如需更多信息,请参阅 创建项目。
- 在 Ansible 插件安装中配置,开发 您链接到 OpenShift Dev Spaces 的链接。OpenShift Dev Spaces 提供按需、基于 Web 的集成开发环境(IDE),您可在其中开发自动化内容。有关更多信息,请参阅 开发项目。
- 操作 会将您连接到 Ansible Automation Platform,您可以在其中创建并运行使用您开发的项目的自动化作业。如需更多信息,请参阅设置控制器项目以运行您的 playbook 项目。
1.3. 了解 Ansible 复制链接链接已复制到粘贴板!
要了解更多有关使用自动化的信息,请点击插件仪表板的 Overview 页面中的 Learn。Learn 页面提供以下选项以学习:
学习路径 列出了托管在 developers.redhat.com 上的一系列学习工具,指导您完成使用 Ansible 的基础、Ansible VS Code 扩展和使用 YAML。
您可以从 Useful links 部分中选择其他 Ansible 学习路径。
- 实验室 是自助式实验,旨在为您提供编写 Ansible 内容和使用 Ansible 开发工具的实践经验。
1.4. 发现现有集合 复制链接链接已复制到粘贴板!
在 Red Hat Developer Hub 上的 Ansible 插件仪表板的 Overview 页面中,单击 Discover Existing Collections。
此窗格中的链接提供对您在插件安装过程中配置的可重复使用的自动化内容集合源的访问。
如果在安装插件时配置了私有自动化中心,您可以点 Go to Automation Hub 查看企业策展的集合和执行环境。
如果您在安装插件时没有配置私有自动化中心 URL,Discover 现有集合 窗格提供了 console.redhat.com 上 Red Hat Automation hub 的链接。您可以探索此站点上已认证和验证的 Ansible 内容集合。
1.5. 创建一个项目 复制链接链接已复制到粘贴板!
前提条件
- 确保具有正确的访问权限(RBAC)以查看 Red Hat Developer Hub 中的模板。如果需要,请联系您的管理员分配访问权限。
流程
- 登录到您的 Red Hat Developer Hub UI。
-
点 Red Hat Developer Hub 导航面板中的 Ansible
A图标。 - 导航到 Overview 页面。
- 点 Create。
- 单击 Create Ansible Git Project。Available Templates 页面将打开。
- 单击 Create Ansible Playbook 项目。
在 Create Ansible Playbook Project 页面中,以表单输入新项目的信息。
您可以在 Example 项目中看到此表单的示例值。
Expand 字段 描述 源代码存储库机构名称或用户名
源代码存储库用户名或机构名称
Playbook 存储库名称
新 Git 存储库的名称
Playbook 描述(可选)
新 playbook 项目的描述
Playbook 项目的集合命名空间
新 playbook Git 项目为您创建一个示例集合文件夹。为集合命名空间输入一个值。
Playbook 项目的集合名称
集合的名称
目录所有者名称
Developer Hub 目录项所有者的名称。这是一个 Red Hat Developer Hub 字段。
源代码存储库机构名称或用户名
源代码存储库用户名或机构名称
Playbook 存储库名称
新 Git 存储库的名称
Playbook 描述(可选)
新 playbook 项目的描述
系统(可选)
这是一个 Red Hat Developer Hub 字段
注意集合命名空间必须遵循 Python 模块命名约定。集合必须具有简短的、所有小写名称。您可以在名称中使用下划线以提高它的可读性。
如需更多信息,请参阅 Ansible Collection 命名约定文档。
- 点 Review。
1.6. 查看您的项目 复制链接链接已复制到粘贴板!
要查看您在插件中创建的项目,请导航到 Ansible 插件的 Overview 页面,再单击 My Items。
1.7. 开发项目 复制链接链接已复制到粘贴板!
1.7.1. 在 Dev Spaces 中开发项目 复制链接链接已复制到粘贴板!
OpenShift Dev Spaces 不包含在您的 Ansible Automation Platform 订阅中,或 Red Hat Developer Hub 的 Ansible 插件中。
插件提供上下文感知链接,以便在 Dev Spaces 中编辑您的项目。
Dev Spaces 实例提供了一个默认配置,用于安装 Ansible VS Code 扩展并提供 Ansible 命令行工具。您可以在 Ansible VS Code 扩展中激活 Ansible Lightspeed。如需更多信息,请参阅 带有 IBM watsonx Code Assistant User Guide 的 Red Hat Ansible Lightspeed。
1.7.2. 在 Dev Spaces 中执行自动化任务 复制链接链接已复制到粘贴板!
Dev Spaces 的默认配置提供对 Ansible 命令行工具的访问。
要从 VSCode 用户界面在 Dev Spaces 中执行自动化任务,请在文件列表中右键单击 playbook 名称,并通过 ansible-navigator run 或 Run playbook 选择 Run Ansible Playbook。
1.8. 设置控制器项目以运行您的 playbook 项目 复制链接链接已复制到粘贴板!
流程
- Ansible 插件提供 Ansible Automation Platform 的链接。
- 登录到您的 Red Hat Developer Hub UI。
-
点 Red Hat Developer Hub 导航面板中的 Ansible
A图标。 点 Operate 显示到 Ansible Automation Platform 实例的链接。
如果插件安装中没有包括自动化控制器,则会显示产品功能页面的链接。
点 Go to Ansible Automation Platform 在新的浏览器标签页中打开您的平台实例。
或者,如果您的平台实例没有在 Ansible 插件安装过程中配置,请进入浏览器中的自动化控制器实例并登录。
- 登录到自动化控制器。
- 在 Ansible Automation Platform 中为存储 playbook 项目的 GitHub 存储库创建项目。请参阅 TitleControllerUserGuide 的项目章节。https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/using_automation_execution/controller-projects
- 创建使用您创建的项目中的 playbook 的作业模板。请参阅 TitleControllerUserGuide 中的 工作流作业模板 章节。
第 2 章 在 Ansible 插件中提供反馈 复制链接链接已复制到粘贴板!
Ansible 插件提供了一个反馈表,您可以在其中推荐新功能和内容以及常规反馈。
-
点 Red Hat Developer Hub 导航面板中的 Ansible
A图标。 点 Feedback 图标显示反馈表单。
- 输入您要提供的反馈。
- 选择 我理解的反馈会与红帽共享。
- 点 Submit。
为确保红帽收到您的反馈,在任何浏览器广告块或隐私工具中排除您的 Red Hat Developer Hub URL。
第 3 章 示例:自动化 Red Hat Enterprise Linux 防火墙配置 复制链接链接已复制到粘贴板!
本例演示了 Ansible 插件如何帮助 Ansible 用户创建高质量的 Ansible 内容。
作为 Ansible 熟悉的基础架构工程师,您负责创建一个 playbook 来配置 Red Hat Enterprise Linux (RHEL)主机防火墙。
以下流程演示了如何使用 Ansible 插件和 Dev Spaces 来开发 playbook。
3.1. 了解有关 playbook 的更多信息 复制链接链接已复制到粘贴板!
第一步是使用可用的学习路径了解更多有关 Ansible playbook 的信息。
-
点 Red Hat Developer Hub 导航面板中的 Ansible
A图标。 - 单击 Learn,再选择 Getting Started with Ansible Playbook 学习路径。这会将您重定向到 Red Hat Developer 网站。
- 如果提示您登录,请创建一个 Red Hat Developer 帐户,或者输入您的详情。
- 完成学习路径。
3.2. 发现 RHEL 系统角色的现有 Ansible 内容 复制链接链接已复制到粘贴板!
红帽建议您使用红帽或您的机构经过测试并批准的可信自动化内容。
Automation Hub 是一个中央存储库,用于从红帽及其合作伙伴发现、下载和管理可信内容集合。私有自动化中心提供了一个内部解决方案来管理内容集合。
-
点 Red Hat Developer Hub 导航面板中的 Ansible
A图标。 - 单击 Discover existing collections。
点 Go to Automation Hub。
- 如果在 Ansible 插件中配置了私有自动化中心,您会被重定向到您的 PrivateHubName 实例。
- 如果 Ansible 插件安装配置中尚未配置私有自动化中心,您将会被重定向到 Red Hat Hybrid Console (RHCC)自动化中心。
在本例中,您会被重定向到 RHCC 自动化中心。
- 如果提示您登录,请提供您的红帽客户门户网站凭证。
使用
rhel 防火墙关键字过滤集合。搜索返回
rhel_system_roles集合。
RHEL 系统角色集合包含经过认证的 Ansible 内容,您可以重复使用这些内容来配置您的防火墙。
3.3. 创建一个新的 playbook 项目以配置防火墙 复制链接链接已复制到粘贴板!
使用 Ansible 插件创建新的 Ansible Playbook 项目。
-
点 Red Hat Developer Hub 导航面板中的 Ansible
A图标。 - 从登录页面上的创建下拉菜单中,选择 Create Ansible Git Project。
- 单击 Create Ansible Playbook Project 软件模板中的 Choose。
- 在 Create Ansible Playbook Project 页面中填写以下信息:
| 字段 | 必填 | 描述 | 示例值 |
|---|---|---|---|
| 源代码存储库机构名称或用户名 | 是 | 源代码存储库用户名或机构名称。 |
|
| Playbook 存储库名称 | 是 | 新 Git 存储库的名称。 |
|
| Playbook 描述 | 否 | 新 playbook 项目的描述。 |
|
| Playbook 项目的集合命名空间 | 是 | 新 playbook Git 项目为您创建一个示例集合文件夹。为集合命名空间输入一个值。 |
|
| Playbook 项目的集合名称 | 是 | 这是示例集合的名称。 |
|
| 目录所有者名称 | 是 | Developer Hub 目录项所有者的名称。这是一个 Red Hat Developer Hub 字段。 |
|
| System | 否 | 这是一个 Red Hat Developer Hub 字段。 |
|
- 点 Review。
- 单击 Create 以置备您的新 playbook 项目。
- 点 Open in catalog 查看您的项目。
3.4. 创建新 playbook 以自动化防火墙配置 复制链接链接已复制到粘贴板!
创建新 playbook,并使用 RHEL 系统角色集合来自动化 Red Hat Enterprise Linux 防火墙配置。
- 在 Dev Spaces 实例中,点 → 。
-
为文件名输入
firewall.yml,然后单击 OK 将其保存到根目录中。 在您的
firewall.yml文件中添加以下行:Copy to Clipboard Copied! Toggle word wrap Toggle overflow
您可以将 Ansible Lightspeed 与 IBM watsonx Code Assistant 搭配使用,以帮助您生成 playbook。如需更多信息,请参阅使用 IBM watsonx Code Assistant 用户指南的 Ansible Lightspeed。
3.5. 编辑防火墙 playbook 项目 复制链接链接已复制到粘贴板!
Ansible 插件集成 OpenShift Dev Spaces,以编辑您的 Ansible 项目。OpenShift Dev Spaces 提供按需、基于 Web 的集成开发环境(IDE)。
使用 Ansible 插件置备的 Ansible Git 项目包括 OpenShift Dev Spaces 的最佳实践配置。这些配置包括安装 Ansible VS Code 扩展,并从 IDE 终端提供对 Ansible 开发工具的访问,如 Ansible Navigator 和 Ansible Lint。
OpenShift Dev Spaces 是可选的,不需要运行 Ansible 插件。它是一个单独的红帽产品,它不包括在 Ansible Automation Platform 或 Red Hat Developer Hub 订阅中。
本例假定 OpenShift Dev Spaces 已在 Ansible 插件安装中配置。
流程
在 playbook 项目的目录项 视图中,单击 OpenShift Dev Spaces 中的 Open Ansible 项目。
OpenShift Dev Spaces 的 VS Code 实例会在新的浏览器标签页中打开。它会自动加载您的新 Ansible Playbook Git 项目。