自动化控制器入门

Red Hat Ansible Automation Platform 2.4

自动化控制器入门指南

Red Hat Customer Content Services

摘要

本指南介绍了如何设置控制器应用，然后使用启动更复杂的 playbook。设置过程通常少于 30 分钟。

前言

首先，安装 Ansible Automation Platform 并选择可以部署初始 playbook 的目标系统（由自动化控制器提供）。第一个 playbook 执行简单的 Ansible 任务，同时指导您如何使用控制器并正确设置它。您可以使用 Ansible 可管理的任何类型的系统，如 Ansible 文档的 Managed nodes 部分所述。具体步骤请查看 Red Hat Ansible Automation Platform 安装指南。

注意

Ansible Automation Platform 基于订阅提供。这些订阅在价格和支持级别上有所不同。有关订阅和功能的更多信息，请参阅订阅类型。

对红帽文档提供反馈

如果您对本文档有任何改进建议，或发现错误，请通过 https://access.redhat.com 联系技术支持来创建一个请求。

第 1 章安装后登录到自动化控制器仪表板

安装自动化控制器后，您必须登录到仪表板。

流程

使用安装完成后提供的登录信息，打开 Web 浏览器，并通过导航到其服务器 URL 登录自动化控制器： https://<CONTROLLER_SERVER_NAME>/
使用安装过程中指定的凭证登录：
- 默认用户名是 admin。
- admin 的密码是指定的值。
点所需用户 旁边的 More Actions 图标。
点 Edit。
编辑所需详情并点 Save。

第 2 章管理 Ansible 自动化控制器订阅

在使用自动化控制器前，您必须有一个有效的订阅，授权其使用。

2.1. 获取授权的 Ansible 自动化控制器订阅

如果您已经订阅红帽产品，您可以通过该订阅获取自动化控制器订阅。如果您没有 Red Hat Ansible Automation Platform 和 Red Hat Satellite 订阅，您可以请求一个试用订阅。

流程

如果您有 Red Hat Ansible Automation Platform 订阅，请在启动自动化控制器时使用您的红帽客户凭证来访问您的订阅信息。请参阅导入订阅。
如果您有非 Ansible 红帽或 Satellite 订阅，请使用以下方法之一访问自动化控制器：
- 在许可证页面中输入您的用户名和密码。
- 从红帽客户门户网站的 Subscription Allocations 页面获取订阅清单。如需更多信息，请参阅自动控制器 用户指南中的获取订阅清单。
- 如果您没有 Red Hat Ansible Automation Platform 订阅，请访问 Try Red Hat Ansible Automation Platform 并请求试用订阅。

其他资源

要了解您的订阅支持的内容，请参阅自动化控制器许可证、更新和支持。* 如果您的订阅有问题，请联络您的销售账户经理或红帽客户服务：https://access.redhat.com/support/contact/customerService/。

2.2. 导入订阅

获得授权 Ansible Automation Platform 订阅后，您必须在使用自动化控制器前将其导入到自动化控制器系统中。

注意

默认情况下，当您在第一次登录时激活自动化控制器时，您会被选择用于 Automation Analytics。这有助于红帽通过提供更好的用户体验来改进产品。您可以通过执行以下操作来选择不使用：

在导航面板中，选择 Settings 并选择 Miscellaneous System settings 选项。
点 Edit。
将 Automation Analytics 的 Gather 数据 切换到 off 位置。
点击 Save。

要使自动化分析有效，您的自动化控制器实例必须在 Red Hat Enterprise Linux 上运行。

如需更多信息，请参阅 Automation Analytics 部分。

先决条件

您已获得一个订阅清单。如需更多信息，请参阅获取订阅清单。

流程

第一次启动自动化控制器。这时将显示 订阅管理 屏幕。
通过完成以下步骤之一检索并导入您的订阅：
1. 如果您获取了订阅清单，请导航到保存该文件的位置来上传它。订阅清单是完整的 .zip 文件，而不仅仅是其组件部分。
  注意
  如果 Subscription manifest 选项中的 Browse 选项被禁用，请清除 username 和 password 字段来启用它。
  然后，订阅元数据从 RHSM/Satellite API 或提供的清单中检索。如果在单一安装中应用了很多订阅计数，自动化控制器会合并计数，但使用最早的过期日期作为过期日期（必须刷新您的订阅）。
2. 如果您使用您的红帽客户凭证，请在许可证页面中输入您的用户名和密码。如果您的自动化控制器集群节点使用 Subscription Manager 注册到 Satellite，请使用您的 Satellite 用户名或密码。输入凭证后，点 Get Subscriptions。
  自动化控制器检索您配置的订阅服务。然后，它会提示您选择要运行的订阅，并将该元数据应用到自动化控制器。您可以随着时间的推移登录，并在续订后检索新的订阅。
点击 Next。
检查并选中 I agree to the End User License Agreement 复选框，点 Submit。
接受订阅后，自动化控制器会显示订阅详情并打开 Dashboard。要从 Dashboard 返回 Subscription 设置屏幕，请在导航面板中的 Subscription 选项中选择 Settings Subscription 设置。
可选：要从 Dashboard 返回 Subscription 设置屏幕，请在导航面板中选择 Settings → Subscription settings 选项。

对订阅进行故障排除

当您的订阅过期时（您可以在 Subscription settings 窗口的订阅详情中检查它），您必须在自动化控制器中更新它。您可以通过导入新订阅或设置新订阅来完成此操作。

如果您满足"安全获取许可证"消息，请检查您是否具有 Satellite 用户所需的正确权限。自动化控制器管理员需要应用订阅。

Satellite 用户名和密码用于查询 Satellite API 现有订阅。在 Satellite API 中，自动化控制器接收有关这些订阅的元数据，然后过滤以查找可应用的有效订阅。然后，在 UI 中将它们显示为有效订阅选项。

以下 Satellite 角色授予适当的访问权限：

Custom with view_subscriptions 和 view_organizations 过滤器
Viewer
Administrator
Organization Administrator（机构管理员）
Manager（管理者）

将 Custom 角色用于自动化控制器集成，因为它是最严格的限制。如需更多信息，请参阅有关管理用户和角色的 Satellite 文档。

注意

System Administrator 角色不等于 Administrator 用户复选框，不提供访问订阅 API 页面的足够权限。

2.3. 故障排除：保持您的订阅符合要求

您的订阅具有两个可能的状态：

compliant ：代表您的订阅适用于您在订阅数中自动的主机数量。
合规性 ：表示您已超过订阅中的主机数量。

如需更多信息，请参阅自动控制器 用户指南中的 故障排除：在合规中保持您的订阅。

2.4. 主机指标工具

自动化控制器提供了一种通过命令行界面(CLI)生成主机指标数据和主机指标摘要的 CSV 输出的方法。您还可以通过 API 软删除批量的主机。

如需更多信息，请参阅 自动化控制器用户指南中的 主机指标实用程序章节。

第 3 章使用自动化控制器仪表板进行 IT 编配

控制面板为您的 IT 编配需求提供图形框架。使用导航菜单完成以下任务：

显示不同的视图
进入您的资源
授予用户访问权限
在 UI 中管理自动化控制器功能

3.1. 查看仪表板

流程

点 Menu 图标隐藏或显示导航面板。
- 在主仪表板中，会出现一个列出您当前的 作业状态 的摘要。
- 您可以在一段时间内或按作业类型过滤作业状态。
- 您可以在对应的标签页中查看 Recent Jobs 和 Recent Templates 的摘要。

导航面板中的最后一个项是 Settings，它提供对自动化控制器配置设置的访问。

Settings 页面允许管理员配置以下设置：

身份验证
Jobs
系统级属性
自定义 UI 和产品许可证信息

如需更多信息，请参阅 自动化控制器管理指南中的自动化控制器配置。

注意

要启动简单的 playbook，您必须设置多个配置选项。完成启动的配置任务现在可确保自动化控制器配置正确，以后可以更轻松地执行更多涉及的 playbook。

第 4 章管理自动化控制器中的机构

机构是用户、团队、项目和清单的逻辑集合。它是控制器对象层次结构中的最高级别对象。创建机构后，自动化控制器会显示机构详情。然后，您可以管理机构的访问和执行环境。

4.1. 查看机构

机构页面会显示您安装的现有机构。

流程

在导航面板中，选择 Access → Organizations。
注意
自动化控制器会自动创建默认机构。如果您有自助支持级别许可证，则只有默认机构可用，且不得删除它。
您可以使用默认机构，因为它最初设置并在以后编辑它。
注意
只有企业或高级许可证才能添加新机构。

希望添加新机构的企业和高级许可证用户应该请参见 自动化控制器用户指南中的 组织部分。

4.2. 编辑机构

在初始设置过程中，您可以将默认机构保留原样，但您可以稍后编辑它。

流程

使用以下方法之一编辑机构：
- 在 organizations Details 页面中，点您要修改的机构旁的 Edit。
- 在导航面板中，选择 Access → Organizations。选择您要修改的机构，并编辑适当的详情。
保存您的更改。

第 5 章自动化控制器中的用户角色

与某个机构关联的用户显示在机构的 Access 选项卡中。

会自动创建具有 System Administrator 角色的默认管理员用户，并可供自动化控制器的所有用户使用。您可以将其原样使用，或在以后进行编辑。可以将其他用户添加到组织，包括 普通用户、系统审计员 或 System Administrator，但必须首先创建它们。

如需更多信息，请参阅自动化控制器用户指南中的用户部分。

为了获得入门指南，请保留默认用户。

第 6 章清单

清单是由自动化控制器管理的主机的集合。机构被分配到清单，而针对清单启动 playbook 的权限则在用户或团队级别上控制。

如需更多信息，请参阅以下文档：

6.1. 创建新清单

Inventories 窗口显示当前可用的清单列表。您可以根据名称、搜索类型、机构、描述、所有者和修饰符对清单列表进行排序，或者其它标准。

流程

要查看现有清单，请从导航面板中选择 Resources → Inventories。
- 自动化控制器提供了一个演示清单，供您用于学习控制器的工作原理。您可以将其原样使用，或在以后进行编辑。如果需要，您可以创建另一个清单。
要添加另一个清单，请参阅 自动化控制器用户指南中的 添加新清单。https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html-single/automation_controller_user_guide/index#proc-controller-adding-new-inventory
单击 Demo Inventory 以查看其详细信息。

与机构一样，清单也关联了用户和团队，您可以通过 Access 选项卡来查看它们。如需更多信息，请参阅 自动化控制器用户指南中的 清单。

为此，会自动填充 具有系统管理员 角色的用户。

6.2. 管理组和主机

清单被分成组和主机。组可以代表特定的环境（如 "Datacenter 1" 或 "Stage Testing"）、服务器类型（如 "Application Servers" 或 "DB Servers"），或者您的环境的任何其他表示。属于 Demo 清单的组和主机显示在 Groups 和 Hosts 选项卡中。

6.2.1. 添加新组和主机

组仅适用于标准清单，不能直接通过智能清单进行配置。您可以通过与标准清单搭配使用的主机关联现有组。如需更多信息，请参阅 自动化控制器用户指南中的 将组添加到清单。

流程

在导航面板中，选择 Resources → Inventories。
要添加新组，请选择" 组" 选项卡，然后单击添加。
要向组添加新主机，请选择 Hosts 选项卡，再单击 Add。

作为初始设置的一部分，并测试自动化控制器是否已正确设置，添加了本地主机供您使用。

示例

如果您创建的机构有一组支持特定应用程序的 web 服务器主机，请完成以下步骤：

创建组并添加 Web 服务器主机，将这些主机添加到清单中。
点 Cancel （如果您没有进行任何更改），或者使用自动化控制器浏览器顶部的面包屑 导航链接返回清单 列表视图。点 Save 不会退出 Details 对话框。

第 7 章管理凭证

凭据对控制器用户进行身份验证，以启动 Ansible playbook。密码和 SSH 密钥用于对清单主机进行身份验证。通过使用自动化控制器的凭证功能，您可以要求自动化控制器用户在 playbook 启动时输入密码或密钥短语。

7.1. 创建新凭证

作为初始设置的一部分，已创建一个演示凭据和一个 Galaxy 凭据供您使用。使用 Galaxy 凭据作为模板。它可以复制，但不能编辑。您可以根据需要添加更多凭证。

流程

在导航面板中，选择 Resources → Credentials。
要添加新凭证，请参阅 自动化控制器用户指南中的 创建凭证。
注意
设置附加凭证时，您分配的用户必须有 root 访问权限，或者能够使用 SSH 连接到主机机器。
单击 Demo Credential 以查看其详细信息。

7.2. 编辑凭证

作为初始设置的一部分，您可以保留默认的 Demo Credential，稍后您可以编辑它。

流程

使用以下方法之一编辑凭证：
- 进入 credential Details 页面，再单击 Edit。
- 在导航面板中，选择 Resources → Credentials。点凭证名称旁的 Edit，并编辑适当的详情。
保存您的更改。

第 8 章管理项目

项目是自动化控制器中代表的 Ansible playbook 的逻辑集合。您可以以不同的方式管理 playbook 和 playbook 目录：

将它们手动放在自动化控制器服务器的 Project Base 路径下。
通过将 playbook 放置到自动化控制器支持的源代码管理(SCM)系统中。这包括 Git、Subversion 和 Mercurial。

注意

此入门指南使用轻量级示例来启动并运行。但出于生产目的，您必须使用源控制来管理 playbook。最佳实践是将您的基础架构视为符合 DevOps 理想的代码。

8.1. 设置项目

自动化控制器简化了启动过程，为您提供一个 演示项目，您可以初始使用。

流程

要查看现有项目，请从导航面板中选择 Resources → Projects。
单击 Demo Project 以查看其详细信息。

8.2. 编辑项目

作为初始设置的一部分，您可以保留默认的 Demo Project。您可以稍后编辑它。

流程

打开项目以使用以下方法之一编辑它：
- 前往项目 Details 页面，再单击 Edit。
- 在导航面板中，选择 Resources → Projects。点项目名称旁边的 Edit，再编辑适当的详情。
保存您的更改

8.3. 同步项目

如果要获取项目中的最新更改，您可以手动启动此项目的 SCM 同步。

流程

打开项目，以使用以下方法之一更新基于 SCM 的演示项目：
- 前往项目 Details 页面，再单击 Sync。
- 在导航面板中，选择 Resources → Projects，再单击 Sync Project。

注意

当您添加项目设置为使用源控制时，会启动 "sync"。这会从配置的源控制获取项目详情。

第 9 章使用作业模板

作业模板将项目中的 Ansible playbook 和启动它所需的设置合并在一起。作业模板可用于多次运行同一作业。作业模板还鼓励重复使用 Ansible playbook 内容，并在团队间协作。如需更多信息，请参阅 自动化控制器用户指南中的 作业模板。

9.1. 作业模板入门

作为初始设置的一部分，会为您创建一个 Demo Job Template。

流程

要查看现有模板，请从导航面板中选择 Resources → Templates。
单击 Demo Job Template 以查看其详细信息。

9.2. 编辑作业模板

作为初始设置的一部分，您可以保留默认的 Demo Job Template，但您可以稍后编辑它。

流程

打开模板以使用以下方法之一编辑它：
- 在作业模板 Details 页面中，点 Edit。
- 在导航面板中，选择 Resources → Templates。点模板名称旁边的 Edit，并编辑适当的详情。
保存您的更改。
要在保存并返回模板列表视图后退出，请使用面包屑导航链接或单击 Cancel。点 Save 不会退出 Details 对话框。

9.3. 运行作业模板

自动化控制器的一个优点是 Ansible Playbook 的按钮式部署。您可以配置模板，以存储您通常在命令行上传递给 Ansible Playbook 的所有参数。除了 playbook 外，模板还会通过清单、凭证、额外变量以及您可以在命令行中指定的所有选项和设置。

流程

在导航面板中，选择 Resources → Templates，再单击作业模板的 Launch。

初始作业启动会生成状态页面，该页面使用自动化控制器的实时事件功能自动更新，直到作业完成为止。

如需有关作业结果的更多信息，请参阅 自动化控制器用户指南中的作业。

其他资源

要了解更多有关这些自动化控制器功能的信息，或者了解管理任务和控制器 API，请参阅以下文档集：

法律通告

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

自动化控制器入门