Ansible 导航器创建指南
在 Ansible 创建器工作流中使用 Ansible 导航器.
摘要
使开源包含更多
红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。我们从这四个术语开始：master、slave、黑名单和白名单。由于此项工作十分艰巨，这些更改将在即将推出的几个发行版本中逐步实施。有关更多详情，请参阅我们的首席技术官 Chris Wright 提供的消息。
第 1 章 Ansible 内容导航器简介
作为内容创建者，您可以使用 Automation content 浏览器来开发与红帽 Ansible 自动化平台兼容的 Ansible playbook、集合和角色。您可以在以下环境中使用自动内容导航器，并在所有这些环境中无缝且可预测的结果：
- 本地开发机器
- 自动执行环境
自动化内容导航器还会生成可用于帮助您开发 playbook 和对问题区域进行故障排除的工件文件。
1.2. 自动化内容导航器模式
自动化内容导航器以两种模式运行：
- stdout 模式
- 在命令行中接受大多数现有的 Ansible 命令和扩展。
- 基于文本的用户界面模式
- 为 Ansible 命令提供基于文本的交互式界面。使用工件文件运行 playbook 后，使用此模式评估内容、运行 playbook 并对它们进行故障排除。
1.2.1. stdout 模式
使用带有 Automation 内容导航器的 -m stdout 子命令在自动化执行环境或本地开发环境中使用熟悉的 Ansible 命令，如 ansible-playbook。您可以使用您熟悉的命令来执行快速任务。
在此模式中，自动化内容导航器还提供大量帮助：
--help-
可从
ansible-navigator命令或任何子命令访问，如ansible-navigator config --help。 - 子命令帮助
-
可从子命令访问，如
ansible-navigator config --help-config。此帮助显示相关 Ansible 命令支持的所有参数的详细信息。
1.2.2. 基于文本的用户界面模式
基于文本的用户界面模式增强了与自动化执行环境、集合、playbook 和清单的交互。此模式兼容集成开发环境 (IDE)，如 Visual Studio Code。
这个模式包括很多有用的用户界面选项：
- 冒号命令
-
您可以使用冒号访问所有 Automation 内容导航器命令，如
:run或:collections - 导航基于文本的界面
-
屏幕中显示了如何向上或向下滚动页面、滚动到之前的屏幕或
access:help。 - 按行号输出
-
您可以在输出中的任何行编号前面加上冒号，例如
:12。 - 颜色编码的输出
- 启用颜色后，Automation content navigator 以红色显示项目，如已弃用的模块。
- 分页和滚动
- 您可以使用每个 Automation 内容导航器屏幕底部显示的选项来上一页或向下滚动或转义。
您无法在自动化内容导航器运行后在模式之间进行切换。
本文档对大多数步骤都使用基于文本的用户界面模式。
第 2 章 在 RHEL 上安装自动化内容导航器
作为内容创建者，您可以在 Red Hat Enterprise Linux (RHEL) 8 及更新版本上安装自动化内容导航程序。
2.1. 从 RPM 安装 RHEL 上的自动化内容导航器
您可以从 RPM 在 Red Hat Enterprise Linux (RHEL) 上安装自动化内容导航程序。
先决条件
- 已安装 RHEL 8 或更高版本。
- 使用 Red Hat Subscription Manager 注册了您的系统。
流程
附加 Red Hat Ansible Automation Platform SKU。
$ subscription-manager attach --pool=<sku-pool-id>
为 RHEL 8 启用存储库。
$ sudo subscription-manager repos --enable ansible-automation-platform-2.1-for-rhel-8-x86_64-rpms
安装自动化内容导航器.
$ dnf install ansible-navigator
验证
验证自动化内容导航器安装：
$ ansible-navigator --help
以下示例演示了成功安装：
第 3 章 使用自动化内容导航器查看自动化执行环境
作为内容开发人员，您可以使用 Automation 内容导航器查看自动化执行环境，并显示自动化执行环境中包含的软件包和集合。自动化内容导航器运行 playbook 来提取和显示结果。
3.1. 从自动化内容导航器查看自动化执行环境
您可以使用自动化内容导航器基于文本的用户界面查看自动化执行环境。
先决条件
- 自动执行环境
流程
查看 Automation 内容导航器配置中包含的自动化执行环境。
$ ansible-navigator images
如需更多详细信息，请键入您要提取的自动化执行环境的数量。
您可以检查每个安装的自动化执行环境的软件包和版本，以及任何包含的集合的 Ansible 版本。
可选：传递您要使用的自动化执行环境。这将是自动化内容导航器使用的自动化执行环境。
$ ansible-navigator images --eei registry.example.com/example-enterprise-ee:latest
验证
查看自动化执行环境输出。
第 5 章 使用自动化内容导航器浏览集合
作为内容创建者，您可以使用自动化内容导航器并以交互方式浏览 Ansible 集合，浏览到本地或自动化执行环境中开发的每个集合。
5.1. 自动化内容导航程序集合显示
自动化内容导航器显示有关您的集合的信息，每个集合的详情如下：
- SHADOWED
- 表示在搜索顺序中，集合的额外副本较高，playbook 首选使用该集合。
- TYPE
-
显示集合是否包含在作为
bind_mount的自动化执行环境或挂载到自动化执行环境中的卷中。 - PATH
- 根据集合 TYPE 字段，反映自动化执行环境或本地文件系统中的集合位置。
5.2. 从 Automation 内容导航器浏览集合
您可以使用交互模式的自动化内容浏览或基于文本的用户界面浏览 Ansible 集合，并转至各个集合。自动化内容导航器显示当前项目目录中的集合，以及自动化执行环境中可用的集合
先决条件
- 本地可访问的集合或安装的自动化执行环境。
流程
启动自动化内容导航器
$ ansible-navigator
浏览该集合。或者，您也可以键入
ansible-navigator collections来直接浏览集合。$ :collections
键入您要浏览的集合数。
:4
键入与您要转至的模块对应的数字。
ANSIBLE.UTILS.IP_ADDRESS: Test if something in an IP address 0│--- 1│additional_information: {} 2│collection_info: 3│ authors: 4│ - Ansible Community 5│ dependencies: {} 6│ description: Ansible Collection with utilities to ease the management, manipulation, 7│ and validation of data within a playbook 8│ documentation: null 9│ homepage: null 10│ issues: null 11│ license: [] 12│ license_file: LICENSE 13│ name: ansible.utils 14│ namespace: ansible 15│ path:/usr/share/ansible/collections/ansible_collections/ansible/utils/ 16│ readme: README.md <... output truncated...>可选：跳至此模块的文档示例。
:{{ examples }} 0│ 1│ 2│#### Simple examples 3│ 4│- name: Check if 10.1.1.1 is a valid IP address 5│ ansible.builtin.set_fact: 6│ data: "{{ '10.1.1.1' is ansible.utils.ip_address }}" 7│ 8│# TASK [Check if 10.1.1.1 is a valid IP address] ********************* 9│# ok: [localhost] => { 10│# "ansible_facts": { 11│# "data": true 12│# }, 13│# "changed": false 14│# } 15│可选：打开编辑器中的示例，将其复制到 playbook 中。
:open
验证
浏览集合列表。
其他资源
5.3. 查看自动化内容导航器中的文档
您可以通过交互模式中的 Automation 内容导航器用户界面查看集合和插件 Ansible 文档。自动化内容导航器显示当前项目目录中的集合，以及自动化执行环境中可用的集合
先决条件
- 本地可访问的集合或安装的自动化执行环境。
流程
启动自动化内容导航器
$ ansible-navigator
查看您感兴趣的模块。或者，您也可以键入
ansible-navigator doc来访问文档。:doc ansible.utils.ip_address
ANSIBLE.UTILS.IP_ADDRESS: Test if something in an IP address 0│--- 1│additional_information: {} 2│collection_info: 3│ authors: 4│ - Ansible Community 5│ dependencies: {} 6│ description: Ansible Collection with utilities to ease the management, manipulation, 7│ and validation of data within a playbook 8│ documentation: null 9│ homepage: null 10│ issues: null 11│ license: [] 12│ license_file: LICENSE 13│ name: ansible.utils 14│ namespace: ansible 15│ path:/usr/share/ansible/collections/ansible_collections/ansible/utils/ 16│ readme: README.md <... output truncated...>跳转到此模块的文档示例。
:{{ examples }} 0│ 1│ 2│#### Simple examples 3│ 4│- name: Check if 10.1.1.1 is a valid IP address 5│ ansible.builtin.set_fact: 6│ data: "{{ '10.1.1.1' is ansible.utils.ip_address }}" 7│ 8│# TASK [Check if 10.1.1.1 is a valid IP address] ********************* 9│# ok: [localhost] => { 10│# "ansible_facts": { 11│# "data": true 12│# }, 13│# "changed": false 14│# } 15│可选：打开编辑器中的示例，将其复制到 playbook 中。
:open
有关如何设置编辑器的详情，请查看 第 8.2 节 “自动化内容导航器常规设置”。
其他资源
第 6 章 使用自动化内容导航器运行 Ansible playbook
作为内容创建者，您可以使用自动化内容导航器并以交互方式执行 Ansible playbook，以交互方式查看各个 play 的结果，以及验证或排查 playbook 的任务。您还可以在执行环境中执行 Ansible playbook，且无需执行环境，以比较和排除任何问题。
6.1. 从 Automation 内容导航器执行 playbook
您可以使用自动化内容导航器基于文本的用户界面运行 Ansible playbook，以跟踪任务的执行，并获取每个任务的结果。
先决条件
- 一个 playbook。
-
有效的清单文件（如果没有使用
localhost）或清单插件。
流程
启动自动化内容导航器
$ ansible-navigator
运行 playbook。
$ :run
-
可选：键入
ansible-navigator run simple-playbook.yml -i inventory.yml以运行 playbook。 验证或添加清单以及任何其他命令行参数。
INVENTORY OR PLAYBOOK NOT FOUND, PLEASE CONFIRM THE FOLLOWING ───────────────────────────────────────────────────────────────────────── Path to playbook: /home/ansible-navigator_demo/simple_playbook.yml Inventory source: /home/ansible-navigator-demo/inventory.yml Additional command line parameters: Please provide a value (optional) ────────────────────────────────────────────────────────────────────────── Submit Cancel点
Submit并按回车。您应该会看到任务正在执行。
输入 play 旁边的数字以进入 play 结果，或者如果大于 9， 键入
:<number>。
如果您为 Automation 内容导航器启用了颜色，则失败的任务以红色显示。
键入要查看任务结果的任务旁边的数字，或者如果大于 9，键入
:<number>。
可选：
type:doc调出任务中使用的模块或插件文档，以帮助进行故障排除。ANSIBLE.BUILTIN.PACKAGE_FACTS (MODULE) 0│--- 1│doc: 2│ author: 3│ - Matthew Jones (@matburt) 4│ - Brian Coca (@bcoca) 5│ - Adam Miller (@maxamillion) 6│ collection: ansible.builtin 7│ description: 8│ - Return information about installed packages as facts. <... output omitted ...> 11│ module: package_facts 12│ notes: 13│ - Supports C(check_mode). 14│ options: 15│ manager: 16│ choices: 17│ - auto 18│ - rpm 19│ - apt 20│ - portage 21│ - pkg 22│ - pacman <... output truncated ...>
6.2. 检查 playbook 结果，其中包含自动化内容导航器工件文件
自动化内容导航器将 playbook 运行的结果保存到 JSON 构件文件中。您可以使用此文件与其他人共享 playbook 结果，出于安全或合规性的原因将其保存，或者稍后进行检查和故障排除。您只需要构件文件即可查看 playbook 运行。您不需要访问 playbook 本身或清单访问权限。
先决条件
- 从 playbook 运行中自动化内容导航器构件 JSON 文件。
流程
使用工件文件启动自动化内容导航器。
$ ansible-navigator replay simple_playbook_artifact.json
检查 playbook 运行时的 playbook 结果。
现在，您可以键入 play 和任务旁边的数字，以逐一检查结果，如执行 playbook 后一样。
第 7 章 使用自动化内容导航器查看 Ansible 配置
作为内容创建者，您可以使用 Automation 内容导航器来查看 Ansible 配置，并以交互方式签入设置。
7.1. 从 Automation 内容导航器查看 Ansible 配置
您可以使用交互模式的自动化内容导航器用户界面查看 Ansible 配置，并转至设置中。自动化内容导航器从可访问的 Ansible 配置文件中提取结果，或者返回默认值（如果没有配置文件）。
先决条件
- 如果您需要访问其他自动化执行环境，您需要向 Red Hat registry 进行身份验证。详情请参阅 Red Hat Container Registry 身份验证。
流程
启动自动化内容导航器
$ ansible-navigator
可选：从命令行键入
ansible-navigator config来访问 Ansible 配置设置。检查 Ansible 配置。
:config
某些值反映了自动化执行环境正常工作所需的自动化执行环境中进行的设置。这些设置显示为您在 Ansible 配置文件中无法设置的非默认设置。
输入与您要提取的设置对应的数字，或者如果大于 9，键入
:<number>。ANSIBLE COW ACCEPTLIST (current: ['bud-frogs', 'bunny', 'cheese']) (default: 0│--- 1│current: 2│- bud-frogs 3│- bunny 4│- cheese 5│default: 6│- bud-frogs 7│- bunny 8│- cheese 9│- daemon
输出显示了当前设置以及 默认设置。请注意，本例中的 source 是 env，因为设置来自自动化执行环境。
验证
检查配置输出。
其他资源
第 9 章 使用自动化内容浏览器对 Ansible 内容进行故障排除
作为内容创建者，您可以使用自动化内容导航器对 Ansible 内容（收集、自动化执行环境和 playbook）进行故障排除，并以交互方式对 playbook 进行故障排除。您还可以比较自动化执行环境内部或外部的结果，并对任何问题进行故障排除。
9.1. 检查 playbook 结果，其中包含自动化内容导航器工件文件
自动化内容导航器将 playbook 运行的结果保存到 JSON 构件文件中。您可以使用此文件与其他人共享 playbook 结果，出于安全或合规性的原因将其保存，或者稍后进行检查和故障排除。您只需要构件文件即可查看 playbook 运行。您不需要访问 playbook 本身或清单访问权限。
先决条件
- 从 playbook 运行中自动化内容导航器构件 JSON 文件。
流程
使用工件文件启动自动化内容导航器。
$ ansible-navigator replay simple_playbook_artifact.json
检查 playbook 运行时的 playbook 结果。
现在，您可以键入 play 和任务旁边的数字，以逐一检查结果，如执行 playbook 后一样。
