From eb27c2b3bac49c7fbf0f867a434c747bff30f4df Mon Sep 17 00:00:00 2001
From: Sven Kieske <kieske@osism.tech>
Date: Tue, 5 Mar 2024 11:26:31 +0100
Subject: [PATCH] [doc] document --limit limitations
there are currently known bugs in our interaction with the ansible
--limit option. document those and recommend not to use this like it
was agreed in the kolla meeting:
https://meetings.opendev.org/meetings/kolla/2024/kolla.2024-02-21-14.00.log.txt
Signed-off-by: Sven Kieske <kieske@osism.tech>
Change-Id: Iaeaa8c667ce7cd677b2b3dc2096ef4e52c1f651f
---
doc/source/user/operating-kolla.rst | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/doc/source/user/operating-kolla.rst b/doc/source/user/operating-kolla.rst
index 5e1846e5f9..889d54b613 100644
--- a/doc/source/user/operating-kolla.rst
+++ b/doc/source/user/operating-kolla.rst
@@ -56,6 +56,16 @@ deployment.
Limitations and Recommendations
-------------------------------
+.. warning::
+
+ Please notice that using the ansible ``--limit`` option is not recommended.
+ The reason is, that there are known bugs with it, e.g. when `upgrading parts of nova.
+ <https://bugs.launchpad.net/kolla-ansible/+bug/2054348>`__
+ We accept bug reports for this and try to fix issues when they are known.
+ The core problem is how the ``register:`` keyword works and how it
+ interacts with the ``--limit`` option. You can find more information in the above
+ bug report.
+
.. note::
Please note that when the ``use_preconfigured_databases`` flag is set to