diff options
author | Brian Coca <bcoca@users.noreply.github.com> | 2022-09-15 11:12:48 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-09-15 11:12:48 -0400 |
commit | db33ca8e1a8b9805eb0a074eee86aaa2237065cd (patch) | |
tree | 746bdc028ef79687c4a64c8c651303b0bed55e9f /docs/docsite | |
parent | f50ff1c2dbb2eee88b2ac9e50e9f13d942e41f12 (diff) | |
download | ansible-db33ca8e1a8b9805eb0a074eee86aaa2237065cd.tar.gz |
faq legacy vs builtin (#78769)
Diffstat (limited to 'docs/docsite')
-rw-r--r-- | docs/docsite/rst/reference_appendices/faq.rst | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/docsite/rst/reference_appendices/faq.rst b/docs/docsite/rst/reference_appendices/faq.rst index 486fb5f09a..feeb99bdac 100644 --- a/docs/docsite/rst/reference_appendices/faq.rst +++ b/docs/docsite/rst/reference_appendices/faq.rst @@ -845,6 +845,35 @@ How do I submit a change to the documentation? Documentation for Ansible is kept in the main project git repository, and complete instructions for contributing can be found in the docs README `viewable on GitHub <https://github.com/ansible/ansible/blob/devel/docs/docsite/README.md>`_. Thanks! + +.. _legacy_vs_builtin: + +What is the difference between ``ansible.legacy`` and ``ansible.builtin`` collections? +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +Neither is a real collection. They are virtually constructed by the core engine (synthetic collections). + +The ``ansible.builtin`` collection only refers to plugins that ship with ``ansible-core``. + +The ``ansible.legacy`` collection is a superset of ``ansible.builtin`` (you can reference the plugins from builtin through ``ansible.legacy``). You also get the ability to +add 'custom' plugins in the :ref:`configured paths and adjacent directories <ansible_search_path>`, with the ability to override the builtin plugins that have the same name. + +Also, ``ansible.legacy`` is what you get by default when you do not specify an FQCN. +So this: + + .. code-block:: yaml + + - shell: echo hi + +Is really equivalent to: + + .. code-block:: yaml + + - ansible.legacy.shell: echo hi + +Though, if you do not override the ``shell`` module, you can also just write it as ``ansible.builtin.shell``, since legacy will resolve to the builtin collection. + + .. _i_dont_see_my_question: I don't see my question here |