-
Notifications
You must be signed in to change notification settings - Fork 25
docs(kroxylicious): additions for virtual cluster support in UI #2404
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
PaulRMellor
merged 5 commits into
streamshub:main
from
PaulRMellor:docs_virtual-clusters-ui
Mar 16, 2026
+69
−4
Merged
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
a210838
docs(kroxylicious): additions for virtual cluster support in UI
PaulRMellor ace31af
docs(review): updates from comments by copilot
PaulRMellor c4917cb
Merge branch 'main' into docs_virtual-clusters-ui
PaulRMellor 47267eb
Merge branch 'main' into docs_virtual-clusters-ui
PaulRMellor e0f4bf2
Merge branch 'main' into docs_virtual-clusters-ui
PaulRMellor File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
41 changes: 41 additions & 0 deletions
41
docs/sources/modules/deploying/ref-virtual-kafka-clusters.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| :_mod-docs-content-type: REFERENCE | ||
|
|
||
| [id='ref-virtual-kafka-clusters-{context}'] | ||
| = Adding virtual Kafka clusters | ||
|
|
||
| [role="_abstract"] | ||
| You can configure the console to connect to Kroxylicious virtual Kafka clusters. | ||
| A virtual cluster is a logical Kafka endpoint exposed by the Kroxylicious proxy. | ||
|
|
||
| When configured, virtual clusters appear in the console alongside physical Kafka clusters. | ||
| Virtual clusters are identified with a *Virtual* label in the cluster selector. | ||
|
|
||
| Virtual clusters are defined using the `kafkaClusters.kind` property. | ||
|
|
||
| `kafkaClusters.kind`:: Specifies the type of Kafka cluster resource. | ||
| If not specified, the console assumes a Strimzi-managed Kafka cluster (`kafkas.kafka.strimzi.io`). | ||
| Set this property to `virtualkafkaclusters.kroxylicious.io` when configuring a Kroxylicious virtual Kafka cluster. | ||
|
|
||
| .Deploying the console with an example configuration for connecting to a virtual Kafka cluster | ||
| [source,yaml] | ||
| ---- | ||
| apiVersion: console.streamshub.github.com/v1alpha1 | ||
| kind: Console | ||
| metadata: | ||
| name: my-console | ||
| spec: | ||
| hostname: my-console.<cluster_domain> | ||
| kafkaClusters: | ||
| - name: my-cluster | ||
| kind: virtualkafkaclusters.kroxylicious.io | ||
| namespace: my-proxy | ||
| properties: | ||
| values: | ||
| - name: bootstrap.servers | ||
| value: 'my-cluster-cluster-ip-bootstrap.my-proxy.svc.cluster.local:9292' | ||
| ---- | ||
|
|
||
| * `kafkaClusters.name` specifies the name of the Kroxylicious `VirtualKafkaCluster` resource that represents the cluster. | ||
| * `kafkaClusters.kind` specifies that the cluster is a Kroxylicious virtual Kafka cluster. | ||
| * `kafkaClusters.namespace` specifies the namespace where the `VirtualKafkaCluster` resource is deployed. | ||
| * `kafkaClusters.properties.values` specifies Kafka client connection properties, such as the bootstrap server address. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.