46b1a999c6
* Build documentation for Ansible-2.10 (formerly known as ACD).
Builds plugin docs from collections whose source is on galaxy
The new command downloads collections from galaxy, then finds the
plugins inside of them to get the documentation for those plugins.
* Update the python syntax checks
* docs builds can now require python 3.6+.
* Move plugin formatter code out to an external tool, antsibull-docs.
Collection owners want to be able to extract docs for their own
websites as well.
* The jinja2 filters, tests, and other support code have moved to antsibull
* Remove document_plugins as that has now been integrated into antsibull-docs
* Cleanup and bugfix to other build script code:
* The Commands class needed to have its metaclass set for abstractmethod
to work correctly
* Fix lint issues in some command plugins
* Add the docs/docsite/rst/collections to .gitignore as
everything in that directory will be generated so we don't want any of
it saved in the git repository
* gitignore the build dir and remove edit docs link on module pages
* Add docs/rst/collections as a directory to remove on make clean
* Split the collections docs from the main docs
* remove version and edit on github
* remove version banner for just collections
* clarify examples need collection keyword defined
* Remove references to plugin documentation locations that no longer exist.
* Perhaps the pages in plugins/*.rst should be deprecated
altogether and their content moved?
* If not, perhaps we want to rephrase and link into the collection
documentation?
* Or perhaps we want to link to the plugins which are present in
collections/ansible/builtin?
* Remove PYTHONPATH from the build-ansible calls
One of the design goals of the build-ansible.py script was for it to
automatically set its library path to include the checkout of ansible
and the library of code to implement itself. Because it automatically
includes the checkout of ansible, we don't need to set PYTHONPATH in
the Makefile any longer.
* Create a command to only build ansible-base plugin docs
* When building docs for devel, only build the ansible-base docs for
now. This is because antsibull needs support for building a "devel
tree" of docs. This can be changed once that is implemented
* When building docs for the sanity tests, only build the ansible-base
plugin docs for now. Those are the docs which are in this repo so
that seems appropriate for now.
* Docs: User guide overhaul, part 5 (#70307)
(cherry picked from commit db354c0300)
* Need to return any error code from running antsibull-docs (#70763)
This way we fail early if there's a problem
(cherry picked from commit 1e3989c9f7)
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2.1 KiB
Become Plugins
2.8
Become plugins work to ensure that Ansible can use certain privilege escalation systems when running the basic commands to work with the target machine as well as the modules required to execute the tasks specified in the play.
These utilities (sudo, su,
doas, etc) generally let you 'become' another user to
execute a command with the permissions of that user.
Enabling Become Plugins
The become plugins shipped with Ansible are already enabled. Custom
plugins can be added by placing them into a become_plugins
directory adjacent to your play, inside a role, or by placing them in
one of the become plugin directory sources configured in ansible.cfg <ansible_configuration_settings>.
Using Become Plugins
In addition to the default configuration settings in ansible_configuration_settings or the
--become-method command line option, you can use the
become_method keyword in a play or, if you need to be 'host
specific', the connection variable ansible_become_method to
select the plugin to use.
You can further control the settings for each plugin via other configuration options detailed in the plugin themselves (linked below).
Plugin List
You can use ansible-doc -t become -l to see the list of
available plugins. Use
ansible-doc -t become <plugin name> to see specific
documentation and examples.
about_playbooks-
An introduction to playbooks
inventory_plugins-
Ansible inventory plugins
callback_plugins-
Ansible callback plugins
playbooks_filters-
Jinja2 filter plugins
playbooks_tests-
Jinja2 test plugins
playbooks_lookups-
Jinja2 lookup plugins
- User Mailing List
-
Have a question? Stop by the google group!
- irc.freenode.net
-
#ansible IRC chat channel