Skip to content

Commit

Permalink
[eclipse#253] Update NOTES.txt with information related to Kafka.
Browse files Browse the repository at this point in the history
Signed-off-by: Abel Buechner-Mihaljevic <[email protected]>
  • Loading branch information
b-abel committed Jun 4, 2021
1 parent 8513546 commit 742adf6
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
2 changes: 1 addition & 1 deletion charts/hono/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ name: hono
description: |
Eclipse Hono™ provides remote service interfaces for connecting large numbers of IoT devices to a back end and
interacting with them in a uniform way regardless of the device communication protocol.
version: 1.8.4
version: 1.8.5
# Version of Hono being deployed by the chart
appVersion: 1.8.0
keywords:
Expand Down
24 changes: 24 additions & 0 deletions charts/hono/templates/NOTES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,32 @@ NAME {{ "READY STATUS RESTARTS AGE" | i

Once all pods have status 'Running', Hono is ready to be used.

{{ if (eq .Values.messagingNetworkType "kafka") -}}
{{- if .Values.kafkaMessagingClusterExample.enabled -}}
Hono is configured to use an example Kafka cluster for messaging. To learn more
about it, you should follow the guide for Getting started with Kafka messaging at
https://eclipse.org/hono/getting-started-kafka/

Clients can connect to the Kafka cluster with the configuration properties below.
The Getting started guide shows how to obtain the actual values of the IP address
and the path to the truststore. Please don't forget to replace them before using
this config:

bootstrap.servers=$KAFKA_IP:9094
ssl.truststore.location=$KAFKA_TRUSTSTORE_PATH
security.protocol=SASL_SSL
sasl.mechanism=SCRAM-SHA-512
sasl.jaas.config=org.apache.kafka.common.security.scram.ScramLoginModule required username="{{ first .Values.kafka.auth.sasl.jaas.clientUsers }}" password="{{ first .Values.kafka.auth.sasl.jaas.clientPasswords }}";
ssl.truststore.password={{ .Values.kafka.auth.tls.password | quote }}
ssl.endpoint.identification.algorithm=""
{{- else -}}
The messaging in Hono is configured to use the Kafka cluster with the boostrap servers:
{{ index .Values.adapters.kafkaMessagingSpec.commonClientConfig "bootstrap.servers" }}
{{- end }}
{{- else -}}
To learn more about Hono's functionality, you should follow the Getting started guide at
https://eclipse.org/hono/getting-started/
{{- end }}

Enjoy :-)

0 comments on commit 742adf6

Please sign in to comment.