2025.1 Series Release Notes

8.1.0

New Features

  • Adds a utility CLI module for checking images against the format inspector in oslo_utils.imageutils. After installing oslo.utils, simply run python -m oslo_utils.imageutils -h for full usage for the new CLI helper.

Deprecation Notes

  • Eventlet usages are deprecated and the removal of Eventlet from OpenStack is planned, for this reason the eventletutils module is deprecated. Please start considering removing your internal Eventlet usages and migrating your stack.

  • The exception_to_unicode function from the oslo_utils.encodeutils module has been deprecated. Use str(exc) instead.

8.0.0

New Features

  • The following utility functions have been added to the oslo_utils.secretutils module. These can be used to replace the built-in crypt module which was removed in Python 3.13.

    • crypt_password

    • crypt_mksalt

Upgrade Notes

  • The netutils.is_valid_ipv4 method now enables the strict check by default. To preserve the previous behavior, set the strict argument to False.

7.4.0

New Features

  • The new VersionPredicate class has been added to the versionutils module, which parses version predicate and check if the given version meets the described requirements.

Upgrade Notes

  • Support for Python 3.8 has been removed. Now the minimum python version supported is 3.9 .

Deprecation Notes

  • The oslo_utils.secretutils.constant_time_compare function has been deprecated. Use the compare_digest function from the built-in hmac module.

  • The md5 method from oslo_utils.secretutils module has been deprecated because hashlib.md5 can be used instead in all supported python versions.

7.3.0

New Features

  • The format_inspector module has been imported from the projects that were using it. They had effectively maintained in-tree forks of the original code from glance. This code has been imported (from Nova) into oslo.utils under imageutils for common use. A refactoring of how the safety check works was done to facilitate the ability to surface fine-grained information about individual checks, as needed by some projects, as well as a few other generalizing aspects, which are detailed in the following.

  • A gpt/mbr format inspector was added, which should reduce the number of disk images that are detected as “raw”. This furthers the goal of trying to avoid using “raw” for both “anything we don’t recognize” and “exact image of a physical disk”.

  • The glance-centric InfoWrapper from the imported code has been replaced with InspectWrapper, which natively runs multiple (default: all) inspector classes in parallel. This is identical to what detect_file_format() did, but in a stream-friendly way, and detect_file_format() now uses this internally. Users of the glance-based code moving to the oslo implemenation should switch to using the InspectWrapper going forward.

  • Bug #2073894: Added the netutils.get_noscope_ipv6() function in order to fix errors related to IPv6 address formatting that can happen when using an IPv6 defined with scope.

7.1.0

New Features

  • Introducing a new spec DSL operator called <range-in> that allows users to match a numeric value against a range of numbers that are delimited with lower and upper limits. The new operator is a binary operator that accepts 4 arguments.

    • The first one and the last one are brackets. [ and ] defines inclusive limits while ( and ) defines exclusive limits.

    • The second one is the lower limit while the third one is the upper limit.

    Example: “<range-in> [ 10.4 20 )” will match a value against an range such as the lower limit of the range is 10.4 and the upper limit is 20. Note that 10.4 is included while 20 is excluded.

7.0.0

Upgrade Notes

  • The strict argument has been removed from the is_same_callback function. The argument has had no effect in Python 3.8.

6.2.0

New Features

  • New method netutils.get_my_ipv6() returns the IPv6 address of the local machine.

Other Notes

  • Implement zoneinfo to allow us to remove pytz’s dependency for Python 3.9 and 3.10.

6.0.0

Upgrade Notes

  • The oslo_utils.fnmatch module has been removed. The stdlib fnmatch module is thread safe in Python 3+.

  • The isotime, strtime and iso8601_from_timestamp helpers have been removed from oslo_utils.timeutils. These are all available in the stdlib in Python 3.

4.13.0

Security Issues

  • This patch ensures that we mask sensitive data when masking password, even if double quotes are used as password value.

4.12.1

Bug Fixes

  • Fix regex used to mask password. The strutils.mask_password function will now correctly handle passwords that contain single or double quotes. Previously, only the characters before the quote were masked.

4.11.0

Bug Fixes

  • bug #1942682: Fix inconsistent value of QemuImgInfo.encrypted. Now the attribute is always ‘yes’ or None regardless of the format(human or json) used.

4.10.0

New Features

  • keystoneidsentinel singleton was introduced to generate random keystone-like UUIDs. New sentinel could be used in the same way as existing uuidsentinel.

4.9.1

Deprecation Notes

  • Oslo.utils’s fnmatch module is deprecated, please use the stdlib fnmatch module which is thread safe for python 3+.

  • Support for parsing the human format has been deprecated and will be removed in a future release.

4.8.0

New Features

  • Add a strict flag to netutils.is_valid_ipv4 to allowing users to restrict validation to IP addresses in presentation format (a.b.c.d) as opposed to address format (a.b.c.d, a.b.c, a.b, a).

4.7.0

New Features

  • A wrapper for hashlib.md5() has been added to allow OpenStack to run on systems where FIPS is enabled. Under FIPS, md5 is disabled and calls to hashlib.md5() will fail. In most cases in OpenStack, though, md5 is not used within a security context.

    In https://bugs.python.org/issue9216, a proposal has been made to allow the addition of a keyword parameter usedforsecurity, which can be used to designate non-security context uses. In this case, md5() operations would be permitted. This feature is expected to be delivered in python 3.9.

    Downstream python already supports this option, though. This wrapper simply allows for this option to be supported where the underlying python version supports it.

4.5.0

New Features

  • New method is_json is_yaml added in fileutils. These can be used to check if file is JSON or YAML formatted.

4.4.0

New Features

  • New method netutils.get_mac_addr_by_ipv6(ipv6, dialect) extracts the MAC address from IPv6 addresses generated from MACs.

4.1.0

Bug Fixes

  • qemu 4.1.0 output shifts to scientific notation at 1000mb, breaking oslo.utils. QemuImgInfo is now fixed to support this notation.

4.0.0

Upgrade Notes

  • Support for Python 2.7 has been dropped. The minimum version of Python now supported is Python 3.6.

3.42.1

Security Issues

  • This patch ensures that we mask sensitive data when masking dicts, even if the case doesn’t match. This means the behaviour of mask_password and mask_dict_password is now the same.

  • Additional password names were included from real world logs that contained sensitive information.

3.18.0

Other Notes

  • Introduce reno for deployer release notes.

3.13.0

Bug Fixes

  • Expanded range of allowed ports by adding 0 to valid number.