Skip to content

Commit e66fcae

Browse files
JSticklerJStickler
authored
Merge pull request #42168 from JStickler/OSSMDOC-168
OSSMDOC-168: Part 1 of Kiali config reference.
2 parents bef4743 + 5075ec5 commit e66fcae

11 files changed

+248
-16
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2977,8 +2977,10 @@ Topics:
29772977
File: threescale-adapter
29782978
- Name: Troubleshooting Service Mesh
29792979
File: ossm-troubleshooting-istio
2980-
- Name: Service Mesh configuration reference
2980+
- Name: Control plane configuration reference
29812981
File: ossm-reference-smcp
2982+
- Name: Kiali configuration reference
2983+
File: ossm-reference-kiali
29822984
- Name: Jaeger configuration reference
29832985
File: ossm-reference-jaeger
29842986
- Name: Uninstalling Service Mesh

‎modules/jaeger-config-default.adoc

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@
22
This REFERENCE module included in the following assemblies:
33
- rhbjaeger-deploying.adoc
44
////
5-
5+
:_content-type: REFERENCE
66
[id="jaeger-config-default_{context}"]
77
= Jaeger default configuration options
8-
:pantheon-module-type: REFERENCE
98

10-
The Jaeger custom resource (CR) defines the architecture and settings to be used when creating the Jaeger resources. You can modify these parameters to customize your Jaeger implementation to your business needs.
9+
The Jaeger custom resource (CR) defines the architecture and settings to use when creating the Jaeger resources. You can modify these parameters to customize your Jaeger implementation to your business needs.
1110

1211
.Jaeger generic YAML example
1312
[source,yaml]
@@ -62,13 +61,13 @@ spec:
6261
|{product-title} automatically generates the `UID` and completes the `namespace` with the name of the project where the object is created.
6362

6463
|`name:`
65-
|Name for the object.
64+
|Name of Jaeger custom resource. If a Jaeger CR matching the value of `name` exists, the {SMProductShortname} Operator will use that CR for the installation. If no Jaeger CR exists, the Operator will create one using this `name` and the configuration options specified in the SMCP.
6665
|The name of your Jaeger instance.
6766
|`jaeger-all-in-one-inmemory`
6867

6968
|`spec:`
7069
|Specification for the object to be created.
71-
|Contains all of the configuration parameters for your Jaeger instance. When a common definition (for all Jaeger components) is required, it is defined under the spec node. When the definition relates to an individual component, it is placed under the spec/<component> node.
70+
|Contains all of the configuration parameters for your Jaeger instance. When a common definition (for all Jaeger components) is required, it is defined under the spec node. When the definition relates to an individual component, it is placed under the spec/<component> node.
7271
|N/A
7372

7473
|`strategy:`
@@ -110,7 +109,6 @@ spec:
110109
|Configuration options that define the Ingester service.
111110
|
112111
|
113-
114112
|===
115113

116114

‎modules/ossm-configuring-jaeger.adoc renamed to ‎modules/ossm-config-smcp-jaeger.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// * service_mesh/v2x/customizing-installation-ossm.adoc
44

5-
5+
:_content-type: CONCEPT
66
[id="ossm-specifying-jaeger-configuration_{context}"]
77
= Specifying Jaeger configuration in the SMCP
88

‎modules/ossm-config-smcp-kiali.adoc

Lines changed: 204 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,204 @@
1+
// Module included in the following assemblies:
2+
//* service_mesh/v2x/ossm-reference-kiali.adoc
3+
:_content-type: REFERENCE
4+
[id="ossm-smcp-kiali_{context}"]
5+
= Specifying Kiali configuration in the SMCP
6+
7+
You can configure Kiali under the `addons` section of the `ServiceMeshControlPlane` resource. Kiali is enabled by default. To disable Kiali, set `spec.addons.kiali.enabled` to `false`.
8+
9+
You can specify your Kiali configuration in either of two ways:
10+
11+
* Specify the Kiali configuration in the `ServiceMeshControlPlane` resource under `spec.addons.kiali.install`. This approach has some limitations, because the complete list of Kiali configurations is not available in the SMCP.
12+
13+
* Configure and deploy a Kiali instance and specify the name of the Kiali resource as the value for `spec.addons.kiali.name` in the `ServiceMeshControlPlane` resource. You must create the CR in the same namespace as the Service Mesh control plane, for example, `istio-system`. If a Kiali resource matching the value of `name` exists, the control plane will configure that Kiali resource for use with the control plane. This approach lets you fully customize your Kiali configuration in the Kiali resource. Note that with this approach, various fields in the Kiali resource are overwritten by the {SMProductShortName} Operator, specifically, the `accessible_namespaces` list, as well as the endpoints for Grafana, Prometheus, and tracing.
14+
15+
.Example SMCP parameters for Kiali
16+
[source,yaml]
17+
----
18+
apiVersion: maistra.io/v2
19+
kind: ServiceMeshControlPlane
20+
metadata:
21+
name: basic
22+
spec:
23+
addons:
24+
kiali:
25+
name: kiali
26+
enabled: true
27+
install:
28+
dashboard:
29+
viewOnly: false
30+
enableGrafana: true
31+
enableTracing: true
32+
enablePrometheus: true
33+
service:
34+
ingress:
35+
contextPath: /kiali
36+
----
37+
38+
.`ServiceMeshControlPlane` Kiali parameters
39+
[options="header"]
40+
[cols="l, a, a, a"]
41+
|===
42+
|Parameter |Description |Values |Default value
43+
|spec:
44+
addons:
45+
kiali:
46+
name:
47+
|Name of Kiali custom resource. If a Kiali CR matching the value of `name` exists, the {SMProductShortname} Operator will use that CR for the installation. If no Kiali CR exists, the Operator will create one using this `name` and the configuration options specified in the SMCP.
48+
|string
49+
|`kiali`
50+
51+
|kiali:
52+
enabled:
53+
|This parameter enables or disables Kiali. Kiali is enabled by default.
54+
|`true`/`false`
55+
|`true`
56+
57+
|kiali:
58+
install:
59+
|Install a Kiali resource if the named Kiali resource is not present. The `install` section is ignored if `addons.kiali.enabled` is set to `false`.
60+
|
61+
|
62+
63+
|kiali:
64+
install:
65+
dashboard:
66+
|Configuration parameters for the dashboards shipped with Kiali.
67+
|
68+
|
69+
70+
|kiali:
71+
install:
72+
dashboard:
73+
viewOnly:
74+
|This parameter enables or disables view-only mode for the Kiali console. When view-only mode is enabled, users cannot use the Kiali console to make changes to the {SMProductShortname}.
75+
|`true`/`false`
76+
|`false`
77+
78+
|kiali:
79+
install:
80+
dashboard:
81+
enableGrafana:
82+
|Grafana endpoint configured based on `spec.addons.grafana` configuration.
83+
|`true`/`false`
84+
|`true`
85+
86+
|kiali:
87+
install:
88+
dashboard:
89+
enablePrometheus:
90+
|Prometheus endpoint configured based on `spec.addons.prometheus` configuration.
91+
|`true`/`false`
92+
|`true`
93+
94+
|kiali:
95+
install:
96+
dashboard:
97+
enableTracing:
98+
|Tracing endpoint configured based on Jaeger custom resource configuration.
99+
|`true`/`false`
100+
|`true`
101+
102+
|kiali:
103+
install:
104+
service:
105+
|Configuration parameters for the Kubernetes service associated with the Kiali installation.
106+
|
107+
|
108+
109+
|kiali:
110+
install:
111+
service:
112+
metadata:
113+
|Use to specify additional metadata to apply to resources.
114+
|N/A
115+
|N/A
116+
117+
|kiali:
118+
install:
119+
service:
120+
metadata:
121+
annotations:
122+
|Use to specify additional annotations to apply to the component's service.
123+
|string
124+
|N/A
125+
126+
|kiali:
127+
install:
128+
service:
129+
metadata:
130+
labels:
131+
|Use to specify additional labels to apply to the component's service.
132+
|string
133+
|N/A
134+
135+
|kiali:
136+
install:
137+
service:
138+
ingress:
139+
|Use to specify details for accessing the component’s service through an OpenShift Route.
140+
|N/A
141+
|N/A
142+
143+
|kiali:
144+
install:
145+
service:
146+
ingress:
147+
metadata:
148+
annotations:
149+
|Use to specify additional annotations to apply to the component's service ingress.
150+
|string
151+
|N/A
152+
153+
|kiali:
154+
install:
155+
service:
156+
ingress:
157+
metadata:
158+
labels:
159+
|Use to specify additional labels to apply to the component's service ingress.
160+
|string
161+
|N/A
162+
163+
|kiali:
164+
install:
165+
service:
166+
ingress:
167+
enabled:
168+
|Use to customize an OpenShift Route for the service associated with a component.
169+
|`true`/`false`
170+
|`true`
171+
172+
|kiali:
173+
install:
174+
service:
175+
ingress:
176+
contextPath:
177+
|Use to specify the context path to the service.
178+
|string
179+
|N/A
180+
181+
|install:
182+
service:
183+
ingress:
184+
hosts:
185+
|Use to specify a single hostname per OpenShift route. An empty hostname implies a default hostname for the Route.
186+
|string
187+
|N/A
188+
189+
|install:
190+
service:
191+
ingress:
192+
tls:
193+
|Use to configure the TLS for the OpenShift route.
194+
|
195+
|N/A
196+
197+
|kiali:
198+
install:
199+
service:
200+
nodePort:
201+
|Use to specify the `nodePort` for the component's service `Values.<component>.service.nodePort.port`
202+
|integer
203+
|N/A
204+
|===

‎modules/ossm-configuring-external-kiali.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * service_mesh/v2x/customizing-installation-ossm.adoc
4+
:_content-type: CONCEPT
5+
[id="ossm-specifying-external-kiali_{context}"]
6+
= Specifying Kiali configuration in a Kiali custom resource
7+
8+
You can fully customize your Kiali deployment by configuring Kiali in the Kiali custom resource (CR) rather than in the `ServiceMeshControlPlane` (SMCP) resource. This configuration is sometimes called an "external Kiali" since the configuration is specified outside of the SMCP.
9+
10+
[NOTE]
11+
====
12+
You must deploy the `ServiceMeshControlPlane` and Kiali custom resources in the same namespace. For example, `istio-system`.
13+
====
14+
15+
You can configure and deploy a Kiali instance and then specify the `name` of the Kiali resource as the value for `spec.addons.kiali.name` in the SMCP resource. If a Kiali CR matching the value of `name` exists, the control plane will use the existing installation. This approach lets you fully customize your Kiali configuration.

‎modules/ossm-configuring-kiali.adoc renamed to ‎modules/ossm-configuring-kiali-v1x.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// * service_mesh/v1x/customizing-installation-ossm.adoc
44
// * service_mesh/v2x/customizing-installation-ossm.adoc
5-
5+
:_content-type: REFERENCE
66
[id="configuring-kiali_{context}"]
77
= Configuring Kiali
88

‎modules/ossm-kiali-service-mesh.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,15 @@
22
This CONCEPT module included in the following assemblies:
33
-service_mesh/v1x/ossm-vs-community.adoc
44
-service_mesh/v2x/ossm-vs-community.adoc
5-
65
////
7-
6+
:_content-type: CONCEPT
87
[id="ossm-kiali-service-mesh_{context}"]
98
= Kiali and service mesh
109

11-
Installing Kiali via the Service Mesh on {product-title} differs from community Kiali installations in multiple ways. These modifications are sometimes necessary to resolve issues, provide additional features, or to handle differences when deploying on {product-title}.
10+
Installing Kiali via the Service Mesh on {product-title} differs from community Kiali installations in multiple ways. These modifications are sometimes necessary to resolve issues, provide additional features, or to handle differences when deploying on {product-title}.
1211

1312
* Kiali has been enabled by default.
1413
* Ingress has been enabled by default.
1514
* Updates have been made to the Kiali ConfigMap.
1615
* Updates have been made to the ClusterRole settings for Kiali.
17-
* Do not edit the ConfigMap or the Kiali custom resource files as those changes might be overwritten by the {SMProductShortName} or Kiali Operators. All configuration for Kiali running on {SMProductName} is done in the `ServiceMeshControlPlane` custom resource file and there are limited configuration options. Updating the Operator files should be restricted to those users with `cluster-admin` privileges. If you use {product-dedicated}, updating the operator files should be restricted to those users with `dedicated-admin` privileges.
16+
* Do not edit the ConfigMap, because your changes might be overwritten by the {SMProductShortName} or Kiali Operators. Files that the Kiali Operator manages have a `kiali.io/`` label or annotation. Updating the Operator files should be restricted to those users with `cluster-admin` privileges. If you use {product-dedicated}, updating the Operator files should be restricted to those users with `dedicated-admin` privileges.

‎modules/ossm-vs-istio.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Hold for OSSMDOC-547 as to what we support
3737
|===
3838
|
3939
|Upstream Istio
40-
|{ProductName}
40+
|{SMProductName}
4141
4242
|Namespace Label
4343
|supports "enabled" and "disabled"

‎service_mesh/v1x/ossm-custom-resources.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ include::modules/ossm-cr-mixer.adoc[leveloffset=+2]
2727

2828
include::modules/ossm-cr-pilot.adoc[leveloffset=+2]
2929

30-
include::modules/ossm-configuring-kiali.adoc[leveloffset=+1]
30+
include::modules/ossm-configuring-kiali-v1x.adoc[leveloffset=+1]
3131

3232
include::modules/ossm-configuring-jaeger-v1x.adoc[leveloffset=+1]
3333

‎service_mesh/v2x/ossm-reference-jaeger.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ When the {SMProductShortName} Operator deploys the `ServiceMeshControlPlane` res
1010

1111
include::modules/ossm-enabling-jaeger.adoc[leveloffset=+1]
1212

13-
include::modules/ossm-configuring-jaeger.adoc[leveloffset=+1]
13+
include::modules/ossm-config-smcp-jaeger.adoc[leveloffset=+1]
1414

1515
include::modules/ossm-deploying-jaeger.adoc[leveloffset=+1]
1616

0 commit comments

Comments
 (0)