From 2d7ce45351d57ecb3ebc2192ae72e6d5a598e382 Mon Sep 17 00:00:00 2001
From: Will Szumski <will@stackhpc.com>
Date: Thu, 7 Nov 2024 16:26:40 +0000
Subject: [PATCH] Mention change of default in release note
TrivialFix
Change-Id: Ia56d98d5ad335de7b32261aa3617aee4780a1e70
---
...pect-comment-for-keep-ports-e0b1ab73395055a6.yaml | 12 +++++++++---
1 file changed, 9 insertions(+), 3 deletions(-)
diff --git a/releasenotes/notes/respect-comment-for-keep-ports-e0b1ab73395055a6.yaml b/releasenotes/notes/respect-comment-for-keep-ports-e0b1ab73395055a6.yaml
index 0d6bbdbc..b502fca2 100644
--- a/releasenotes/notes/respect-comment-for-keep-ports-e0b1ab73395055a6.yaml
+++ b/releasenotes/notes/respect-comment-for-keep-ports-e0b1ab73395055a6.yaml
@@ -1,11 +1,17 @@
---
upgrade:
- |
- If you have customized ``inspector_keep_ports``, ensure it is set to one of:
- ``all``, ``present``, ``added``.
+ If you have customized ``inspector_keep_ports``, ensure it is set to one
+ of: ``all``, ``present``, or ``added``. Prior to this release, setting
+ ``inspector_keep_ports`` to any truthy value would result in the
+ ``keep_ports`` Ironic Inspector configuration option being set to
+ ``present``. As the default value of ``inspector_keep_ports`` is ``added``,
+ we are effectively changing the default value of ``keep_ports`` from
+ ``present`` to ``added``. If you are relying on the previous behaviour
+ you should set ``ironic_keep_ports`` to ``present``.
fixes:
- |
``inspector_keep_ports`` can be set to one of: ``all``, ``present``,
``added``. The previous behavior was to set this to ``present`` if the
- variable was changed to any non-None value. This respects the behavior
+ variable was changed to any truthy value. This respects the behavior
indicated in the comments.
--
GitLab