Website build Hono-Website-Declarative-Pipeline-196
Signed-off-by: Hono Bot <hono-bot@eclipse.org>
diff --git a/docs/1.6/admin-guide/hono-kafka-client-configuration/index.html b/docs/1.6/admin-guide/hono-kafka-client-configuration/index.html
index a885fb8..7a55ce0 100644
--- a/docs/1.6/admin-guide/hono-kafka-client-configuration/index.html
+++ b/docs/1.6/admin-guide/hono-kafka-client-configuration/index.html
@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <meta name="generator" content="Hugo 0.58.3" />
+ <meta name="generator" content="Hugo 0.81.0" />
<meta name="description" content="A set of micro-services for connecting millions of devices.">
<meta name="author" content="The Eclipse Hono Project">
@@ -21,21 +21,21 @@
<title>Hono Kafka Client Configuration :: Eclipse Hono™ Vers.: 1.6</title>
- <link href="/hono/docs/css/nucleus.css?1617757958" rel="stylesheet">
- <link href="/hono/docs/css/fontawesome-all.min.css?1617757958" rel="stylesheet">
- <link href="/hono/docs/css/hybrid.css?1617757958" rel="stylesheet">
- <link href="/hono/docs/css/featherlight.min.css?1617757958" rel="stylesheet">
- <link href="/hono/docs/css/perfect-scrollbar.min.css?1617757958" rel="stylesheet">
- <link href="/hono/docs/css/auto-complete.css?1617757958" rel="stylesheet">
- <link href="/hono/docs/css/atom-one-dark-reasonable.css?1617757958" rel="stylesheet">
- <link href="/hono/docs/css/theme.css?1617757958" rel="stylesheet">
- <link href="/hono/docs/css/hugo-theme.css?1617757958" rel="stylesheet">
+ <link href="/hono/docs/css/nucleus.css?1617844311" rel="stylesheet">
+ <link href="/hono/docs/css/fontawesome-all.min.css?1617844311" rel="stylesheet">
+ <link href="/hono/docs/css/hybrid.css?1617844311" rel="stylesheet">
+ <link href="/hono/docs/css/featherlight.min.css?1617844311" rel="stylesheet">
+ <link href="/hono/docs/css/perfect-scrollbar.min.css?1617844311" rel="stylesheet">
+ <link href="/hono/docs/css/auto-complete.css?1617844311" rel="stylesheet">
+ <link href="/hono/docs/css/atom-one-dark-reasonable.css?1617844311" rel="stylesheet">
+ <link href="/hono/docs/css/theme.css?1617844311" rel="stylesheet">
+ <link href="/hono/docs/css/hugo-theme.css?1617844311" rel="stylesheet">
- <link href="/hono/docs/css/theme-hono.css?1617757958" rel="stylesheet">
+ <link href="/hono/docs/css/theme-hono.css?1617844311" rel="stylesheet">
- <link href="/hono/docs/css/hono.css?1617757958" rel="stylesheet">
+ <link href="/hono/docs/css/hono.css?1617844311" rel="stylesheet">
- <script src="/hono/docs/js/jquery-3.3.1.min.js?1617757958"></script>
+ <script src="/hono/docs/js/jquery-3.3.1.min.js?1617844311"></script>
<style>
:root #header + #content > #left > #rlblock_left{
@@ -83,14 +83,14 @@
<span data-search-clear=""><i class="fas fa-times"></i></span>
</div>
-<script type="text/javascript" src="/hono/docs/js/lunr.min.js?1617757958"></script>
-<script type="text/javascript" src="/hono/docs/js/auto-complete.js?1617757958"></script>
+<script type="text/javascript" src="/hono/docs/js/lunr.min.js?1617844311"></script>
+<script type="text/javascript" src="/hono/docs/js/auto-complete.js?1617844311"></script>
<script type="text/javascript">
var baseurl = "https:\/\/www.eclipse.org\/hono\/docs\/\/1.6";
</script>
-<script type="text/javascript" src="/hono/docs/js/search.js?1617757958"></script>
+<script type="text/javascript" src="/hono/docs/js/search.js?1617844311"></script>
</div>
@@ -1606,7 +1606,37 @@
- <option id="stable" value="https://www.eclipse.org/hono/docs/admin-guide/hono-kafka-client-configuration/">stable (1.6)</option>
+ <option id="stable" value="https://www.eclipse.org/hono/docs/admin-guide/hono-kafka-client-configuration/">stable (1.7)</option>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <option id="1.7" value="https://www.eclipse.org/hono/docs/1.7/admin-guide/hono-kafka-client-configuration/">1.7</option>
@@ -1632,6 +1662,8 @@
+
+
<option id="1.6" value="https://www.eclipse.org/hono/docs/1.6/admin-guide/hono-kafka-client-configuration/" selected>1.6</option>
@@ -1672,6 +1704,8 @@
+
+
<option id="dev" value="https://www.eclipse.org/hono/docs/dev/admin-guide/hono-kafka-client-configuration/">dev</option>
@@ -1728,6 +1762,12 @@
<div id="overlay"></div>
+ <div class="old-version-hint">
+ <p>This page refers to version <em>1.6</em>.
+ You might want to use the <a href="https://www.eclipse.org/hono/docs/">current stable</a> version.
+ </p>
+ </div>
+
<div class="padding highlightable">
@@ -1784,24 +1824,24 @@
<div class="progress">
<div class="wrapper">
<nav id="TableOfContents">
-<ul>
-<li>
-<ul>
-<li><a href="#producer-configuration-properties">Producer Configuration Properties</a>
-<ul>
-<li><a href="#using-tls">Using TLS</a></li>
-</ul></li>
-<li><a href="#consumer-configuration-properties">Consumer Configuration Properties</a>
-<ul>
-<li><a href="#using-tls-1">Using TLS</a></li>
-</ul></li>
-<li><a href="#admin-client-configuration-properties">Admin Client Configuration Properties</a>
-<ul>
-<li><a href="#using-tls-2">Using TLS</a></li>
-</ul></li>
-<li><a href="#common-configuration-properties">Common Configuration Properties</a></li>
-</ul></li>
-</ul>
+ <ul>
+ <li><a href="#producer-configuration-properties">Producer Configuration Properties</a>
+ <ul>
+ <li><a href="#using-tls">Using TLS</a></li>
+ </ul>
+ </li>
+ <li><a href="#consumer-configuration-properties">Consumer Configuration Properties</a>
+ <ul>
+ <li><a href="#using-tls-1">Using TLS</a></li>
+ </ul>
+ </li>
+ <li><a href="#admin-client-configuration-properties">Admin Client Configuration Properties</a>
+ <ul>
+ <li><a href="#using-tls-2">Using TLS</a></li>
+ </ul>
+ </li>
+ <li><a href="#common-configuration-properties">Common Configuration Properties</a></li>
+ </ul>
</nav>
</div>
</div>
@@ -1825,175 +1865,134 @@
-
-
<p>Protocol adapters can be configured to use Kafka for the messaging. The Kafka client used there can be configured with
environment variables and/or command line options.</p>
-
<div class="alert alert-notice">
<h4 class="alert-heading"><i class="fas fa-info-circle"></i> Tech preview</h4>
<div>The support of Kafka as a messaging system is currently a preview and not yet ready for production.
The implementation as well as it’s APIs may change with the next version.</div>
</div>
-
<h2 id="producer-configuration-properties">Producer Configuration Properties</h2>
-
<p>The <code>org.eclipse.hono.client.kafka.CachingKafkaProducerFactory</code> factory can be used to create Kafka producers for Hono’s Kafka based APIs.
The producers created by the factory are configured with instances of the class <code>org.eclipse.hono.client.kafka.KafkaProducerConfigProperties</code>
which can be used to programmatically configure a producer.</p>
-
<p>The configuration needs to be provided in the form <code>HONO_KAFKA_PRODUCERCONFIG_${PROPERTY}</code> as an environment variable or
as a command line option in the form <code>hono.kafka.producerConfig.${property}</code>, where <code>${PROPERTY}</code> respectively
<code>${property}</code> is any of the Kafka client’s <a href="https://kafka.apache.org/documentation/#producerconfigs">producer properties</a>.
The provided configuration is passed directly to the Kafka producer without Hono parsing or validating it.</p>
-
<p>The following properties can <em>not</em> be set using this mechanism because the protocol adapters use fixed values instead
in order to implement the message delivery semantics defined by Hono’s Telemetry and Event APIs.</p>
-
<table>
<thead>
<tr>
-<th align="left">Kafka Producer Config Property</th>
-<th align="left">Fixed Value</th>
+<th style="text-align:left">Kafka Producer Config Property</th>
+<th style="text-align:left">Fixed Value</th>
</tr>
</thead>
-
<tbody>
<tr>
-<td align="left"><code>key.serializer</code></td>
-<td align="left"><code>org.apache.kafka.common.serialization.StringSerializer</code></td>
+<td style="text-align:left"><code>key.serializer</code></td>
+<td style="text-align:left"><code>org.apache.kafka.common.serialization.StringSerializer</code></td>
</tr>
-
<tr>
-<td align="left"><code>value.serializer</code></td>
-<td align="left"><code>io.vertx.kafka.client.serialization.BufferSerializer</code></td>
+<td style="text-align:left"><code>value.serializer</code></td>
+<td style="text-align:left"><code>io.vertx.kafka.client.serialization.BufferSerializer</code></td>
</tr>
-
<tr>
-<td align="left"><code>enable.idempotence</code></td>
-<td align="left"><code>true</code></td>
+<td style="text-align:left"><code>enable.idempotence</code></td>
+<td style="text-align:left"><code>true</code></td>
</tr>
</tbody>
</table>
-
<div class="alert alert-notice">
<h4 class="alert-heading"><i class="fas fa-info-circle"></i> Enable Kafka based Messaging</h4>
<div>The Kafka client requires the property <code>bootstrap.servers</code> to be provided. This variable is the minimal configuration
required to enable Kafka based messaging.</div>
</div>
-
<h3 id="using-tls">Using TLS</h3>
-
<p>The factory can be configured to use TLS for</p>
-
<ul>
<li>authenticating the brokers in the Kafka cluster during connection establishment and</li>
<li>(optionally) authenticating to the broker using a client certificate</li>
</ul>
-
<p>To use this, a Kafka Producer configuration as described in
<a href="https://kafka.apache.org/documentation/#security_configclients">Kafka documentation - section “Security”</a> needs to be provided.
The properties must be prefixed with <code>HONO_KAFKA_PRODUCERCONFIG_</code> and <code>hono.kafka.producerConfig.</code> respectively as shown in
<a href="#producer-configuration-properties">Producer Configuration Properties</a>.
The complete reference of available properties and the possible values is available in
<a href="https://kafka.apache.org/documentation/#producerconfigs">Kafka documentation - section “Producer Configs”</a>.</p>
-
<h2 id="consumer-configuration-properties">Consumer Configuration Properties</h2>
-
<p>Consumers for Hono’s Kafka based APIs are configured with instances of the class <code>org.eclipse.hono.client.kafka.consumer.KafkaConsumerConfigProperties</code>
which can be used to programmatically configure a consumer.</p>
-
<p>The configuration needs to be provided in the form <code>HONO_KAFKA_CONSUMERCONFIG_${PROPERTY}</code> as an environment variable or
as a command line option in the form <code>hono.kafka.consumerConfig.${property}</code>, where <code>${PROPERTY}</code> respectively
<code>${property}</code> is any of the Kafka client’s <a href="https://kafka.apache.org/documentation/#consumerconfigs">consumer properties</a>.
The provided configuration is passed directly to the Kafka consumer without Hono parsing or validating it.</p>
-
<p>The following properties can <em>not</em> be set using this mechanism because the protocol adapters use fixed values instead.</p>
-
<table>
<thead>
<tr>
-<th align="left">Kafka Consumer Config Property</th>
-<th align="left">Fixed Value</th>
+<th style="text-align:left">Kafka Consumer Config Property</th>
+<th style="text-align:left">Fixed Value</th>
</tr>
</thead>
-
<tbody>
<tr>
-<td align="left"><code>key.deserializer</code></td>
-<td align="left"><code>org.apache.kafka.common.serialization.StringDeserializer</code></td>
+<td style="text-align:left"><code>key.deserializer</code></td>
+<td style="text-align:left"><code>org.apache.kafka.common.serialization.StringDeserializer</code></td>
</tr>
-
<tr>
-<td align="left"><code>value.deserializer</code></td>
-<td align="left"><code>io.vertx.kafka.client.serialization.BufferDeserializer</code></td>
+<td style="text-align:left"><code>value.deserializer</code></td>
+<td style="text-align:left"><code>io.vertx.kafka.client.serialization.BufferDeserializer</code></td>
</tr>
</tbody>
</table>
-
<div class="alert alert-notice">
<h4 class="alert-heading"><i class="fas fa-info-circle"></i> Enable Kafka based Messaging</h4>
<div>The Kafka client requires the property <code>bootstrap.servers</code> to be provided. This variable is the minimal configuration
required to enable Kafka based messaging.</div>
</div>
-
<h3 id="using-tls-1">Using TLS</h3>
-
<p>The factory can be configured to use TLS for</p>
-
<ul>
<li>authenticating the brokers in the Kafka cluster during connection establishment and</li>
<li>(optionally) authenticating to the broker using a client certificate</li>
</ul>
-
<p>To use this, a Kafka Consumer configuration as described in
<a href="https://kafka.apache.org/documentation/#security_configclients">Kafka documentation - section “Security”</a> needs to be provided.
The properties must be prefixed with <code>HONO_KAFKA_CONSUMERCONFIG_</code> and <code>hono.kafka.consumerConfig.</code> respectively as shown in
<a href="#consumer-configuration-properties">Consumer Configuration Properties</a>.
The complete reference of available properties and the possible values is available in
<a href="https://kafka.apache.org/documentation/#consumerconfigs">Kafka documentation - section “Consumer Configs”</a>.</p>
-
<h2 id="admin-client-configuration-properties">Admin Client Configuration Properties</h2>
-
<p>Admin clients for Hono’s Kafka based APIs are configured with instances of the class <code>org.eclipse.hono.client.kafka.KafkaAdminClientConfigProperties</code>
which can be used to programmatically configure an admin client.</p>
-
<p>The configuration needs to be provided in the form <code>HONO_KAFKA_ADMINCLIENTCONFIG_${PROPERTY}</code> as an environment variable or
as a command line option in the form <code>hono.kafka.adminClientConfig.${property}</code>, where <code>${PROPERTY}</code> respectively
<code>${property}</code> is any of the Kafka client’s <a href="https://kafka.apache.org/documentation/#adminclientconfigs">admin client properties</a>.
The provided configuration is passed directly to the Kafka admin client without Hono parsing or validating it.</p>
-
<div class="alert alert-notice">
<h4 class="alert-heading"><i class="fas fa-info-circle"></i> Enable Kafka based Messaging</h4>
<div>The Kafka client requires the property <code>bootstrap.servers</code> to be provided. This variable is the minimal configuration
required to enable Kafka based messaging.</div>
</div>
-
<h3 id="using-tls-2">Using TLS</h3>
-
<p>The factory can be configured to use TLS for</p>
-
<ul>
<li>authenticating the brokers in the Kafka cluster during connection establishment and</li>
<li>(optionally) authenticating to the broker using a client certificate</li>
</ul>
-
<p>To use this, a Kafka admin client configuration as described in
<a href="https://kafka.apache.org/documentation/#security_configclients">Kafka documentation - section “Security”</a> needs to be provided.
The properties must be prefixed with <code>HONO_KAFKA_ADMINCLIENTCONFIG_</code> and <code>hono.kafka.adminClientConfig.</code> respectively as shown in
<a href="#admin-client-configuration-properties">Admin Client Configuration Properties</a>.
The complete reference of available properties and the possible values is available in
<a href="https://kafka.apache.org/documentation/#adminclientconfigs">Kafka documentation - section “Admin Configs”</a>.</p>
-
<h2 id="common-configuration-properties">Common Configuration Properties</h2>
-
<p>Configuration properties that are common to all the client types described above can be put in a common configuration section.
This will avoid having to define duplicate configuration properties for the different client types.</p>
-
<p>Relevant properties are <code>bootstrap.servers</code> and the properties related to the TLS configuration (see chapters above).</p>
-
<p>The properties must be prefixed with <code>HONO_KAFKA_COMMONCLIENTCONFIG_</code> and <code>hono.kafka.commonClientConfig.</code> respectively.</p>
-
<p>A property with the same name defined in the configuration of one of the specific client types above will have precedence
over the common property.</p>
@@ -3109,19 +3108,19 @@
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
</div>
- <script src="/hono/docs/js/clipboard.min.js?1617757959"></script>
- <script src="/hono/docs/js/perfect-scrollbar.min.js?1617757959"></script>
- <script src="/hono/docs/js/perfect-scrollbar.jquery.min.js?1617757959"></script>
- <script src="/hono/docs/js/jquery.sticky.js?1617757959"></script>
- <script src="/hono/docs/js/featherlight.min.js?1617757959"></script>
- <script src="/hono/docs/js/highlight.pack.js?1617757959"></script>
+ <script src="/hono/docs/js/clipboard.min.js?1617844312"></script>
+ <script src="/hono/docs/js/perfect-scrollbar.min.js?1617844312"></script>
+ <script src="/hono/docs/js/perfect-scrollbar.jquery.min.js?1617844312"></script>
+ <script src="/hono/docs/js/jquery.sticky.js?1617844312"></script>
+ <script src="/hono/docs/js/featherlight.min.js?1617844312"></script>
+ <script src="/hono/docs/js/highlight.pack.js?1617844312"></script>
<script>hljs.initHighlightingOnLoad();</script>
- <script src="/hono/docs/js/modernizr.custom-3.6.0.js?1617757959"></script>
- <script src="/hono/docs/js/learn.js?1617757959"></script>
- <script src="/hono/docs/js/hugo-learn.js?1617757959"></script>
+ <script src="/hono/docs/js/modernizr.custom-3.6.0.js?1617844312"></script>
+ <script src="/hono/docs/js/learn.js?1617844312"></script>
+ <script src="/hono/docs/js/hugo-learn.js?1617844312"></script>
- <link href="/hono/docs/mermaid/mermaid.css?1617757959" rel="stylesheet" />
- <script src="/hono/docs/mermaid/mermaid.js?1617757959"></script>
+ <link href="/hono/docs/mermaid/mermaid.css?1617844312" rel="stylesheet" />
+ <script src="/hono/docs/mermaid/mermaid.js?1617844312"></script>
<script>
mermaid.initialize({ startOnLoad: true });
</script>
