internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-07 05:42:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

centralize doc/config plugin lists (#38775)

Browse Source 
* centralize doc/config plugin lists

also update list for generation in docsite
added note to ensure they are in sync

* updated shell page to list plugins

added some more docs hinting at plugins being configurable

* fix edit link for plugins
This commit is contained in:
Brian Coca
2018-04-16 09:29:49 -04:00
committed by GitHub
parent a30befa609
commit bdbb89378f
6 changed files with 27 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/docsite/rst/plugins/shell.rst
View File

@@ -1,7 +1,10 @@
.. contents:: Topics
Shell Plugins
-------------
Shell plugins work transparently to ensure that the basic commands Ansible runs are properly formatted to work with the target machine.
Shell plugins work to ensure that the basic commands Ansible runs are properly formatted to work with
the target machine and allow the user to configure certain behaviours related to how Ansible executes tasks.
.. _enabling_shell:
@@ -11,18 +14,26 @@ Enabling Shell Plugins
You can add a custom shell plugin by dropping it into a ``shell_plugins`` directory adjacent to your play, inside a role,
or by putting it in one of the shell plugin directory sources configured in :doc:`ansible.cfg <../config>`.
.. warning:: You should not alter the configuration for these plugins unless you have a setup
in which the default ``/bin/sh`` is not a POSIX compatible shell or is not availble for execution.
.. warning:: You should not alter which plugin is used unless you have a setup in which the default ``/bin/sh``
is not a POSIX compatible shell or is not availble for execution.
.. _using_shell:
Using Shell Plugins
+++++++++++++++++++
In addition to the default configuration settings in :doc:`../config`,
you can use a 'connection variable' :ref:`ansible_shell_type` to select the plugin to use.
In addition to the default configuration settings in :doc:`../config`, you can use
a 'connection variable' :ref:`ansible_shell_type` to select the plugin to use.
In this case, you will also want to update the :ref:`ansible_executable` to match.
You can further control the settings for each plugin via other configuration options
detailed in the plugin themsleves (linked below).
.. toctree:: :maxdepth: 1
:glob:
shell/*
.. seealso::
:doc:`../user_guide/playbooks`