From 47e9ad74c047dbf101a70689490b0dcd20e54da7 Mon Sep 17 00:00:00 2001 From: James Falcon Date: Fri, 19 Apr 2024 09:23:34 -0500 Subject: [PATCH] docs: Add breaking datasource identification changes (#5171) --- doc/rtd/reference/breaking_changes.rst | 24 ++++++++++++++++++++++++ doc/rtd/spelling_word_list.txt | 1 + 2 files changed, 25 insertions(+) diff --git a/doc/rtd/reference/breaking_changes.rst b/doc/rtd/reference/breaking_changes.rst index fa75554e342..9449a9fa95d 100644 --- a/doc/rtd/reference/breaking_changes.rst +++ b/doc/rtd/reference/breaking_changes.rst @@ -6,6 +6,30 @@ Breaking changes This section provides guidance on specific breaking changes to cloud-init releases. +.. note:: + These changes may not be present in all distributions of cloud-init as + many operating system vendors patch out breaking changes in + cloud-init to ensure consistent behavior on their platform. + +23.2-24.1 - Datasource identification +===================================== + +**23.2** + If the detected ``datasource_list`` contains a single datasource or + that datasource plus ``None``, automatically use that datasource without + checking to see if it is available. This allows for using datasources that + don't have a way to be deterministically detected. +**23.4** + If the detected ``datasource_list`` contains a single datasource plus + ``None``, no longer automatically use that datasource because ``None`` is + a valid datasource that may be used if the primary datasource is + not available. +**24.1** + ds-identify no longer automatically appends ``None`` to a + datasource list with a single entry provided under ``/etc/cloud``. + If ``None`` is desired as a fallback, it must be explicitly added to the + customized datasource list. + 24.1 - removed Ubuntu's ordering dependency on snapd.seeded =========================================================== diff --git a/doc/rtd/spelling_word_list.txt b/doc/rtd/spelling_word_list.txt index 83c824b8347..c38daee28a2 100644 --- a/doc/rtd/spelling_word_list.txt +++ b/doc/rtd/spelling_word_list.txt @@ -61,6 +61,7 @@ dotnet downstreams dpkg dropbearssh +ds dsa dsmode dsname