For the complete documentation index, see llms.txt. Markdown versions of all docs pages are available by appending .md to any docs URL.

Review how the Solo UI components extend observability for your Istio environment, and review requirements and other recommendations for your Solo Enterprise for Istio setup.

About

The Solo UI deploys alongside your Istio ambient mesh environment in single or multicluster environments, and can discover existing ambient mesh installations across clusters and infrastructure providers. The UI works with ambient service meshes, whether you use community Istio images or Solo distributions of Istio.

The Solo UI includes components that Solo develops alongside several integrated, third-party, open source projects that extend its capabilities.

Key features that you have access to when using the Solo UI include:

• Visual service graph: Review what services can communicate with other services, the policies that are applied before traffic is sent to a service, and how traffic between services is secured.
• Live metrics: With the built-in ClickHouse integration, the Solo UI has access to workload-specific metrics, such as the number of requests that were received for a workload. This data is visualized in the Solo UI graph. For more information about the ClickHouse integration, see ClickHouse.
• Global services: In multicluster setups, you can review all services that are exposed globally across the multicluster mesh, including their health statuses.
• Resource overview: With the Solo UI, you can view all Istio and Kubernetes resources in one place for all the clusters that you registered with the management server.

Number of clusters

Single cluster

Solo Enterprise for Istio is fully functional when you run both the Solo UI components and an Istio service mesh within the same cluster. The Solo UI deploys alongside your workloads and provides observability into your mesh environment.

When a single-cluster guide in this documentation set requires your cluster name and context, you can save the name of your cluster in the ${cluster1} environment variable, and the context of your cluster in the ${context1} environment variable.

Multicluster

A multicluster Solo Enterprise for Istio setup consists of one cluster that you deploy the UI management components to, and one or more connected clusters in the multicluster mesh that you deploy the UI relay components to. The cluster that you install the management components in often also runs service mesh workloads, and does not need to serve as a dedicated management cluster.

Note that before you install the Solo UI into a multicluster environment, you must first install a multicluster ambient mesh. The multicluster ambient mesh provides the capability to expose the UI services in the management cluster globally, so that relay components in other clusters in the multicluster mesh can access the telemetry gateway and tunnel server addresses.

When a multicluster guide requires example names, the examples use cluster1 and cluster2. Otherwise, you can save the names of your clusters in the ${cluster1} and ${cluster2} environment variables, and the contexts of your clusters in the ${context1} and ${context2} environment variables.

Dedicated management cluster (no Istio required)

You can optionally deploy the Solo UI management components on a dedicated cluster where Istio is not installed. This topology separates observability infrastructure from your workload clusters.

In this topology, the management cluster hosts the UI server, OTel gateway, and ClickHouse. Each workload cluster runs the relay chart, which connects to the management cluster over load balancer addresses that are accessible from the workload clusters, rather than over an ambient mesh global service. To install in this topology, set istio.ambient.enabled=false in the management chart, expose the tunnel server and OTel gateway as load balancer services, and set tunnel.fqdn and telemetry.fqdn in the relay chart to those external addresses. For more information, see the installation guide.

Components

Management chart

Version 0.5.7 and later of the Solo UI management chart deploys the following pods.

The solo-enterprise-ui pod runs the following three containers.

The solo-enterprise-tunnel pod runs the following container.

The solo-enterprise-k8sobjects-collector pod runs the following container.

Relay chart

Version 0.5.7 and later of the Solo UI relay chart deploys the following pods in each workload cluster.

The relay chart pods run the following containers.

Network architecture

Review the deployed components and their ports in single or multicluster setups.

Single cluster

Review how the Solo UI components communicate with each other in one cluster in the following diagram.

Review the following table to understand the ports and protocols that the Solo UI uses for communication among components in a single-cluster setup. All components are deployed by the solo-enterprise/management Helm chart.

Multicluster

Review how the Solo UI components communicate with each other in the following diagram. This diagram represents the network architecture in a multicluster setup that consists of one cluster where the Solo UI is deployed, and one connected cluster. Both clusters are connected by a multicluster ambient mesh, and service mesh workloads can run in both clusters.

Review the following tables to understand the ports and protocols that the Solo UI uses for communication among components.

Management component ports

The following components are deployed by the solo-enterprise/management Helm chart in a cluster that serves as the management plane. In the ambient mesh topology shown in this diagram, this cluster is included in the multicluster ambient mesh and often also runs workloads in the mesh. If you instead use a dedicated management cluster, the cluster does not need to be part of an ambient mesh, and relay components connect to it over load balancer addresses that are accessible from the workload clusters.

Relay component ports

The following components are deployed by the solo-enterprise/relay Helm chart in a cluster that runs mesh workloads.

Version

The Solo UI is supported for Solo Enterprise for Istio versions 1.30 or later. Review the minimum Solo UI version that is tested and compatible with each Solo Enterprise for Istio version.

Additionally, note that the Solo UI is supported for ambient meshes, and requires an Enterprise-level license for Solo Enterprise for Istio. If you have a Basic or Premium license for Solo Enterprise for Istio, or use a sidecar mesh setup, use the Gloo UI. for observability and management of your Istio environment.

* OpenShift: Support depends on the underlying versions of Kubernetes and Gateway API that the OpenShift Container Platform version includes. For more information, see OpenShift.