Skip to content

docs: virtual cluster quota update #310

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.

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
merged 5 commits into from
Apr 7, 2025
Merged
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions src/.vuepress/navbar/en.ts
Original file line number Diff line number Diff line change
@@ -31,8 +31,8 @@ export const enNavbar = navbar([
"link": "/deployment/zilla-plus-in-production/web-streaming/README.md"
},
{
"text": "Virtual Cluster",
"link": "/deployment/zilla-plus-in-production/virtual-cluster/README.md"
"text": "Virtual Clusters",
"link": "/deployment/zilla-plus-in-production/virtual-clusters/README.md"
}
]
},
13 changes: 6 additions & 7 deletions src/.vuepress/sidebar/en.ts
Original file line number Diff line number Diff line change
@@ -393,14 +393,13 @@ export const enSidebar = sidebar({
children: [
"avro.md",
"boolean.md",
"double.md",
"float.md",
"int32.md",
"int64.md",
"json.md",
"protobuf.md",
"boolean.md",
"string.md",
"int32.md",
"int64.md",
"double.md",
"float.md",
],
},
],
@@ -694,8 +693,8 @@ export const enSidebar = sidebar({
],
},
{
text: "Virtual Cluster",
link: "virtual-cluster/README.md",
text: "Virtual Clusters",
link: "virtual-clusters/README.md",
children: [],
},
"zilla-plus-on-aws-ecs-fargate.md",
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# Virtual Cluster
---
shortTitle: Virtual Clusters
description: Virtual Clusters in Zilla allow for the logical segregation of a single Kafka cluster.
---

# Virtual Clusters

[Available in Zilla Plus](https://www.aklivity.io/products/zilla-plus)
{.zilla-plus-badge .hint-container .info}
@@ -12,10 +17,12 @@ This feature is enabled by **Zilla Plus**, which provides advanced Kafka proxy c

## Key Features
- **Multiple Virtual Clusters Over a Single System Cluster**: One or more virtual clusters can be defined over a single system cluster.
- **Stateless Architecture**: Eliminating the need for managing custom metadata.
- **Virtual Topics**: Topics are created following the pattern `<cluster_name>.<topic_name>`.
- **Virtual Consumer Groups**: Consumer groups follow the same pattern as topics, ensuring segmentation.
- **Virtual Partitions**: Supports mapping virtual topic partitions to system topic partitions.
- **Access Control**: Virtual ACLs are mapped to system ACLs.
- **Client Quotas**: Ensures quotas are applied per virtual cluster, as per configured limit.
- **Backwards Compatibility**: If no pattern is specified, virtual clusters are disabled.

## Virtual Cluster Mechanisms
@@ -30,6 +37,11 @@ This feature is enabled by **Zilla Plus**, which provides advanced Kafka proxy c
### Virtual Access Control Lists (ACLs)
- Each virtual ACL is mapped directly to a system ACL (`one-to-one`).

### Virtual Cluster Quotas
- Virtual cluster quotas are directly mapped to system client quotas (`one-to-one`).
- Client IDs are prefixed with the virtual cluster name following the pattern `<cluster_name>.<clientId>`, to enforce quotas.
- Clients without a defined Client ID are assigned the virtual cluster name `<cluster_name>`, ensuring that quotas are applied at the virtual cluster level.

## Configuration
A virtual cluster is defined using a configuration structure like the example below: