Skip to content

Commit 5de1eb3

Browse files
authored
Merge pull request #3208 from ansible/release/porting-guide-12.2.0
Add the Ansible community 12.2.0 porting guide
2 parents ff54f34 + 7db74fe commit 5de1eb3

File tree

1 file changed

+66
-2
lines changed

1 file changed

+66
-2
lines changed

docs/docsite/rst/porting_guides/porting_guide_12.rst

Lines changed: 66 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ These changes enable reporting of numerous problematic behaviors that went undet
2323
with wide-ranging positive effects on security, performance, and user experience.
2424

2525
Backward compatibility has been preserved where practical, but some breaking changes were necessary.
26-
This guide describes some common problem scenarios with example content, error messsages, and suggested solutions.
26+
This guide describes some common problem scenarios with example content, error messages, and suggested solutions.
2727

2828
We recommend you test your playbooks and roles in a staging environment with this release to determine where you may need to make changes.
2929

@@ -250,7 +250,7 @@ The environment variable ``_ANSIBLE_TEMPLAR_UNTRUSTED_TEMPLATE_BEHAVIOR`` can be
250250
Valid options are:
251251

252252
* ``warning`` - A warning will be issued when an untrusted template is encountered.
253-
* ``fail`` - An error will be raised when an untrusted template is encountered.
253+
* ``error`` - An error will be raised when an untrusted template is encountered.
254254
* ``ignore`` - Untrusted templates are silently ignored and used as-is. This is the default behavior.
255255

256256
.. note::
@@ -910,6 +910,70 @@ Networking
910910

911911
No notable changes
912912

913+
Porting Guide for v12.2.0
914+
=========================
915+
916+
Known Issues
917+
------------
918+
919+
community.sops
920+
^^^^^^^^^^^^^^
921+
922+
- When using the ``community.sops.load_vars`` with ansible-core 2.20, note that the deprecation of ``INJECT_FACTS_AS_VARS`` causes deprecation warnings to be shown every time a variable loaded with ``community.sops.load_vars`` is used. This is due to ansible-core deprecating ``INJECT_FACTS_AS_VARS`` without providing an alternative for modules like ``community.sops.load_vars`` to use. If you do not like these deprecation warnings, you have to explicitly set ``INJECT_FACTS_AS_VARS`` to ``true``. **DO NOT** change the use of SOPS encrypted variables to ``ansible_facts``. The situation will hopefully improve in ansible-core 2.21 through the promised API that allows action plugins to set variables; community.sops will adapt to use it, which will make the warning go away. (The API was originally promised for ansible-core 2.20, but then delayed.)
923+
924+
Major Changes
925+
-------------
926+
927+
community.vmware
928+
^^^^^^^^^^^^^^^^
929+
930+
- Replace ``ansible.module_utils._text`` (https://github.com/ansible-collections/community.vmware/issues/2497).
931+
- Replace ``ansible.module_utils.common._collections_compat`` (https://github.com/ansible-collections/community.vmware/issues/2497).
932+
- Replace ``ansible.module_utils.six`` (https://github.com/ansible-collections/community.vmware/pull/2495).
933+
934+
fortinet.fortios
935+
^^^^^^^^^^^^^^^^
936+
937+
- Supported default_group feature for the all of the modules.
938+
939+
grafana.grafana
940+
^^^^^^^^^^^^^^^
941+
942+
- Fallback to empty dict in case grafana_ini is undefined by @root-expert in https://github.com/grafana/grafana-ansible-collection/pull/403
943+
- Fix Mimir config file validation task by @Windos in https://github.com/grafana/grafana-ansible-collection/pull/428
944+
- Fixes issue by @digiserg in https://github.com/grafana/grafana-ansible-collection/pull/421
945+
- Import custom dashboards only when directory exists by @mahendrapaipuri in https://github.com/grafana/grafana-ansible-collection/pull/430
946+
- Restore default listen address and port in Mimir by @56quarters in https://github.com/grafana/grafana-ansible-collection/pull/456
947+
- Updated YUM repo urls from `packages.grafana.com` to `rpm.grafana.com` by @DejfCold in https://github.com/grafana/grafana-ansible-collection/pull/414
948+
- Use credentials from grafana_ini when importing dashboards by @root-expert in https://github.com/grafana/grafana-ansible-collection/pull/402
949+
- do not skip scrape latest github version even in check_mode by @cmehat in https://github.com/grafana/grafana-ansible-collection/pull/408
950+
- fix broken Grafana apt repository addition by @kleini in https://github.com/grafana/grafana-ansible-collection/pull/454
951+
- fix datasource documentation by @jeremad in https://github.com/grafana/grafana-ansible-collection/pull/437
952+
- fix mimir_download_url_deb & mimir_download_url_rpm by @germebl in https://github.com/grafana/grafana-ansible-collection/pull/400
953+
- update catalog info by @Duologic in https://github.com/grafana/grafana-ansible-collection/pull/434
954+
- use deb822 for newer debian versions by @Lukas-Heindl in https://github.com/grafana/grafana-ansible-collection/pull/440
955+
956+
Deprecated Features
957+
-------------------
958+
959+
- The ``community.digitalocean`` collection has been deprecated.
960+
It will be removed from Ansible 13 if no one starts maintaining it again before Ansible 13.
961+
See `Collections Removal Process for unmaintained collections <https://docs.ansible.com/ansible/devel/community/collection_contributors/collection_package_removal.html#unmaintained-collections>`__ for more details (`https://forum.ansible.com/t/44602 <https://forum.ansible.com/t/44602>`__).
962+
963+
community.hrobot
964+
^^^^^^^^^^^^^^^^
965+
966+
- storagebox\* modules - membership in the ``community.hrobot.robot`` action group (module defaults group) is deprecated; the modules will be removed from the group in community.hrobot 3.0.0. Use ``community.hrobot.api`` instead (https://github.com/ansible-collections/community.hrobot/pull/178).
967+
- storagebox\* modules - the ``hetzner_token`` option for these modules will be required from community.hrobot 3.0.0 on (https://github.com/ansible-collections/community.hrobot/pull/178).
968+
- storagebox\* modules - the ``hetzner_user`` and ``hetzner_pass`` options for these modules are deprecated; support will be removed in community.hrobot 3.0.0. Use ``hetzner_token`` instead (https://github.com/ansible-collections/community.hrobot/pull/178).
969+
- storagebox_info - the ``storageboxes[].login``, ``storageboxes[].disk_quota``, ``storageboxes[].disk_usage``, ``storageboxes[].disk_usage_data``, ``storageboxes[].disk_usage_snapshot``, ``storageboxes[].webdav``, ``storageboxes[].samba``, ``storageboxes[].ssh``, ``storageboxes[].external_reachability``, and ``storageboxes[].zfs`` return values are deprecated and will be removed from community.routeros. Check out the documentation to find out their new names according to the new API (https://github.com/ansible-collections/community.hrobot/pull/178).
970+
- storagebox_snapshot_info - the ``snapshots[].timestamp``, ``snapshots[].size``, ``snapshots[].filesystem_size``, ``snapshots[].automatic``, and ``snapshots[].comment`` return values are deprecated and will be removed from community.routeros. Check out the documentation to find out their new names according to the new API (https://github.com/ansible-collections/community.hrobot/pull/178).
971+
- storagebox_snapshot_plan - the ``plans[].month`` return value is deprecated, since it only returns ``null`` with the new API and cannot be set to any other value (https://github.com/ansible-collections/community.hrobot/pull/178).
972+
- storagebox_snapshot_plan_info - the ``plans[].month`` return value is deprecated, since it only returns ``null`` with the new API and cannot be set to any other value (https://github.com/ansible-collections/community.hrobot/pull/178).
973+
- storagebox_subaccount - ``password_mode=set-to-random`` is deprecated and will be removed from community.hrobot 3.0.0. Hetzner's new API does not support this anyway, it can only be used with the legacy API (https://github.com/ansible-collections/community.hrobot/pull/183).
974+
- storagebox_subaccount - the ``subaccount.homedirectory``, ``subaccount.samba``, ``subaccount.ssh``, ``subaccount.external_reachability``, ``subaccount.webdav``, ``subaccount.readonly``, ``subaccount.createtime``, and ``subaccount.comment`` return values are deprecated and will be removed from community.routeros. Check out the documentation to find out their new names according to the new API (https://github.com/ansible-collections/community.hrobot/pull/178).
975+
- storagebox_subaccount_info - the ``subaccounts[].accountid``, ``subaccounts[].homedirectory``, ``subaccounts[].samba``, ``subaccounts[].ssh``, ``subaccounts[].external_reachability``, ``subaccounts[].webdav``, ``subaccounts[].readonly``, ``subaccounts[].createtime``, and ``subaccounts[].comment`` return values are deprecated and will be removed from community.routeros. Check out the documentation to find out their new names according to the new API (https://github.com/ansible-collections/community.hrobot/pull/178).
976+
913977
Porting Guide for v12.1.0
914978
=========================
915979

0 commit comments

Comments
 (0)