Skip to content

docs: Kafka ACL requirements for kafka cache bootstrap #339

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

Merged
ankitk-me merged 1 commit into from
Mar 23, 2026
Merged

docs: Kafka ACL requirements for kafka cache bootstrap #339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion src/reference/config/bindings/kafka/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Defines a binding with `kafka` protocol support, with `cache_client`, `cache_ser

The `cache_client` and `cache_server` kinds combine to provide a persistent cache of `kafka` messages per `topic` `partition` honoring the `kafka` `topic` configuration for message expiration and compaction. Messages ordering is guaranteed per `partition` and messages are merged into a unified stream for the `topic` spanning all `partitions`.

The `cache_server` kind supports proactive `fetch` of messages to keep the cache fresh in preparation for new consumers. This is enabled by configuring a list of `bootstrap` topics for the binding.
The `cache_server` kind supports proactive `fetch` of messages to keep the cache fresh in preparation for new consumers. This is enabled by configuring a list of `bootstrap` topics for the binding. When using bootstrap, the Zilla service principal requires `DESCRIBE` and `READ` ACLs on each bootstrapped topic.

The `cache_client` kind supports filtering by `kafka` message key, headers or a combination of key and headers.

Expand Down
10 changes: 10 additions & 0 deletions src/reference/config/bindings/kafka/cache_server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,16 @@ options:

Topics to bootstrap in cache server even when no clients.

::: info Kafka ACL Requirements
When using `bootstrap`, the Zilla service principal must have the following ACLs on each bootstrapped topic:

| Operation | Resource Type | Description |
|------------|---------------|------------------------------------------------------------|
| `DESCRIBE` | `Topic` | Required to fetch topic metadata and partition information |
| `READ` | `Topic` | Required to fetch messages from the topic |
:::


#### options.topics

> `array` of `object`
Expand Down
Loading