diff options
Diffstat (limited to 'docs/docsite')
4 files changed, 193 insertions, 52 deletions
diff --git a/docs/docsite/rst/dev_guide/testing_running_locally.rst b/docs/docsite/rst/dev_guide/testing_running_locally.rst index 40910a87ec..0267fcdf6a 100644 --- a/docs/docsite/rst/dev_guide/testing_running_locally.rst +++ b/docs/docsite/rst/dev_guide/testing_running_locally.rst @@ -14,14 +14,16 @@ This document describes how to run tests using ``ansible-test``. Setup ===== -Before running ``ansible-test``, set up your environment for :ref:`Testing an Ansible Collection` or -:ref:`Testing ansible-core`, depending on which scenario applies to you. +Before running ``ansible-test``, set up your environment for :ref:`testing_an_ansible_collection` or +:ref:`testing_ansible_core`, depending on which scenario applies to you. .. warning:: If you use ``git`` for version control, make sure the files you are working with are not ignored by ``git``. If they are, ``ansible-test`` will ignore them as well. +.. _testing_an_ansible_collection: + Testing an Ansible Collection ----------------------------- @@ -60,6 +62,8 @@ For example, to work with the ``community.windows`` collection, follow these ste cd ~/dev/ansible_collections/community/windows +.. _testing_ansible_core: + Testing ``ansible-core`` ------------------------ @@ -179,6 +183,8 @@ These instructions explain how to use ``ansible-test`` with WSL2 and Docker Desk If your WSL2 environment includes ``systemd`` support, these steps are not required. +.. _configuration_requirements: + Configuration requirements """""""""""""""""""""""""" @@ -194,6 +200,8 @@ Configuration requirements 4. Click **Apply and restart** if changes were made. +.. setup_instructions: + Setup instructions """""""""""""""""" @@ -201,7 +209,7 @@ Setup instructions If all WSL instances have been stopped, these changes will need to be re-applied. -1. Verify Docker Desktop is properly configured (see :ref:`Configuration requirements`). +1. Verify Docker Desktop is properly configured (see :ref:`configuration_requirements`). 2. Quit Docker Desktop if it is running: a. Right click the **Docker Desktop** taskbar icon. @@ -229,8 +237,8 @@ Setup instructions grep systemd /proc/self/cgroup - b. If any matches are found, re-check the :ref:`Configuration requirements` and follow the - :ref:`Setup instructions` again. + b. If any matches are found, re-check the :ref:`configuration_requirements` and follow the + :ref:`setup_instructions` again. b. Mount the ``systemd`` cgroup hierarchy with the following commands: @@ -243,6 +251,8 @@ Setup instructions You should now be able to use ``ansible-test`` with the ``--docker`` option. +.. linux_cgroup_configuration: + Linux cgroup configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -268,7 +278,7 @@ Make sure to substitute your user and group for ``{user}`` and ``{group}`` respe Podman """""" -When using Podman, you may need to stop existing Podman processes after following the :ref:`Linux cgroup configuration` +When using Podman, you may need to stop existing Podman processes after following the :ref:`linux_cgroup_configuration` instructions. Otherwise Podman may be unable to see the new mount point. You can check to see if Podman is running by looking for ``podman`` and ``catatonit`` processes. @@ -334,7 +344,7 @@ When using environment variables to manipulate tests there some limitations to k Example: ``ANSIBLE_KEEP_REMOTE_FILES=1`` can be set when running ``ansible-test integration --venv``. However, using the ``--docker`` option would require running ``ansible-test shell`` to gain access to the Docker environment. Once at the shell prompt, the environment variable could be set and the tests executed. This is useful for debugging tests inside a container by following the - :ref:`Debugging AnsibleModule-based modules <debugging_modules>` instructions. + :ref:`debugging_modules` instructions. Interactive shell ================= diff --git a/docs/docsite/rst/playbook_guide/playbooks_blocks.rst b/docs/docsite/rst/playbook_guide/playbooks_blocks.rst index a628164655..805045daa3 100644 --- a/docs/docsite/rst/playbook_guide/playbooks_blocks.rst +++ b/docs/docsite/rst/playbook_guide/playbooks_blocks.rst @@ -43,7 +43,7 @@ All tasks in a block inherit directives applied at the block level. Most of what become_user: root ignore_errors: true -In the example above, the 'when' condition will be evaluated before Ansible runs each of the three tasks in the block. All three tasks also inherit the privilege escalation directives, running as the root user. Finally, ``ignore_errors: yes`` ensures that Ansible continues to execute the playbook even if some of the tasks fail. +In the example above, the 'when' condition will be evaluated before Ansible runs each of the three tasks in the block. All three tasks also inherit the privilege escalation directives, running as the root user. Finally, ``ignore_errors: true`` ensures that Ansible continues to execute the playbook even if some of the tasks fail. Names for blocks have been available since Ansible 2.3. We recommend using names in all tasks, within blocks or elsewhere, for better visibility into the tasks being executed when you run the playbook. diff --git a/docs/docsite/rst/playbook_guide/playbooks_variables.rst b/docs/docsite/rst/playbook_guide/playbooks_variables.rst index ad31c0ea05..9482845dfd 100644 --- a/docs/docsite/rst/playbook_guide/playbooks_variables.rst +++ b/docs/docsite/rst/playbook_guide/playbooks_variables.rst @@ -331,14 +331,16 @@ When passing variables with ``--extra-vars``, you must escape quotes and other s ansible-playbook arcade.yml --extra-vars '{"name":"Conan O'\\\''Brien"}' ansible-playbook script.yml --extra-vars "{\"dialog\":\"He said \\\"I just can\'t get enough of those single and double-quotes"\!"\\\"\"}" -If you have a lot of special characters, use a JSON or YAML file containing the variable definitions. vars from a JSON or YAML file ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +If you have a lot of special characters, use a JSON or YAML file containing the variable definitions. Prepend both JSON and YAML filenames with `@`. + .. code-block:: text ansible-playbook release.yml --extra-vars "@some_file.json" + ansible-playbook release.yml --extra-vars "@some_file.yaml" .. _ansible_variable_precedence: diff --git a/docs/docsite/rst/reference_appendices/release_and_maintenance.rst b/docs/docsite/rst/reference_appendices/release_and_maintenance.rst index a5039fc432..cf523778b9 100644 --- a/docs/docsite/rst/reference_appendices/release_and_maintenance.rst +++ b/docs/docsite/rst/reference_appendices/release_and_maintenance.rst @@ -115,52 +115,181 @@ You can refer to the :ref:`core_porting_guides` for tips on updating your playbo You can install ``ansible-core`` with ``pip``. See :ref:`intro_installation_guide` for details. .. _release_schedule: +.. _support_life: + +``ansible-core`` support matrix +------------------------------- + +This table links to the changelogs for each major ``ansible-core`` release. These changelogs contain the dates and significant changes in each minor release. +Dates listed indicate the start date of the maintenance cycle. + +.. list-table:: + :header-rows: 1 + + * - Version + - Support + - End Of Life + - Controller Python + - Target Python / PowerShell + * - `2.15`_ + - | GA: 22 May 2023 + | Critical: 06 Nov 2023 + | Security: 20 May 2024 + - Nov 2024 + - | Python 3.9 - 3.11 + - | Python 2.7 + | Python 3.5 - 3.11 + | PowerShell 3 - 5.1 + * - `2.14`_ + - | GA: 07 Nov 2022 + | Critical: 22 May 2023 + | Security: 06 Nov 2023 + - 20 May 2024 + - | Python 3.9 - 3.11 + - | Python 2.7 + | Python 3.5 - 3.11 + | PowerShell 3 - 5.1 + * - `2.13`_ + - | GA: 23 May 2022 + | Critical: 07 Nov 2022 + | Security: 22 May 2023 + - 06 Nov 2023 + - | Python 3.8 - 3.10 + - | Python 2.7 + | Python 3.5 - 3.10 + | PowerShell 3 - 5.1 + * - `2.12`_ + - | GA: 08 Nov 2021 + | Critical: 23 May 2022 + | Security: 07 Nov 2022 + - 22 May 2023 + - | Python 3.8 - 3.10 + - | Python 2.6 + | Python 3.5 - 3.10 + | PowerShell 3 - 5.1 + * - `2.11`_ + - | GA: 26 Apr 2021 + | Critical: 08 Nov 2021 + | Security: 23 May 2022 + - | **EOL** + | 07 Nov 2022 + - | Python 2.7 + | Python 3.5 - 3.9 + - | Python 2.6 - 2.7 + | Python 3.5 - 3.9 + | PowerShell 3 - 5.1 + * - `2.10`_ + - | GA: 13 Aug 2020 + | Critical: 26 Apr 2021 + | Security: 08 Nov 2021 + - | **EOL** + | 23 May 2022 + - | Python 2.7 + | Python 3.5 - 3.9 + - | Python 2.6 - 2.7 + | Python 3.5 - 3.9 + | PowerShell 3 - 5.1 + * - `2.9`_ + - | GA: 31 Oct 2019 + | Critical: 13 Aug 2020 + | Security: 26 Apr 2021 + - | **EOL** + | 23 May 2022 + - | Python 2.7 + | Python 3.5 - 3.8 + - | Python 2.6 - 2.7 + | Python 3.5 - 3.8 + | PowerShell 3 - 5.1 +.. * - 2.16 +.. - 06 Nov 2023 +.. - 20 May 2024 +.. - Nov 2024 +.. - May 2025 +.. - | Python 3.10 - 3.12 +.. - | Python 3.6 - 3.12 +.. | PowerShell TBD +.. * - 2.17 +.. - 20 May 2024 +.. - Nov 2024 +.. - May 2025 +.. - Nov 2025 +.. - | Python 3.10 - 3.12 +.. - | Python 3.6 - 3.12 +.. | PowerShell TBD +.. * - 2.18 +.. - Nov 2024 +.. - May 2025 +.. - Nov 2025 +.. - May 2026 +.. - | Python 3.11 - 3.13 +.. - | Python 3.6 - 3.13 +.. | PowerShell TBD +.. * - 2.19 +.. - May 2025 +.. - Nov 2025 +.. - May 2026 +.. - Nov 2026 +.. - | Python 3.11 - 3.13 +.. - | Python 3.6 - 3.13 +.. | PowerShell TBD +.. * - 2.20 +.. - Nov 2025 +.. - May 2026 +.. - Nov 2026 +.. - May 2027 +.. - | Python 3.12 - 3.14 +.. - | Python 3.8 - 3.14 +.. | PowerShell TBD +.. * - 2.21 +.. - May 2026 +.. - Nov 2026 +.. - May 2027 +.. - Nov 2027 +.. - | Python 3.12 - 3.14 +.. - | Python 3.8 - 3.14 +.. | PowerShell TBD +.. * - 2.22 +.. - Nov 2026 +.. - May 2027 +.. - Nov 2027 +.. - May 2028 +.. - | Python 3.13 - 3.15 +.. - | Python 3.8 - 3.15 +.. | PowerShell TBD +.. * - 2.23 +.. - May 2027 +.. - Nov 2027 +.. - May 2028 +.. - Nov 2028 +.. - | Python 3.13 - 3.15 +.. - | Python 3.8 - 3.15 +.. | PowerShell TBD +.. * - 2.24 +.. - Nov 2027 +.. - May 2028 +.. - Nov 2028 +.. - May 2029 +.. - | Python 3.14 - 3.16 +.. - | Python 3.8 - 3.16 +.. | PowerShell TBD +.. * - 2.25 +.. - May 2028 +.. - Nov 2028 +.. - May 2029 +.. - Nov 2029 +.. - | Python 3.14 - 3.16 +.. - | Python 3.8 - 3.16 +.. | PowerShell TBD -``ansible-core`` changelogs ----------------------------- -This table links to the changelogs for each major ``ansible-core`` -release. These changelogs contain the dates and -significant changes in each minor release. - -================================= ==================================================== ====================== -``ansible-core``/``ansible-base`` Status Expected end of life - Release -================================= ==================================================== ====================== -devel In development (ansible-core 2.15 unreleased, trunk) TBD -`2.14 ansible-core Changelogs`_ Maintained (security **and** general bug fixes) May 2024 -`2.13 ansible-core Changelogs`_ Maintained (security **and** critical bug fixes) Nov 2023 -`2.12 ansible-core Changelogs`_ Maintained (security bug fixes only) May 2023 -`2.11 ansible-core Changelogs`_ Unmaintained (end of life) EOL -`2.10 ansible-base Changelogs`_ Unmaintained (end of life) EOL -`2.9 Changelogs`_ Unmaintained (end of life) EOL -`2.8 Changelogs`_ Unmaintained (end of life) EOL -`2.7 Changelogs`_ Unmaintained (end of life) EOL -`2.6 Changelogs`_ Unmaintained (end of life) EOL -`2.5 Changelogs`_ Unmaintained (end of life) EOL -<2.5 Unmaintained (end of life) EOL -================================= ==================================================== ====================== - -.. _2.14 ansible-core Changelogs: -.. _2.14: https://github.com/ansible/ansible/blob/stable-2.14/changelogs/CHANGELOG-v2.14.rst -.. _2.13 ansible-core Changelogs: -.. _2.13: https://github.com/ansible/ansible/blob/stable-2.13/changelogs/CHANGELOG-v2.13.rst -.. _2.12 ansible-core Changelogs: -.. _2.12: https://github.com/ansible/ansible/blob/stable-2.12/changelogs/CHANGELOG-v2.12.rst -.. _2.11 ansible-core Changelogs: -.. _2.11: https://github.com/ansible/ansible/blob/stable-2.11/changelogs/CHANGELOG-v2.11.rst -.. _2.10 ansible-base Changelogs: -.. _2.10: https://github.com/ansible/ansible/blob/stable-2.10/changelogs/CHANGELOG-v2.10.rst -.. _2.9 Changelogs: .. _2.9: https://github.com/ansible/ansible/blob/stable-2.9/changelogs/CHANGELOG-v2.9.rst -.. _2.8 Changelogs: -.. _2.8: https://github.com/ansible/ansible/blob/stable-2.8/changelogs/CHANGELOG-v2.8.rst -.. _2.7 Changelogs: https://github.com/ansible/ansible/blob/stable-2.7/changelogs/CHANGELOG-v2.7.rst -.. _2.6 Changelogs: -.. _2.6: https://github.com/ansible/ansible/blob/stable-2.6/changelogs/CHANGELOG-v2.6.rst -.. _2.5 Changelogs: https://github.com/ansible/ansible/blob/stable-2.5/changelogs/CHANGELOG-v2.5.rst -.. _support_life: -.. _methods: +.. _2.10: https://github.com/ansible/ansible/blob/stable-2.10/changelogs/CHANGELOG-v2.10.rst +.. _2.11: https://github.com/ansible/ansible/blob/stable-2.11/changelogs/CHANGELOG-v2.11.rst +.. _2.12: https://github.com/ansible/ansible/blob/stable-2.12/changelogs/CHANGELOG-v2.12.rst +.. _2.13: https://github.com/ansible/ansible/blob/stable-2.13/changelogs/CHANGELOG-v2.13.rst +.. _2.14: https://github.com/ansible/ansible/blob/stable-2.14/changelogs/CHANGELOG-v2.14.rst +.. _2.15: https://github.com/ansible/ansible/blob/stable-2.15/changelogs/CHANGELOG-v2.15.rst + Preparing for a new release =========================== |