diff --git a/docs/docsite/rst/porting_guides/porting_guide_12.rst b/docs/docsite/rst/porting_guides/porting_guide_12.rst index 68c3cbf749..e1b53e3c0b 100644 --- a/docs/docsite/rst/porting_guides/porting_guide_12.rst +++ b/docs/docsite/rst/porting_guides/porting_guide_12.rst @@ -23,7 +23,7 @@ These changes enable reporting of numerous problematic behaviors that went undet with wide-ranging positive effects on security, performance, and user experience. Backward compatibility has been preserved where practical, but some breaking changes were necessary. -This guide describes some common problem scenarios with example content, error messsages, and suggested solutions. +This guide describes some common problem scenarios with example content, error messages, and suggested solutions. We recommend you test your playbooks and roles in a staging environment with this release to determine where you may need to make changes. @@ -250,7 +250,7 @@ The environment variable ``_ANSIBLE_TEMPLAR_UNTRUSTED_TEMPLATE_BEHAVIOR`` can be Valid options are: * ``warning`` - A warning will be issued when an untrusted template is encountered. -* ``fail`` - An error will be raised when an untrusted template is encountered. +* ``error`` - An error will be raised when an untrusted template is encountered. * ``ignore`` - Untrusted templates are silently ignored and used as-is. This is the default behavior. .. note:: @@ -910,6 +910,70 @@ Networking No notable changes +Porting Guide for v12.2.0 +========================= + +Known Issues +------------ + +community.sops +^^^^^^^^^^^^^^ + +- 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.) + +Major Changes +------------- + +community.vmware +^^^^^^^^^^^^^^^^ + +- Replace ``ansible.module_utils._text`` (https://github.com/ansible-collections/community.vmware/issues/2497). +- Replace ``ansible.module_utils.common._collections_compat`` (https://github.com/ansible-collections/community.vmware/issues/2497). +- Replace ``ansible.module_utils.six`` (https://github.com/ansible-collections/community.vmware/pull/2495). + +fortinet.fortios +^^^^^^^^^^^^^^^^ + +- Supported default_group feature for the all of the modules. + +grafana.grafana +^^^^^^^^^^^^^^^ + +- Fallback to empty dict in case grafana_ini is undefined by @root-expert in https://github.com/grafana/grafana-ansible-collection/pull/403 +- Fix Mimir config file validation task by @Windos in https://github.com/grafana/grafana-ansible-collection/pull/428 +- Fixes issue by @digiserg in https://github.com/grafana/grafana-ansible-collection/pull/421 +- Import custom dashboards only when directory exists by @mahendrapaipuri in https://github.com/grafana/grafana-ansible-collection/pull/430 +- Restore default listen address and port in Mimir by @56quarters in https://github.com/grafana/grafana-ansible-collection/pull/456 +- Updated YUM repo urls from `packages.grafana.com` to `rpm.grafana.com` by @DejfCold in https://github.com/grafana/grafana-ansible-collection/pull/414 +- Use credentials from grafana_ini when importing dashboards by @root-expert in https://github.com/grafana/grafana-ansible-collection/pull/402 +- do not skip scrape latest github version even in check_mode by @cmehat in https://github.com/grafana/grafana-ansible-collection/pull/408 +- fix broken Grafana apt repository addition by @kleini in https://github.com/grafana/grafana-ansible-collection/pull/454 +- fix datasource documentation by @jeremad in https://github.com/grafana/grafana-ansible-collection/pull/437 +- fix mimir_download_url_deb & mimir_download_url_rpm by @germebl in https://github.com/grafana/grafana-ansible-collection/pull/400 +- update catalog info by @Duologic in https://github.com/grafana/grafana-ansible-collection/pull/434 +- use deb822 for newer debian versions by @Lukas-Heindl in https://github.com/grafana/grafana-ansible-collection/pull/440 + +Deprecated Features +------------------- + +- The ``community.digitalocean`` collection has been deprecated. + It will be removed from Ansible 13 if no one starts maintaining it again before Ansible 13. + See `Collections Removal Process for unmaintained collections `__ for more details (`https://forum.ansible.com/t/44602 `__). + +community.hrobot +^^^^^^^^^^^^^^^^ + +- 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). +- 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). +- 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). +- 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). +- 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). +- 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). +- 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). +- 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). +- 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). +- 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). + Porting Guide for v12.1.0 =========================