用法

命令行界面

注意

如果提示符以 (kayobe) 开头，则表示用户已激活 Kayobe 虚拟环境。可以通过以下方式完成此操作

$ source /path/to/venv/bin/activate

要停用虚拟环境

(kayobe) $ deactivate

要查看有关如何使用 kayobe CLI 及其提供的命令的信息

(kayobe) $ kayobe help

由于 kayobe CLI 基于 cliff 包（如 openstack 客户端所用），因此它支持子命令的选项卡自动补全。可以通过生成然后 source bash 补全脚本来激活它

(kayobe) $ kayobe complete > kayobe-complete
(kayobe) $ source kayobe-complete

使用 Ansible Vault

如果 Ansible Vault 已用于加密 Kayobe 配置文件，则需要向 kayobe 命令提供访问 vault 密码的权限。有四种方法可以做到这一点

提示

使用 kayobe --ask-vault-pass 提示输入密码。

文件

使用 kayobe --vault-password-file <file> 从（纯文本）文件中读取密码。

环境变量：KAYOBE_VAULT_PASSWORD

导出环境变量 KAYOBE_VAULT_PASSWORD 以从环境变量读取密码。

环境变量：ANSIBLE_VAULT_PASSWORD_FILE

导出环境变量 ANSIBLE_VAULT_PASSWORD_FILE 以从（纯文本）文件中读取密码，该文件的路径从环境变量读取。

限制主机

有时可能需要将 kayobe 或 kolla-ansible playbook 的执行限制为一部分主机。 --limit <SUBSET> 参数允许限制 kayobe ansible 主机。 --kolla-limit <SUBSET> 参数允许限制 kolla-ansible 主机。可以将这两个选项组合在一个命令中。在两种情况下，提供的参数都应是 Ansible 主机模式，最终将作为 --limit 参数传递给 ansible-playbook。

标签

Ansible 标签提供了一种有用的机制，用于执行 playbook 中的一部分 playbook 或任务。 --tags <TAGS> 参数允许将 kayobe ansible playbook 的执行限制为匹配的 playbook 和任务。 --kolla-tags <TAGS> 参数允许将 kolla-ansible ansible playbook 的执行限制为匹配的 playbook 和任务。 --skip-tags <TAGS> 和 --kolla-skip-tags <TAGS> 参数允许避免执行匹配的 playbook 和任务。

检查和差异模式

Ansible 支持 检查和差异模式，可用于提高对目标系统所做更改的可见性。 Kayobe CLI 支持 --check 参数，并且自 11.0.0 版本以来，支持 --diff 参数。请注意，当某些任务依赖于较早的任务时，这些模式并不总是保证有效。

避免在控制主机上进行权限提升

注意

这意味着 kayobe 将无法安装操作系统包或使用用户无写入权限的路径。

可以避免在控制主机上进行权限提升。要使用此功能，请设置以下配置选项

$KAYOBE_CONFIG_PATH/globals.yml

kayobe_control_host_become: false