docs(kroxylicious): additions for virtual cluster support in UI (#2404)

* docs(kroxylicious): additions for virtual cluster support in UI

Signed-off-by: prmellor <pmellor@redhat.com>

* docs(review): updates from comments by copilot

Signed-off-by: prmellor <pmellor@redhat.com>

---------

Signed-off-by: prmellor <pmellor@redhat.com>

Author: PaulRMellor

docs/sources/assemblies/assembly-deploying.adoc

@@ -38,6 +38,8 @@ include::../modules/deploying/proc-deploying-operator-crd.adoc[leveloffset=+2]
 //include::../modules/deploying/proc-deploying-operator-olm-ui.adoc[leveloffset=+2]
 //Using the operator to deploy the console
 include::../modules/deploying/proc-connecting-console.adoc[leveloffset=+1]
+//virtual kafka clusters
+include::../modules/deploying/ref-virtual-kafka-clusters.adoc[leveloffset=+2]
 //cluster connection authentication options
 include::../modules/deploying/ref-authentication-options.adoc[leveloffset=+2]
 //kafka connect 

docs/sources/modules/con-cluster-overview-page.adoc

@@ -7,6 +7,8 @@
 The *Cluster overview* page shows the status of a Kafka cluster. 
 Use this page to assess broker readiness, identify cluster errors or warnings, and monitor overall health.
 
+Virtual Kafka clusters are identified with a *Virtual* label next to the cluster name.
+
 At a glance, the page displays:
 
 * Number of topics and partitions
@@ -22,7 +24,9 @@ At a glance, the page displays:
 Metrics are presented as interactive charts.
 
 * For *Cluster metrics*, use the dropdown menu to view data for a specific node or for all nodes.  
-* For *Topic metrics*, use the dropdown menu to view data for a specific topic or for all topics.  
+* For *Topic metrics*, use the dropdown menu to view data for a specific topic or for all topics. 
+
+NOTE: Metrics are not available for virtual Kafka clusters.
 
 You can adjust the time range for the charts, from the last 5 minutes up to 7 days.
 

docs/sources/modules/con-navigating-the-console.adoc

@@ -17,6 +17,20 @@ Offset and lag metrics are available for consumer groups.
 
 NOTE: If the cluster navigation menu is hidden, click the navigation menu icon (three horizontal lines) in the console header to reveal it.
 
+== Navigate between clusters
+
+After you log in to a cluster, a cluster selector appears at the top of each console page.
+The selector shows the current cluster and the number of available clusters.
+
+Click the selector to:
+
+* Switch to another cluster
+* Return to the console homepage to view all clusters
+
+Kroxylicious virtual Kafka clusters appear with a *Virtual* label in the console.
+A virtual Kafka cluster is a logical Kafka cluster that is accessible to clients over the network.
+The Kroxylicious proxy exposes the virtual cluster and forwards client requests to an underlying Kafka cluster using configured filters.
+
 == Choose how the console looks
 
 The StreamsHub Console supports three theme options: *Light*, *Dark*, and *System*. When set to *System*, the console matches your operating system theme preference.

docs/sources/modules/deploying/proc-connecting-console.adoc

@@ -24,7 +24,7 @@ If you deployed the xref:proc-deploying-kafka-{context}[example Kafka cluster] p
 +
 Otherwise, configure the resource to connect to your Kafka cluster.
 +
-.Example console configuration
+.Deploying the console with an example configuration for connecting to a Kafka cluster
 [source,yaml]
 ----
 apiVersion: console.streamshub.github.com/v1alpha1
@@ -46,8 +46,8 @@ spec:
 ----
 
 * `hostname` defines the hostname used to access the console over HTTP.
-* `kafkaClusters.name` defines the name of the `Kafka` resource that represents the cluster.
-* `kafkaClusters.namespace` specifies the namespace where the Kafka cluster is deployed.
+* `kafkaClusters.name` specifies the name of the Strimzi `Kafka` resource that represents the cluster.
+* `kafkaClusters.namespace` specifies the namespace where the `Kafka` resource is deployed.
 * `kafkaClusters.listener` specifies the listener used to expose the Kafka cluster for console connections.
 * `kafkaClusters.properties.values` optionally defines additional connection properties.
 * `kafkaClusters.properties.valuesFrom` optionally specifies ConfigMaps or Secrets that provide connection properties.

docs/sources/modules/deploying/ref-virtual-kafka-clusters.adoc

@@ -0,0 +1,45 @@
+:_mod-docs-content-type: REFERENCE
+
+// Module included in the following assemblies:
+//
+// assembly-deploying.adoc
+
+[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.