From 8bdaca9e771eb1f4d05a5e0f2c65483eb84e2e0b Mon Sep 17 00:00:00 2001
From: "Alex Ellis (OpenFaaS Ltd)" <alexellis2@gmail.com>
Date: Fri, 13 Jan 2023 20:09:00 +0000
Subject: [PATCH] Update notes in values.yaml
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
---
chart/kafka-connector/README.md | 5 ++++-
chart/kafka-connector/values.yaml | 4 +++-
2 files changed, 7 insertions(+), 2 deletions(-)
diff --git a/chart/kafka-connector/README.md b/chart/kafka-connector/README.md
index b191c297..f14d8499 100644
--- a/chart/kafka-connector/README.md
+++ b/chart/kafka-connector/README.md
@@ -24,6 +24,8 @@ The [Kafka connector](https://docs.openfaas.com/openfaas-pro/introduction) bring
[Aiven](https://aiven.io/) and [Confluent Cloud](https://confluent.cloud/) have both been tested with the Kafka Connector.
+Other versions of Kafka like Redpanda should work out of the box.
+
## Complete walk-through guide
You can continue with this guide, or start the [walk-through](quickstart.md) for testing purposes.
@@ -51,6 +53,7 @@ $ helm upgrade kafka-connector openfaas/kafka-connector \
> The above command will also update your helm repo to pull in any new releases.
## Install a development version
+
```sh
$ helm upgrade kafka-connector ./chart/kafka-connector \
--install \
@@ -74,7 +77,7 @@ Additional kafka-connector options in `values.yaml`.
| Parameter | Description | Default |
| ------------------------ | -------------------------------------------------------------------------------------- | ------------------------------ |
-| `topics` | Topics to which the connector will bind, provide as a comma-separated list. | `faas-request` |
+| `topics` | Topics to which the connector will bind, provide as a comma-separated list or a single item. | `faas-request` |
| `brokerHost` | location of the Kafka brokers. | `kafka` |
| `asyncInvocation` | For long running or slow functions, offload to asychronous function invocations and carry on processing the stream | `false` |
| `upstreamTimeout` | Maximum timeout for upstream function call, must be a Go formatted duration string. | `2m` |
diff --git a/chart/kafka-connector/values.yaml b/chart/kafka-connector/values.yaml
index 1265af0f..4d8cad11 100644
--- a/chart/kafka-connector/values.yaml
+++ b/chart/kafka-connector/values.yaml
@@ -21,7 +21,9 @@ rebuildInterval: 30s
# Use with slow consumers or long running functions
asyncInvocation: false
-# Alter to the topics required
+# Set either a single topic, or multiple with a comma separating each
+# topics: payment.requested
+# topics: payment.requested,customer.created,invoice.generated
topics: faas-request
# Your Kafka broker
--
GitLab