From Fedora Project Wiki
m
(Lets toss this to the wrangler...)
Line 16: Line 16:


== Current status ==
== Current status ==
[[Category:ChangePageIncomplete]]
[[Category:ChangeReadyForWrangler]]
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->

Revision as of 18:55, 15 October 2021

Ansible 5

Summary

The ansible project has re-organized how they release and distribute ansible. This change moves Fedora to be in sync with those changes and retires the old 'ansible classic/2.9.x' package in favor of a 'ansible' package that pulls in ansible-core (the engine) and includes all the collections in upstream ansible releases.

Owner

  • Email: kevin@scrye.com, dmsimard@redhat.com


Current status

  • Targeted release: Fedora Linux 36
  • Last updated: 2021-10-15
  • FESCo issue: <will be assigned by the Wrangler>
  • Tracker bug: <will be assigned by the Wrangler>
  • Release notes tracker: <will be assigned by the Wrangler>

Detailed Description

The upstream ansible project found that maintaining a single monolithic ansible package with everything included was not working well (source). Small changes had to wait for releases, some areas had no subject matter reviewers, it was difficult to try and handle all the issues and changes in a timely manner. So, the ansible engine was split off and then the rest of the content was moved to separate collections. These collections could then be maintained by communities that care about that area and could release at their own pace. A number of collections have agreed to release on the same cadence. These collections, along with the ansible-core engine comprise a upstream 'ansible' release.

The engine package (ansible-core) is already in Fedora 35+. Currently the 'ansible' package is 'ansible classic', ie, the 2.9.x version from before the reorganization. While Ansible 2.9.x will continue to be maintained from a security perspective until 2022, it is desireable to update to the latest release of both ansible-core and ansible in order to benefit from continued updates, bug fixes and improvements.

This change will modify the existing 'ansible' package to include the Ansible Collections that are provided in the upstream ansible releases from PyPi. The ansible package will not include ansible-core but will have a requirement (dependency) on it.

Having two separate packages will give users the ability to select the best option based on their needs:

  1. Install the 'ansible' package to mirror the user experience when installing ansible from PyPi: it will install ansible-core as well as the collections as they are included in the upstream ansible release.
  2. Install just the 'ansible-core' package when no external collections are necessary
  3. Install 'ansible-core' and then manually install collections either from existing packages in Fedora, from Ansible Galaxy or elsewhere.

Feedback

Benefit to Fedora

  • On current upstream releases with bugfixes and enhancements.
  • Increases flexibility by allowing users to choose which Ansible collections to install and where they install it from.
  • More rapid improvements for Fedora users.

Scope

  • Proposal owners:

'ansible' package needs to be modified for this change (work is in progress already).

  • Other developers: N/A
  • Release engineering: N/A
  • Policies and guidelines:

Possibly policies for packaging collections?

  • Trademark approval: N/A (not needed for this Change
  • Alignment with Objectives: First!

Upgrade/compatibility impact

On upgrade, ansible-2.9.x will be replaced by ansible-core + release collections. Ansible playbooks will continue to run as before.

How To Test

Playbooks that run as expected under Ansible 2.9 may behave differently under Ansible 5 which effectively updates the (ansible-core) runtime from 2.9 to 2.12.

Users are encouraged to take a look at the available porting guides for both Ansible and ansible-core (https://docs.ansible.com/ansible/devel/porting_guides/porting_guides.html) and carefully test the behavior of their roles and playbooks in case of any adjustments are needed.

The Ansible community package follows semantic versioning rules, so incompatible changes are only made between major versions. Unfortunately in this case, there are a number of major versions between 2.9 and 5.0.

User Experience

Users can remove the release collections and install separately packaged collections or install from ansible-galaxy.

Dependencies

Might need to conflict with some seperately packaged collections.

Contingency Plan

  • Contingency mechanism: Keep shipping ansible classic, but it will go EOL and updates will become much harder.
  • Contingency deadline: N/A (not a System Wide Change)
  • Blocks release? N/A (not a System Wide Change)

Documentation

N/A (not a System Wide Change)

Release Notes

Ansible is now shipped as 'ansible-core' (the engine) and a curated set of Ansible collections. Users can use 'dnf install ansible' to install ansible-core as well as the Ansible collections included in the upstream Ansible releases. Users can also opt to 'dnf install ansible-core' and then install collections manually from standalone packages or via ansible-galaxy.