Automator: update istio.io@ reference docs (#12414)

This commit is contained in:
Istio Automation 2022-12-23 18:52:24 -08:00 committed by GitHub
parent 3e3cbe44a3
commit d0c391ec56
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 128 additions and 2 deletions

View File

@ -270,6 +270,11 @@ debug and diagnose their Istio mesh.
<td>Process directory arguments recursively. Useful when you want to analyze related manifests organized within the same directory. </td>
</tr>
<tr>
<td><code>--revision &lt;string&gt;</code></td>
<td></td>
<td>analyze a specific revision deployed. (default `default`)</td>
</tr>
<tr>
<td><code>--suppress &lt;stringArray&gt;</code></td>
<td><code>-S</code></td>
<td>Suppress reporting a message code on a specific resource. Values are supplied in the form &lt;code&gt;=&lt;resource&gt; (e.g. &#39;--suppress &#34;IST0102=DestinationRule primary-dr.default&#34;&#39;). Can be repeated. You can include the wildcard character &#39;*&#39; to support a partial match (e.g. &#39;--suppress &#34;IST0102=DestinationRule *.default&#34; ). (default `[]`)</td>
@ -300,6 +305,9 @@ debug and diagnose their Istio mesh.
<pre class="language-bash"><code> # Analyze the current live cluster
istioctl analyze
# Analyze the current live cluster for a specific revision
istioctl analyze --revision 1-16
# Analyze the current live cluster, simulating the effect of applying additional yaml files
istioctl analyze a.yaml b.yaml my-app-config/

View File

@ -7,7 +7,7 @@ location: https://istio.io/docs/reference/config/istio.mesh.v1alpha1.html
layout: protoc-gen-docs
generator: protoc-gen-docs
weight: 20
number_of_entries: 55
number_of_entries: 56
---
<p>Configuration affecting the service mesh as a whole.</p>
@ -2181,6 +2181,61 @@ No
<p>Optional. Format for the proxy access log
Empty value results in proxy&rsquo;s default access log format, following Envoy access logging formatting.</p>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="MeshConfig-ExtensionProvider-OpenTelemetryTracingProvider">MeshConfig.ExtensionProvider.OpenTelemetryTracingProvider</h2>
<section>
<p>Defines configuration for an OpenTelemetry tracing backend. Istio 1.16.1 or higher is needed.</p>
<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="MeshConfig-ExtensionProvider-OpenTelemetryTracingProvider-service">
<td><code>service</code></td>
<td><code>string</code></td>
<td>
<p>REQUIRED. Specifies the OpenTelemetry endpoint that will receive OTLP traces.
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
to unambiguously resolve a service in the service registry. The <code>&lt;Hostname&gt;</code> is a fully qualified host name of a
service defined by the Kubernetes service or ServiceEntry.</p>
<p>Example: &ldquo;otlp.default.svc.cluster.local&rdquo; or &ldquo;bar/otlp.example.com&rdquo;.</p>
</td>
<td>
No
</td>
</tr>
<tr id="MeshConfig-ExtensionProvider-OpenTelemetryTracingProvider-port">
<td><code>port</code></td>
<td><code>uint32</code></td>
<td>
<p>REQUIRED. Specifies the port of the service.</p>
</td>
<td>
No
</td>
</tr>
<tr id="MeshConfig-ExtensionProvider-OpenTelemetryTracingProvider-max_tag_length">
<td><code>maxTagLength</code></td>
<td><code>uint32</code></td>
<td>
<p>Optional. Controls the overall path length allowed in a reported span.
NOTE: currently only controls max length of the path tag.</p>
</td>
<td>
No

View File

@ -270,6 +270,11 @@ debug and diagnose their Istio mesh.
<td>Process directory arguments recursively. Useful when you want to analyze related manifests organized within the same directory. </td>
</tr>
<tr>
<td><code>--revision &lt;string&gt;</code></td>
<td></td>
<td>analyze a specific revision deployed. (default `default`)</td>
</tr>
<tr>
<td><code>--suppress &lt;stringArray&gt;</code></td>
<td><code>-S</code></td>
<td>Suppress reporting a message code on a specific resource. Values are supplied in the form &lt;code&gt;=&lt;resource&gt; (e.g. &#39;--suppress &#34;IST0102=DestinationRule primary-dr.default&#34;&#39;). Can be repeated. You can include the wildcard character &#39;*&#39; to support a partial match (e.g. &#39;--suppress &#34;IST0102=DestinationRule *.default&#34; ). (default `[]`)</td>
@ -300,6 +305,9 @@ debug and diagnose their Istio mesh.
<pre class="language-bash"><code> # Analyze the current live cluster
istioctl analyze
# Analyze the current live cluster for a specific revision
istioctl analyze --revision 1-16
# Analyze the current live cluster, simulating the effect of applying additional yaml files
istioctl analyze a.yaml b.yaml my-app-config/

View File

@ -7,7 +7,7 @@ location: https://istio.io/docs/reference/config/istio.mesh.v1alpha1.html
layout: protoc-gen-docs
generator: protoc-gen-docs
weight: 20
number_of_entries: 55
number_of_entries: 56
---
<p>Configuration affecting the service mesh as a whole.</p>
@ -2181,6 +2181,61 @@ No
<p>Optional. Format for the proxy access log
Empty value results in proxy&rsquo;s default access log format, following Envoy access logging formatting.</p>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="MeshConfig-ExtensionProvider-OpenTelemetryTracingProvider">MeshConfig.ExtensionProvider.OpenTelemetryTracingProvider</h2>
<section>
<p>Defines configuration for an OpenTelemetry tracing backend. Istio 1.16.1 or higher is needed.</p>
<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="MeshConfig-ExtensionProvider-OpenTelemetryTracingProvider-service">
<td><code>service</code></td>
<td><code>string</code></td>
<td>
<p>REQUIRED. Specifies the OpenTelemetry endpoint that will receive OTLP traces.
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
to unambiguously resolve a service in the service registry. The <code>&lt;Hostname&gt;</code> is a fully qualified host name of a
service defined by the Kubernetes service or ServiceEntry.</p>
<p>Example: &ldquo;otlp.default.svc.cluster.local&rdquo; or &ldquo;bar/otlp.example.com&rdquo;.</p>
</td>
<td>
No
</td>
</tr>
<tr id="MeshConfig-ExtensionProvider-OpenTelemetryTracingProvider-port">
<td><code>port</code></td>
<td><code>uint32</code></td>
<td>
<p>REQUIRED. Specifies the port of the service.</p>
</td>
<td>
No
</td>
</tr>
<tr id="MeshConfig-ExtensionProvider-OpenTelemetryTracingProvider-max_tag_length">
<td><code>maxTagLength</code></td>
<td><code>uint32</code></td>
<td>
<p>Optional. Controls the overall path length allowed in a reported span.
NOTE: currently only controls max length of the path tag.</p>
</td>
<td>
No