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 exec
This command can be used to execute Ansible modules ad-hoc against a given environment. You can use any arguments accepted by the ansible command - they will be executed in the DebOps project context, including the runtime environment variables and with the
ansible/secret/directory unlocked if necessary.
- 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 runcommand above, but automatically adds the
--checkansible-playbook options to ensure that the playbooks are executed in a check mode;
- debops env
This command can be used to inspect the environment variables which will be present when various DebOps commands are executed. It can also be used to run shell commands in DebOps environment, which is a handy shortcut for using Ansible ecosystem with DebOps project directories.
- 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
debops-* manual pages or by running them with the
Display the help and usage information
Display the version of the debops scripts
Verbose mode and logging
The debops script can send log messages about its operation to the syslog service. Using configuration options, users can specify where to send the log messages, default log level and facility.
Users can specify the
-v flag in the debops
subcommands to increase the script verbosity. The flag enables log output to the
standard error (stderr) stream. Multiple uses of the flag increase the log level
from the default
To view the logs from debops using journald service, run the command:
journalctl -f _COMM=debops
These environment variables can be used to affect the environment during script execution:
Path to the ansible binary used by DebOps. Can be overridden by configuration files.
Path to the ansible-playbook binary used by DebOps. Can be overridden by configuration files.
Path to the gpg binary used by DebOps. Can be overridden by configuration files.
Path to the encfs binary used by DebOps. Can be overridden by configuration files.
Path to the umount binary used by DebOps on Darwin-based hosts. Can be overridden by configuration files.
Path to the fusermount binary used by DebOps. Can be overridden by configuration files.