Update documentation (Strimzi CI build )

Signed-off-by: Strimzi CI <[email protected]>
strimzi · Nov 25, 2023 · 491c34d · 491c34d
1 parent 51d502c
commit 491c34d
Show file tree

Hide file tree

Showing 8 changed files with 67 additions and 13 deletions.
diff --git a/contributing/guide/contributing.html b/contributing/guide/contributing.html
@@ -1516,7 +1516,7 @@ <h3 id="access_another_writers_unmerged_commits"><a class="link" href="#access_a
 </ol>
 </div>
 <div class="paragraph">
-<p><em>Revised on 2023-11-24 12:45:18 UTC</em></p>
+<p><em>Revised on 2023-11-25 14:51:51 UTC</em></p>
 </div>
 </div>
 </div>

diff --git a/contributing/guide/full.html b/contributing/guide/full.html
@@ -1957,15 +1957,15 @@ <h3 id="access_another_writers_unmerged_commits"><a class="link" href="#access_a
 </ol>
 </div>
 <div class="paragraph">
-<p><em>Revised on 2023-11-24 12:45:16 UTC</em></p>
+<p><em>Revised on 2023-11-25 14:51:49 UTC</em></p>
 </div>
 </div>
 </div>
 </div>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2023-11-24 12:44:50 UTC
+Last updated 2023-11-25 14:51:19 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/operators/in-development/contributing-book.html b/docs/operators/in-development/contributing-book.html
@@ -1516,7 +1516,7 @@ <h3 id="access_another_writers_unmerged_commits"><a class="link" href="#access_a
 </ol>
 </div>
 <div class="paragraph">
-<p><em>Revised on 2023-11-24 12:45:18 UTC</em></p>
+<p><em>Revised on 2023-11-25 14:51:51 UTC</em></p>
 </div>
 </div>
 </div>

diff --git a/docs/operators/in-development/deploying-book.html b/docs/operators/in-development/deploying-book.html
@@ -243,7 +243,8 @@
 <li><a href="#con-deleting-managed-topics-str">10.8. (Preview) Deleting managed topics</a></li>
 <li><a href="#proc-changing-topic-operator-mode-str">10.9. Switching between Topic Operator modes</a></li>
 <li><a href="#con-removing-topic-finalizers-str">10.10. (Preview) Removing finalizers on topics</a></li>
-<li><a href="#con-tuning-topic-request-batches-str">10.11. (Preview) Tuning request batches for topic operations</a></li>
+<li><a href="#con-disabling-topic-deletion-str">10.11. Considerations when disabling topic deletion</a></li>
+<li><a href="#con-tuning-topic-request-batches-str">10.12. (Preview) Tuning request batches for topic operations</a></li>
 </ul>
 </li>
 <li><a href="#assembly-using-the-user-operator-str">11. Using the User Operator to manage Kafka users</a>
@@ -15560,7 +15561,33 @@ <h3 id="con-removing-topic-finalizers-str"><a class="link" href="#con-removing-t
 </div>
 </div>
 <div class="sect2">
-<h3 id="con-tuning-topic-request-batches-str"><a class="link" href="#con-tuning-topic-request-batches-str">10.11. (Preview) Tuning request batches for topic operations</a></h3>
+<h3 id="con-disabling-topic-deletion-str"><a class="link" href="#con-disabling-topic-deletion-str">10.11. Considerations when disabling topic deletion</a></h3>
+<div class="paragraph _abstract">
+<p>When the <code>delete.topic.enable</code> configuration in Kafka is set to <code>false</code>, topics cannot be deleted.
+This might be required in certain scenarios, but it introduces a consideration when using the Topic Operator in unidirectional mode.</p>
+</div>
+<div class="paragraph">
+<p>As topics cannot be deleted, finalizers added to the metadata of a <code>KafkaTopic</code> resource to control topic deletion are never removed by the Topic Operator (though they can be <a href="#con-removing-topic-finalizers-str">removed manually</a>).
+Similarly, any Custom Resource Definitions (CRDs) or namespaces associated with topics cannot be deleted.</p>
+</div>
+<div class="paragraph">
+<p>Before configuring <code>delete.topic.enable=false</code>, assess these implications to ensure it aligns with your specific requirements.</p>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">
+To avoid using finalizers, you can set the <code>STRIMZI_USE_FINALIZERS</code> Topic Operator environment variable to <code>false</code>.
+</td>
+</tr>
+</table>
+</div>
+</div>
+<div class="sect2">
+<h3 id="con-tuning-topic-request-batches-str"><a class="link" href="#con-tuning-topic-request-batches-str">10.12. (Preview) Tuning request batches for topic operations</a></h3>
 <div class="paragraph">
 <p>In unidirectional mode, the Topic Operator uses the request batching capabilities of the Kafka Admin API for operations on topic resources.
 You can fine-tune the batching mechanism using the following operator configuration properties:</p>

diff --git a/docs/operators/in-development/full/configuring.html b/docs/operators/in-development/full/configuring.html
@@ -17662,7 +17662,7 @@ <h2 id="type-StrimziPodSetStatus-reference"><a class="link" href="#type-StrimziP
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2023-11-24 12:44:50 UTC
+Last updated 2023-11-25 14:51:19 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/operators/in-development/full/contributing.html b/docs/operators/in-development/full/contributing.html
@@ -1957,15 +1957,15 @@ <h3 id="access_another_writers_unmerged_commits"><a class="link" href="#access_a
 </ol>
 </div>
 <div class="paragraph">
-<p><em>Revised on 2023-11-24 12:45:16 UTC</em></p>
+<p><em>Revised on 2023-11-25 14:51:49 UTC</em></p>
 </div>
 </div>
 </div>
 </div>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2023-11-24 12:44:50 UTC
+Last updated 2023-11-25 14:51:19 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/operators/in-development/full/deploying.html b/docs/operators/in-development/full/deploying.html
@@ -682,7 +682,8 @@ <h1>Deploying and Managing Strimzi</h1>
 <li><a href="#con-deleting-managed-topics-str">10.8. (Preview) Deleting managed topics</a></li>
 <li><a href="#proc-changing-topic-operator-mode-str">10.9. Switching between Topic Operator modes</a></li>
 <li><a href="#con-removing-topic-finalizers-str">10.10. (Preview) Removing finalizers on topics</a></li>
-<li><a href="#con-tuning-topic-request-batches-str">10.11. (Preview) Tuning request batches for topic operations</a></li>
+<li><a href="#con-disabling-topic-deletion-str">10.11. Considerations when disabling topic deletion</a></li>
+<li><a href="#con-tuning-topic-request-batches-str">10.12. (Preview) Tuning request batches for topic operations</a></li>
 </ul>
 </li>
 <li><a href="#assembly-using-the-user-operator-str">11. Using the User Operator to manage Kafka users</a>
@@ -16001,7 +16002,33 @@ <h3 id="con-removing-topic-finalizers-str"><a class="link" href="#con-removing-t
 </div>
 </div>
 <div class="sect2">
-<h3 id="con-tuning-topic-request-batches-str"><a class="link" href="#con-tuning-topic-request-batches-str">10.11. (Preview) Tuning request batches for topic operations</a></h3>
+<h3 id="con-disabling-topic-deletion-str"><a class="link" href="#con-disabling-topic-deletion-str">10.11. Considerations when disabling topic deletion</a></h3>
+<div class="paragraph _abstract">
+<p>When the <code>delete.topic.enable</code> configuration in Kafka is set to <code>false</code>, topics cannot be deleted.
+This might be required in certain scenarios, but it introduces a consideration when using the Topic Operator in unidirectional mode.</p>
+</div>
+<div class="paragraph">
+<p>As topics cannot be deleted, finalizers added to the metadata of a <code>KafkaTopic</code> resource to control topic deletion are never removed by the Topic Operator (though they can be <a href="#con-removing-topic-finalizers-str">removed manually</a>).
+Similarly, any Custom Resource Definitions (CRDs) or namespaces associated with topics cannot be deleted.</p>
+</div>
+<div class="paragraph">
+<p>Before configuring <code>delete.topic.enable=false</code>, assess these implications to ensure it aligns with your specific requirements.</p>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">
+To avoid using finalizers, you can set the <code>STRIMZI_USE_FINALIZERS</code> Topic Operator environment variable to <code>false</code>.
+</td>
+</tr>
+</table>
+</div>
+</div>
+<div class="sect2">
+<h3 id="con-tuning-topic-request-batches-str"><a class="link" href="#con-tuning-topic-request-batches-str">10.12. (Preview) Tuning request batches for topic operations</a></h3>
 <div class="paragraph">
 <p>In unidirectional mode, the Topic Operator uses the request batching capabilities of the Kafka Admin API for operations on topic resources.
 You can fine-tune the batching mechanism using the following operator configuration properties:</p>
@@ -37569,7 +37596,7 @@ <h5 id="why_is_hostname_verification_failing_when_connecting_to_nodeports_using_
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2023-11-24 12:44:50 UTC
+Last updated 2023-11-25 14:51:19 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/operators/in-development/full/overview.html b/docs/operators/in-development/full/overview.html
@@ -2826,7 +2826,7 @@ <h3 id="metrics-overview-cruisecontrol_str"><a class="link" href="#metrics-overv
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2023-11-24 12:44:50 UTC
+Last updated 2023-11-25 14:51:19 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>
-Original file line number
+Diff line change
@@ Expand Up @@
     </ol>
     </div>
     <div class="paragraph">
-    <p><em>Revised on 2023-11-24 12:45:18 UTC</em></p>
+    <p><em>Revised on 2023-11-25 14:51:51 UTC</em></p>
     </div>
     </div>
     </div>
@@ Expand Down @@