4.4. 创建 playbook 和查看 playbook 的解释
使用 Ansible VS Code 扩展,您可以使用英语中的自然语言接口创建 Ansible playbook。Red Hat Ansible Lightspeed with IBM watsonx Code Assistant 会读取自然语言提示,并根据您的意图生成完整的 playbook 建议。您还可以查看新或现有 playbook 的解释。playbook 解释描述了 playbook 的作用,并上下文其影响。
这些功能使 Ansible 开发人员能够使用自然语言提示快速、高效地创建新的 Ansible playbook,并获得现有 Ansible playbook 的解释,从而减少了整体的学习周期。有关 Ansible playbook 的信息,请参阅开始使用 Ansible Playbook 指南。
您可以创建 playbook,并在连接到 Red Hat Ansible Lightspeed 云服务和内部部署时查看 playbook 说明。
4.4.1. 创建 playbook 的最佳实践 复制链接链接已复制到粘贴板!
遵循这些 playbook 建议的最高质量。
确保目标语句直接指定 playbook 必须做什么。
您的声明应从 playbook 的目标开始,例如,
将安全补丁应用到 RHEL9
。避免启动声明,创建 的 playbook
,请准备一个 playbook
,或者我需要帮助
。- 确保 goal 语句不包含新行。
确保 target 语句不止一个句子。
您可能需要在 goal 语句中重复详细信息,才能生成最佳结果。建议您使用生成的概述作为您的目标语句是否可能从更多或较少的详细信息中受益,然后根据需要修改目标声明。
在编辑概述时确保以下内容:
- 不要重新声明 playbook 的目标。
- 验证在 playbook 中捕获关键步骤的步骤。这些步骤不需要反映 playbook 中预期的每个任务。
- 在不向概述中添加新行的情况下,以一个句子保持步骤描述。
4.4.2. 生成 Ansible playbook 复制链接链接已复制到粘贴板!
您可以使用 Ansible VS Code 扩展中的自然语言接口来生成整个 Ansible playbook。
先决条件
您满足以下 一项 要求:
- 您的机构对 Red Hat Ansible Automation Platform 和 IBM watsonx Code Assistant 都有一个试用或付费的订阅。
- 您的机构对 Red Hat Ansible Automation Platform 具有试用或付费的订阅,并且您有 Red Hat Ansible Lightspeed 试用帐户。
- 已安装并配置了 Ansible VS Code 扩展。
流程
- 使用您的红帽帐户登录 VS Code。
- 在 Activity 栏中,点 Ansible 图标。
在 Ansible Creator 下,单击 Get started。此时会显示 Ansible Content Creator 页面。
下图显示了 Ansible Content Creator 页面:
图 4.5. 创建 Ansible playbook 的设置
- 选择带有 Ansible Lightspeed 标题的 Playbook。此时会显示 Create a playbook 页面。
在 What do want the playbook to accomplish? 字段中,输入提示以创建 playbook,然后单击 Analyze。
几秒钟后,您的 playbook 意图的建议步骤会显示在您的 playbook 的"检查"步骤,并根据需要进行修改。
执行以下任务之一:
- 如果步骤与您的意图匹配:单击 Generate Playbook。
- 如果需要修改:点编辑器并更新任务或步骤以符合您的意图。
- 如果任务建议与您的意图不匹配:单击 Back 以更改原始提示,然后重新开始。
- 如果要恢复原始任务建议:点 Reset,然后继续下一步。
验证步骤后,单击 Generate playbook。
playbook 生成几秒钟,并且为字段 生成以下 playbook 会显示新生成的 playbook:
- 单击 Open editor。生成的 playbook 在 VS Code 编辑器中作为无权利的 YAML 文件打开。
- 保存没有权利的 YAML 文件。
4.4.3. 查看 playbook 的解释 复制链接链接已复制到粘贴板!
您可以为新创建的 playbook 以及现有的 Ansible playbook 请求解释。
先决条件
您满足以下 一项 要求:
- 您的机构对 Red Hat Ansible Automation Platform 和 IBM watsonx Code Assistant 都有一个试用或付费的订阅。
- 您的机构对 Red Hat Ansible Automation Platform 具有试用或付费的订阅,并且您有 Red Hat Ansible Lightspeed 试用帐户。
- 已安装并配置了 Ansible VS Code 扩展。
- 您已打开了您要查看其说明的 playbook。
流程
- 使用您的红帽帐户登录 VS Code。
- 在 VS Code 中打开 Ansible playbook YAML 文件。
使用以下方法之一查看 playbook 的解释:
从活跃的 playbook YAML 文件中 :
- 将光标放置在 playbook 文件中的任何位置。
- 右键单击并选择 说明使用 Ansible Lightspeed 的 playbook。
在 Ansible 面板中 :
- 在导航菜单中点 Ansible 图标。
选择 Explain the current playbook。
Playbook 解释显示在 VS Code 屏幕右侧面板中。
下图显示了一个 playbook 的示例:
图 4.6. playbook 解释示例