使用 Ansible Automation Platform 自助服务技术预览
使用 Ansible Automation Platform 自助服务技术预览
摘要
前言
感谢您对 Red Hat Ansible Automation Platform 的关注。Ansible Automation Platform 是一个商业产品,它可以帮助团队通过增加控制、知识、协调基于 Ansible 的环境来更好地管理多阶的复杂部署环境。
本指南论述了如何将模板添加到 Ansible Automation Platform 自助服务技术预览实例中,以及如何启动模板以运行自动化作业。它还介绍了如何配置基于角色的访问控制(RBAC),以便您可以限制可运行作业的团队和用户。
本文档已更新,以包含 Ansible Automation Platform 最新版本的信息。
对红帽文档提供反馈
如果您对本文档有任何改进建议,或发现错误,请通过 https://access.redhat.com 联系技术支持来创建一个请求。
Ansible Automation Platform 自助服务技术预览功能只是一个技术预览功能。
技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
第 1 章 概述
要使用模板填充自助服务技术预览,您必须在 GitHub 或 Gitlab 中创建存储库,以用于定义模板的集合。
目前,红帽提供了使用自助服务技术预览为 RHEL、网络、Windows 和云自动化作业的示例。
提供的已验证内容示例有自己的支持声明和生命周期定义。请参阅 Red Hat Ansible Automation Platform 生命周期。
这些集合托管在自动化中心中。您的管理员必须将集合添加到私有自动化中心,以便您可以下载它们并创建存储库。
然后,您可以将模板导入到自助服务技术预览中,并启动它们以运行自动化作业。
第 2 章 先决条件
- 您的 Ansible Automation Platform 管理员使用集合填充私有自动化中心。
- 有访问私有自动化中心中的集合的权限。
- 已安装并配置了自助服务技术预览。
第 3 章 为集合设置软件仓库
3.1. 从私有自动化中心导出集合
- 登录到 Ansible Automation Platform。
在导航面板中,选择
→ 。Collections 页面显示所有存储库中的所有集合。您可以搜索特定的集合。
点击您要导出的集合。
此时会打开 Collection 详情页面。
在 Install 选项卡中,选择 Download tarball。
.tar
文件下载到您的默认浏览器下载文件夹。
3.2. 为集合创建软件仓库
-
找到集合的
.tar
文件。 - 创建新目录以存储解压缩的文件。
运行以下命令来解包
.tar
文件:Copy to Clipboard Copied! Toggle word wrap Toggle overflow tar -xvf <collection-name>.tar.gz – directory <collection_directory>
$ tar -xvf <collection-name>.tar.gz – directory <collection_directory>
进入提取的集合目录并将其初始化为 Git 存储库:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow cd <collection_directory> git init
$ cd <collection_directory> $ git init
如果要修改模板,请编辑集合。
Ansible 模板定义存储在存储库的
extensions/patterns/
目录中。将存储库推送到您的 SCM。
- 请参阅 GitHub 文档中的使用 Git 将本地存储库添加到 GitHub。
- 请参阅 Gitlab 文档中的使用 git push 创建项目。
3.3. 为 ansible-pattern-loader
创建软件仓库
要在自助服务技术预览中使用预加载标题之一,您必须在 GitHub 或 Gitlab 中为 ansible-pattern-loader
存储库创建一个存储库。
克隆存储库:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow git clone git@github.com:ansible/ansible-pattern-loader.git
$ git clone git@github.com:ansible/ansible-pattern-loader.git
将存储库推送到您的 SCM。
- 请参阅 GitHub 文档中的使用 Git 将本地存储库添加到 GitHub。
- 请参阅 Gitlab 文档中的使用 git push 创建项目。
第 4 章 为私有存储库配置源控制凭证
要使用私有存储库,您必须将 GitHub 或 Gitlab 个人访问令牌添加到 Ansible Automation Platform 中作为源控制凭证。
确保分配给 Ansible Automation Platform 对象的 Ansible Automation Platform 用户和团队(如源控制凭证)是配置为同步到自助服务技术预览的 Ansible Automation Platform 机构的一部分。如需更多信息,请参阅安装 Ansible Automation Platform 自助服务技术预览。
4.1. 在 Ansible Automation Platform 中为 GitHub 或 Gitlab 添加源控制凭证
前提条件
确保需要访问存储库的用户具有适当的权限。
流程
- 以管理员身份登录 Ansible Automation Platform。
- 进入 → → 。
- 在 Credentials 页面中,单击 。
添加以下详情:
- 名称 :凭证名称。
Organization: 与凭证关联的机构的名称。默认值为 Default。
注意Ansible Automation Platform 中的凭证始终在特定机构下创建。
- 凭证类型 : Source Control.
用户名 :您的 Github 用户名或托管该存储库的 Gitlab 组名称。
注意自助服务技术预览不支持在个人用户帐户下创建或修改 Gitlab 存储库。您必须改为使用 Gitlab Group。
第 5 章 使用模板
5.1. 添加模板
此流程描述了如何在自助服务技术预览实例的 模板 视图中添加标题。
前提条件
您已在 SCM 中为您要使用的模板创建了存储库。
流程
- 在浏览器中,导航到您的自助服务技术预览实例,并使用 Ansible Automation Platform 凭证登录。
- 进入 Templates 页面。
- 单击 Add template。
- 输入您要添加的模板的有效 Github URL。
- 单击 Analyze 以获取模板。
- 获取模板后,查看将要导入并添加到目录中的内容的列表。
- 单击 导入。
验证
导入完成后,返回到 Templates 页面以查看新创建的模板。现在,您可以启动您的模板。
5.2. 启动模板
此流程描述了如何从自助服务技术预览实例的 Templates 视图中的标题启动模板。
流程
- 在浏览器中,导航到您的自助服务技术预览实例,并使用 Ansible Automation Platform 凭证登录。
- 导航到 Templates 页面。您设置的模板会在页面中以标题的形式显示。
在您要启动的模板中,点 Start。
此时会显示模板的描述。
- 点 Launch 开始配置用于运行模板的参数。
- 填写所需字段。
- 点 Next。
- 检查输入的信息。
- 点 Create 启动模板。
- 此时会显示模板执行的进度。
验证
要查看模板执行的日志,请单击 Show logs。
第 6 章 使用 RBAC
6.1. 设置 RBAC
RBAC 在 Helm Chart 中设置,admin
用户设置为 RBAC 管理员(rbac_admin
)。
此流程描述了如何在自助服务技术预览中创建角色,仅允许所选团队查看和执行特定的模板。
先决条件
流程
-
在浏览器中,以 Ansible Automation Platform
admin
用户身份登录自助服务技术预览实例。 - 在导航面板中,选择 → 。
在 RBAC 视图中,点 Create。
此时会出现 Create Role 视图。
- 输入角色的名称。
- 选择您要允许使用角色的用户或组。
- 在 Add Permission policies 部分中,选择要为角色启用的插件。
- 在插件列表中选择 Permission,以便为角色配置细粒度权限策略。
- 点 Next。
- 查看您为角色选择的设置。
- 单击 Create 以创建该角色。
6.2. 验证 RBAC
这个步骤描述了如何验证您设置的角色是否正常工作。
验证具有权限的用户是否可以使用模板:
- 以作为已启用使用角色的团队成员的用户身份登录自助服务技术预览。
- 验证是否应用了 RBAC,并且用户可以使用您为角色启用的模板。
- 从自助服务技术预览注销。
验证没有权限的用户无法看到或使用模板:
- 以不是已启用使用该角色的新团队成员的用户身份登录自助服务技术预览。
- 验证是否应用了 RBAC,并且用户无法使用您为角色启用的模板。
- 从自助服务技术预览注销。
第 7 章 取消注册模板
7.1. 取消激活动态添加的模板
动态添加的模板是在自助服务技术预览控制台中使用 Add Template 添加的模板。
- 在浏览器中,导航到自助服务技术预览实例。
- 单击目录模板名称,以导航到 模板详情视图。导航栏包含 Unregister Template 选项。
- 点 Unregister Template。
- 在对话框中,确认您要取消注册模板。
- 点 Delete Entity 取消模板。
验证
在浏览器中,导航到您的自助服务技术预览实例的 Templates 视图。验证模板已被删除。
7.2. 取消注册预安装的模板
自助服务技术预览已预先加载示例模板,以帮助您开始。要从 Templates 页面中删除预加载的模板,您必须为自助服务安装编辑 Helm Chart。
- 在浏览器中,前往 Ansible Self-service 的 OpenShift 项目。
- 选择 Topology 视图。
- 为您的部署打开 Helm Chart。
找到 Helm Chart 的
catalog.locations
部分:Copy to Clipboard Copied! Toggle word wrap Toggle overflow locations: - type: file target: /software-templates/seed.yaml rules: - allow: [Template]
locations: - type: file target: /software-templates/seed.yaml rules: - allow: [Template]
通过添加
#
字符注释掉catalog.locations
的类型
、target
和rules
键:Copy to Clipboard Copied! Toggle word wrap Toggle overflow locations: # - type: file # target: /software-templates/seed.yaml # rules: # - allow: [Template]
locations: # - type: file # target: /software-templates/seed.yaml # rules: # - allow: [Template]
- 单击 Create 以重新启动部署。
验证
在浏览器中,导航到您的自助服务技术预览实例的 Templates 视图。验证模板已被删除。
第 8 章 在自助服务技术预览中提供反馈
自助服务技术预览提供了一个反馈表,您可以在其中推荐新功能和内容,并提供一般反馈。
在自助服务技术预览控制台中点 Feedback 以显示反馈表。
- 输入您要提供的反馈。
- 选择 我理解的反馈会与红帽共享。
- 点 Submit。
为确保红帽收到您的反馈,在任何浏览器广告块或隐私工具中排除您的自助服务技术预览 URL。