matrix-docker-ansible-deploy icon indicating copy to clipboard operation
matrix-docker-ansible-deploy copied to clipboard

Documentation refinement: Move documentation out of /examples/hosts and into docs/ansible.md

Open QEDeD opened this issue 2 months ago • 2 comments

My thinking is that it would be more fitting to have documentation related to ansible configuration removed from the hosts example and instead keep it all in /docs/ansible.md for increased simplicity.

Instead docs/ansible.md can be referenced in the example file.

Somewhat related, it seems the following section from the hosts example isn't correct:

If you're running this Ansible playbook on the same server as the one you're installing to, consider adding an additional ansible_connection=local argument to the host line below.

The Ansible documentation states that the localhost IP should be the host and the playbook command invoked with the option --connection=local

To run an entire playbook locally, just set the hosts: line to hosts: 127.0.0.1 and then run the playbook like so:

ansible-playbook playbook.yml --connection=local

If you set the connection to local and there is no ansible_python_interpreter set, modules will run under /usr/bin/python and not under {{ ansible_playbook_python }}. Be sure to set ansible_python_interpreter: “{{ ansible_playbook_python }}” in host_vars/localhost.yml, for example. You can avoid this issue by using local_action or delegate_to: localhost instead.

QEDeD avatar Sep 28 '25 19:09 QEDeD