跳转到主要内容

Red Hat Ansible Automation Platform的基于文本的用户界面(TUI)

项目描述

ansible-navigator

Ansible的基于文本的用户界面(TUI)。

该界面的演示可以在YouTube上找到。

沟通

有关如何与我们联系的信息,请参阅贡献指南中的联系我们部分。

您还可以在Ansible沟通指南中找到更多信息。

贡献

本项目欢迎并感谢所有形式的贡献,无论是文档改进、错误报告pull请求审核,还是补丁。

有关详细信息,请参阅贡献指南

行为准则

请参阅官方的Ansible社区行为准则

快速入门

安装

使用ansible-navigator开始使用非常简单

pip3 install 'ansible-navigator[ansible-core]'
ansible-navigator --help

(希望在内置环境中安装的用户可能需要相关的Python文档。)

默认情况下,ansible-navigator使用容器运行时(首先找到的podmandocker),并在执行环境(包含ansible-core和一组Ansible集合的预构建容器镜像)中运行Ansible。

可以通过以--execution-environment false启动ansible-navigator来禁用此默认行为。在这种情况下,必须在系统上手动安装Ansible和所需的任何集合。

有关LinuxmacOSWindows with WSL2的附加安装说明,请参阅安装指南

欢迎

当不带参数运行ansible-navigator时,您将看到欢迎页面。从该页面,您可以运行剧本、浏览集合、探索清单、阅读Ansible文档等。

通过输入:help可以查看密钥绑定列表。

输出模式

ansible-navigator可以以两种模式运行

  • 交互式模式,它提供基于curses的用户界面,并允许您实时“放大”数据,过滤它,并在不同的Ansible组件之间导航;
  • 标准输出模式,它不使用curses,并将输出直接返回到终端的标准输出流,就像Ansible的命令一样。

交互式模式是默认模式,可以通过传递--mode stdout-m stdout)或设置配置中的mode来覆盖此默认模式。

示例命令

可以从上述描述的欢迎页面访问ansible-navigator的所有功能,但作为快捷方式,也可以直接将命令作为命令行参数提供。

一些示例

  • 审查和探索可用的集合:ansible-navigator collections
  • 审查和探索当前的Ansible配置:ansible-navigator config
  • 审查和探索Ansible文档:ansible-navigator doc ansible.netcommon.cli_command
  • 审查本地可用的执行环境镜像:ansible-navigator images
  • 审查和探索清单:ansible-navigator inventory -i inventory.yaml
  • 运行和探索剧本:ansible-navigator run site.yaml -i inventory.yaml

或者使用上述描述的标准输出模式

  • 显示当前的Ansible配置:ansible-navigator config dump -m stdout
  • 显示文档:ansible-navigator doc sudo -t become -m stdout

...等等。有关子命令及其与Ansible命令的关系的完整列表,请参阅子命令文档

配置ansible-navigator

有几种方法可以配置ansible-navigator,用户和项目可以自由选择对他们最方便的方法。有关如何应用各种配置来源的完整层次结构,请参阅以下提到的常见问题解答(FAQ)。

值得注意的是,使用 ansible-navigator 的项目可以包含一个与项目一起的项目级配置文件。如果没有找到,ansible-navigator 将在用户的家目录中查找用户特定的配置文件。有关详细信息,请参阅设置文档

常见问题(FAQ)

我们维护了一个常见问题列表,这为检查是否有问题困扰您提供了很好的资源。我们也鼓励社区为这份文档做出贡献!

许可

ansible-navigator 在 Apache License 版本 2 下发布。有关更多详细信息,请参阅LICENSE文件。

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源代码分发

ansible_navigator-24.9.0.tar.gz (390.6 kB 查看哈希值)

上传时间 源代码

构建分发

ansible_navigator-24.9.0-py3-none-any.whl (302.3 kB 查看哈希值)

上传时间 Python 3

支持者

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页