Describe how collections can be removed from the Ansible package #201

felixfontein · 2022-03-23T19:47:15Z

SUMMARY

I wrote this up based on the discussion we had at today's community meeting. The aim of this PR is to have some basic rules on which collections can be removed so we can vote on them soon and establish them. The aim is not to have a complete list of rules. I expect we will have more discussions and additional situations added to this document in follow-up PRs.

The two processes described here are modelled after two explicit examples:

community.kubevirt is currently broken and does not work as inclued in Ansible 5, since it requires community.kubernetes < 2.0.0, while Ansible 5 includes community.kubernetes >= 2.0.0. Adjusting the collection to community.kubernetes >= 2.0.0 or kubernetes.core >= 2.0.0 have been unsuccessful and stagnated (Get working with k8s.core 2 and above community.kubevirt#34 has been inactive for six months now). Since more breakage could happen with kubernetes.core 3.0.0, we do not want to keep this collection in Ansible without active maintainers who promise to keep the code working with current versions. The first of the two processes will apply to this collection.
community.google seems to be unmaintained. It is unclear whether it still works (there is no indication it does, but also no indication that it does not). It uses very old and outdated dependencies, and CI has been broken for a long time before it was automatically disabled months ago. (The broken part was sanity checks only, unit tests were passing.) Since there has been no community interaction on this for a long time (there is no issue except some generic announcements, and there are no PRs), and there has never been any real community work on this collection, it is more likely that nobody is using it and it might even be totally broken without anyone realizing. The second process is written with this collection in mind. It gives community and users of this collection a chance to say that they use it and to step up helping it, but if nobody does, we have a process to remove it. (Also if it is removed folks can still manually install it.)

ISSUE TYPE

Docs Pull Request

COMPONENT NAME

removal_from_ansible.rst

briantist

Thanks for putting this together @felixfontein !

It's only the Y = X+1 part I'm a little unclear on, the rest I'd feel comfortable approving now as a first set of rules that can be iterated on.

removal_from_ansible.rst

Andersson007 · 2022-03-24T07:05:11Z

@felixfontein thanks for starting this!
How about the following structure for each paragraph?

Case 1
======

General things here

Conditions
~~~~~~~~

* bullet point 1
* bullet point 2
* ...

Process
~~~~~~

#. step 1
#. step 2
#. ...

What do you think?

removal_from_ansible.rst

Andersson007 · 2022-03-24T07:49:03Z

Relates to ansible-community/community-topics#79 and ansible-community/community-topics#34

felixfontein · 2022-03-25T06:21:51Z

@felixfontein thanks for starting this! How about the following structure for each paragraph?
Case 1
======

General things here

Conditions
~~~~~~~~

* bullet point 1
* bullet point 2
* ...

Process
~~~~~~

#. step 1
#. step 2
#. ...
What do you think?

So you mean for every case (like unmaintained collection) there are multiple subsections (removal, stop removal, re-adding), every one of them following this stucture?

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

felixfontein · 2022-03-30T05:38:37Z

Ooops, wrong PR...

Andersson007 · 2022-03-30T18:12:36Z

So you mean for every case (like unmaintained collection) there are multiple subsections (removal, stop removal, re-adding), every one of them following this stucture?

yep

acozine

Overall this is a great start. I made a few suggestions to clarify and simplify the language. I'd be happy to review the wording again as we keep moving forward.

removal_from_ansible.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

Andersson007

@felixfontein great job, thanks!
Couple of cosmetic things from me. Generally the process LGTM

removal_from_ansible.rst

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

Andersson007

LGTM

felixfontein · 2022-04-11T11:37:14Z

@acozine @briantist @mariolenz any more comments on this? If not, let's start a vote in community-topics.

briantist · 2022-04-11T13:11:34Z

I'm good with a vote

mariolenz · 2022-04-11T14:58:39Z

removal_from_ansible.rst

+
+The announcement mentioned below must state the reasons for the proposed removal and alert maintainers and the Ansible community that, to prevent the removal, the collection urgently needs new maintainers who can fix the problems.
+
+#. Announce upcoming removal in Ansible X+1 as described in :ref:`announce_removal`.


The internal references and links don't work for me. This one, for example, links to removal_from_ansible.rst#id1 although I think it should link to removal_from_ansible.rst#announcing-upcoming-removal.

This is unfortunately a general problem with GitHub's RST renderer, you can also see it in action here: https://github.com/ansible-collections/overview/blob/main/collection_requirements.rst#collection-infrastructure Basically GH does not support :ref:, see github/markup#122.

I've tried to fix the references by converting them to links. Now rst2html5 from docutils properly handles them, but GitHub's rest2html does not: it shows links (https://github.com/ansible-collections/overview/blob/130944d4e056ec829f97a48de223522929292201/removal_from_ansible.rst), but uses the wrong hrefs so the links do nothing. This is really sad.

github/markup#1535, github/markup#1536

This is unfortunately a general problem with GitHub's RST renderer

In that case, should we keep it as it is and vote? The links are broken on GitHub but the content is OK. Maybe we find a way to fix this later. Or GitHub fixes its RST renderer if we're lucky.

This is really sad.

Definitely.

mariolenz · 2022-04-11T15:08:33Z

any more comments on this? If not, let's start a vote in community-topics.

The internal references don't work for me (see above). Is this a GitHub issue or some problem on my side?

Anyway, I've read through the document again and the text looks OK to me. So start a vote in community-topics if you want to.

acozine

Overall looks good. I added some ideas for making it better.

removal_from_ansible.rst

acozine · 2022-04-11T18:45:07Z

removal_from_ansible.rst

+#. Re-add collection to ``collection-meta.yaml`` (``https://github.com/ansible-community/ansible-build-data/blob/main/<X>/collection-meta.yaml``).
+#. If the removal was announced in the Ansible changelog for a version that has not yet been released (``https://github.com/ansible-community/ansible-build-data/blob/main/<X>/changelog.yaml``), remove the announcement.
+
+Broken collections


I would still add a heading here for "Reasons we remove collections" and then make "Broken collections" and "Unmaintained collections" sub-sections of that. But we can do this after the content is voted on and merged in.

I agree with Alicia's points here

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

removal_from_ansible.rst

Co-authored-by: Mario Lenz <m@riolenz.de>

felixfontein · 2022-04-13T18:07:25Z

Thanks @gotmax23 and @mariolenz!

gundalow

+1 to this once existing review comments have been addresses.

gundalow · 2022-04-20T18:13:58Z

removal_from_ansible.rst

+#. Re-add collection to ``collection-meta.yaml`` (``https://github.com/ansible-community/ansible-build-data/blob/main/<X>/collection-meta.yaml``).
+#. If the removal was announced in the Ansible changelog for a version that has not yet been released (``https://github.com/ansible-community/ansible-build-data/blob/main/<X>/changelog.yaml``), remove the announcement.
+
+Broken collections


I agree with Alicia's points here

dmsimard · 2022-04-20T18:15:55Z

Hi @ansible-collections/steering-committee, please read and approve or state objections for this PR so we can move ahead. Thanks.

acozine · 2022-04-20T18:18:30Z

+1 to merging now. We can make it progressively better over time.

mariolenz · 2022-04-20T18:24:23Z

Hi @ansible-collections/steering-committee, please read and approve or state objections for this PR so we can move ahead. Thanks.

It's still WIP. I won't approve a PR that's work in progress. Feels somehow wrong to me.

felixfontein · 2022-04-20T19:00:54Z

Sorry, I completely forgot last week to remove the WIP mark and create a voting issue for this...

Andersson007 · 2022-04-21T06:40:46Z

+1 to merging this now.
@felixfontein i think it makes sense to put links to this doc in collection_requirements at least (with a separate PR).
Maybe also in the collection inclusion's README somewhere at the top in bold:)

russoz

+1 from my side

felixfontein · 2022-04-21T07:43:01Z

Please use the voting issue (ansible-community/community-topics#90) to vote on this, and not this PR. Thanks!

jamescassell

+1

felixfontein · 2022-04-27T18:14:35Z

Approved by ansible-community/community-topics#90

felixfontein · 2022-04-27T18:15:47Z

Thanks everyone!

Describe how collections can be removed from the Ansible package.

2ff398a

felixfontein mentioned this pull request Mar 23, 2022

Removing unsupported, inactive or otherwise unmaintained collections from the community package ansible-community/community-topics#79

Closed

briantist reviewed Mar 23, 2022

View reviewed changes

removal_from_ansible.rst Outdated Show resolved Hide resolved

removal_from_ansible.rst Outdated Show resolved Hide resolved

briantist mentioned this pull request Mar 24, 2022

Future of the "ansible" package ansible-community/community-topics#82

Closed

Andersson007 mentioned this pull request Mar 24, 2022

Rename k8s dependency ansible-collections/community.kubevirt#25

Closed

Andersson007 reviewed Mar 24, 2022

View reviewed changes

Andersson007 mentioned this pull request Mar 24, 2022

We are looking for new maintainers and contributors ansible-collections/community.kubevirt#27

Closed

felixfontein and others added 2 commits March 25, 2022 07:40

Apply suggestions from code review

943a61a

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

More updates.

a2a5b49

briantist approved these changes Mar 30, 2022

View reviewed changes

acozine reviewed Apr 6, 2022

View reviewed changes

felixfontein and others added 6 commits April 6, 2022 21:54

Apply suggestions from code review

fd47162

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

Apply suggestions from code review

a7daa80

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

Rewrite.

a1f305f

Extract common processes.

4e7b2f5

Fix labels.

20be039

Fix refs.

44b0ad1

Andersson007 reviewed Apr 7, 2022

View reviewed changes

felixfontein and others added 3 commits April 7, 2022 12:30

Apply suggestions from code review

9cefc8b

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

Update removal_from_ansible.rst

864fb23

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

Update removal_from_ansible.rst

209715b

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

Andersson007 approved these changes Apr 11, 2022

View reviewed changes

briantist approved these changes Apr 11, 2022

View reviewed changes

mariolenz reviewed Apr 11, 2022

View reviewed changes

acozine reviewed Apr 11, 2022

View reviewed changes

felixfontein and others added 4 commits April 11, 2022 20:49

Apply suggestions from code review

cc46ab3

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

Get rid of :ref: style references.

ae096ab

Make rst2html happy, hopefully also making GH's RST renderer happy.

8d9dedb

Fix document link.

130944d

gotmax23 reviewed Apr 13, 2022

View reviewed changes

removal_from_ansible.rst Outdated Show resolved Hide resolved

mariolenz reviewed Apr 13, 2022

View reviewed changes

removal_from_ansible.rst Outdated Show resolved Hide resolved

Update removal_from_ansible.rst

2f93b93

Co-authored-by: Mario Lenz <m@riolenz.de>

felixfontein mentioned this pull request Apr 13, 2022

Community Working Group Meeting Agenda 2022 ansible/community#645

Closed

briantist approved these changes Apr 20, 2022

View reviewed changes

gundalow reviewed Apr 20, 2022

View reviewed changes

felixfontein changed the title ~~[WIP] Describe how collections can be removed from the Ansible package~~ Describe how collections can be removed from the Ansible package Apr 20, 2022

russoz approved these changes Apr 21, 2022

View reviewed changes

felixfontein mentioned this pull request Apr 21, 2022

[Vote ended on 2022-04-27] Describe how collections can be removed from the Ansible package ansible-community/community-topics#90

Closed

jamescassell approved these changes Apr 21, 2022

View reviewed changes

felixfontein merged commit b605a63 into main Apr 27, 2022

felixfontein deleted the removal branch April 27, 2022 18:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Describe how collections can be removed from the Ansible package #201

Describe how collections can be removed from the Ansible package #201

felixfontein commented Mar 23, 2022

briantist left a comment

Andersson007 commented Mar 24, 2022

Andersson007 commented Mar 24, 2022

felixfontein commented Mar 25, 2022

felixfontein commented Mar 30, 2022 •

edited

Andersson007 commented Mar 30, 2022

acozine left a comment

Andersson007 left a comment

Andersson007 left a comment

felixfontein commented Apr 11, 2022

briantist commented Apr 11, 2022

mariolenz Apr 11, 2022

felixfontein Apr 12, 2022

felixfontein Apr 12, 2022 •

edited

mariolenz Apr 12, 2022

mariolenz commented Apr 11, 2022

acozine left a comment

acozine Apr 11, 2022

gundalow Apr 20, 2022

felixfontein commented Apr 13, 2022

gundalow left a comment

gundalow Apr 20, 2022

dmsimard commented Apr 20, 2022

acozine commented Apr 20, 2022

mariolenz commented Apr 20, 2022

felixfontein commented Apr 20, 2022

Andersson007 commented Apr 21, 2022 •

edited

russoz left a comment

felixfontein commented Apr 21, 2022

jamescassell left a comment

felixfontein commented Apr 27, 2022

felixfontein commented Apr 27, 2022


		The announcement mentioned below must state the reasons for the proposed removal and alert maintainers and the Ansible community that, to prevent the removal, the collection urgently needs new maintainers who can fix the problems.

		#. Announce upcoming removal in Ansible X+1 as described in :ref:`announce_removal`.

Describe how collections can be removed from the Ansible package #201

Describe how collections can be removed from the Ansible package #201

Conversation

felixfontein commented Mar 23, 2022

SUMMARY

ISSUE TYPE

COMPONENT NAME

briantist left a comment

Choose a reason for hiding this comment

Andersson007 commented Mar 24, 2022

Andersson007 commented Mar 24, 2022

felixfontein commented Mar 25, 2022

felixfontein commented Mar 30, 2022 • edited

Andersson007 commented Mar 30, 2022

acozine left a comment

Choose a reason for hiding this comment

Andersson007 left a comment

Choose a reason for hiding this comment

Andersson007 left a comment

Choose a reason for hiding this comment

felixfontein commented Apr 11, 2022

briantist commented Apr 11, 2022

mariolenz Apr 11, 2022

Choose a reason for hiding this comment

felixfontein Apr 12, 2022

Choose a reason for hiding this comment

felixfontein Apr 12, 2022 • edited

Choose a reason for hiding this comment

mariolenz Apr 12, 2022

Choose a reason for hiding this comment

mariolenz commented Apr 11, 2022

acozine left a comment

Choose a reason for hiding this comment

acozine Apr 11, 2022

Choose a reason for hiding this comment

gundalow Apr 20, 2022

Choose a reason for hiding this comment

felixfontein commented Apr 13, 2022

gundalow left a comment

Choose a reason for hiding this comment

gundalow Apr 20, 2022

Choose a reason for hiding this comment

dmsimard commented Apr 20, 2022

acozine commented Apr 20, 2022

mariolenz commented Apr 20, 2022

felixfontein commented Apr 20, 2022

Andersson007 commented Apr 21, 2022 • edited

russoz left a comment

Choose a reason for hiding this comment

felixfontein commented Apr 21, 2022

jamescassell left a comment

Choose a reason for hiding this comment

felixfontein commented Apr 27, 2022

felixfontein commented Apr 27, 2022

felixfontein commented Mar 30, 2022 •

edited

felixfontein Apr 12, 2022 •

edited

Andersson007 commented Apr 21, 2022 •

edited