Skip to content

Commit

Permalink
Added 2.18 porting guide (#2076)
Browse files Browse the repository at this point in the history
* Added 2.18 porting guide

* Removed assertion change from porting guide

* Apply suggestions from code review

Co-authored-by: Sandra McCann <[email protected]>

---------

Co-authored-by: Sandra McCann <[email protected]>
  • Loading branch information
jborean93 and samccann authored Oct 29, 2024
1 parent ef750f6 commit d6eb6c9
Show file tree
Hide file tree
Showing 2 changed files with 100 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/docsite/rst/porting_guides/core_porting_guides.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Please note that this is not a complete list. If you believe any extra informati
:maxdepth: 1
:glob:

porting_guide_core_2.18
porting_guide_core_2.17
porting_guide_core_2.16
porting_guide_core_2.15
Expand Down
99 changes: 99 additions & 0 deletions docs/docsite/rst/porting_guides/porting_guide_core_2.18.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@

.. _porting_2.18_guide_core:

*******************************
Ansible-core 2.18 Porting Guide
*******************************

This section discusses the behavioral changes between ``ansible-core`` 2.17 and ``ansible-core`` 2.18.

It is intended to assist in updating your playbooks, plugins and other parts of your Ansible infrastructure so they will work with this version of Ansible.

We suggest you read this page along with `ansible-core Changelog for 2.18 <https://github.com/ansible/ansible/blob/stable-2.18/changelogs/CHANGELOG-v2.18.rst>`_ to understand what updates you may need to make.

This document is part of a collection on porting. The complete list of porting guides can be found at :ref:`porting guides <porting_guides>`.

.. contents:: Topics


Playbook
========

No notable changed


Command Line
============

* Python 3.10 is a no longer supported control node version. Python 3.11+ is now required for running Ansible.
* Python 3.7 is a no longer supported remote version. Python 3.8+ is now required for target execution.


Deprecated
==========

No notable changes


Modules
=======

No notable changes


Modules removed
---------------

The following modules no longer exist:

* No notable changes


Deprecation notices
-------------------

No notable changes


Noteworthy module changes
-------------------------

No notable changes


Plugins
=======

* The ``ssh`` connection plugin now officially supports targeting Windows hosts. A
breaking change that has been made as part of this official support is the low level command
execution done by plugins like ``ansible.builtin.raw`` and action plugins calling
``_low_level_execute_command`` is no longer wrapped with a ``powershell.exe`` wrapped
invocation. These commands will now be executed directly on the target host using
the default shell configuration set on the Windows host. This change is done to
simplify the configuration required on the Ansible side, make module execution more
efficient, and to remove the need to decode stderr CLIXML output. A consequence of this
change is that ``ansible.builtin.raw`` commands are no longer guaranteed to be
run through a PowerShell shell and with the output encoding of UTF-8. To run a command
through PowerShell and with UTF-8 output support, use the ``ansible.windows.win_shell``
or ``ansible.windows.win_powershell`` module instead.

.. code-block:: yaml
- name: Run with win_shell
ansible.windows.win_shell: Write-Host "Hello, Café"
- name: Run with win_powershell
ansible.windows.win_powershell:
script: Write-Host "Hello, Café"
Porting custom scripts
======================

No notable changes


Networking
==========

No notable changes

0 comments on commit d6eb6c9

Please sign in to comment.