forked from kiali/kiali-operator
-
Notifications
You must be signed in to change notification settings - Fork 0
/
kiali.io_kialis.yaml
1291 lines (1258 loc) · 91.1 KB
/
kiali.io_kialis.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
name: kialis.kiali.io
spec:
group: kiali.io
names:
kind: Kiali
listKind: KialiList
plural: kialis
singular: kiali
scope: Namespaced
versions:
- name: v1alpha1
served: true
storage: true
subresources:
status: {}
schema:
openAPIV3Schema:
type: object
properties:
status:
description: "The processing status of this CR as reported by the Kiali operator."
type: object
x-kubernetes-preserve-unknown-fields: true
spec:
description: "This is the CRD for the resources called Kiali CRs. The Kiali Operator will watch for resources of this type and when it detects a Kiali CR has been added, deleted, or modified, it will install, uninstall, and update the associated Kiali Server installation. The settings here will configure the Kiali Server as well as the Kiali Operator. All of these settings will be stored in the Kiali ConfigMap. Do not modify the ConfigMap; it will be managed by the Kiali Operator. Only modify the Kiali CR when you want to change a configuration setting."
type: object
properties:
additional_display_details:
description: |
A list of additional details that Kiali will look for in annotations. When found on any workload or service, Kiali will display the additional details in the respective workload or service details page. This is typically used to inject some CI metadata or documentation links into Kiali views. For example, by default, Kiali will recognize these annotations on a service or workload (e.g. a Deployment, StatefulSet, etc.):
```
annotations:
kiali.io/api-spec: http://list/to/my/api/doc
kiali.io/api-type: rest
```
Note that if you change this setting for your own custom annotations, keep in mind that it would override the current default. So you would have to add the default setting as shown in the example CR if you want to preserve the default links.
type: array
items:
required: ["title", "annotation"]
type: object
properties:
title:
description: "The title of the link that Kiali will display. The link will go to the URL specified in the value of the configured `annotation`."
type: string
annotation:
description: "The name of the annotation whose value is a URL to additional documentation useful to the user."
type: string
icon_annotation:
description: "The name of the annotation whose value is used to determine what icon to display. The annotation name itself can be anything, but note that the value of that annotation must be one of: `rest`, `grpc`, and `graphql` - any other value is ignored."
type: string
installation_tag:
description: "Tag used to identify a particular instance/installation of the Kiali server. This is merely a human-readable string that will be used within Kiali to help a user identify the Kiali being used (e.g. in the Kiali UI title bar). See `deployment.instance_name` for the setting used to customize Kiali resource names that are created."
type: string
istio_namespace:
description: "The namespace where Istio is installed. If left empty, it is assumed to be the same namespace as where Kiali is installed (i.e. `deployment.namespace`)."
type: string
version:
description: |
The version of the Ansible playbook to execute in order to install that version of Kiali.
It is rare you will want to set this - if you are thinking of setting this, know what you are doing first.
The only supported value today is `default`.
If not specified, a default version of Kiali will be installed which will be the most recent release of Kiali.
Refer to this file to see where these values are defined in the master branch,
https://github.com/kiali/kiali-operator/tree/master/playbooks/default-supported-images.yml
This version setting affects the defaults of the deployment.image_name and
deployment.image_version settings. See the comments for those settings
below for additional details. But in short, this version setting will
dictate which version of the Kiali image will be deployed by default.
Note that if you explicitly set deployment.image_name and/or
deployment.image_version you are responsible for ensuring those settings
are compatible with this setting (i.e. the Kiali image must be compatible
with the rest of the configuration and resources the operator will install).
type: string
api:
type: object
properties:
namespaces:
description: "Settings that control what namespaces are returned by Kiali."
type: object
properties:
exclude:
description: "A list of namespaces to be excluded from the list of namespaces provided by the Kiali API and Kiali UI. Regex is supported. This does not affect explicit namespace access."
type: array
items:
type: string
include:
description: "A list of namespaces to be included in the list of namespaces provided by the Kiali API and Kiali UI (if those namespaces exist). Regex is supported. An undefined or empty list is ignored. This does not affect explicit namespace access."
type: array
items:
type: string
label_selector_exclude:
description: |
A Kubernetes label selector (e.g. `myLabel=myValue`) which is used for filtering out namespaces
when fetching the list of available namespaces. This does not affect explicit namespace access.
type: string
label_selector_include:
description: |
A Kubernetes label selector (e.g. `myLabel=myValue`) which is used when fetching the list of
available namespaces. This does not affect explicit namespace access.
If `deployment.accessible_namespaces` does not have the special value of `'**'`
then the Kiali operator will add a new label to all accessible namespaces - that new
label will be this `label_selector_include` (this label is added regardless if the namespace matches the label_selector_exclude also).
Note that if you do not set this `label_selector_include` setting but `deployment.accessible_namespaces`
does not have the special "all namespaces" entry of `'**'` then this `label_selector_include` will be set
to a default value of `kiali.io/[<deployment.instance_name>.]member-of=<deployment.namespace>`
where `[<deployment.instance_name>.]` is the instance name assigned to the Kiali installation
if it is not the default 'kiali' (otherwise, this is omitted) and `<deployment.namespace>`
is the namespace where Kiali is to be installed.
type: string
auth:
type: object
properties:
strategy:
description: |
Determines what authentication strategy to use when users log into Kiali.
Options are `anonymous`, `token`, `openshift`, `openid`, or `header`.
* Choose `anonymous` to allow full access to Kiali without requiring any credentials.
* Choose `token` to allow access to Kiali using service account tokens, which controls
access based on RBAC roles assigned to the service account.
* Choose `openshift` to use the OpenShift OAuth login which controls access based on
the individual's RBAC roles in OpenShift. Not valid for non-OpenShift environments.
* Choose `openid` to enable OpenID Connect-based authentication. Your cluster is required to
be configured to accept the tokens issued by your IdP. There are additional required
configurations for this strategy. See below for the additional OpenID configuration section.
* Choose `header` when Kiali is running behind a reverse proxy that will inject an
Authorization header and potentially impersonation headers.
When empty, this value will default to `openshift` on OpenShift and `token` on other Kubernetes environments.
type: string
enum: ["","anonymous","token","openshift","openid","header"]
openid:
description: "To learn more about these settings and how to configure the OpenId authentication strategy, read the documentation at https://kiali.io/docs/configuration/authentication/openid/"
type: object
properties:
additional_request_params:
type: object
x-kubernetes-preserve-unknown-fields: true
allowed_domains:
type: array
items:
type: string
api_proxy:
type: string
api_proxy_ca_data:
type: string
api_token:
type: string
authentication_timeout:
type: integer
authorization_endpoint:
type: string
client_id:
type: string
disable_rbac:
type: boolean
http_proxy:
type: string
https_proxy:
type: string
insecure_skip_verify_tls:
type: boolean
issuer_uri:
type: string
scopes:
type: array
items:
type: string
username_claim:
type: string
openshift:
description: "To learn more about these settings and how to configure the OpenShift authentication strategy, read the documentation at https://kiali.io/docs/configuration/authentication/openshift/"
type: object
properties:
auth_timeout:
description: "The amount of time in seconds Kiali will wait for a response from the OpenShift API server when requesting authentication results."
type: integer
client_id:
description: "The full client ID used to identify the OAuth client. If specified, client_id_prefix is ignored."
type: string
client_id_prefix:
description: "The Route resource name and OAuthClient resource name will have this value as its prefix. This value normally should never change. The installer will ensure this value is set correctly. This is ignored if client_id is specified."
type: string
custom_ca:
description: "When set, this is the base64-encoded CA cert used for OpenShift OAuth. When set, use_system_ca is ignored."
type: string
server_prefix:
description: "The protocol://hostname/ used to communicate with the OpenShift cluster during OAuth handshake. Default is `https://kubernetes.default.svc/`."
type: string
token_inactivity_timeout:
description: "Timeout that overrides the default OpenShift token inactivity timeout. This value represents the maximum amount of time in seconds that can occur between consecutive uses of the token. Tokens become invalid if they are not used within this temporal window. If 0, the Kiali tokens never timeout. OpenShift may have a minimum allowed value - see the OpenShift documentation specific for the version of OpenShift you are using. WARNING: existing tokens will not be affected by changing this setting."
type: integer
token_max_age:
description: "A time duration in seconds that overrides the default OpenShift access token max age. If 0 then there will be no expiration of tokens."
type: integer
use_system_ca:
description: "When false, the Kiali serviceaccount CA is used during OpenShift OAuth. When true, the system CA is used. This is ignored if custom_ca is specified. Default is `false`."
type: boolean
custom_dashboards:
description: |
A list of user-defined custom monitoring dashboards that you can use to generate metrics charts
for your applications. The server has some built-in dashboards; if you define a custom dashboard here
with the same name as a built-in dashboard, your custom dashboard takes precedence and will overwrite
the built-in dashboard. You can disable one or more of the built-in dashboards by simply defining an
empty dashboard.
An example of an additional user-defined dashboard,
```
- name: myapp
title: My App Metrics
items:
- chart:
name: "Thread Count"
spans: 4
metricName: "thread-count"
dataType: "raw"
```
An example of disabling a built-in dashboard (in this case, disabling the Envoy dashboard),
```
- name: envoy
```
To learn more about custom monitoring dashboards, see the documentation at https://kiali.io/docs/configuration/custom-dashboard/
type: array
items:
type: object
x-kubernetes-preserve-unknown-fields: true
deployment:
type: object
properties:
accessible_namespaces:
description: "When `cluster_wide_access=false` this must be set to the list of namespaces to which Kiali is to be given permissions. You can provide names using regex expressions matched against all namespaces the operator can see. If left unset it is required that `cluster_wide_access` be `true`, and Kiali will have permissions to all namespaces. The list of namespaces that a user can access is a subset of these namespaces, given that user's RBAC settings."
type: array
items:
type: string
additional_service_yaml:
description: "Additional custom yaml to add to the service definition. This is used mainly to customize the service type. For example, if the `deployment.service_type` is set to 'LoadBalancer' and you want to set the loadBalancerIP, you can do so here with: `additional_service_yaml: { 'loadBalancerIP': '78.11.24.19' }`. Another example would be if the `deployment.service_type` is set to 'ExternalName' you will need to configure the name via: `additional_service_yaml: { 'externalName': 'my.kiali.example.com' }`. A final example would be if external IPs need to be set: `additional_service_yaml: { 'externalIPs': ['80.11.12.10'] }`"
type: object
x-kubernetes-preserve-unknown-fields: true
affinity:
description: "Affinity definitions that are to be used to define the nodes where the Kiali pod should be constrained. See the Kubernetes documentation on Assigning Pods to Nodes for the proper syntax for these three different affinity types."
type: object
properties:
node:
type: object
x-kubernetes-preserve-unknown-fields: true
pod:
type: object
x-kubernetes-preserve-unknown-fields: true
pod_anti:
type: object
x-kubernetes-preserve-unknown-fields: true
cluster_wide_access:
description: "Determines if the Kiali server will be granted cluster-wide permissions to see all namespaces. When true, this provides more efficient caching within the Kiali server. It must be `true` if `deployment.accessible_namespaces` is left unset. To limit the namespaces for which Kiali has permissions, set to `false` and list the desired namespaces in `deployment.accessible_namespaces`. When not set, this value will default to `false` if `deployment.accessible_namespaces` is set to a list of namespaces; otherwise this will be `true`."
type: boolean
configmap_annotations:
description: "Custom annotations to be created on the Kiali ConfigMap."
type: object
x-kubernetes-preserve-unknown-fields: true
custom_secrets:
description: |
Defines additional secrets that are to be mounted in the Kiali pod.
These are useful to contain certs that are used by Kiali to securely connect to third party systems
(for example, see `external_services.tracing.auth.ca_file`).
These secrets must be created by an external mechanism. Kiali will not generate these secrets; it
is assumed these secrets are externally managed. You can define 0, 1, or more secrets.
An example configuration is,
```
custom_secrets:
- name: mysecret
mount: /mysecret-path
- name: my-other-secret
mount: /my-other-secret-location
optional: true
```
type: array
items:
required: ["name", "mount"]
type: object
properties:
name:
description: "The name of the secret that is to be mounted to the Kiali pod's file system. The name of the custom secret must not be the same name as one created by the operator. Names such as `kiali`, `kiali-cert-secret`, and `kiali-cabundle` should not be used as a custom secret name because the operator may want to create one with one of those names."
type: string
mount:
description: "The file path location where the secret content will be mounted. The custom secret cannot be mounted on a path that the operator will use to mount its secrets. Make sure you set your custom secret mount path to a unique, unused path. Paths such as `/kiali-configuration`, `/kiali-cert`, `/kiali-cabundle`, and `/kiali-secret` should not be used as mount paths for custom secrets because the operator may want to use one of those paths."
type: string
optional:
description: "Indicates if the secret may or may not exist at the time the Kiali pod starts. This will default to 'false' if not specified."
type: boolean
hpa:
description: |
Determines what (if any) HorizontalPodAutoscaler should be created to autoscale the Kiali pod.
A typical way to configure HPA for Kiali is,
```
hpa:
api_version: "autoscaling/v2"
spec:
maxReplicas: 2
minReplicas: 1
metrics:
- type: Resource
resource:
name: cpu
target:
type: Utilization
averageUtilization: 50
```
type: object
properties:
api_version:
description: "A specific HPA API version that can be specified in case there is some HPA feature you want to use that is only supported in that specific version. If value is an empty string, an attempt will be made to determine a valid version."
type: string
spec:
description: "The `spec` specified here will be placed in the created HPA resource's 'spec' section. If `spec` is left empty, no HPA resource will be created. Note that you must not specify the 'scaleTargetRef' section in `spec`; the Kiali Operator will populate that for you."
type: object
x-kubernetes-preserve-unknown-fields: true
host_aliases:
description: |
This is content for the Kubernetes 'hostAliases' setting for the Kiali server.
This allows you to modify the Kiali server pod '/etc/hosts' file.
A typical way to configure this setting is,
```
host_aliases:
- ip: 192.168.1.100
hostnames:
- "foo.local"
- "bar.local"
```
For details on the content of this setting, see https://kubernetes.io/docs/tasks/network/customize-hosts-file-for-pods/#adding-additional-entries-with-hostaliases
type: array
items:
type: object
properties:
ip:
type: string
hostnames:
type: array
items:
type: string
image_digest:
description: "If `deployment.image_version` is a digest hash, this value indicates what type of digest it is. A typical value would be 'sha256'. Note: do NOT prefix this value with a '@'."
type: string
image_name:
description: "Determines which Kiali image to download and install. If you set this to a specific name (i.e. you do not leave it as the default empty string), you must make sure that image is supported by the operator. If empty, the operator will use a known supported image name based on which `version` was defined. Note that, as a security measure, a cluster admin may have configured the Kiali operator to ignore this setting. A cluster admin may do this to ensure the Kiali operator only installs a single, specific Kiali version, thus this setting may have no effect depending on how the operator itself was configured."
type: string
image_pull_policy:
description: "The Kubernetes pull policy for the Kiali deployment. This is overridden to be 'Always' if `deployment.image_version` is set to 'latest'."
type: string
image_pull_secrets:
description: "The names of the secrets to be used when container images are to be pulled."
type: array
items:
type: string
image_version:
description: |
Determines which version of Kiali to install.
Choose 'lastrelease' to use the last Kiali release.
Choose 'latest' to use the latest image (which may or may not be a released version of Kiali).
Choose 'operator_version' to use the image whose version is the same as the operator version.
Otherwise, you can set this to any valid Kiali version (such as 'v1.0') or any valid Kiali
digest hash (if you set this to a digest hash, you must indicate the digest in `deployment.image_digest`).
Note that if this is set to 'latest' then the `deployment.image_pull_policy` will be set to 'Always'.
If you set this to a specific version (i.e. you do not leave it as the default empty string),
you must make sure that image is supported by the operator.
If empty, the operator will use a known supported image version based on which 'version' was defined.
Note that, as a security measure, a cluster admin may have configured the Kiali operator to
ignore this setting. A cluster admin may do this to ensure the Kiali operator only installs
a single, specific Kiali version, thus this setting may have no effect depending on how the
operator itself was configured.
type: string
ingress:
description: "Configures if/how the Kiali endpoint should be exposed externally."
type: object
properties:
additional_labels:
description: "Additional labels to add to the Ingress (or Route if on OpenShift). These are added to the labels that are created by default; these do not override the default labels."
type: object
x-kubernetes-preserve-unknown-fields: true
class_name:
description: "If `class_name` is a non-empty string, it will be used as the 'spec.ingressClassName' in the created Kubernetes Ingress resource. This setting is ignored if on OpenShift. This is also ignored if `override_yaml.spec` is defined (i.e. you must define the 'ingressClassName' directly in your override yaml)."
type: string
enabled:
description: "Determines if the Kiali endpoint should be exposed externally. If 'true', an Ingress will be created if on Kubernetes or a Route if on OpenShift. If left undefined, this will be 'false' on Kubernetes and 'true' on OpenShift."
type: boolean
override_yaml:
description: |
Because an Ingress into a cluster can vary wildly in its desired configuration,
this setting provides a way to override complete portions of the Ingress resource
configuration (Ingress on Kubernetes and Route on OpenShift). It is up to the user
to ensure this override YAML configuration is valid and supports the cluster environment
since the operator will blindly copy this custom configuration into the resource it
creates.
This setting is not used if `deployment.ingress.enabled` is set to 'false'.
Note that only 'metadata.annotations' and 'spec' is valid and only they will
be used to override those same sections in the created resource. You can define
either one or both.
Note that `override_yaml.metadata.labels` is not allowed - you cannot override the labels; to add
labels to the default set of labels, use the `deployment.ingress.additional_labels` setting.
Example,
```
override_yaml:
metadata:
annotations:
nginx.ingress.kubernetes.io/secure-backends: "true"
nginx.ingress.kubernetes.io/backend-protocol: "HTTPS"
spec:
rules:
- http:
paths:
- path: /kiali
pathType: Prefix
backend:
service
name: "kiali"
port:
number: 20001
```
type: object
properties:
metadata:
type: object
properties:
annotations:
type: object
x-kubernetes-preserve-unknown-fields: true
spec:
type: object
x-kubernetes-preserve-unknown-fields: true
instance_name:
description: "The instance name of this Kiali installation. This instance name will be the prefix prepended to the names of all Kiali resources created by the operator and will be used to label those resources as belonging to this Kiali installation instance. You cannot change this instance name after a Kiali CR is created. If you attempt to change it, the operator will abort with an error. If you want to change it, you must first delete the original Kiali CR and create a new one. Note that this does not affect the name of the auto-generated signing key secret. If you do not supply a signing key, the operator will create one for you in a secret, but that secret will always be named 'kiali-signing-key' and shared across all Kiali instances in the same deployment namespace. If you want a different signing key secret, you are free to create your own and tell the operator about it via `login_token.signing_key`. See the docs on that setting for more details. Note also that if you are setting this value, you may also want to change the `installation_tag` setting, but this is not required."
type: string
logger:
description: "Configures the logger that emits messages to the Kiali server pod logs."
type: object
properties:
log_level:
description: "The lowest priority of messages to log. Must be one of: `trace`, `debug`, `info`, `warn`, `error`, or `fatal`."
type: string
enum: ["trace","debug","info","warn","error","fatal"]
log_format:
description: "Indicates if the logs should be written with one log message per line or using a JSON format. Must be one of: `text` or `json`."
type: string
enum: ["text","json"]
sampler_rate:
description: "With this setting every sampler_rate-th message will be logged. By default, every message is logged. As an example, setting this to `'2'` means every other message will be logged. The value of this setting is a string but must be parsable as an integer."
type: string
pattern: "^[0-9]+$"
time_field_format:
description: "The log message timestamp format. This supports a golang time format (see https://golang.org/pkg/time/)"
type: string
namespace:
description: "The namespace into which Kiali is to be installed. If this is empty or not defined, the default will be the namespace where the Kiali CR is located."
type: string
node_selector:
description: "A set of node labels that dictate onto which node the Kiali pod will be deployed."
type: object
x-kubernetes-preserve-unknown-fields: true
pod_annotations:
description: "Custom annotations to be created on the Kiali pod."
type: object
x-kubernetes-preserve-unknown-fields: true
pod_labels:
description: |
Custom labels to be created on the Kiali pod.
An example use for this setting is to inject an Istio sidecar such as,
```
sidecar.istio.io/inject: "true"
```
type: object
x-kubernetes-preserve-unknown-fields: true
priority_class_name:
description: "The priorityClassName used to assign the priority of the Kiali pod."
type: string
replicas:
description: "The replica count for the Kiail deployment."
type: integer
resources:
description: |
Defines compute resources that are to be given to the Kiali pod's container. The value is a dict as defined by Kubernetes. See the Kubernetes documentation (https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container).
If you set this to an empty dict (`{}`) then no resources will be defined in the Deployment.
If you do not set this at all, the default is,
```
requests:
cpu: "10m"
memory: "64Mi"
limits:
memory: "1Gi"
```
type: object
x-kubernetes-preserve-unknown-fields: true
secret_name:
description: "The name of a secret used by the Kiali. This secret is optionally used when configuring the OpenID authentication strategy. Consult the OpenID docs for more information at https://kiali.io/docs/configuration/authentication/openid/"
type: string
security_context:
description: "Custom security context to be placed on the server container. The entire security context on the container will be the value of this setting if the operator is configured to allow it. Note that, as a security measure, a cluster admin may have configured the Kiali operator to not allow portions of this override setting - in this case you can specify additional security context settings but you cannot replace existing, default ones."
type: object
x-kubernetes-preserve-unknown-fields: true
service_annotations:
description: "Custom annotations to be created on the Kiali Service resource."
type: object
x-kubernetes-preserve-unknown-fields: true
service_type:
description: "The Kiali service type. Kubernetes determines what values are valid. Common values are 'NodePort', 'ClusterIP', and 'LoadBalancer'."
type: string
tolerations:
description: "A list of tolerations which declare which node taints Kiali can tolerate. See the Kubernetes documentation on Taints and Tolerations for more details."
type: array
items:
type: object
x-kubernetes-preserve-unknown-fields: true
verbose_mode:
description: "DEPRECATED! Determines which priority levels of log messages Kiali will output. Use `deployment.logger` settings instead."
type: string
version_label:
description: |
Kiali resources will be assigned a 'version' label when they are deployed.
This setting determines what value those 'version' labels will have.
When empty, its default will be determined as follows,
* If `deployment.image_version` is 'latest', `version_label` will be fixed to 'master'.
* If `deployment.image_version` is 'lastrelease', `version_label` will be fixed to the last Kiali release version string.
* If `deployment.image_version` is anything else, `version_label` will be that value, too.
type: string
view_only_mode:
description: "When true, Kiali will be in 'view only' mode, allowing the user to view and retrieve management and monitoring data for the service mesh, but not allow the user to modify the service mesh."
type: boolean
external_services:
description: |
These external service configuration settings define how to connect to the external services
like Prometheus, Grafana, and Jaeger.
Regarding sensitive values in the external_services 'auth' sections:
Some external services configured below support an 'auth' sub-section in order to tell Kiali
how it should authenticate with the external services. Credentials used to authenticate Kiali
to those external services can be defined in the `auth.password` and `auth.token` values
within the `auth` sub-section. Because these are sensitive values, you may not want to declare
the actual credentials here in the Kiali CR. In this case, you may store the actual password
or token string in a Kubernetes secret. If you do, you need to set the `auth.password` or
`auth.token` to a value in the format `secret:<secretName>:<secretKey>` where `<secretName>`
is the name of the secret object that Kiali can access, and `<secretKey>` is the name of the
key within the named secret that contains the actual password or token string. For example,
if Grafana requires a password, you can store that password in a secret named 'myGrafanaCredentials'
in a key named 'myGrafanaPw'. In this case, you would set `external_services.grafana.auth.password`
to `secret:myGrafanaCredentials:myGrafanaPw`.
type: object
properties:
custom_dashboards:
description: "Settings for enabling and discovering custom dashboards."
type: object
properties:
discovery_auto_threshold:
description: "Threshold of the number of pods, for a given Application or Workload, above which dashboards discovery will be skipped. This setting only takes effect when `discovery_enabled` is set to 'auto'."
type: integer
discovery_enabled:
description: "Enable, disable or set 'auto' mode to the dashboards discovery process. If set to 'true', Kiali will always try to discover dashboards based on metrics. Note that this can generate performance penalties while discovering dashboards for workloads having many pods (thus many metrics). When set to 'auto', Kiali will skip dashboards discovery for workloads with more than a configured threshold of pods (see `discovery_auto_threshold`). When discovery is disabled or auto/skipped, it is still possible to tie workloads with dashboards through annotations on pods (refer to the doc https://kiali.io/docs/configuration/custom-dashboard/#pod-annotations). Value must be one of: `true`, `false`, `auto`."
type: string
enabled:
description: "Enable or disable custom dashboards, including the dashboards discovery process."
type: boolean
is_core:
description: "Used in the Components health feature. When true, the unhealthy scenarios will be raised as errors. Otherwise, they will be raised as a warning."
type: boolean
namespace_label:
description: "The Prometheus label name used for identifying namespaces in metrics for custom dashboards. The default is `namespace` but you may want to use `kubernetes_namespace` depending on your Prometheus configuration."
type: string
prometheus:
description: "The Prometheus configuration defined here refers to the Prometheus instance that is dedicated to fetching metrics for custom dashboards. This means you can obtain these metrics for the custom dashboards from a Prometheus instance that is different from the one that Istio uses. If this section is omitted, the same Prometheus that is used to obtain the Istio metrics will also be used for retrieving custom dashboard metrics."
type: object
properties:
auth:
description: "Settings used to authenticate with the Prometheus instance."
type: object
properties:
ca_file:
description: "The certificate authority file to use when accessing Prometheus using https. An empty string means no extra certificate authority file is used."
type: string
insecure_skip_verify:
description: "Set true to skip verifying certificate validity when Kiali contacts Prometheus over https."
type: boolean
password:
description: "Password to be used when making requests to Prometheus, for basic authentication. May refer to a secret."
type: string
token:
description: "Token / API key to access Prometheus, for token-based authentication. May refer to a secret."
type: string
type:
description: "The type of authentication to use when contacting the server. Use `bearer` to send the token to the Prometheus server. Use `basic` to connect with username and password credentials. Use `none` to not use any authentication (this is the default)."
type: string
use_kiali_token:
description: "When true and if `auth.type` is `bearer`, Kiali Service Account token will be used for the API calls to Prometheus (in this case, `auth.token` config is ignored)."
type: boolean
username:
description: "Username to be used when making requests to Prometheus with `basic` authentication."
type: string
cache_duration:
description: "Prometheus caching duration expressed in seconds."
type: integer
cache_enabled:
description: "Enable/disable Prometheus caching used for Health services."
type: boolean
cache_expiration:
description: "Prometheus caching expiration expressed in seconds."
type: integer
custom_headers:
description: "A set of name/value settings that will be passed as headers when requests are sent to Prometheus."
type: object
x-kubernetes-preserve-unknown-fields: true
health_check_url:
description: "Used in the Components health feature. This is the url which Kiali will ping to determine whether the component is reachable or not. It defaults to `url` when not provided."
type: string
is_core:
description: "Used in the Components health feature. When true, the unhealthy scenarios will be raised as errors. Otherwise, they will be raised as a warning."
type: boolean
query_scope:
description: "A set of labelName/labelValue settings applied to every Prometheus query. Used to narrow unified metrics to only those scoped to the Kiali instance."
type: object
x-kubernetes-preserve-unknown-fields: true
thanos_proxy:
description: "Define this section if Prometheus is to be queried through a Thanos proxy. Kiali will still use the `url` setting to query for Prometheus metrics so make sure that is set appropriately."
type: object
properties:
enabled:
description: "Set to true when a Thanos proxy is in front of Prometheus."
type: boolean
retention_period:
description: "Thanos Retention period value expresed as a string."
type: string
scrape_interval:
description: "Thanos Scrape interval value expresed as a string."
type: string
url:
description: "The URL used to query the Prometheus Server. This URL must be accessible from the Kiali pod. If empty, the default will assume Prometheus is in the Istio control plane namespace; e.g. `http://prometheus.<istio_namespace>:9090`."
type: string
grafana:
description: "Configuration used to access the Grafana dashboards."
type: object
properties:
auth:
description: "Settings used to authenticate with the Grafana instance."
type: object
properties:
ca_file:
description: "The certificate authority file to use when accessing Grafana using https. An empty string means no extra certificate authority file is used."
type: string
insecure_skip_verify:
description: "Set true to skip verifying certificate validity when Kiali contacts Grafana over https."
type: boolean
password:
description: "Password to be used when making requests to Grafana, for basic authentication. May refer to a secret."
type: string
token:
description: "Token / API key to access Grafana, for token-based authentication. May refer to a secret."
type: string
type:
description: "The type of authentication to use when contacting the server. Use `bearer` to send the token to the Grafana server. Use `basic` to connect with username and password credentials. Use `none` to not use any authentication (this is the default)."
type: string
use_kiali_token:
description: "When true and if `auth.type` is `bearer`, Kiali Service Account token will be used for the API calls to Grafana (in this case, `auth.token` config is ignored)."
type: boolean
username:
description: "Username to be used when making requests to Grafana with `basic` authentication."
type: string
dashboards:
description: "A list of Grafana dashboards that Kiali can link to."
type: array
items:
type: object
properties:
name:
description: "The name of the Grafana dashboard."
type: string
variables:
type: object
properties:
app:
description: "The name of a variable that holds the app name, if used in that dashboard (else it must be omitted)."
type: string
namespace:
description: "The name of a variable that holds the namespace, if used in that dashboard (else it must be omitted)."
type: string
service:
description: "The name of a variable that holds the service name, if used in that dashboard (else it must be omitted)."
type: string
workload:
description: "The name of a variable that holds the workload name, if used in that dashboard (else it must be omitted)."
type: string
enabled:
description: "When true, Grafana support will be enabled in Kiali."
type: boolean
health_check_url:
description: "Used in the Components health feature. This is the URL which Kiali will ping to determine whether the component is reachable or not. It defaults to `in_cluster_url` when not provided."
type: string
in_cluster_url:
description: "The URL used for in-cluster access. An example would be `http://grafana.istio-system:3000`. This URL can contain query parameters if needed, such as '?orgId=1'. If not defined, it will default to `http://grafana.<istio_namespace>:3000`."
type: string
is_core:
description: "Used in the Components health feature. When true, the unhealthy scenarios will be raised as errors. Otherwise, they will be raised as a warning."
type: boolean
url:
description: "The URL that Kiali uses when integrating with Grafana. This URL must be accessible to clients external to the cluster in order for the integration to work properly. If empty, an attempt to auto-discover it is made. This URL can contain query parameters if needed, such as '?orgId=1'."
type: string
istio:
description: "Istio configuration that Kiali needs to know about in order to observe the mesh."
type: object
properties:
component_status:
description: "Istio components whose status will be monitored by Kiali."
type: object
properties:
components:
description: "A specific Istio component whose status will be monitored by Kiali."
type: array
items:
type: object
properties:
app_label:
description: "Istio component pod app label."
type: string
is_core:
description: "Whether the component is to be considered a core component for your deployment."
type: boolean
is_proxy:
description: "Whether the component is a native Envoy proxy."
type: boolean
namespace:
description: "The namespace where the component is installed. It defaults to the Istio control plane namespace (e.g. `istio_namespace`) setting. Note that the Istio documentation suggests you install the ingress and egress to different namespaces, so you most likely will want to explicitly set this namespace value for the ingress and egress components."
type: string
enabled:
description: "Determines if Istio component statuses will be displayed in the Kiali masthead indicator."
type: boolean
config_map_name:
description: "The name of the istio control plane config map."
type: string
envoy_admin_local_port:
description: "The port which kiali will open to fetch envoy config data information."
type: integer
gateway_api_class_name:
description: "The K8s Gateway API GatewayClass's Name used in Istio. If empty, the default value 'istio' is used."
type: string
istio_api_enabled:
description: "Indicates if Kiali has access to istiod. true by default."
type: boolean
istio_canary_revision:
description: "These values are used in Canary upgrade/downgrade functionality when `istio_upgrade_action` is true."
type: object
properties:
current:
description: "The currently installed Istio revision."
type: string
upgrade:
description: "The installed Istio canary revision to upgrade to."
type: string
istio_identity_domain:
description: "The annotation used by Istio to identify domains."
type: string
istio_injection_annotation:
description: "The name of the field that annotates a workload to indicate a sidecar should be automatically injected by Istio. This is the name of a Kubernetes annotation. Note that some Istio implementations also support labels by the same name. In other words, if a workload has a Kubernetes label with this name, that may also trigger automatic sidecar injection."
type: string
istio_sidecar_annotation:
description: "The pod annotation used by Istio to identify the sidecar."
type: string
istio_sidecar_injector_config_map_name:
description: "The name of the istio-sidecar-injector config map."
type: string
istiod_deployment_name:
description: "The name of the istiod deployment."
type: string
istiod_pod_monitoring_port:
description: "The monitoring port of the IstioD pod (not the Service)."
type: integer
root_namespace:
description: "The namespace to treat as the administrative root namespace for Istio configuration."
type: string
url_service_version:
description: "The Istio service used to determine the Istio version. If empty, assumes the URL for the well-known Istio version endpoint."
type: string
prometheus:
description: "The Prometheus configuration defined here refers to the Prometheus instance that is used by Istio to store its telemetry."
type: object
properties:
auth:
description: "Settings used to authenticate with the Prometheus instance."
type: object
properties:
ca_file:
description: "The certificate authority file to use when accessing Prometheus using https. An empty string means no extra certificate authority file is used."
type: string
insecure_skip_verify:
description: "Set true to skip verifying certificate validity when Kiali contacts Prometheus over https."
type: boolean
password:
description: "Password to be used when making requests to Prometheus, for basic authentication. May refer to a secret."
type: string
token:
description: "Token / API key to access Prometheus, for token-based authentication. May refer to a secret."
type: string
type:
description: "The type of authentication to use when contacting the server. Use `bearer` to send the token to the Prometheus server. Use `basic` to connect with username and password credentials. Use `none` to not use any authentication (this is the default)."
type: string
use_kiali_token:
description: "When true and if `auth.type` is `bearer`, Kiali Service Account token will be used for the API calls to Prometheus (in this case, `auth.token` config is ignored)."
type: boolean
username:
description: "Username to be used when making requests to Prometheus with `basic` authentication."
type: string
cache_duration:
description: "Prometheus caching duration expressed in seconds."
type: integer
cache_enabled:
description: "Enable/disable Prometheus caching used for Health services."
type: boolean
cache_expiration:
description: "Prometheus caching expiration expressed in seconds."
type: integer
custom_headers:
description: "A set of name/value settings that will be passed as headers when requests are sent to Prometheus."
type: object
x-kubernetes-preserve-unknown-fields: true
health_check_url:
description: "Used in the Components health feature. This is the url which Kiali will ping to determine whether the component is reachable or not. It defaults to `url` when not provided."
type: string
is_core:
description: "Used in the Components health feature. When true, the unhealthy scenarios will be raised as errors. Otherwise, they will be raised as a warning."
type: boolean
query_scope:
description: "A set of labelName/labelValue settings applied to every Prometheus query. Used to narrow unified metrics to only those scoped to the Kiali instance."
type: object
x-kubernetes-preserve-unknown-fields: true
thanos_proxy:
description: "Define this section if Prometheus is to be queried through a Thanos proxy. Kiali will still use the `url` setting to query for Prometheus metrics so make sure that is set appropriately."
type: object
properties:
enabled:
description: "Set to true when a Thanos proxy is in front of Prometheus."
type: boolean
retention_period:
description: "Thanos Retention period value expresed as a string."
type: string
scrape_interval:
description: "Thanos Scrape interval value expresed as a string."
type: string
url:
description: "The URL used to query the Prometheus Server. This URL must be accessible from the Kiali pod. If empty, the default will assume Prometheus is in the Istio control plane namespace; e.g. `http://prometheus.<istio_namespace>:9090`."
type: string
tracing:
description: "Configuration used to access the Tracing (Jaeger) dashboards."
type: object
properties:
auth:
description: "Settings used to authenticate with the Tracing server instance."
type: object
properties:
ca_file:
description: "The certificate authority file to use when accessing the Tracing server using https. An empty string means no extra certificate authority file is used."
type: string
insecure_skip_verify:
description: "Set true to skip verifying certificate validity when Kiali contacts the Tracing server over https."
type: boolean
password:
description: "Password to be used when making requests to the Tracing server, for basic authentication. May refer to a secret."
type: string
token:
description: "Token / API key to access the Tracing server, for token-based authentication. May refer to a secret."
type: string
type:
description: "The type of authentication to use when contacting the server. Use `bearer` to send the token to the Tracing server. Use `basic` to connect with username and password credentials. Use `none` to not use any authentication (this is the default)."
type: string
use_kiali_token:
description: "When true and if `auth.type` is `bearer`, Kiali Service Account token will be used for the API calls to the Tracing server (in this case, `auth.token` config is ignored)."
type: boolean
username:
description: "Username to be used when making requests to the Tracing server with `basic` authentication."
type: string
enabled:
description: "When true, connections to the Tracing server are enabled. `in_cluster_url` and/or `url` need to be provided."
type: boolean
in_cluster_url:
description: "Set URL for in-cluster access, which enables further integration between Kiali and Jaeger. When not provided, Kiali will only show external links using the `url` setting. Note: Jaeger v1.20+ has separated ports for GRPC(16685) and HTTP(16686) requests. Make sure you use the appropriate port according to the `use_grpc` value. Example: http://tracing.istio-system:16685"
type: string
is_core:
description: "Used in the Components health feature. When true, the unhealthy scenarios will be raised as errors. Otherwise, they will be raised as a warning."
type: boolean
namespace_selector:
description: "Kiali use this boolean to find traces with a namespace selector : service.namespace."
type: boolean
query_scope:
description: "A set of tagKey/tagValue settings applied to every Jaeger query. Used to narrow unified traces to only those scoped to the Kiali instance."
type: object
x-kubernetes-preserve-unknown-fields: true
query_timeout:
description: "The amount of time in seconds Kiali will wait for a response from 'jaeger-query' service when fetching traces."
type: integer
url:
description: "The external URL that will be used to generate links to Jaeger. It must be accessible to clients external to the cluster (e.g: a browser) in order to generate valid links. If the tracing service is deployed with a QUERY_BASE_PATH set, set this URL like https://<hostname>/<QUERY_BASE_PATH>. For example, https://tracing-service:8080/jaeger"
type: string
use_grpc:
description: "Set to true in order to enable GRPC connections between Kiali and Jaeger which will speed up the queries. In some setups you might not be able to use GRPC (e.g. if Jaeger is behind some reverse proxy that doesn't support it). If not specified, this will defalt to 'false' if deployed within a Maistra/OSSM+OpenShift environment, 'true' otherwise."
type: boolean
whitelist_istio_system:
description: "Kiali will get the traces of these services found in the Istio control plane namespace."
type: array
items:
description: "A name of a service found in the Istio control plane namespace whose traces will be retrieved by Kiali."
type: string
health_config:
description: "This section defines what it means for nodes to be healthy. For more details, see https://kiali.io/docs/configuration/health/"
type: object
properties:
rate:
type: array
items:
type: object
properties:
namespace:
description: "The name of the namespace that this configuration applies to. This is a regular expression."
type: string
kind:
description: "The type of resource that this configuration applies to. This is a regular expression."
type: string
name:
description: "The name of a resource that this configuration applies to. This is a regular expression."
type: string
tolerance:
description: "A list of tolerances for this configuration."
type: array
items:
type: object
properties:
protocol:
description: "The protocol that applies for this tolerance (e.g. grpc or http). This is a regular expression."
type: string
direction:
description: "The direction that applies for this tolerance (e.g. inbound or outbound). This is a regular expression."
type: string
code:
description: "The status code that applies for this tolerance. This is a regular expression."
type: string
degraded:
description: "Health will be considered degraded when the telemetry reaches this value (specified as an integer representing a percentage)."
type: integer
failure:
description: "A failure status will be shown when the telemetry reaches this value (specified as an integer representing a percentage)."
type: integer
identity:
description: "Settings that define the Kiali server identity."
type: object
properties:
cert_file:
description: "Certificate file used to identify the Kiali server. If set, you must go over https to access Kiali. The Kiali operator will set this if it deploys Kiali behind https. When left undefined, the operator will attempt to generate a cluster-specific cert file that provides https by default (today, this auto-generation of a cluster-specific cert is only supported on OpenShift). When set to an empty string, https will be disabled."
type: string
private_key_file:
description: "Private key file used to identify the Kiali server. If set, you must go over https to access Kiali. When left undefined, the Kiali operator will attempt to generate a cluster-specific private key file that provides https by default (today, this auto-generation of a cluster-specific private key is only supported on OpenShift). When set to an empty string, https will be disabled."
type: string
istio_labels:
description: "Defines specific labels used by Istio that Kiali needs to know about."
type: object
properties:
app_label_name:
description: "The name of the label used to define what application a workload belongs to. This is typically something like `app` or `app.kubernetes.io/name`."
type: string
injection_label_name:
description: "The name of the label used to instruct Istio to automatically inject sidecar proxies when applications are deployed."
type: string
injection_label_rev:
description: "The label used to identify the Istio revision."
type: string
version_label_name:
description: "The name of the label used to define what version of the application a workload belongs to. This is typically something like `version` or `app.kubernetes.io/version`."
type: string
kiali_feature_flags:
description: "Kiali features that can be enabled or disabled."
type: object
properties: