Skip to content

Commit 9d7b3f1

Browse files
felixfonteinrussoz
andauthored
Remove deprecated features and plugins for 11.0.0 (#10126)
* Bump version to 11.0.0. * Removed deprecated plugins/modules. * Remove _init_session(). * Remove ack_venv_creation_deprecation. * Change behavior of state. * Remove value reading. * Remove list_all. * Remove various deprecated module helper things. * Change default of proxmox's update parameter. * Fix constructor command order. Co-authored-by: Alexei Znamensky <[email protected]> * MH: adjust guide --------- Co-authored-by: Alexei Znamensky <[email protected]> Co-authored-by: Alexei Znamensky <[email protected]>
1 parent b861850 commit 9d7b3f1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+89
-10574
lines changed

.github/BOTMETA.yml

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,6 @@ files:
127127
maintainers: $team_ansible_core
128128
$doc_fragments/:
129129
labels: docs_fragments
130-
$doc_fragments/clc.py:
131-
maintainers: clc-runner russoz
132130
$doc_fragments/django.py:
133131
maintainers: russoz
134132
$doc_fragments/hpe3par.py:
@@ -254,8 +252,6 @@ files:
254252
$inventories/scaleway.py:
255253
labels: cloud scaleway
256254
maintainers: $team_scaleway
257-
$inventories/stackpath_compute.py:
258-
maintainers: shayrybak
259255
$inventories/virtualbox.py: {}
260256
$inventories/xen_orchestra.py:
261257
maintainers: ddelnano shinuza
@@ -299,9 +295,6 @@ files:
299295
$lookups/lastpass.py: {}
300296
$lookups/lmdb_kv.py:
301297
maintainers: jpmens
302-
$lookups/manifold.py:
303-
labels: manifold
304-
maintainers: galanoff
305298
$lookups/merge_variables.py:
306299
maintainers: rlenferink m-a-r-k-e alpex8
307300
$lookups/onepass:
@@ -510,8 +503,6 @@ files:
510503
maintainers: NickatEpic
511504
$modules/cisco_webex.py:
512505
maintainers: drew-russell
513-
$modules/clc_:
514-
maintainers: clc-runner
515506
$modules/cloud_init_data_facts.py:
516507
maintainers: resmo
517508
$modules/cloudflare_dns.py:
@@ -670,8 +661,6 @@ files:
670661
maintainers: marns93
671662
$modules/hg.py:
672663
maintainers: yeukhon
673-
$modules/hipchat.py:
674-
maintainers: pb8226 shirou
675664
$modules/homebrew.py:
676665
ignore: ryansb
677666
keywords: brew cask darwin homebrew macosx macports osx
@@ -1145,8 +1134,6 @@ files:
11451134
maintainers: $team_bsd berenddeboer
11461135
$modules/pritunl_:
11471136
maintainers: Lowess
1148-
$modules/profitbricks:
1149-
maintainers: baldwinSPC
11501137
$modules/proxmox:
11511138
keywords: kvm libvirt proxmox qemu
11521139
labels: proxmox virt
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
removed_features:
2+
- "stackpath_compute inventory plugin - the plugin was removed since the company and the service were sunset in June 2024 (https://github.com/ansible-collections/community.general/pull/10126)."
3+
- "manifold lookup plugin - the plugin was removed since the company was acquired in 2021 and service was ceased afterwards (https://github.com/ansible-collections/community.general/pull/10126)."
4+
- "clc_* modules and doc fragment - the modules were removed since CenturyLink Cloud services went EOL in September 2023 (https://github.com/ansible-collections/community.general/pull/10126)."
5+
- "hipchat - the module was removed since the hipchat service has been discontinued and the self-hosted variant has been End of Life since 2020 (https://github.com/ansible-collections/community.general/pull/10126)."
6+
- "profitbrick* modules - the modules were removed since the supporting library is unsupported since 2021 (https://github.com/ansible-collections/community.general/pull/10126)."
7+
- "redfish_utils module utils - the ``_init_session`` method has been removed (https://github.com/ansible-collections/community.general/pull/10126)."
8+
- "django_manage - the ``ack_venv_creation_deprecation`` option has been removed. It had no effect anymore anyway (https://github.com/ansible-collections/community.general/pull/10126)."
9+
- "apt_rpm - the ``present`` and ``installed`` states are no longer equivalent to ``latest``, but to ``present_not_latest`` (https://github.com/ansible-collections/community.general/pull/10126)."
10+
- "git_config - it is no longer allowed to use ``state=present`` with no value to read the config value. Use the ``community.general.git_config_info`` module instead (https://github.com/ansible-collections/community.general/pull/10126)."
11+
- "git_config - the ``list_all`` option has been removed. Use the ``community.general.git_config_info`` module instead (https://github.com/ansible-collections/community.general/pull/10126)."
12+
- "mh.mixins.deps module utils - this module utils has been removed. Use the ``deps`` module utils instead (https://github.com/ansible-collections/community.general/pull/10126)."
13+
- "mh.mixins.vars module utils - this module utils has been removed. Use ``VarDict`` from the ``vardict`` module utils instead (https://github.com/ansible-collections/community.general/pull/10126)."
14+
- "mh.module_helper module utils - ``VarDict`` is now imported from the ``vardict`` module utils and no longer from the removed ``mh.mixins.vars`` module utils (https://github.com/ansible-collections/community.general/pull/10126)."
15+
- "mh.module_helper module utils - ``AnsibleModule`` and ``VarsMixin`` are no longer provided (https://github.com/ansible-collections/community.general/pull/10126)."
16+
- "mh.module_helper module utils - the attributes ``use_old_vardict`` and ``mute_vardict_deprecation`` from ``ModuleHelper`` have been removed. We suggest to remove them from your modules if you no longer support community.general < 11.0.0 (https://github.com/ansible-collections/community.general/pull/10126)."
17+
- "module_helper module utils - ``StateMixin``, ``DependencyCtxMgr``, ``VarMeta``, ``VarDict``, and ``VarsMixin`` are no longer provided (https://github.com/ansible-collections/community.general/pull/10126)."
18+
breaking_changes:
19+
- "proxmox - the default of ``update`` changed from ``false`` to ``true`` (https://github.com/ansible-collections/community.general/pull/10126)."

docs/docsite/rst/guide_modulehelper.rst

Lines changed: 6 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ But bear in mind that it does not showcase all of MH's features:
3838
),
3939
supports_check_mode=True,
4040
)
41-
use_old_vardict = False
4241
4342
def __run__(self):
4443
self.vars.original_message = ''
@@ -84,10 +83,6 @@ section above, but there are more elements that will take part in it.
8483
8584
facts_name = None # used if generating facts, from parameters or otherwise
8685
87-
# transitional variables for the new VarDict implementation, see information below
88-
use_old_vardict = True
89-
mute_vardict_deprecation = False
90-
9186
module = dict(
9287
argument_spec=dict(...),
9388
# ...
@@ -207,28 +202,14 @@ By using ``self.vars``, you get a central mechanism to access the parameters but
207202
As described in :ref:`ansible_collections.community.general.docsite.guide_vardict`, variables in ``VarDict`` have metadata associated to them.
208203
One of the attributes in that metadata marks the variable for output, and MH makes use of that to generate the module's return values.
209204

210-
.. important::
211-
212-
The ``VarDict`` feature described was introduced in community.general 7.1.0, but there was a first
213-
implementation of it embedded within ``ModuleHelper``.
214-
That older implementation is now deprecated and will be removed in community.general 11.0.0.
215-
After community.general 7.1.0, MH modules generate a deprecation message about *using the old VarDict*.
216-
There are two ways to prevent that from happening:
217-
218-
#. Set ``mute_vardict_deprecation = True`` and the deprecation will be silenced. If the module still uses the old ``VarDict``,
219-
it will not be able to update to community.general 11.0.0 (Spring 2025) upon its release.
220-
#. Set ``use_old_vardict = False`` to make the MH module use the new ``VarDict`` immediately.
221-
We strongly recommend you use the new ``VarDict``, for that you make sure to consult its documentation at
222-
:ref:`ansible_collections.community.general.docsite.guide_vardict`.
223-
224-
.. code-block:: python
205+
.. note::
225206

226-
class MyTest(ModuleHelper):
227-
use_old_vardict = False
228-
mute_vardict_deprecation = True
229-
...
207+
The ``VarDict`` class was introduced in community.general 7.1.0, as part of ``ModuleHelper`` itself.
208+
However, it has been factored out to become an utility on its own, described in :ref:`ansible_collections.community.general.docsite.guide_vardict`,
209+
and the older implementation was removed in community.general 11.0.0.
230210

231-
These two settings are mutually exclusive, but that is not enforced and the behavior when setting both is not specified.
211+
Some code might still refer to the class variables ``use_old_vardict`` and ``mute_vardict_deprecation``, used for the transtition to the new
212+
implementation but from community.general 11.0.0 onwards they are no longer used and can be safely removed from the code.
232213

233214
Contrary to new variables created in ``VarDict``, module parameters are not set for output by default.
234215
If you want to include some module parameters in the output, list them in the ``output_params`` class variable.
@@ -410,7 +391,6 @@ By using ``StateModuleHelper`` you can make your code like the excerpt from the
410391
module = dict(
411392
...
412393
)
413-
use_old_vardict = False
414394
415395
def __init_module__(self):
416396
self.runner = gconftool2_runner(self.module, check_rc=True)

galaxy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
namespace: community
77
name: general
8-
version: 10.7.0
8+
version: 11.0.0
99
readme: README.md
1010
authors:
1111
- Ansible (https://github.com/ansible)

meta/runtime.yml

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ plugin_routing:
100100
hashi_vault:
101101
redirect: community.hashi_vault.hashi_vault
102102
manifold:
103-
deprecation:
103+
tombstone:
104104
removal_version: 11.0.0
105105
warning_text: Company was acquired in 2021 and service was ceased afterwards.
106106
nios:
@@ -129,39 +129,39 @@ plugin_routing:
129129
cisco_spark:
130130
redirect: community.general.cisco_webex
131131
clc_alert_policy:
132-
deprecation:
132+
tombstone:
133133
removal_version: 11.0.0
134134
warning_text: CenturyLink Cloud services went EOL in September 2023.
135135
clc_blueprint_package:
136-
deprecation:
136+
tombstone:
137137
removal_version: 11.0.0
138138
warning_text: CenturyLink Cloud services went EOL in September 2023.
139139
clc_firewall_policy:
140-
deprecation:
140+
tombstone:
141141
removal_version: 11.0.0
142142
warning_text: CenturyLink Cloud services went EOL in September 2023.
143143
clc_group:
144-
deprecation:
144+
tombstone:
145145
removal_version: 11.0.0
146146
warning_text: CenturyLink Cloud services went EOL in September 2023.
147147
clc_loadbalancer:
148-
deprecation:
148+
tombstone:
149149
removal_version: 11.0.0
150150
warning_text: CenturyLink Cloud services went EOL in September 2023.
151151
clc_modify_server:
152-
deprecation:
152+
tombstone:
153153
removal_version: 11.0.0
154154
warning_text: CenturyLink Cloud services went EOL in September 2023.
155155
clc_publicip:
156-
deprecation:
156+
tombstone:
157157
removal_version: 11.0.0
158158
warning_text: CenturyLink Cloud services went EOL in September 2023.
159159
clc_server:
160-
deprecation:
160+
tombstone:
161161
removal_version: 11.0.0
162162
warning_text: CenturyLink Cloud services went EOL in September 2023.
163163
clc_server_snapshot:
164-
deprecation:
164+
tombstone:
165165
removal_version: 11.0.0
166166
warning_text: CenturyLink Cloud services went EOL in September 2023.
167167
consul_acl:
@@ -320,7 +320,7 @@ plugin_routing:
320320
hetzner_firewall_info:
321321
redirect: community.hrobot.firewall_info
322322
hipchat:
323-
deprecation:
323+
tombstone:
324324
removal_version: 11.0.0
325325
warning_text: The hipchat service has been discontinued and the self-hosted variant has been End of Life since 2020.
326326
hpilo_facts:
@@ -645,23 +645,23 @@ plugin_routing:
645645
postgresql_user_obj_stat_info:
646646
redirect: community.postgresql.postgresql_user_obj_stat_info
647647
profitbricks:
648-
deprecation:
648+
tombstone:
649649
removal_version: 11.0.0
650650
warning_text: Supporting library is unsupported since 2021.
651651
profitbricks_datacenter:
652-
deprecation:
652+
tombstone:
653653
removal_version: 11.0.0
654654
warning_text: Supporting library is unsupported since 2021.
655655
profitbricks_nic:
656-
deprecation:
656+
tombstone:
657657
removal_version: 11.0.0
658658
warning_text: Supporting library is unsupported since 2021.
659659
profitbricks_volume:
660-
deprecation:
660+
tombstone:
661661
removal_version: 11.0.0
662662
warning_text: Supporting library is unsupported since 2021.
663663
profitbricks_volume_attachments:
664-
deprecation:
664+
tombstone:
665665
removal_version: 11.0.0
666666
warning_text: Supporting library is unsupported since 2021.
667667
purefa_facts:
@@ -970,7 +970,7 @@ plugin_routing:
970970
kubevirt:
971971
redirect: community.kubevirt.kubevirt
972972
stackpath_compute:
973-
deprecation:
973+
tombstone:
974974
removal_version: 11.0.0
975975
warning_text: The company and the service were sunset in June 2024.
976976
filter:

plugins/doc_fragments/clc.py

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)