diff --git a/chart/kafka-connector/README.md b/chart/kafka-connector/README.md index b191c29728e9a5c5ddf0961a809067d2d3e75a38..f14d8499d24b9270f4478000f68eba00de61a9ad 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 1265af0f6f46b4040dd7ce777bc15f6ab9e02b5b..4d8cad11ce8c6f731873c9c21bd14af06f1a106c 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