Skip to content

Commit 09abf53

Browse files
authored
Update features - istio component status (#451)
- re-order Feature sections alphabetically by removing weights - shorten install link titles to avoid wrapping
1 parent 37c676f commit 09abf53

21 files changed

+32
-56
lines changed

content/en/docs/Features/_index.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
title: "Features"
3-
date: 2018-06-20T19:04:38+02:00
4-
draft: false
5-
weight: 2
63
description: An overview of important Kiali features.
4+
weight: 2
75
---
86

content/en/docs/Features/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Istio Configuration"
3-
weight: 7
3+
description: "Using Kiali to generate Istio mesh-wide configuration."
44
---
55

66
Kiali is more than observability, it also helps you to configure, update and validate your Istio service mesh.

content/en/docs/Features/details.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: Detail Views
33
description: Kiali provides list and detail views for your mesh components.
4-
weight: 3
54
---
65

76
Kiali provides filtered list views of all your service mesh definitions. Each view provides health, details, YAML definitions and links to help you visualize your mesh. There are list and detail views for:

content/en/docs/Features/health.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Health"
3-
weight: 2
3+
description: "How Kiali reflects your Service Mesh Health."
44
---
55

66
Kiali help users know whether their service mesh is healthy. This includes the health of the mesh infrastructure itself, and the deployed application services.
@@ -11,6 +11,8 @@ Users can quickly confirm the health of their infrastructure by looking at the K
1111

1212
![Masthead Health](/images/documentation/features/health-masthead.png "Masthead Health")
1313

14+
For more detail on how Kiali tracks the Istio infrastructure status, see the [Istio Status Feature]({{< relref "./istio-component-status" >}}).
15+
1416
## Overview Health
1517

1618
The default Kiali page is an Overview Dashboard. This view will quickly allow you to identify namespaces with issues. It provides a summary of configuration health, component health and request traffic health. The component health is selectable via a dropdown and the page offers various filter, sort and presentation options:

content/en/docs/Features/istio-component-status.md

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,35 @@
11
---
2-
title: "Istio Status"
3-
date: 2018-06-20T19:04:38+02:00
4-
draft: false
5-
weight: 9
2+
title: "Istio Component Status"
3+
linkTitle: "Istio Status"
4+
description: "How Kiali monitors your Istio infrastructure."
65
---
76

8-
## Istio Component Status
7+
A service mesh simplifies application services by deferring the non-business logic to the mesh. But for healthy applications the service mesh infrastructure must also be running normally. Kiali monitors the multiple components that make up the service mesh, letting you know if there is an underlying problem.
98

10-
The Istio service mesh architecture is comprised of several components, from istiod to Jaeger. Each component must work as expected for the mesh to work well overall. Kiali regularly checks the status of each Istio component to ensure the mesh is healthy.
9+
![Istio component status](/images/documentation/features/istio-status-masthead.png "Istio component status")
1110

12-
![Istio components status: components not healthy or found](/images/documentation/features/istio-components-1.24.png "Istio components status: components not healthy or found")
11+
A component *status* will be one of: `Not found`, `Not ready`, `Unreachable`, `Not healthy` and `Healthy`. `Not found` means that Kiali is not able to find the deployment. `Not ready` means no pods are running. `Unreachable` means that Kiali hasn't been successfully able to communicate with the component (Prometheus, Grafana and Jaeger). `Not healthy` means that the deployment doesn't have the desired amount of replicas running. Otherwise, the component is `Healthy` and it won't be shown in the list.
1312

14-
A component *status* will be one of: `Not found`, `Unreachable`, `Not healthy` and `Healthy`. The `Not found` status means that Kiali is not able to find the deployment. The `Unreachable` status means that Kiali hasn't been succesfuly able to communicate with the component (Prometheus, Grafana and Jaeger). The `Not healthy` status means that the deployment doesn't have the desired amount of replicas running. The `Healthy` status is when the component is not in the previous ones, plus, healthy components won't be shown in the list.
13+
Regarding the *severity* of each component, there are only two options: `core` or `add-on`. The `core` components are those shown as errors (in red) whereas the `add-ons` are displayed as warnings (in orange).
1514

16-
Regarding the *severity* of each component, there are only to options: `core` or `add-on`. The `core` components are those shown as errors (in red) whereas the `add-ons` are displayed as warnings (in orange).
15+
By default, Kiali checks that the `core` components "istiod", "ingress", and "egress" are installed and running in the control plane namespace, and that the `add-ons` "prometheus", "grafana" and "jaeger" are available.
1716

18-
By default, Kiali checks the following components installed in the control plane namespace: istiod, ingress, egress; and prometheus, grafana and jaeger accessible thought their services.
17+
## Certificate Information Indicators
1918

20-
## Certificates Information Indicators
19+
In some situations, it is useful to get information about the certificates used by internal mTLS, for example:
2120

22-
In some situations, it would be useful to get information about the certificates used by internal mTLS, for example:
23-
24-
* Know whether the default CA is used or if there is another CA configured
25-
* Check the certificates issuer and their validity timestamps to troubleshoot any issue with certificates
21+
* Know whether the default CA is used or if there is another CA configured.
22+
* Check the certificates issuer and their validity timestamps to troubleshoot any issue with certificates.
2623

2724
The certificates shown depends on how Istio is configured. The following cases are possible:
2825

29-
* Using Istio CA certificates (default), the information shown is from a secret named *istio-ca-secret*
30-
* Using https://istio.io/latest/docs/tasks/security/cert-management/plugin-ca-cert/[Plug in CA certificates, window=_blank], the information shown is from a secret named *cacerts*
31-
* Using https://istio.io/latest/docs/tasks/security/cert-management/dns-cert/[DNS certificates, window=_blank], the information shown is from reading many secrets found in Istio configuration
26+
* Using Istio CA certificates (default), the information shown is from a secret named *istio-ca-secret*.
27+
* Using [Plug in CA certificates](https://istio.io/latest/docs/tasks/security/cert-management/plugin-ca-cert/), the information shown is from a secret named *cacerts*.
28+
* Using [DNS certificates](https://istio.io/latest/docs/tasks/security/cert-management/dns-cert/), the information shown is from reading many secrets found in Istio configuration.
3229

3330
The following is an example of viewing the default case:
3431

35-
![Certificates information](/images/documentation/features/certificates-information-indicators.png "Certificates information")
32+
![Certificates information](/images/documentation/features/istio-status-certificate-info-indicators.png "Certificates information")
3633

3734
Note that displaying this configuration requires permissions to read secrets (*istio-ca-secret* by default, possibly *cacerts* or any secret configured when using DNS certificates).
3835

content/en/docs/Features/multi-cluster.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
2-
title: "Advanced Mesh Deployment and Multi-cluster support"
3-
date: 2018-06-20T19:04:38+02:00
4-
draft: false
5-
weight: 10
2+
title: "Multi-cluster Deployment"
3+
description: "Advanced Mesh Deployment and Multi-cluster support."
64
---
75

86
A basic Istio mesh deployment has a single control plane with a single data plane, deployed on a single Kubernetes cluster. But Istio supports a variety of advanced

content/en/docs/Features/security.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
---
22
title: "Security"
3-
date: 2018-06-20T19:04:38+02:00
4-
draft: false
5-
weight: 8
63
---
74

85
Kiali gives support to better understand how mTLS is used in Istio meshes. Find those helpers in the graph, the masthead menu, the overview page and specific validations.

content/en/docs/Features/topology.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: Topology
33
description: How Kiali visualizes the mesh topology.
4-
weight: 1
54
---
65

76
Kiali offers multiple ways for users to examine their mesh Topology. Each combines several information types to help users quickly evaluate the health of their service architecture.

content/en/docs/Features/tracing.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: Tracing
33
description: How Kiali integrates Distributed Tracing with Jaeger.
4-
weight: 4
54
---
65

76
Kiali offers a native integration with Jaeger for Distributed Tracing. As such, users can access Jaeger's trace visualizations. But more

content/en/docs/Features/validations.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: "Validation"
3-
weight: 5
43
---
54

65
Kiali performs a set of validations on your Istio Objects, such as Destination Rules, Service Entries, and Virtual Services. Kiali's validations go above and beyond what Istio offers. Where Istio offers mainly static checks for well-formed definitions, Kiali performs semantic validations to ensure that the definitions make sense, across objects, and in some cases even across namespaces. Kiali validations are based on the runtime status of your service mesh.

content/en/docs/Features/wizards.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
---
22
title: "Wizards"
3-
date: 2018-06-20T19:04:38+02:00
4-
draft: false
5-
weight: 6
63
---
74

85
Kiali is more than observability, it also helps you to configure, update and validate your Istio service mesh.

content/en/docs/Installation/installation-guide/accessing-kiali.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
2-
title: "Accessing and exposing Kiali"
3-
date: 2021-09-12T00:00:00+00:00
4-
draft: false
2+
title: "Accessing Kiali"
3+
description: "Accessing and exposing Kiali"
54
weight: 50
65
---
76

content/en/docs/Installation/installation-guide/advanced-install-options.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
2-
title: "Advanced installation options"
3-
date: 2021-09-12T00:00:00+00:00
4-
draft: false
2+
title: "Advanced Install"
3+
description: "Advanced installation options"
54
weight: 60
65
---
76

content/en/docs/Installation/installation-guide/creating-updating-kiali-cr.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
2-
title: "Creating and updating the Kiali CR"
3-
date: 2021-09-12T00:00:00+00:00
4-
draft: false
2+
title: "The Kiali CR"
3+
description: "Creating and updating the Kiali CR"
54
weight: 40
65
---
76

content/en/docs/Installation/installation-guide/example-install.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
---
2-
title: "Example Installation"
3-
date: 2021-10-20:00:00+00:00
4-
draft: false
2+
title: "Example Install"
53
weight: 70
64
---
75

content/en/docs/Installation/installation-guide/install-with-helm.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
---
2-
title: "Installation via Helm"
3-
date: 2021-09-12T00:00:00+00:00
4-
draft: false
2+
title: "Install via Helm"
53
weight: 20
64
---
75

content/en/docs/Installation/installation-guide/installing-with-operatorhub.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
---
2-
title: "Installation via OperatorHub"
3-
date: 2021-09-12T00:00:00+00:00
4-
draft: false
2+
title: "Install via OperatorHub"
53
weight: 30
64
---
75

Binary file not shown.
Binary file not shown.
Loading
Loading

0 commit comments

Comments
 (0)