status.rst

Ansible Collections Project Status

Topics

• Overview
• Summary
• Ansible Roadmap
• Remaining big ticket items
  • Collection redirection/tombstoning
  • Versioning and Deprecation policy
  • ACD Proposal
  • Automatic push to Galaxy on Git tag
  • community.general collection
  • Ansibulbot
  • Moving Issues and PRs from ansible/ansible
  • Documentation changes
  • Other items
• Limitations and known issues

Overview

This page gives an overview

Warning: Subject to frequent updates

This is a "living document", expect it to change as we progress with the Collections work over the next few months.

For background on collections see Ansible Collections Overview.

Summary

# FIXME, can we say all collections from acd.in are good now?

A lot of the new Ansible Collection repos are open for contributions Most Collections aren't ready to be used yet, though you can start contributing to a few.

• Devel is now ansible-base
• Collection repos created: DONE
• Collection repos that are ready for use:
  • amazon.aws done
  • ansible.posix done
  • ansible.windows done
  • community.aws done
  • community.grafana done
  • community.kubernetes done
  • community.mongodb done
  • community.windows done

Ansible Roadmap

This section details the various deadlines and milestones which make up the Ansible release.

Ansible-base has it's own roadmap.

• ansible-base 2.10 beta 1 (creation of ansible/ansible:stable-2.10)
• All collections passing ansible-test sanity against ansible/ansible:stable-2.10
• No more moving (claiming) content from communtiy.general or community.network into dedicated collections
• Feature freeze for all collections (no more modules/plugins)
• New ansible package for PyPi
• new ansible package for rpm, deb,... (include externally maintained packages?)

Note, the order of the above items may change, also items may be added or removed

Remaining big ticket items

The following section details the remaining large blocks of work remaining before Ansible 2.10 can be released. Some of these item are proposals, or work in progress (WIP) Pull Requests. As Collections is a large change to development, community and end-users it's really important to us that

Collection redirection/tombstoning

This PR to ansible-base is one of the key features to allow Ansible 2.9 playbooks work without modification in Ansible 2.10

Once this PR merged CI for the community.general collection repository should be a lot greener.

The main features it will provide are:

• Modules and plugins to be reference by the "short form", ie mail rather than community.general.mail
• Ability to have deprecated content in Collections via a meta/routing.yml file in a collection example

See ` collection redirection/tombstoning (#67684) <ansible/ansible#67684>`_ for a full list of features.

Versioning and Deprecation policy

In Ansible 2.9 (and earlier) all modules and plugins were all packaged to gether, so a single version could be used. As collections can be released and versioned independently this is no longer true.

Versioning and deprecation proposal

ACD Proposal

ACD Proposal

FIXME: Link to proposal

Automatic push to Galaxy on Git tag

Allows Collection owners to publish their Collection to Galaxy with ease.

community.general collection

The community.general is the largest collection we have. It has ~1,000 modules in.

• DONE Network content moved to community.network
• Remove hacks once collection redirection/tombstoning (#67684) has been merged
• re-enable disabled integration tests

Ansibulbot

For larger Collection repos we will need ansibulbot to help maintainers.

We expect ansibulbot to be needed on:

• community.aws
• community.general
• community.network
• community.windows

The bot is mostly functional, we need to do some more testing on it

Moving Issues and PRs from ansible/ansible

• We have a script which will help move PRs from ansible/ansible into the collection which hosts the code
• Once the repos are stable we will auto close PRs in ansible/ansible
• We don't have a good method to move Issues, these will stay in ansible/ansible for longer

Documentation changes

The main pending documentation changes include:

• Create a pipeline to pull module documentation for ACD into docs.ansible.com to replace the old module pages.
• Define the recommended changelog strategy for individual collections and how that feeds into an ACD changelog (draft mockup).
• update examples to use FQCN.
• Update user/developer guides to reflect collections now.

The other documentation issues related to collections on docs.ansible.com are being tracked with the docs and collections labels.

Other items

This document is just a summary of the bigger todo items.

A list of items can be found in the Community Collection Project Board

Limitations and known issues