openstack/kayobe
Code Issues Proposed changes
a9aa8c7f7c
kayobe/doc/source/usage.rst
Mark Goddard 9c2565a60c Support Ansible diff mode 
Adds a '--diff' argument to kayobe CLI commands. This is passed through
to ansible-playbook for Kayobe Ansible playbooks, and can be used with
the '--check' argument to see changes that would be made to files.

This change also passes through --check and --diff arguments to
kolla-ansible.

Story: 2009038
Task: 42794

Change-Id: I350795c328c0dc0a91a5cd500c252c5b7b1eafc1
2021-10-21 12:00:33 +00:00

2.9 KiB
Raw Blame History

Usage

Command Line Interface

Note

Where a prompt starts with (kayobe) it is implied that the user has activated the Kayobe virtualenv. This can be done as follows:

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

To deactivate the virtualenv:

(kayobe) $ deactivate

To see information on how to use the kayobe CLI and the commands it provides:

(kayobe) $ kayobe help

As the kayobe CLI is based on the cliff package (as used by the openstack client), it supports tab auto-completion of subcommands. This can be activated by generating and then sourcing the bash completion script:

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

Working with Ansible Vault

If Ansible vault has been used to encrypt Kayobe configuration files, it will be necessary to provide the kayobe command with access to vault password. There are three options for doing this:

Prompt

Use kayobe --ask-vault-pass to prompt for the password.

File

Use kayobe --vault-password-file <file> to read the password from a (plain text) file.

Environment variable

Export the environment variable KAYOBE_VAULT_PASSWORD to read the password from the environment.

Limiting Hosts

Sometimes it may be necessary to limit execution of kayobe or kolla-ansible plays to a subset of the hosts. The --limit <SUBSET> argument allows the kayobe ansible hosts to be limited. The --kolla-limit <SUBSET> argument allows the kolla-ansible hosts to be limited. These two options may be combined in a single command. In both cases, the argument provided should be an Ansible host pattern, and will ultimately be passed to ansible-playbook as a --limit argument.

Tags

Ansible tags provide a useful mechanism for executing a subset of the plays or tasks in a playbook. The --tags <TAGS> argument allows execution of kayobe ansible playbooks to be limited to matching plays and tasks. The --kolla-tags <TAGS> argument allows execution of kolla-ansible ansible playbooks to be limited to matching plays and tasks. The --skip-tags <TAGS> and --kolla-skip-tags <TAGS> arguments allow for avoiding execution of matching plays and tasks.

Check and diff mode

Ansible supports check and diff modes, which can be used to improve visibility into changes that would be made on target systems. The Kayobe CLI supports the --check argument, and since 11.0.0, the --diff argument. Note that these modes are not always guaranteed to work, when some tasks are dependent on earlier ones.