Skip to content

Commit 0582193

Browse files
istio-testingistio-testing
authored
Automator: update istio.io@ reference docs (#16615)
1 parent ed2812a commit 0582193

File tree

6 files changed

+220
-10
lines changed

6 files changed

+220
-10
lines changed

‎content/en/docs/reference/commands/pilot-discovery/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -268,17 +268,17 @@ <h3 id="pilot-discovery-discovery">pilot-discovery discovery</h3>
268268
<tr>
269269
<td><code>--log_caller &lt;string&gt;</code></td>
270270
<td></td>
271-
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, deltaadsc, file, fullpush, gateway, grpc, grpcgen, ip-autoallocate, klog, krt, kube, model, monitoring, pkica, pkira, probes, processing, retry, rootcertrotator, secretcontroller, security, serverca, serviceentry, spiffe, status, trustBundle, untaint, validation, validationController, validationServer, wasm, wle] (default ``)</td>
271+
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, deltaadsc, file, fullpush, gateway, grpc, grpcgen, ip-autoallocate, klog, krt, kube, model, monitoring, pkica, pkira, probes, processing, retry, rootcertrotator, secretcontroller, security, serverca, serviceentry, spiffe, status, tag-watcher, trustBundle, untaint, validation, validationController, validationServer, wasm, wle] (default ``)</td>
272272
</tr>
273273
<tr>
274274
<td><code>--log_output_level &lt;string&gt;</code></td>
275275
<td></td>
276-
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... where scope can be one of [ads, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, deltaadsc, file, fullpush, gateway, grpc, grpcgen, ip-autoallocate, klog, krt, kube, model, monitoring, pkica, pkira, probes, processing, retry, rootcertrotator, secretcontroller, security, serverca, serviceentry, spiffe, status, trustBundle, untaint, validation, validationController, validationServer, wasm, wle] and level can be one of [debug, info, warn, error, fatal, none] (default ``)</td>
276+
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... where scope can be one of [ads, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, deltaadsc, file, fullpush, gateway, grpc, grpcgen, ip-autoallocate, klog, krt, kube, model, monitoring, pkica, pkira, probes, processing, retry, rootcertrotator, secretcontroller, security, serverca, serviceentry, spiffe, status, tag-watcher, trustBundle, untaint, validation, validationController, validationServer, wasm, wle] and level can be one of [debug, info, warn, error, fatal, none] (default ``)</td>
277277
</tr>
278278
<tr>
279279
<td><code>--log_stacktrace_level &lt;string&gt;</code></td>
280280
<td></td>
281-
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope:level&gt;,... where scope can be one of [ads, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, deltaadsc, file, fullpush, gateway, grpc, grpcgen, ip-autoallocate, klog, krt, kube, model, monitoring, pkica, pkira, probes, processing, retry, rootcertrotator, secretcontroller, security, serverca, serviceentry, spiffe, status, trustBundle, untaint, validation, validationController, validationServer, wasm, wle] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
281+
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope:level&gt;,... where scope can be one of [ads, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, deltaadsc, file, fullpush, gateway, grpc, grpcgen, ip-autoallocate, klog, krt, kube, model, monitoring, pkica, pkira, probes, processing, retry, rootcertrotator, secretcontroller, security, serverca, serviceentry, spiffe, status, tag-watcher, trustBundle, untaint, validation, validationController, validationServer, wasm, wle] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
282282
</tr>
283283
<tr>
284284
<td><code>--log_target &lt;stringArray&gt;</code></td>

‎content/en/docs/reference/config/istio.mesh.v1alpha1/index.html

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
layout: protoc-gen-docs
88
generator: protoc-gen-docs
99
weight: 20
10-
number_of_entries: 80
10+
number_of_entries: 81
1111
---
1212
<p>Configuration affecting the service mesh as a whole.</p>
1313

@@ -1016,6 +1016,18 @@ <h3 id="MeshConfig-ExtensionProvider">ExtensionProvider</h3>
10161016
<td>
10171017
<p>Configures an Envoy Open Telemetry Access Logging Service provider.</p>
10181018

1019+
</td>
1020+
</tr>
1021+
<tr id="MeshConfig-ExtensionProvider-sds" class="oneof">
1022+
<td><div class="field"><div class="name"><code><a href="#MeshConfig-ExtensionProvider-sds">sds</a></code></div>
1023+
<div class="type"><a href="#MeshConfig-ExtensionProvider-SDSProvider">SDSProvider (oneof)</a></div>
1024+
</div></td>
1025+
<td>
1026+
<p>Configures an Extension Provider for SDS. This can be used to
1027+
configure an external SDS service to supply secrets for certain Gateways for example.
1028+
This is useful for scenarios where the secrets are stored in an external secret store like Vault.
1029+
The secret should be configured with sds://provider-name format.</p>
1030+
10191031
</td>
10201032
</tr>
10211033
</tbody>
@@ -2400,6 +2412,52 @@ <h6 id="MeshConfig-ExtensionProvider-OpenTelemetryTracingProvider-DynatraceSampl
24002412
<td>
24012413
<p>REQUIRED. Specifies sampling configuration URI.</p>
24022414

2415+
</td>
2416+
</tr>
2417+
</tbody>
2418+
</table>
2419+
</section>
2420+
<h4 id="MeshConfig-ExtensionProvider-SDSProvider">SDSProvider</h4>
2421+
<section>
2422+
<p>Defines configuration for an Gateway SDS provider.</p>
2423+
2424+
<table class="message-fields">
2425+
<thead>
2426+
<tr>
2427+
<th>Field</th>
2428+
<th>Description</th>
2429+
</tr>
2430+
</thead>
2431+
<tbody>
2432+
<tr id="MeshConfig-ExtensionProvider-SDSProvider-name">
2433+
<td><div class="field"><div class="name"><code><a href="#MeshConfig-ExtensionProvider-SDSProvider-name">name</a></code></div>
2434+
<div class="type">string</div>
2435+
</div></td>
2436+
<td>
2437+
<p>REQUIRED. Specifies the name of the provider. This should be used to configure the Gateway SDS.</p>
2438+
2439+
</td>
2440+
</tr>
2441+
<tr id="MeshConfig-ExtensionProvider-SDSProvider-service">
2442+
<td><div class="field"><div class="name"><code><a href="#MeshConfig-ExtensionProvider-SDSProvider-service">service</a></code></div>
2443+
<div class="type">string</div>
2444+
</div></td>
2445+
<td>
2446+
<p>REQUIRED. Specifies the service that implements the SDS service.
2447+
The format is <code>[&lt;Namespace&gt;/]&lt;Hostname&gt;</code>. The specification of <code>&lt;Namespace&gt;</code> is required only when it is insufficient
2448+
to unambiguously resolve a service in the service registry. The <code>&lt;Hostname&gt;</code> is a fully qualified host name of a
2449+
service defined by the Kubernetes service or ServiceEntry.</p>
2450+
<p>Example: &ldquo;gateway-sds.foo.svc.cluster.local&rdquo; or &ldquo;bar/gateway-sds.example.com&rdquo;.</p>
2451+
2452+
</td>
2453+
</tr>
2454+
<tr id="MeshConfig-ExtensionProvider-SDSProvider-port">
2455+
<td><div class="field"><div class="name"><code><a href="#MeshConfig-ExtensionProvider-SDSProvider-port">port</a></code></div>
2456+
<div class="type">uint32</div>
2457+
</div></td>
2458+
<td>
2459+
<p>REQUIRED. Specifies the port of the service.</p>
2460+
24032461
</td>
24042462
</tr>
24052463
</tbody>

‎content/en/docs/reference/config/networking/destination-rule/index.html

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
generator: protoc-gen-docs
99
schema: istio.networking.v1alpha3.DestinationRule
1010
aliases: [/docs/reference/config/networking/v1alpha3/destination-rule]
11-
number_of_entries: 26
11+
number_of_entries: 27
1212
---
1313
<p><code>DestinationRule</code> defines policies that apply to traffic intended for a
1414
service after routing has occurred. These rules specify configuration
@@ -269,6 +269,15 @@ <h2 id="TrafficPolicy">TrafficPolicy</h2>
269269
<td>
270270
<p>The upstream PROXY protocol settings.</p>
271271

272+
</td>
273+
</tr>
274+
<tr id="TrafficPolicy-retry_budget">
275+
<td><div class="field"><div class="name"><code><a href="#TrafficPolicy-retry_budget">retryBudget</a></code></div>
276+
<div class="type"><a href="#TrafficPolicy-RetryBudget">RetryBudget</a></div>
277+
</div></td>
278+
<td>
279+
<p>Specifies a limit on concurrent retries in relation to the number of active requests.</p>
280+
272281
</td>
273282
</tr>
274283
</tbody>
@@ -430,6 +439,44 @@ <h4 id="TrafficPolicy-ProxyProtocol-VERSION">VERSION</h4>
430439
<td>
431440
<p>⁣PROXY protocol version 2. Binary format.</p>
432441

442+
</td>
443+
</tr>
444+
</tbody>
445+
</table>
446+
</section>
447+
<h3 id="TrafficPolicy-RetryBudget">RetryBudget</h3>
448+
<section>
449+
<table class="message-fields">
450+
<thead>
451+
<tr>
452+
<th>Field</th>
453+
<th>Description</th>
454+
</tr>
455+
</thead>
456+
<tbody>
457+
<tr id="TrafficPolicy-RetryBudget-percent">
458+
<td><div class="field"><div class="name"><code><a href="#TrafficPolicy-RetryBudget-percent">percent</a></code></div>
459+
<div class="type"><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#doublevalue">DoubleValue</a></div>
460+
</div></td>
461+
<td>
462+
<p>Specifies the limit on concurrent retries as a percentage of
463+
the sum of active requests and active pending requests.
464+
Defaults to 20%.</p>
465+
466+
</td>
467+
</tr>
468+
<tr id="TrafficPolicy-RetryBudget-min_retry_concurrency">
469+
<td><div class="field"><div class="name"><code><a href="#TrafficPolicy-RetryBudget-min_retry_concurrency">minRetryConcurrency</a></code></div>
470+
<div class="type">uint32</div>
471+
</div></td>
472+
<td>
473+
<p>Specifies the minimum retry concurrency allowed for the retry budget.
474+
For example, a budget of 20% with a minimum retry concurrency of 3
475+
will allow 5 active retries while there are 25 active requests.
476+
If there are 2 active requests, there are still 3 active retries
477+
allowed because of the minimum retry concurrency.</p>
478+
<p>Defaults to 3.</p>
479+
433480
</td>
434481
</tr>
435482
</tbody>

‎content/zh/docs/reference/commands/pilot-discovery/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -268,17 +268,17 @@ <h3 id="pilot-discovery-discovery">pilot-discovery discovery</h3>
268268
<tr>
269269
<td><code>--log_caller &lt;string&gt;</code></td>
270270
<td></td>
271-
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, deltaadsc, file, fullpush, gateway, grpc, grpcgen, ip-autoallocate, klog, krt, kube, model, monitoring, pkica, pkira, probes, processing, retry, rootcertrotator, secretcontroller, security, serverca, serviceentry, spiffe, status, trustBundle, untaint, validation, validationController, validationServer, wasm, wle] (default ``)</td>
271+
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, deltaadsc, file, fullpush, gateway, grpc, grpcgen, ip-autoallocate, klog, krt, kube, model, monitoring, pkica, pkira, probes, processing, retry, rootcertrotator, secretcontroller, security, serverca, serviceentry, spiffe, status, tag-watcher, trustBundle, untaint, validation, validationController, validationServer, wasm, wle] (default ``)</td>
272272
</tr>
273273
<tr>
274274
<td><code>--log_output_level &lt;string&gt;</code></td>
275275
<td></td>
276-
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... where scope can be one of [ads, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, deltaadsc, file, fullpush, gateway, grpc, grpcgen, ip-autoallocate, klog, krt, kube, model, monitoring, pkica, pkira, probes, processing, retry, rootcertrotator, secretcontroller, security, serverca, serviceentry, spiffe, status, trustBundle, untaint, validation, validationController, validationServer, wasm, wle] and level can be one of [debug, info, warn, error, fatal, none] (default ``)</td>
276+
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... where scope can be one of [ads, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, deltaadsc, file, fullpush, gateway, grpc, grpcgen, ip-autoallocate, klog, krt, kube, model, monitoring, pkica, pkira, probes, processing, retry, rootcertrotator, secretcontroller, security, serverca, serviceentry, spiffe, status, tag-watcher, trustBundle, untaint, validation, validationController, validationServer, wasm, wle] and level can be one of [debug, info, warn, error, fatal, none] (default ``)</td>
277277
</tr>
278278
<tr>
279279
<td><code>--log_stacktrace_level &lt;string&gt;</code></td>
280280
<td></td>
281-
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope:level&gt;,... where scope can be one of [ads, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, deltaadsc, file, fullpush, gateway, grpc, grpcgen, ip-autoallocate, klog, krt, kube, model, monitoring, pkica, pkira, probes, processing, retry, rootcertrotator, secretcontroller, security, serverca, serviceentry, spiffe, status, trustBundle, untaint, validation, validationController, validationServer, wasm, wle] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
281+
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope:level&gt;,... where scope can be one of [ads, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, deltaadsc, file, fullpush, gateway, grpc, grpcgen, ip-autoallocate, klog, krt, kube, model, monitoring, pkica, pkira, probes, processing, retry, rootcertrotator, secretcontroller, security, serverca, serviceentry, spiffe, status, tag-watcher, trustBundle, untaint, validation, validationController, validationServer, wasm, wle] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
282282
</tr>
283283
<tr>
284284
<td><code>--log_target &lt;stringArray&gt;</code></td>

‎content/zh/docs/reference/config/istio.mesh.v1alpha1/index.html

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
layout: protoc-gen-docs
88
generator: protoc-gen-docs
99
weight: 20
10-
number_of_entries: 80
10+
number_of_entries: 81
1111
---
1212
<p>Configuration affecting the service mesh as a whole.</p>
1313

@@ -1016,6 +1016,18 @@ <h3 id="MeshConfig-ExtensionProvider">ExtensionProvider</h3>
10161016
<td>
10171017
<p>Configures an Envoy Open Telemetry Access Logging Service provider.</p>
10181018

1019+
</td>
1020+
</tr>
1021+
<tr id="MeshConfig-ExtensionProvider-sds" class="oneof">
1022+
<td><div class="field"><div class="name"><code><a href="#MeshConfig-ExtensionProvider-sds">sds</a></code></div>
1023+
<div class="type"><a href="#MeshConfig-ExtensionProvider-SDSProvider">SDSProvider (oneof)</a></div>
1024+
</div></td>
1025+
<td>
1026+
<p>Configures an Extension Provider for SDS. This can be used to
1027+
configure an external SDS service to supply secrets for certain Gateways for example.
1028+
This is useful for scenarios where the secrets are stored in an external secret store like Vault.
1029+
The secret should be configured with sds://provider-name format.</p>
1030+
10191031
</td>
10201032
</tr>
10211033
</tbody>
@@ -2400,6 +2412,52 @@ <h6 id="MeshConfig-ExtensionProvider-OpenTelemetryTracingProvider-DynatraceSampl
24002412
<td>
24012413
<p>REQUIRED. Specifies sampling configuration URI.</p>
24022414

2415+
</td>
2416+
</tr>
2417+
</tbody>
2418+
</table>
2419+
</section>
2420+
<h4 id="MeshConfig-ExtensionProvider-SDSProvider">SDSProvider</h4>
2421+
<section>
2422+
<p>Defines configuration for an Gateway SDS provider.</p>
2423+
2424+
<table class="message-fields">
2425+
<thead>
2426+
<tr>
2427+
<th>Field</th>
2428+
<th>Description</th>
2429+
</tr>
2430+
</thead>
2431+
<tbody>
2432+
<tr id="MeshConfig-ExtensionProvider-SDSProvider-name">
2433+
<td><div class="field"><div class="name"><code><a href="#MeshConfig-ExtensionProvider-SDSProvider-name">name</a></code></div>
2434+
<div class="type">string</div>
2435+
</div></td>
2436+
<td>
2437+
<p>REQUIRED. Specifies the name of the provider. This should be used to configure the Gateway SDS.</p>
2438+
2439+
</td>
2440+
</tr>
2441+
<tr id="MeshConfig-ExtensionProvider-SDSProvider-service">
2442+
<td><div class="field"><div class="name"><code><a href="#MeshConfig-ExtensionProvider-SDSProvider-service">service</a></code></div>
2443+
<div class="type">string</div>
2444+
</div></td>
2445+
<td>
2446+
<p>REQUIRED. Specifies the service that implements the SDS service.
2447+
The format is <code>[&lt;Namespace&gt;/]&lt;Hostname&gt;</code>. The specification of <code>&lt;Namespace&gt;</code> is required only when it is insufficient
2448+
to unambiguously resolve a service in the service registry. The <code>&lt;Hostname&gt;</code> is a fully qualified host name of a
2449+
service defined by the Kubernetes service or ServiceEntry.</p>
2450+
<p>Example: &ldquo;gateway-sds.foo.svc.cluster.local&rdquo; or &ldquo;bar/gateway-sds.example.com&rdquo;.</p>
2451+
2452+
</td>
2453+
</tr>
2454+
<tr id="MeshConfig-ExtensionProvider-SDSProvider-port">
2455+
<td><div class="field"><div class="name"><code><a href="#MeshConfig-ExtensionProvider-SDSProvider-port">port</a></code></div>
2456+
<div class="type">uint32</div>
2457+
</div></td>
2458+
<td>
2459+
<p>REQUIRED. Specifies the port of the service.</p>
2460+
24032461
</td>
24042462
</tr>
24052463
</tbody>

‎content/zh/docs/reference/config/networking/destination-rule/index.html

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
generator: protoc-gen-docs
99
schema: istio.networking.v1alpha3.DestinationRule
1010
aliases: [/zh/docs/reference/config/networking/v1alpha3/destination-rule]
11-
number_of_entries: 26
11+
number_of_entries: 27
1212
---
1313
<p><code>DestinationRule</code> defines policies that apply to traffic intended for a
1414
service after routing has occurred. These rules specify configuration
@@ -269,6 +269,15 @@ <h2 id="TrafficPolicy">TrafficPolicy</h2>
269269
<td>
270270
<p>The upstream PROXY protocol settings.</p>
271271

272+
</td>
273+
</tr>
274+
<tr id="TrafficPolicy-retry_budget">
275+
<td><div class="field"><div class="name"><code><a href="#TrafficPolicy-retry_budget">retryBudget</a></code></div>
276+
<div class="type"><a href="#TrafficPolicy-RetryBudget">RetryBudget</a></div>
277+
</div></td>
278+
<td>
279+
<p>Specifies a limit on concurrent retries in relation to the number of active requests.</p>
280+
272281
</td>
273282
</tr>
274283
</tbody>
@@ -430,6 +439,44 @@ <h4 id="TrafficPolicy-ProxyProtocol-VERSION">VERSION</h4>
430439
<td>
431440
<p>⁣PROXY protocol version 2. Binary format.</p>
432441

442+
</td>
443+
</tr>
444+
</tbody>
445+
</table>
446+
</section>
447+
<h3 id="TrafficPolicy-RetryBudget">RetryBudget</h3>
448+
<section>
449+
<table class="message-fields">
450+
<thead>
451+
<tr>
452+
<th>Field</th>
453+
<th>Description</th>
454+
</tr>
455+
</thead>
456+
<tbody>
457+
<tr id="TrafficPolicy-RetryBudget-percent">
458+
<td><div class="field"><div class="name"><code><a href="#TrafficPolicy-RetryBudget-percent">percent</a></code></div>
459+
<div class="type"><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#doublevalue">DoubleValue</a></div>
460+
</div></td>
461+
<td>
462+
<p>Specifies the limit on concurrent retries as a percentage of
463+
the sum of active requests and active pending requests.
464+
Defaults to 20%.</p>
465+
466+
</td>
467+
</tr>
468+
<tr id="TrafficPolicy-RetryBudget-min_retry_concurrency">
469+
<td><div class="field"><div class="name"><code><a href="#TrafficPolicy-RetryBudget-min_retry_concurrency">minRetryConcurrency</a></code></div>
470+
<div class="type">uint32</div>
471+
</div></td>
472+
<td>
473+
<p>Specifies the minimum retry concurrency allowed for the retry budget.
474+
For example, a budget of 20% with a minimum retry concurrency of 3
475+
will allow 5 active retries while there are 25 active requests.
476+
If there are 2 active requests, there are still 3 active retries
477+
allowed because of the minimum retry concurrency.</p>
478+
<p>Defaults to 3.</p>
479+
433480
</td>
434481
</tr>
435482
</tbody>

0 commit comments

Comments
 (0)