Skip to content

Commit

Permalink
Update docs for multi-primary support (#732) (#737)
Browse files Browse the repository at this point in the history
  • Loading branch information
nrfox committed Dec 18, 2023
1 parent 4b54e4b commit adb5365
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
8 changes: 3 additions & 5 deletions content/en/docs/Configuration/multi-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,9 @@ Before proceeding with the setup, ensure you meet the requirements.

### Requirements

1. **Primary-remote istio deployment.** Only the primary-remote istio deployment is currently supported.
1. **Aggregated metrics and traces.** Kiali needs a single endpoint for metrics and a single endpoint for traces where it can consume aggregated metrics/traces across all clusters. There are many ways to aggregate metrics/traces such as Prometheus federation or using OTEL collector pipelines but setting these up are outside of the scope of Kiali.

2. **Aggregated metrics and traces.** Kiali needs a single endpoint for metrics and a single endpoint for traces where it can consume aggregated metrics/traces across all clusters. There are many ways to aggregate metrics/traces such as prometheus federation or using OTEL collector pipelines but setting these up are outside of the scope of Kiali.

3. **Anonymous or OpenID authentication strategy.** The unified multi-cluster configuration currently only supports anonymous or OpenID [authentication strategies]({{< relref "../Configuration/authentication" >}}). In addition, current support varies by provider for OpenID across clusters.
2. **Anonymous or OpenID authentication strategy.** The unified multi-cluster configuration currently only supports anonymous or OpenID [authentication strategies]({{< relref "../Configuration/authentication" >}}). In addition, current support varies by provider for OpenID across clusters.

### Setup

Expand Down Expand Up @@ -60,7 +58,7 @@ spec:
EOF
```

As an alternative, it can be added in the Istio tracing config in the primary cluster (Without using the Telemetry API):
As an alternative, it can be added in the Istio tracing config in the primary cluster(s) (Without using the Telemetry API):

```
meshConfig:
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/Features/multi-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ A basic Istio mesh deployment has a single control plane with a single data plan
[deployment models](https://istio.io/latest/docs/ops/deployment/deployment-models/). It allows a mesh to span multiple primary (control plane) and/or remote (data plane only) clusters, and can use a single or
[multi-network](https://istio.io/latest/docs/ops/deployment/deployment-models/#multiple-networks) approach. The only strict rule is that within a mesh service names are unique. A non-basic mesh deployment generally involves multiple clusters. See [installation instructions](https://istio.io/docs/setup/install/multicluster/) for more detail on installing advanced mesh deployments.

A single Kiali install can currently work with at most one mesh, one istiod, one metric store and one trace store but it can be configured for "single cluster" or "multi-cluster". All clusters must be part of the same mesh, have data planes controlled by the single istiod (control plane), and report to the same metric and trace store, whether directly or via some sort of aggregator. See the [multi-cluster configuration page]({{< relref "../Configuration/multi-cluster" >}}) for more information on requirements.
A single Kiali install can currently work with at most one mesh, one metric store and one trace store but it can be configured for "single cluster" or "multi-cluster". All clusters must be part of the same mesh and report to the same metric and trace store, whether directly or via some sort of aggregator. See the [multi-cluster configuration page]({{< relref "../Configuration/multi-cluster" >}}) for more information on requirements.

For multi-cluster configurations, Kiali provides a unified view and management of your mesh across clusters.

Expand All @@ -35,7 +35,7 @@ Unlike single-cluster configurations, multi-cluster configurations show list/det

### List Views: Aggregated mesh view

With a multi-cluster Kiali configuration, you can view all apps, workloads, services, and Istio config in your mesh from a single place. Istio configuration is currently read only for remote clusters.
With a multi-cluster Kiali configuration, you can view all apps, workloads, services, and Istio config in your mesh from a single place.

![Multi-cluster list pages](/images/documentation/features/multi-cluster-list.png "Multi-cluster list pages")

Expand Down

0 comments on commit adb5365

Please sign in to comment.