Skip to content

Commit a8dfb20

Browse files
author
kiali-bot
committed
Auto-generated CRD schema documentation
1 parent 6f9c26c commit a8dfb20

File tree

1 file changed

+196
-1
lines changed

1 file changed

+196
-1
lines changed

‎content/en/docs/Configuration/kialis.kiali.io.md‎

Lines changed: 196 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,8 @@ spec:
229229
sampler_rate: "1"
230230
time_field_format: "2006-01-02T15:04:05Z07:00"
231231
namespace: "istio-system"
232+
network_policy:
233+
enabled: true
232234
# default: node_selector is empty
233235
node_selector:
234236
nodeSelector: "nodeSelectorValue"
@@ -442,7 +444,10 @@ spec:
442444
cache_capacity: 200
443445
cache_enabled: true
444446
datasource_uid: ""
447+
name: ""
448+
namespace: ""
445449
org_id: ""
450+
tenant: ""
446451
url_format: "grafana"
447452
use_grpc: true
448453
whitelist_istio_system: ["jaeger-query", "istio-ingressgateway"]
@@ -477,6 +482,11 @@ spec:
477482
kiali_feature_flags:
478483
clustering:
479484
enable_exec_provider: false
485+
# default: custom_workload_types is an empty list
486+
custom_workload_types:
487+
- group: "argoproj.io"
488+
version: "v1alpha1"
489+
kind: "Rollout"
480490
disabled_features: []
481491
istio_annotation_action: true
482492
istio_injection_action: true
@@ -2880,6 +2890,44 @@ Example,</p>
28802890
</div>
28812891
</div>
28822892
2893+
<div class="property depth-2">
2894+
<div class="property-header">
2895+
<hr/>
2896+
<h3 class="property-path" id=".spec.deployment.network_policy">.spec.deployment.network_policy</h3>
2897+
</div>
2898+
<div class="property-body">
2899+
<div class="property-meta">
2900+
<span class="property-type">(object)</span>
2901+
2902+
</div>
2903+
2904+
<div class="property-description">
2905+
<p>Configures if the Kiali server pod should be protected by a NetworkPolicy resource that restricts both ingress and egress traffic.</p>
2906+
2907+
</div>
2908+
2909+
</div>
2910+
</div>
2911+
2912+
<div class="property depth-3">
2913+
<div class="property-header">
2914+
<hr/>
2915+
<h3 class="property-path" id=".spec.deployment.network_policy.enabled">.spec.deployment.network_policy.enabled</h3>
2916+
</div>
2917+
<div class="property-body">
2918+
<div class="property-meta">
2919+
<span class="property-type">(boolean)</span>
2920+
2921+
</div>
2922+
2923+
<div class="property-description">
2924+
<p>If true, a NetworkPolicy resource is created to restrict traffic to the Kiali server pod. The NetworkPolicy will allow ingress traffic only to the Kiali server API port and, if enabled, the metrics port.</p>
2925+
2926+
</div>
2927+
2928+
</div>
2929+
</div>
2930+
28832931
<div class="property depth-2">
28842932
<div class="property-header">
28852933
<hr/>
@@ -6495,6 +6543,44 @@ to <code>secret:myGrafanaCredentials:myGrafanaPw</code>.</p>
64956543
</div>
64966544
</div>
64976545
6546+
<div class="property depth-4">
6547+
<div class="property-header">
6548+
<hr/>
6549+
<h3 class="property-path" id=".spec.external_services.tracing.tempo_config.name">.spec.external_services.tracing.tempo_config.name</h3>
6550+
</div>
6551+
<div class="property-body">
6552+
<div class="property-meta">
6553+
<span class="property-type">(string)</span>
6554+
6555+
</div>
6556+
6557+
<div class="property-description">
6558+
<p>The name of the Tempo instance for the <code>url_format</code> of <code>openshift</code> in the Plugin UI.</p>
6559+
6560+
</div>
6561+
6562+
</div>
6563+
</div>
6564+
6565+
<div class="property depth-4">
6566+
<div class="property-header">
6567+
<hr/>
6568+
<h3 class="property-path" id=".spec.external_services.tracing.tempo_config.namespace">.spec.external_services.tracing.tempo_config.namespace</h3>
6569+
</div>
6570+
<div class="property-body">
6571+
<div class="property-meta">
6572+
<span class="property-type">(string)</span>
6573+
6574+
</div>
6575+
6576+
<div class="property-description">
6577+
<p>The namespace of the Tempo instance for the <code>url_format</code> of <code>openshift</code> in the Plugin UI.</p>
6578+
6579+
</div>
6580+
6581+
</div>
6582+
</div>
6583+
64986584
<div class="property depth-4">
64996585
<div class="property-header">
65006586
<hr/>
@@ -6514,6 +6600,25 @@ to <code>secret:myGrafanaCredentials:myGrafanaPw</code>.</p>
65146600
</div>
65156601
</div>
65166602
6603+
<div class="property depth-4">
6604+
<div class="property-header">
6605+
<hr/>
6606+
<h3 class="property-path" id=".spec.external_services.tracing.tempo_config.tenant">.spec.external_services.tracing.tempo_config.tenant</h3>
6607+
</div>
6608+
<div class="property-body">
6609+
<div class="property-meta">
6610+
<span class="property-type">(string)</span>
6611+
6612+
</div>
6613+
6614+
<div class="property-description">
6615+
<p>The name of the Tempo tenant for the <code>url_format</code> of <code>openshift</code> in the Plugin UI.</p>
6616+
6617+
</div>
6618+
6619+
</div>
6620+
</div>
6621+
65176622
<div class="property depth-4">
65186623
<div class="property-header">
65196624
<hr/>
@@ -6526,7 +6631,7 @@ to <code>secret:myGrafanaCredentials:myGrafanaPw</code>.</p>
65266631
</div>
65276632
65286633
<div class="property-description">
6529-
<p>The URL format for the external url. Can be &lsquo;jaeger&rsquo; or &lsquo;grafana&rsquo;. Default to &lsquo;grafana&rsquo;. Grafana will need a Grafana url in the Grafana settings.</p>
6634+
<p>The URL format for the external url. Can be &lsquo;jaeger&rsquo;, &lsquo;grafana&rsquo; or &lsquo;openshift&rsquo;. Default to &lsquo;grafana&rsquo;. Openshift will need the name, namespace and tenant in the <code>tempo_config</code> settings.</p>
65306635
65316636
</div>
65326637
@@ -7434,6 +7539,96 @@ to <code>secret:myGrafanaCredentials:myGrafanaPw</code>.</p>
74347539
</div>
74357540
</div>
74367541
7542+
<div class="property depth-2">
7543+
<div class="property-header">
7544+
<hr/>
7545+
<h3 class="property-path" id=".spec.kiali_feature_flags.custom_workload_types">.spec.kiali_feature_flags.custom_workload_types</h3>
7546+
</div>
7547+
<div class="property-body">
7548+
<div class="property-meta">
7549+
<span class="property-type">(array)</span>
7550+
7551+
</div>
7552+
7553+
<div class="property-description">
7554+
<p>Enable observability tabs (Traffic, Logs, Metrics, Traces) for custom workload types beyond the built-in Kubernetes controllers.</p>
7555+
7556+
</div>
7557+
7558+
</div>
7559+
</div>
7560+
7561+
<div class="property depth-3">
7562+
<div class="property-header">
7563+
<hr/>
7564+
<h3 class="property-path" id=".spec.kiali_feature_flags.custom_workload_types[*]">.spec.kiali_feature_flags.custom_workload_types[*]</h3>
7565+
</div>
7566+
<div class="property-body">
7567+
<div class="property-meta">
7568+
<span class="property-type">(object)</span>
7569+
7570+
</div>
7571+
7572+
</div>
7573+
</div>
7574+
7575+
<div class="property depth-4">
7576+
<div class="property-header">
7577+
<hr/>
7578+
<h3 class="property-path" id=".spec.kiali_feature_flags.custom_workload_types[*].group">.spec.kiali_feature_flags.custom_workload_types[*].group</h3>
7579+
</div>
7580+
<div class="property-body">
7581+
<div class="property-meta">
7582+
<span class="property-type">(string)</span>
7583+
<span class="property-required">*Required*</span>
7584+
</div>
7585+
7586+
<div class="property-description">
7587+
<p>The API group of the custom workload type (e.g., &lsquo;argoproj.io&rsquo;).</p>
7588+
7589+
</div>
7590+
7591+
</div>
7592+
</div>
7593+
7594+
<div class="property depth-4">
7595+
<div class="property-header">
7596+
<hr/>
7597+
<h3 class="property-path" id=".spec.kiali_feature_flags.custom_workload_types[*].kind">.spec.kiali_feature_flags.custom_workload_types[*].kind</h3>
7598+
</div>
7599+
<div class="property-body">
7600+
<div class="property-meta">
7601+
<span class="property-type">(string)</span>
7602+
<span class="property-required">*Required*</span>
7603+
</div>
7604+
7605+
<div class="property-description">
7606+
<p>The kind of the custom workload type (e.g., &lsquo;Rollout&rsquo;).</p>
7607+
7608+
</div>
7609+
7610+
</div>
7611+
</div>
7612+
7613+
<div class="property depth-4">
7614+
<div class="property-header">
7615+
<hr/>
7616+
<h3 class="property-path" id=".spec.kiali_feature_flags.custom_workload_types[*].version">.spec.kiali_feature_flags.custom_workload_types[*].version</h3>
7617+
</div>
7618+
<div class="property-body">
7619+
<div class="property-meta">
7620+
<span class="property-type">(string)</span>
7621+
<span class="property-required">*Required*</span>
7622+
</div>
7623+
7624+
<div class="property-description">
7625+
<p>The API version of the custom workload type (e.g., &lsquo;v1alpha1&rsquo;).</p>
7626+
7627+
</div>
7628+
7629+
</div>
7630+
</div>
7631+
74377632
<div class="property depth-2">
74387633
<div class="property-header">
74397634
<hr/>

0 commit comments

Comments
 (0)