The debops command¶
The debops command provides multiple sub-commands, some of which are split into sections.
- debops project
- This section includes commands used to create and maintain the "project directories" which contain one or multiple Ansible inventories, PKI infrastructure, GPG keyring, and other resources used in a particular environment.
- debops run
- This command can be used to execute Ansible playbooks against a given
environment. The playbooks used can come either from the DebOps Python
package (included by default), from an Ansible Collection, or from the
ansible/playbooks/
directory in a given project. You can also specify all ansible-playbook arguments to affect the Ansible execution; - debops check
- This command is the same as the
debops run
command above, but automatically adds the--diff
and--check
ansible-playbook options to ensure that the playbooks are executed in a check mode; - debops config
- This command allows the user to inspect and manipulate the DebOps configuration options in various formats;
You can find more information about these subcommands in the DebOps
documentation, debops-*
manual pages or by running them with the --help
option.
Options¶
-h, --help
- Display the help and usage information
--version
- Display the version of the debops scripts
Environment variables¶
These environment variables can be used to affect the environment during script execution:
DEBOPS_CMD_ANSIBLE_PLAYBOOK
- Path to the ansible-playbook binary used by DebOps. Can be overridden by configuration files.
DEBOPS_CMD_GPG
- Path to the gpg binary used by DebOps. Can be overridden by configuration files.
DEBOPS_CMD_ENCFS
- Path to the encfs binary used by DebOps. Can be overridden by configuration files.
DEBOPS_CMD_UMOUNT
- Path to the umount binary used by DebOps on Darwin-based hosts. Can be overridden by configuration files.
DEBOPS_CMD_FUSERMOUNT
- Path to the fusermount binary used by DebOps. Can be overridden by configuration files.