Skip to content

Commit 82545c8

Browse files
author
Strimzi CI
committed
Update documentation (Strimzi CI build )
Signed-off-by: Strimzi CI <ci@strimzi.io>
1 parent fc3a4d9 commit 82545c8

File tree

10 files changed

+1633
-1633
lines changed

10 files changed

+1633
-1633
lines changed

contributing/guide/contributing.html

Lines changed: 44 additions & 44 deletions
Large diffs are not rendered by default.

contributing/guide/full.html

Lines changed: 45 additions & 45 deletions
Large diffs are not rendered by default.

docs/operators/in-development/configuring-book.html

Lines changed: 250 additions & 250 deletions
Large diffs are not rendered by default.

docs/operators/in-development/contributing-book.html

Lines changed: 44 additions & 44 deletions
Large diffs are not rendered by default.

docs/operators/in-development/deploying-book.html

Lines changed: 446 additions & 446 deletions
Large diffs are not rendered by default.

docs/operators/in-development/full/configuring.html

Lines changed: 251 additions & 251 deletions
Large diffs are not rendered by default.

docs/operators/in-development/full/contributing.html

Lines changed: 45 additions & 45 deletions
Large diffs are not rendered by default.

docs/operators/in-development/full/deploying.html

Lines changed: 447 additions & 447 deletions
Large diffs are not rendered by default.

docs/operators/in-development/full/overview.html

Lines changed: 31 additions & 31 deletions
Large diffs are not rendered by default.

docs/operators/in-development/overview-book.html

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
</ul>
5656
</div>
5757
<div class="sect1">
58-
<h2 id="key-features_str">1. Key features</h2>
58+
<h2 id="key-features_str"><a class="link" href="#key-features_str">1. Key features</a></h2>
5959
<div class="sectionbody">
6060
<div class="paragraph _abstract">
6161
<p>Strimzi simplifies the process of running <a href="https://kafka.apache.org/" target="_blank" rel="noopener">Apache Kafka</a> within a Kubernetes cluster.</p>
@@ -66,7 +66,7 @@ <h2 id="key-features_str">1. Key features</h2>
6666
Strimzi provides the necessary files to deploy and manage a Kafka cluster, along with <a href="./deploying.html#config-examples-str" target="_blank" rel="noopener">example configuration files</a> for monitoring your deployment.</p>
6767
</div>
6868
<div class="sect2">
69-
<h3 id="kafka_capabilities">1.1. Kafka capabilities</h3>
69+
<h3 id="kafka_capabilities"><a class="link" href="#kafka_capabilities">1.1. Kafka capabilities</a></h3>
7070
<div class="paragraph">
7171
<p>Kafka&#8217;s data stream-processing capabilities and component architecture offer:</p>
7272
</div>
@@ -97,7 +97,7 @@ <h3 id="kafka_capabilities">1.1. Kafka capabilities</h3>
9797
</div>
9898
</div>
9999
<div class="sect2">
100-
<h3 id="kafka_use_cases">1.2. Kafka use cases</h3>
100+
<h3 id="kafka_use_cases"><a class="link" href="#kafka_use_cases">1.2. Kafka use cases</a></h3>
101101
<div class="paragraph">
102102
<p>Kafka&#8217;s capabilities make it ideal for:</p>
103103
</div>
@@ -131,7 +131,7 @@ <h3 id="kafka_use_cases">1.2. Kafka use cases</h3>
131131
</div>
132132
</div>
133133
<div class="sect2">
134-
<h3 id="how_strimzi_supports_kafka">1.3. How Strimzi supports Kafka</h3>
134+
<h3 id="how_strimzi_supports_kafka"><a class="link" href="#how_strimzi_supports_kafka">1.3. How Strimzi supports Kafka</a></h3>
135135
<div class="paragraph">
136136
<p>Strimzi provides container images and operators for running Kafka on Kubernetes.
137137
These operators are designed with specialized operational knowledge to efficiently manage Kafka on Kubernetes.</p>
@@ -174,7 +174,7 @@ <h3 id="how_strimzi_supports_kafka">1.3. How Strimzi supports Kafka</h3>
174174
</div>
175175
</div>
176176
<div class="sect1">
177-
<h2 id="overview-components_str">2. Strimzi operators</h2>
177+
<h2 id="overview-components_str"><a class="link" href="#overview-components_str">2. Strimzi operators</a></h2>
178178
<div class="sectionbody">
179179
<div class="paragraph _abstract">
180180
<p>Operators are Kubernetes components that package, deploy, and manage applications by extending the Kubernetes API.
@@ -231,7 +231,7 @@ <h2 id="overview-components_str">2. Strimzi operators</h2>
231231
<p><span class="image"><img src="images/operators.png" alt="Operators within the Strimzi architecture"></span></p>
232232
</div>
233233
<div class="sect2">
234-
<h3 id="overview-components-cluster-operator-str">2.1. Cluster Operator</h3>
234+
<h3 id="overview-components-cluster-operator-str"><a class="link" href="#overview-components-cluster-operator-str">2.1. Cluster Operator</a></h3>
235235
<div class="paragraph _abstract">
236236
<p>Strimzi uses the Cluster Operator to deploy and manage clusters.
237237
By default, when you deploy Strimzi a single Cluster Operator replica is deployed.
@@ -294,7 +294,7 @@ <h3 id="overview-components-cluster-operator-str">2.1. Cluster Operator</h3>
294294
</div>
295295
</div>
296296
<div class="sect2">
297-
<h3 id="overview-concepts-topic-operator-str">2.2. Topic Operator</h3>
297+
<h3 id="overview-concepts-topic-operator-str"><a class="link" href="#overview-concepts-topic-operator-str">2.2. Topic Operator</a></h3>
298298
<div class="paragraph _abstract">
299299
<p>The Topic Operator provides a way of managing topics in a Kafka cluster through <code>KafkaTopic</code> resources.
300300
The Cluster Operator can deploy the Topic Operator as part of the <strong>Entity Operator</strong> configuration at the same time as a Kafka cluster.
@@ -315,7 +315,7 @@ <h3 id="overview-concepts-topic-operator-str">2.2. Topic Operator</h3>
315315
</div>
316316
</div>
317317
<div class="sect2">
318-
<h3 id="overview-concepts-user-operator-str">2.3. User Operator</h3>
318+
<h3 id="overview-concepts-user-operator-str"><a class="link" href="#overview-concepts-user-operator-str">2.3. User Operator</a></h3>
319319
<div class="paragraph _abstract">
320320
<p>The User Operator provides a way of managing users in a Kafka cluster through <code>KafkaUser</code> resources.
321321
The Cluster Operator can deploy the User Operator as part of the <strong>Entity Operator</strong> configuration at the same time as a Kafka cluster.
@@ -342,7 +342,7 @@ <h3 id="overview-concepts-user-operator-str">2.3. User Operator</h3>
342342
</div>
343343
</div>
344344
<div class="sect2">
345-
<h3 id="overview-concepts-drain-cleaner-str">2.4. Drain Cleaner</h3>
345+
<h3 id="overview-concepts-drain-cleaner-str"><a class="link" href="#overview-concepts-drain-cleaner-str">2.4. Drain Cleaner</a></h3>
346346
<div class="paragraph _abstract">
347347
<p>If you are using the Cluster Operator to manage your Kafka cluster, you can deploy and use the Drain Cleaner to streamline the process of moving Kafka pods from Kubernetes nodes scheduled for maintenance.</p>
348348
</div>
@@ -357,7 +357,7 @@ <h3 id="overview-concepts-drain-cleaner-str">2.4. Drain Cleaner</h3>
357357
</div>
358358
</div>
359359
<div class="sect2">
360-
<h3 id="con-feature-gates-overview-str">2.5. Feature gates in Strimzi Operators</h3>
360+
<h3 id="con-feature-gates-overview-str"><a class="link" href="#con-feature-gates-overview-str">2.5. Feature gates in Strimzi Operators</a></h3>
361361
<div class="paragraph">
362362
<p>Strimzi operators use feature gates to enable or disable specific features and functions. Enabling a feature gate alters the behavior of the associated operator, introducing the corresponding feature to your Strimzi deployment.</p>
363363
</div>
@@ -372,7 +372,7 @@ <h3 id="con-feature-gates-overview-str">2.5. Feature gates in Strimzi Operators<
372372
</div>
373373
</div>
374374
<div class="sect1">
375-
<h2 id="kafka-components_str">3. Strimzi deployment of Kafka</h2>
375+
<h2 id="kafka-components_str"><a class="link" href="#kafka-components_str">3. Strimzi deployment of Kafka</a></h2>
376376
<div class="sectionbody">
377377
<div class="paragraph">
378378
<p>Strimzi enables the deployment of Apache Kafka components to a Kubernetes cluster, typically running as clusters for high availability.</p>
@@ -408,7 +408,7 @@ <h2 id="kafka-components_str">3. Strimzi deployment of Kafka</h2>
408408
These components can also be used with Kafka clusters that are not managed by Strimzi.</p>
409409
</div>
410410
<div class="sect2">
411-
<h3 id="kafka-deploy-options-str">3.1. Deployment options</h3>
411+
<h3 id="kafka-deploy-options-str"><a class="link" href="#kafka-deploy-options-str">3.1. Deployment options</a></h3>
412412
<div class="paragraph _abstract">
413413
<p>Strimzi can be deployed on Kubernetes using a method that aligns with how you configure and manage your clusters.</p>
414414
</div>
@@ -434,7 +434,7 @@ <h3 id="kafka-deploy-options-str">3.1. Deployment options</h3>
434434
</div>
435435
</div>
436436
<div class="sect2">
437-
<h3 id="kafka-concepts-node-pools-str">3.2. Node pools</h3>
437+
<h3 id="kafka-concepts-node-pools-str"><a class="link" href="#kafka-concepts-node-pools-str">3.2. Node pools</a></h3>
438438
<div class="paragraph _abstract">
439439
<p>A Kafka cluster consists of nodes assigned KRaft roles.
440440
These roles can be <em>brokers</em>, responsible for message streaming and storage, or <em>controllers</em>, which manage cluster state and metadata.
@@ -475,7 +475,7 @@ <h3 id="kafka-concepts-node-pools-str">3.2. Node pools</h3>
475475
</div>
476476
</div>
477477
<div class="sect2">
478-
<h3 id="kafka-concepts-components_str">3.3. Kafka component architecture</h3>
478+
<h3 id="kafka-concepts-components_str"><a class="link" href="#kafka-concepts-components_str">3.3. Kafka component architecture</a></h3>
479479
<div class="paragraph _abstract">
480480
<p>A Kafka cluster consists of broker and controller nodes, which are managed using node pools.
481481
Other Kafka components interact with the Kafka cluster to support specific tasks.</p>
@@ -530,7 +530,7 @@ <h3 id="kafka-concepts-components_str">3.3. Kafka component architecture</h3>
530530
</div>
531531
</div>
532532
<div class="sect1">
533-
<h2 id="kafka-concepts_str">4. About Kafka</h2>
533+
<h2 id="kafka-concepts_str"><a class="link" href="#kafka-concepts_str">4. About Kafka</a></h2>
534534
<div class="sectionbody">
535535
<div class="paragraph">
536536
<p>Apache Kafka is an open-source distributed publish-subscribe messaging system for fault-tolerant real-time data feeds.</p>
@@ -539,7 +539,7 @@ <h2 id="kafka-concepts_str">4. About Kafka</h2>
539539
<p>For more information about Apache Kafka, see the <a href="https://kafka.apache.org/documentation/" target="_blank" rel="noopener">Apache Kafka documentation</a>.</p>
540540
</div>
541541
<div class="sect2">
542-
<h3 id="kafka-concepts-key_str">4.1. How Kafka operates as a message broker</h3>
542+
<h3 id="kafka-concepts-key_str"><a class="link" href="#kafka-concepts-key_str">4.1. How Kafka operates as a message broker</a></h3>
543543
<div class="paragraph _abstract">
544544
<p>To maximise your experience of using Strimzi, you need to understand how Kafka operates as a message broker.</p>
545545
</div>
@@ -606,7 +606,7 @@ <h3 id="kafka-concepts-key_str">4.1. How Kafka operates as a message broker</h3>
606606
</div>
607607
</div>
608608
<div class="sect2">
609-
<h3 id="kafka-concepts-producers-consumers_str">4.2. Producers and consumers</h3>
609+
<h3 id="kafka-concepts-producers-consumers_str"><a class="link" href="#kafka-concepts-producers-consumers_str">4.2. Producers and consumers</a></h3>
610610
<div class="paragraph">
611611
<p>Producers and consumers send and receive messages (publish and subscribe) through brokers.
612612
Messages comprise an optional <em>key</em> and a <em>value</em> that contains the message data, plus headers and related metadata.
@@ -653,7 +653,7 @@ <h3 id="kafka-concepts-producers-consumers_str">4.2. Producers and consumers</h3
653653
</div>
654654
</div>
655655
<div class="sect1">
656-
<h2 id="kafka-connect-components_str">5. About Kafka Connect</h2>
656+
<h2 id="kafka-connect-components_str"><a class="link" href="#kafka-connect-components_str">5. About Kafka Connect</a></h2>
657657
<div class="sectionbody">
658658
<div class="paragraph _abstract">
659659
<p>Kafka Connect is an integration toolkit for streaming data between Kafka brokers and other systems.
@@ -692,7 +692,7 @@ <h2 id="kafka-connect-components_str">5. About Kafka Connect</h2>
692692
Kafka Connect has some built-in transforms, but other transformations can be provided by plugins if necessary.</p>
693693
</div>
694694
<div class="sect2">
695-
<h3 id="key-features-kafka-connect_str">5.1. How Kafka Connect streams data</h3>
695+
<h3 id="key-features-kafka-connect_str"><a class="link" href="#key-features-kafka-connect_str">5.1. How Kafka Connect streams data</a></h3>
696696
<div class="paragraph _abstract">
697697
<p>Kafka Connect uses connector instances to integrate with other systems to stream data.</p>
698698
</div>
@@ -726,7 +726,7 @@ <h3 id="key-features-kafka-connect_str">5.1. How Kafka Connect streams data</h3>
726726
</ul>
727727
</div>
728728
<div class="sect3">
729-
<h4 id="connectors">5.1.1. Connectors</h4>
729+
<h4 id="connectors"><a class="link" href="#connectors">5.1.1. Connectors</a></h4>
730730
<div class="paragraph">
731731
<p>Connectors can be one of the following type:</p>
732732
</div>
@@ -843,7 +843,7 @@ <h4 id="connectors">5.1.1. Connectors</h4>
843843
</div>
844844
</div>
845845
<div class="sect3">
846-
<h4 id="tasks">5.1.2. Tasks</h4>
846+
<h4 id="tasks"><a class="link" href="#tasks">5.1.2. Tasks</a></h4>
847847
<div class="paragraph">
848848
<p>Data transfer orchestrated by the Kafka Connect runtime is split into tasks that run in parallel.
849849
A task is started using the configuration supplied by a connector instance.
@@ -880,7 +880,7 @@ <h4 id="tasks">5.1.2. Tasks</h4>
880880
</div>
881881
</div>
882882
<div class="sect3">
883-
<h4 id="workers">5.1.3. Workers</h4>
883+
<h4 id="workers"><a class="link" href="#workers">5.1.3. Workers</a></h4>
884884
<div class="paragraph">
885885
<p>Workers employ the connector configuration deployed to the Kafka Connect cluster.
886886
The configuration is stored in an internal Kafka topic used by Kafka Connect.
@@ -902,7 +902,7 @@ <h4 id="workers">5.1.3. Workers</h4>
902902
</div>
903903
</div>
904904
<div class="sect3">
905-
<h4 id="transforms">5.1.4. Transforms</h4>
905+
<h4 id="transforms"><a class="link" href="#transforms">5.1.4. Transforms</a></h4>
906906
<div class="paragraph">
907907
<p>Kafka Connect translates and transforms external data.
908908
Single-message transforms change messages into a format suitable for the target destination.
@@ -925,7 +925,7 @@ <h4 id="transforms">5.1.4. Transforms</h4>
925925
</div>
926926
</div>
927927
<div class="sect3">
928-
<h4 id="converters">5.1.5. Converters</h4>
928+
<h4 id="converters"><a class="link" href="#converters">5.1.5. Converters</a></h4>
929929
<div class="paragraph">
930930
<p>When a worker receives data, it converts the data into an appropriate format using a converter.
931931
You specify converters for workers in the worker <code>config</code> in the <code>KafkaConnect</code> resource.</p>
@@ -966,7 +966,7 @@ <h4 id="converters">5.1.5. Converters</h4>
966966
</div>
967967
</div>
968968
<div class="sect1">
969-
<h2 id="overview-components-kafka-bridge_str">6. Kafka Bridge interface</h2>
969+
<h2 id="overview-components-kafka-bridge_str"><a class="link" href="#overview-components-kafka-bridge_str">6. Kafka Bridge interface</a></h2>
970970
<div class="sectionbody">
971971
<div class="paragraph _abstract">
972972
<p>The Kafka Bridge provides a RESTful interface that allows HTTP-based clients to interact with a Kafka cluster. 
@@ -976,7 +976,7 @@ <h2 id="overview-components-kafka-bridge_str">6. Kafka Bridge interface</h2>
976976
<p>The API has two main resources — <code>consumers</code> and <code>topics</code> — that are exposed and made accessible through endpoints to interact with consumers and producers in your Kafka cluster. The resources relate only to the Kafka Bridge, not the consumers and producers connected directly to Kafka.</p>
977977
</div>
978978
<div class="sect2">
979-
<h3 id="http_requests">6.1. HTTP requests</h3>
979+
<h3 id="http_requests"><a class="link" href="#http_requests">6.1. HTTP requests</a></h3>
980980
<div class="paragraph">
981981
<p>The Kafka Bridge supports HTTP requests to a Kafka cluster, with methods to perform operations such as the following:</p>
982982
</div>
@@ -1028,7 +1028,7 @@ <h3 id="http_requests">6.1. HTTP requests</h3>
10281028
</div>
10291029
</div>
10301030
<div class="sect2">
1031-
<h3 id="con-overview-components-kafka-bridge-clients_str">6.2. Supported clients for the Kafka Bridge</h3>
1031+
<h3 id="con-overview-components-kafka-bridge-clients_str"><a class="link" href="#con-overview-components-kafka-bridge-clients_str">6.2. Supported clients for the Kafka Bridge</a></h3>
10321032
<div class="paragraph">
10331033
<p>You can use the Kafka Bridge to integrate both <em>internal</em> and <em>external</em> HTTP client applications with your Kafka cluster.</p>
10341034
</div>
@@ -1054,7 +1054,7 @@ <h3 id="con-overview-components-kafka-bridge-clients_str">6.2. Supported clients
10541054
</div>
10551055
</div>
10561056
<div class="sect1">
1057-
<h2 id="configuration-points_str">7. Configuring Kafka</h2>
1057+
<h2 id="configuration-points_str"><a class="link" href="#configuration-points_str">7. Configuring Kafka</a></h2>
10581058
<div class="sectionbody">
10591059
<div class="paragraph _abstract">
10601060
<p>Strimzi enables the deployment of Kafka components on Kubernetes through highly configurable custom resources.
@@ -1093,7 +1093,7 @@ <h2 id="configuration-points_str">7. Configuring Kafka</h2>
10931093
</div>
10941094
</div>
10951095
<div class="sect1">
1096-
<h2 id="security-overview_str">8. Securing Kafka</h2>
1096+
<h2 id="security-overview_str"><a class="link" href="#security-overview_str">8. Securing Kafka</a></h2>
10971097
<div class="sectionbody">
10981098
<div class="paragraph _abstract">
10991099
<p>A secure deployment of Strimzi might encompass one or more of the following security measures:</p>
@@ -1172,7 +1172,7 @@ <h2 id="security-overview_str">8. Securing Kafka</h2>
11721172
</div>
11731173
</div>
11741174
<div class="sect1">
1175-
<h2 id="metrics-overview_str">9. Monitoring Kafka</h2>
1175+
<h2 id="metrics-overview_str"><a class="link" href="#metrics-overview_str">9. Monitoring Kafka</a></h2>
11761176
<div class="sectionbody">
11771177
<div class="paragraph _abstract">
11781178
<p>Monitoring data allows you to monitor the performance and health of Strimzi.

0 commit comments

Comments
 (0)