From e69c1812c91cae6c7a6e50d1874f11a427d23fa6 Mon Sep 17 00:00:00 2001 From: Sandra McCann Date: Thu, 15 Sep 2022 15:40:55 -0400 Subject: [PATCH] Backportapalooza 9 15 (#78787) * add galaxy docs back to core' (#78764) (cherry picked from commit df6a564abd9a63e1bff0ad14f9b800ceccc2da31) * Ansible 6.4.0: Porting Guide (#78775) (cherry picked from commit d4407ca68822b1f12254957ec9918f94c23d374f) * Documented connection parameters required to enable scp (OpenSSH >=9.0) (#78745) (cherry picked from commit 952ee88f33de4d49ff5f7bd4bec3431a4b0fdc78) * Fix Issue #78564 (#78741) (cherry picked from commit f50ff1c2dbb2eee88b2ac9e50e9f13d942e41f12) * faq legacy vs builtin (#78769) (cherry picked from commit db33ca8e1a8b9805eb0a074eee86aaa2237065cd) * Removed repeated introduction paragraph (#78691) (cherry picked from commit e276770ee9efac3a98c3f1116d9cd9c992ca8c9e) Co-authored-by: Ompragash Viswanathan <21008429+Ompragash@users.noreply.github.com> Co-authored-by: wnjuguna Co-authored-by: Ronan Co-authored-by: Brian Coca --- docs/docsite/rst/core_index.rst | 6 ++++ docs/docsite/rst/dev_guide/testing.rst | 10 ------- .../rst/porting_guides/porting_guide_6.rst | 17 +++++++++++ docs/docsite/rst/reference_appendices/faq.rst | 29 +++++++++++++++++++ docs/docsite/sphinx_conf/core_conf.py | 1 - docs/docsite/sphinx_conf/core_lang_conf.py | 1 - lib/ansible/modules/unarchive.py | 3 +- lib/ansible/plugins/connection/ssh.py | 2 ++ 8 files changed, 56 insertions(+), 13 deletions(-) diff --git a/docs/docsite/rst/core_index.rst b/docs/docsite/rst/core_index.rst index 82bfdca977a..b4cce2dae2d 100644 --- a/docs/docsite/rst/core_index.rst +++ b/docs/docsite/rst/core_index.rst @@ -65,6 +65,12 @@ This documentation covers the version of ``ansible-core`` noted in the upper lef dev_guide/index +.. toctree:: + :maxdepth: 2 + :caption: Ansible Galaxy + + galaxy/user_guide.rst + galaxy/dev_guide.rst .. toctree:: :maxdepth: 1 diff --git a/docs/docsite/rst/dev_guide/testing.rst b/docs/docsite/rst/dev_guide/testing.rst index d1119736161..b065f69e8a1 100644 --- a/docs/docsite/rst/dev_guide/testing.rst +++ b/docs/docsite/rst/dev_guide/testing.rst @@ -41,16 +41,6 @@ At a high level we have the following classifications of tests: * Tests directly against individual parts of the code base. -If you're a developer, one of the most valuable things you can do is look at the GitHub -issues list and help fix bugs. We almost always prioritize bug fixing over feature -development. - -Even for non developers, helping to test pull requests for bug fixes and features is still -immensely valuable. Ansible users who understand writing playbooks and roles should be -able to add integration tests and so GitHub pull requests with integration tests that show -bugs in action will also be a great way to help. - - Testing within GitHub & Azure Pipelines ======================================= diff --git a/docs/docsite/rst/porting_guides/porting_guide_6.rst b/docs/docsite/rst/porting_guides/porting_guide_6.rst index 42c972fb47f..518b50acef0 100644 --- a/docs/docsite/rst/porting_guides/porting_guide_6.rst +++ b/docs/docsite/rst/porting_guides/porting_guide_6.rst @@ -99,6 +99,23 @@ Networking No notable changes +Porting Guide for v6.4.0 +======================== + +Added Collections +----------------- + +- inspur.ispim (version 1.0.1) +- vultr.cloud (version 1.1.0) + +Deprecated Features +------------------- + +community.general +~~~~~~~~~~~~~~~~~ + +- proxmox - deprecated the current ``unprivileged`` default value, will be changed to ``true`` in community.general 7.0.0 (https://github.com/pull/5224). + Porting Guide for v6.3.0 ======================== diff --git a/docs/docsite/rst/reference_appendices/faq.rst b/docs/docsite/rst/reference_appendices/faq.rst index 486fb5f09a2..feeb99bdac4 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 `_. 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 `, 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 diff --git a/docs/docsite/sphinx_conf/core_conf.py b/docs/docsite/sphinx_conf/core_conf.py index f135eca7910..5b34a45cace 100644 --- a/docs/docsite/sphinx_conf/core_conf.py +++ b/docs/docsite/sphinx_conf/core_conf.py @@ -94,7 +94,6 @@ exclude_patterns = [ '2.10_index.rst', 'ansible_index.rst', 'core_index.rst', - 'galaxy', 'network', 'scenario_guides', 'community/collection_contributors/test_index.rst', diff --git a/docs/docsite/sphinx_conf/core_lang_conf.py b/docs/docsite/sphinx_conf/core_lang_conf.py index a164dd67aaf..7e01eda3583 100644 --- a/docs/docsite/sphinx_conf/core_lang_conf.py +++ b/docs/docsite/sphinx_conf/core_lang_conf.py @@ -94,7 +94,6 @@ exclude_patterns = [ '2.10_index.rst', 'ansible_index.rst', 'core_index.rst', - 'galaxy', 'network', 'scenario_guides', 'community/collection_contributors/test_index.rst', diff --git a/lib/ansible/modules/unarchive.py b/lib/ansible/modules/unarchive.py index c5da9615736..7ac19fc7d92 100644 --- a/lib/ansible/modules/unarchive.py +++ b/lib/ansible/modules/unarchive.py @@ -123,7 +123,8 @@ attributes: bypass_host_loop: support: none check_mode: - support: full + support: partial + details: Not supported for gzipped tar files. diff_mode: support: partial details: Uses gtar's C(--diff) arg to calculate if changed or not. If this C(arg) is not supported, it will always unpack the archive. diff --git a/lib/ansible/plugins/connection/ssh.py b/lib/ansible/plugins/connection/ssh.py index e3b7cec68cd..b9d1f1052a6 100644 --- a/lib/ansible/plugins/connection/ssh.py +++ b/lib/ansible/plugins/connection/ssh.py @@ -292,6 +292,7 @@ DOCUMENTATION = ''' description: - "Preferred method to use when transferring files over ssh" - Setting to 'smart' (default) will try them in order, until one succeeds or they all fail + - For OpenSSH >=9.0 you must add an additional option to enable scp (scp_extra_args="-O") - Using 'piped' creates an ssh pipe with C(dd) on either side to copy the data choices: ['sftp', 'scp', 'piped', 'smart'] env: [{name: ANSIBLE_SSH_TRANSFER_METHOD}] @@ -310,6 +311,7 @@ DOCUMENTATION = ''' - "Preferred method to use when transferring files over SSH." - When set to I(smart), Ansible will try them until one succeeds or they all fail. - If set to I(True), it will force 'scp', if I(False) it will use 'sftp'. + - For OpenSSH >=9.0 you must add an additional option to enable scp (scp_extra_args="-O") - This setting will overridden by ssh_transfer_method if set. env: [{name: ANSIBLE_SCP_IF_SSH}] ini: