Skip to content

Commit 23dbead

Browse files
patchback[bot]ansible-documentation-bot[bot]felixfontein
authored
Add the Ansible community 12.1.0 porting guide (#3109) (#3111)
(cherry picked from commit 8adb65b) Co-authored-by: ansible-documentation-bot[bot] <147556122+ansible-documentation-bot[bot]@users.noreply.github.com> Co-authored-by: Felix Fontein <[email protected]>
1 parent 307f086 commit 23dbead

File tree

1 file changed

+120
-1
lines changed

1 file changed

+120
-1
lines changed

docs/docsite/rst/porting_guides/porting_guide_12.rst

Lines changed: 120 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -403,6 +403,41 @@ The result of the corrected template remains a list:
403403
}
404404
405405
406+
Example - unintentional ``None`` result
407+
"""""""""""""""""""""""""""""""""""""""
408+
409+
If a template evaluated to ``None``, it was implicitly converted to an empty string in previous versions of ansible-core.
410+
This can now result in the template evaluating to the *value* ``None``.
411+
412+
The following example shows a case where this happens:
413+
414+
.. code-block:: yaml+jinja
415+
416+
- set_fact:
417+
# If 'foo' is not defined, the else branch basically evaluates to None.
418+
# So value_none will not be an empty string, but None:
419+
value_none: |-
420+
{% if foo is defined %}foo is defined{% endif %}
421+
422+
This example can be fixed as follows:
423+
424+
.. code-block:: yaml+jinja
425+
426+
- set_fact:
427+
# Explicitly return an empty string in the 'else' branch.
428+
# The value is always a string: either "foo is defined" or "".
429+
value_none: |-
430+
{% if foo is defined %}foo is defined{% else %}{{ "" }}{% endif %}
431+
432+
This adjustment is backward-compatible with older ansible-core versions.
433+
434+
.. note::
435+
Since ansible-core 2.19.1, module options of type string accept ``None`` and convert it
436+
to an empty string. Before ansible-core 2.18, passing ``None`` to such options resulted
437+
in an error. This means that in most cases, expressions in roles and playbooks do not need
438+
to be adjusted because of unintentional ``None`` results.
439+
440+
406441
Lazy templating
407442
^^^^^^^^^^^^^^^
408443

@@ -875,6 +910,65 @@ Networking
875910

876911
No notable changes
877912

913+
Porting Guide for v12.1.0
914+
=========================
915+
916+
Added Collections
917+
-----------------
918+
919+
- hitachivantara.vspone_object (version 1.0.0)
920+
- ravendb.ravendb (version 1.0.3)
921+
922+
Major Changes
923+
-------------
924+
925+
containers.podman
926+
^^^^^^^^^^^^^^^^^
927+
928+
- Add inventory plugins for buildah and podman
929+
- Add podman system connection modules
930+
931+
fortinet.fortios
932+
^^^^^^^^^^^^^^^^
933+
934+
- Supported new versions 7.6.3 and 7.6.4.
935+
- Supported the authentication method when using username and password in v7.6.4.
936+
937+
grafana.grafana
938+
^^^^^^^^^^^^^^^
939+
940+
- Add SUSE support to Alloy role by @pozsa in https://github.com/grafana/grafana-ansible-collection/pull/423
941+
- Fixes to foldersFromFilesStructure option by @root-expert in https://github.com/grafana/grafana-ansible-collection/pull/351
942+
- Migrate RedHat install to ansible.builtin.package by @r65535 in https://github.com/grafana/grafana-ansible-collection/pull/431
943+
- add macOS support to alloy role by @l50 in https://github.com/grafana/grafana-ansible-collection/pull/418
944+
- replace None with [] for safe length checks by @voidquark in https://github.com/grafana/grafana-ansible-collection/pull/426
945+
946+
Deprecated Features
947+
-------------------
948+
949+
community.general
950+
^^^^^^^^^^^^^^^^^
951+
952+
- hiera lookup plugin - retrieving data with Hiera has been deprecated a long time ago; because of that this plugin will be removed from community.general 13.0.0. If you disagree with this deprecation, please create an issue in the community.general repository (https://github.com/ansible-collections/community.general/issues/4462, https://github.com/ansible-collections/community.general/pull/10779).
953+
- oci_utils module utils - utils is deprecated and will be removed in community.general 13.0.0 (https://github.com/ansible-collections/community.general/issues/10318, https://github.com/ansible-collections/community.general/pull/10652).
954+
- oci_vcn - module is deprecated and will be removed in community.general 13.0.0 (https://github.com/ansible-collections/community.general/issues/10318, https://github.com/ansible-collections/community.general/pull/10652).
955+
- oracle* doc fragments - fragments are deprecated and will be removed in community.general 13.0.0 (https://github.com/ansible-collections/community.general/issues/10318, https://github.com/ansible-collections/community.general/pull/10652).
956+
957+
community.zabbix
958+
^^^^^^^^^^^^^^^^
959+
960+
- zabbix_maintenance module - Depreicated `minutes` argument for `time_periods`
961+
962+
hetzner.hcloud
963+
^^^^^^^^^^^^^^
964+
965+
- server_type_info - Deprecate Server Type ``deprecation`` property.
966+
967+
purestorage.flasharray
968+
^^^^^^^^^^^^^^^^^^^^^^
969+
970+
- purefa_volume_tags - Deprecated due to removal of REST 1.x support. Will be removed in Collection 2.0.0
971+
878972
Porting Guide for v12.0.0
879973
=========================
880974

@@ -1235,10 +1329,17 @@ google.cloud
12351329
grafana.grafana
12361330
^^^^^^^^^^^^^^^
12371331

1238-
- Ability to set custom directory path for *.alloy config files by @voidquark in https://github.com/grafana/grafana-ansible-collection/pull/294
1332+
- Ability to set custom directory path for \*.alloy config files by @voidquark in https://github.com/grafana/grafana-ansible-collection/pull/294
12391333
- Add delete protection by @KucicM in https://github.com/grafana/grafana-ansible-collection/pull/381
1334+
- Add foldersFromFilesStructure option by @root-expert in https://github.com/grafana/grafana-ansible-collection/pull/326
12401335
- Add tempo role by @CSTDev in https://github.com/grafana/grafana-ansible-collection/pull/323
1336+
- Add tests and support version latest by @pieterlexis-tomtom in https://github.com/grafana/grafana-ansible-collection/pull/299
1337+
- Bump ansible-lint from 24.9.2 to 25.6.1 by @dependabot[bot] in https://github.com/grafana/grafana-ansible-collection/pull/391
1338+
- Bump brace-expansion from 1.1.11 to 1.1.12 in the npm_and_yarn group across 1 directory by @dependabot[bot] in https://github.com/grafana/grafana-ansible-collection/pull/396
1339+
- Changes for issue
12411340
- Do not log grafana.ini contents when setting facts by @root-expert in https://github.com/grafana/grafana-ansible-collection/pull/325
1341+
- Don't override defaults by @56quarters in https://github.com/grafana/grafana-ansible-collection/pull/382
1342+
- Don't use a proxy when doing Alloy readiness check by @benoitc-croesus in https://github.com/grafana/grafana-ansible-collection/pull/375
12421343
- Fix 'dict object' has no attribute 'path' when running with --check by @JMLX42 in https://github.com/grafana/grafana-ansible-collection/pull/283
12431344
- Fix Mimir URL verify task by @parcimonic in https://github.com/grafana/grafana-ansible-collection/pull/358
12441345
- Fix loki_operational_config section not getting rendered in config.yml by @olegkaspersky in https://github.com/grafana/grafana-ansible-collection/pull/330
@@ -1248,15 +1349,33 @@ grafana.grafana
12481349
- Fix the markdown code fences for install command by @benmatselby in https://github.com/grafana/grafana-ansible-collection/pull/306
12491350
- Grafana fix facts in main.yml by @voidquark in https://github.com/grafana/grafana-ansible-collection/pull/315
12501351
- Make dashboard imports more flexible by @torfbolt in https://github.com/grafana/grafana-ansible-collection/pull/308
1352+
- Make systemd create /var/lib/otel-collector by @pieterlexis-tomtom in https://github.com/grafana/grafana-ansible-collection/pull/336
1353+
- Update Mimir README.md by @Gufderald in https://github.com/grafana/grafana-ansible-collection/pull/397
12511354
- Update grafana template by @santilococo in https://github.com/grafana/grafana-ansible-collection/pull/300
12521355
- Update when statement to test for dashboard files found by @hal58th in https://github.com/grafana/grafana-ansible-collection/pull/363
12531356
- Use become false in find task by @santilococo in https://github.com/grafana/grafana-ansible-collection/pull/368
1357+
- Validate config by @pieterlexis-tomtom in https://github.com/grafana/grafana-ansible-collection/pull/327
1358+
- add catalog-info file for internal dev catalog by @theSuess in https://github.com/grafana/grafana-ansible-collection/pull/317
12541359
- add loki bloom support by @voidquark in https://github.com/grafana/grafana-ansible-collection/pull/298
1360+
- add publish step to GitHub Actions workflow for Ansible Galaxy by @thelooter in https://github.com/grafana/grafana-ansible-collection/pull/340
1361+
- add user module to create/update/delete grafana users by @mvalois in https://github.com/grafana/grafana-ansible-collection/pull/178
12551362
- alloy_readiness_check_use_https by @piotr-g in https://github.com/grafana/grafana-ansible-collection/pull/359
1363+
- declare collection dependencies by @ishanjainn in https://github.com/grafana/grafana-ansible-collection/pull/390
1364+
- declare collection dependencies by @kleini in https://github.com/grafana/grafana-ansible-collection/pull/386
1365+
- declare collection dependencies by @kleini in https://github.com/grafana/grafana-ansible-collection/pull/392
1366+
- ensure IP assert returns boolean result by @aardbol in https://github.com/grafana/grafana-ansible-collection/pull/398
1367+
- ensure alerting provisioning directory exists by @derhuerst in https://github.com/grafana/grafana-ansible-collection/pull/364
12561368
- force temporary directory even in check mode for dashboards.yml by @cmehat in https://github.com/grafana/grafana-ansible-collection/pull/339
12571369
- grafana.ini yaml syntax by @intermittentnrg in https://github.com/grafana/grafana-ansible-collection/pull/232
1370+
- improve mimir/alloy examples playbook by @smCloudInTheSky in https://github.com/grafana/grafana-ansible-collection/pull/369
12581371
- integrate sles legacy init-script support by @floerica in https://github.com/grafana/grafana-ansible-collection/pull/184
12591372
- management of the config.river with the conversion of the config.yaml by @lbrule in https://github.com/grafana/grafana-ansible-collection/pull/149
1373+
- mark configuration deployment task with `no_log` by @kkantonop in https://github.com/grafana/grafana-ansible-collection/pull/380
1374+
- properly validate config by @pieterlexis-tomtom in https://github.com/grafana/grafana-ansible-collection/pull/354
1375+
- store APT key with .asc extension by @derhuerst in https://github.com/grafana/grafana-ansible-collection/pull/394
1376+
- template ingester and querier section by @Gufderald in https://github.com/grafana/grafana-ansible-collection/pull/371
1377+
- use ansible_facts instead of ansible_* variables by @kleini in https://github.com/grafana/grafana-ansible-collection/pull/296
1378+
- use ansible_facts instead of variables by @kleini in https://github.com/grafana/grafana-ansible-collection/pull/365
12601379

12611380
junipernetworks.junos
12621381
^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)