Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix spec metadata table for Kafka binding docs #2504

Merged
merged 2 commits into from
Jun 10, 2022
Merged

Fix spec metadata table for Kafka binding docs #2504

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
480cf3f
fix formatting and add response output
sarsharma Jun 9, 2022
3c3702d
Merge branch 'v1.7' into v1.7
msfussell Jun 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions daprdocs/content/en/reference/components-reference/supported-bindings/kafka.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ spec:
secretKeyRef:
name: kafka-secrets
key: saslPasswordSecret
- name: initialOffset # Optional. Used for input bindings.
value: "newest"
- name: maxMessageBytes # Optional.
value: 1024
- name: version # Optional.
Expand All @@ -54,9 +56,9 @@ spec:
| authRequired | Y | Input/Output | Enable [SASL](https://en.wikipedia.org/wiki/Simple_Authentication_and_Security_Layer) authentication with the Kafka brokers. | `"true"`, `"false"` |
| saslUsername | N | Input/Output | The SASL username used for authentication. Only required if `authRequired` is set to `"true"`. | `"adminuser"` |
| saslPassword | N | Input/Output | The SASL password used for authentication. Can be `secretKeyRef` to use a [secret reference]({{< ref component-secrets.md >}}). Only required if `authRequired` is set to `"true"`. | `""`, `"KeFg23!"` |
| initialOffset | N | The initial offset to use if no offset was previously committed. Should be "newest" or "oldest". Defaults to "newest". | `"oldest"` |
| initialOffset | N | Input | The initial offset to use if no offset was previously committed. Should be "newest" or "oldest". Defaults to "newest". | `"oldest"` |
| maxMessageBytes | N | Input/Output | The maximum size in bytes allowed for a single Kafka message. Defaults to 1024. | `2048` |
| version | N | Kafka cluster version. Defaults to 1.0.0 | `1.0.0`
| version | N | Input/Output | Kafka cluster version. Defaults to 1.0.0 | `1.0.0`

## Binding support

Expand Down Expand Up @@ -88,6 +90,10 @@ curl -X POST http://localhost:3500/v1.0/bindings/myKafka \
}'
```

### Response

An HTTP 204 (No Content) and empty body will be returned if successful.

## Related links

- [Basic schema for a Dapr component]({{< ref component-schema >}})
Expand Down