Developer documentation - Change path to connection_plugins #52577
Conversation
The documentation referred to the connection plugin path as `connection_plugins` but the incomplete path is actually `plugins/connection`. This PR fixes it. +label: docsite_pr
| @@ -246,7 +246,7 @@ Connection plugins allow Ansible to connect to the target hosts so it can execut | |||
|
|
|||
| Ansible version 2.1 introduced the ``smart`` connection plugin. The ``smart`` connection type allows Ansible to automatically select either the ``paramiko`` or ``openssh`` connection plugin based on system capabilities, or the ``ssh`` connection plugin if OpenSSH supports ControlPersist. | |||
|
|
|||
| To create a new connection plugin (for example, to support SNMP, Message bus, or other transports), copy the format of one of the existing connection plugins and drop it into the ``connection_plugins`` directory. | |||
| To create a new connection plugin (for example, to support SNMP, Message bus, or other transports), copy the format of one of the existing connection plugins and drop it into the ``plugins/connection`` directory. | |||
There was a problem hiding this comment.
This change is not necessarily true. By default we will utilize a connection_plugins directory relative to the playbook. plugins/connection has no real meaning. The default connection plugin path is defined as ~/.ansible/plugins/connection:/usr/share/ansible/plugins/connection
There was a problem hiding this comment.
Hrm, I suppose there is more ambiguity here. As this doesn't indicate the purpose of creating the connection plugin. Whether it is to contribute back to Ansible, or just for personal development.
There was a problem hiding this comment.
When I read connection_plugins I read it as the path to the source (/lib/ansible/plugins/connection/) and not where the plugins are kept after installation. If I'm developing a plugin, I am thinking in the context of the source tree and not the installation path.
ansibot
added
affects_2.8
dagwieers
added
the
docsite_pr
There was a problem hiding this comment.
Yeah, connection_plugins is misleading here. The default paths do not have _plugin on them (see https://github.com/ansible/ansible/pull/52881/files). How about referring to the section on using plugins locally, as in my suggestion above?
Co-Authored-By: kbreit <kevin.breit@kevinbreit.net>
|
@acozine Accepted |
|
Thanks @kbreit. |
SUMMARY
The documentation referred to the connection plugin path as
connection_pluginsbut the incomplete path is actuallyplugins/connection. This PR fixes it.+label: docsite_pr
ISSUE TYPE
COMPONENT NAME
docs