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

This commit is contained in:
Istio Automation 2021-03-26 19:45:26 -07:00 committed by GitHub
parent 593e85fb66
commit dd0bed6af5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 433 additions and 1 deletions

View File

@ -264,6 +264,13 @@ remove_toc_prefix: 'pilot-discovery '
<td>Discovery service secured gRPC address (default `:15012`)</td>
</tr>
<tr>
<td><code>--tls-cipher-suites &lt;stringSlice&gt;</code></td>
<td></td>
<td>Comma-separated list of cipher suites for istiod TLS server. If omitted, the default Go cipher suites will be used.
Preferred values: TLS_AES_128_GCM_SHA256, TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256, TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_GCM_SHA384.
Insecure values: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_RC4_128_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_RC4_128_SHA, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_RC4_128_SHA. (default `[]`)</td>
</tr>
<tr>
<td><code>--tlsCertFile &lt;string&gt;</code></td>
<td></td>
<td>File containing the x509 Server Certificate (default ``)</td>

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: 34
number_of_entries: 41
---
<p>Configuration affecting the service mesh as a whole.</p>
@ -594,6 +594,17 @@ No
<p>Defines a list of extension providers that extend Istio&rsquo;s functionality. For example, the AuthorizationPolicy
can be used with an extension provider to delegate the authorization decision to a custom authorization system.</p>
</td>
<td>
No
</td>
</tr>
<tr id="MeshConfig-default_providers">
<td><code>defaultProviders</code></td>
<td><code><a href="#MeshConfig-DefaultProviders">DefaultProviders</a></code></td>
<td>
<p>Specifies extension providers to use by default in Istio configuration resources.</p>
</td>
<td>
No
@ -963,6 +974,92 @@ No
<td>
<p>Configures an external authorizer that implements the Envoy ext_authz filter authorization check service using the gRPC API.</p>
</td>
<td>
No
</td>
</tr>
<tr id="MeshConfig-ExtensionProvider-zipkin" class="oneof">
<td><code>zipkin</code></td>
<td><code><a href="#MeshConfig-ExtensionProvider-ZipkinTracingProvider">ZipkinTracingProvider (oneof)</a></code></td>
<td>
<p>Configures a tracing provider that uses the Zipkin API.</p>
</td>
<td>
No
</td>
</tr>
<tr id="MeshConfig-ExtensionProvider-lightstep" class="oneof">
<td><code>lightstep</code></td>
<td><code><a href="#MeshConfig-ExtensionProvider-LightstepTracingProvider">LightstepTracingProvider (oneof)</a></code></td>
<td>
<p>Configures a Lightstep tracing provider.</p>
</td>
<td>
No
</td>
</tr>
<tr id="MeshConfig-ExtensionProvider-datadog" class="oneof">
<td><code>datadog</code></td>
<td><code><a href="#MeshConfig-ExtensionProvider-DatadogTracingProvider">DatadogTracingProvider (oneof)</a></code></td>
<td>
<p>Configures a Datadog tracing provider.</p>
</td>
<td>
No
</td>
</tr>
<tr id="MeshConfig-ExtensionProvider-stackdriver" class="oneof">
<td><code>stackdriver</code></td>
<td><code><a href="#MeshConfig-ExtensionProvider-StackdriverProvider">StackdriverProvider (oneof)</a></code></td>
<td>
<p>Configures a Stackdriver provider.</p>
</td>
<td>
No
</td>
</tr>
<tr id="MeshConfig-ExtensionProvider-opencensus" class="oneof">
<td><code>opencensus</code></td>
<td><code><a href="#MeshConfig-ExtensionProvider-OpenCensusAgentTracingProvider">OpenCensusAgentTracingProvider (oneof)</a></code></td>
<td>
<p>Configures an OpenCensusAgent tracing provider.</p>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="MeshConfig-DefaultProviders">MeshConfig.DefaultProviders</h2>
<section>
<p>Holds the name references to the providers that will be used by default
in other Istio configuration resources if the provider is not specified.</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-DefaultProviders-tracing">
<td><code>tracing</code></td>
<td><code>string</code></td>
<td>
<p>Name of the default provider for tracing. This must match a provider
defined in <code>extension_providers</code> that is one of the support tracing
providers.</p>
</td>
<td>
No
@ -1201,6 +1298,284 @@ No
<p>Sets the HTTP status that is returned to the client when there is a network error to the authorization service.
The default status is &ldquo;403&rdquo; (HTTP Forbidden).</p>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="MeshConfig-ExtensionProvider-ZipkinTracingProvider">MeshConfig.ExtensionProvider.ZipkinTracingProvider</h2>
<section>
<p>Defines configuration for a Zipkin tracer.</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-ZipkinTracingProvider-service">
<td><code>service</code></td>
<td><code>string</code></td>
<td>
<p>REQUIRED. Specifies the service that the Zipkin API.
The format is &ldquo;[<Namespace>/]<Hostname>&rdquo;. The specification of <Namespace> is required only when it is insufficient
to unambiguously resolve a service in the service registry. The <Hostname> is a fully qualified host name of a
service defined by the Kubernetes service or ServiceEntry.</p>
<p>Example: &ldquo;zipkin.default.svc.cluster.local&rdquo; or &ldquo;bar/zipkin.example.com&rdquo;.</p>
</td>
<td>
No
</td>
</tr>
<tr id="MeshConfig-ExtensionProvider-ZipkinTracingProvider-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-ZipkinTracingProvider-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
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="MeshConfig-ExtensionProvider-LightstepTracingProvider">MeshConfig.ExtensionProvider.LightstepTracingProvider</h2>
<section>
<p>Defines configuration for a Lightstep tracer.</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-LightstepTracingProvider-service">
<td><code>service</code></td>
<td><code>string</code></td>
<td>
<p>REQUIRED. Specifies the service for the Lightstep collector.
The format is &ldquo;[<Namespace>/]<Hostname>&rdquo;. The specification of <Namespace> is required only when it is insufficient
to unambiguously resolve a service in the service registry. The <Hostname> is a fully qualified host name of a
service defined by the Kubernetes service or ServiceEntry.</p>
<p>Example: &ldquo;lightstep.default.svc.cluster.local&rdquo; or &ldquo;bar/lightstep.example.com&rdquo;.</p>
</td>
<td>
No
</td>
</tr>
<tr id="MeshConfig-ExtensionProvider-LightstepTracingProvider-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-LightstepTracingProvider-access_token">
<td><code>accessToken</code></td>
<td><code>string</code></td>
<td>
<p>The Lightstep access token.</p>
</td>
<td>
No
</td>
</tr>
<tr id="MeshConfig-ExtensionProvider-LightstepTracingProvider-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
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="MeshConfig-ExtensionProvider-DatadogTracingProvider">MeshConfig.ExtensionProvider.DatadogTracingProvider</h2>
<section>
<p>Defines configuration for a Datadog tracer.</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-DatadogTracingProvider-service">
<td><code>service</code></td>
<td><code>string</code></td>
<td>
<p>REQUIRED. Specifies the service for the Datadog agent.
The format is &ldquo;[<Namespace>/]<Hostname>&rdquo;. The specification of <Namespace> is required only when it is insufficient
to unambiguously resolve a service in the service registry. The <Hostname> is a fully qualified host name of a
service defined by the Kubernetes service or ServiceEntry.</p>
<p>Example: &ldquo;datadog.default.svc.cluster.local&rdquo; or &ldquo;bar/datadog.example.com&rdquo;.</p>
</td>
<td>
No
</td>
</tr>
<tr id="MeshConfig-ExtensionProvider-DatadogTracingProvider-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-DatadogTracingProvider-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
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="MeshConfig-ExtensionProvider-StackdriverProvider">MeshConfig.ExtensionProvider.StackdriverProvider</h2>
<section>
<p>Defines configuration for Stackdriver.</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-StackdriverProvider-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
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="MeshConfig-ExtensionProvider-OpenCensusAgentTracingProvider">MeshConfig.ExtensionProvider.OpenCensusAgentTracingProvider</h2>
<section>
<p>Defines configuration for an OpenCensus tracer writing to an OpenCensus backend.</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-OpenCensusAgentTracingProvider-service">
<td><code>service</code></td>
<td><code>string</code></td>
<td>
<p>REQUIRED. Specifies the service for the OpenCensusAgent.
The format is &ldquo;[<Namespace>/]<Hostname>&rdquo;. The specification of <Namespace> is required only when it is insufficient
to unambiguously resolve a service in the service registry. The <Hostname> is a fully qualified host name of a
service defined by the Kubernetes service or ServiceEntry.</p>
<p>Example: &ldquo;ocagent.default.svc.cluster.local&rdquo; or &ldquo;bar/ocagent.example.com&rdquo;.</p>
</td>
<td>
No
</td>
</tr>
<tr id="MeshConfig-ExtensionProvider-OpenCensusAgentTracingProvider-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-OpenCensusAgentTracingProvider-context">
<td><code>context</code></td>
<td><code><a href="#MeshConfig-ExtensionProvider-OpenCensusAgentTracingProvider-TraceContext">TraceContext[]</a></code></td>
<td>
<p>Specifies the set of context propagation headers used for distributed
tracing. Default is <code>[&quot;W3C_TRACE_CONTEXT&quot;]</code>. If multiple values are specified,
the proxy will attempt to read each header for each request and will
write all headers.</p>
</td>
<td>
No
</td>
</tr>
<tr id="MeshConfig-ExtensionProvider-OpenCensusAgentTracingProvider-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
@ -2310,6 +2685,56 @@ service registry as well as those defined through ServiceEntries</p>
<p>outbound traffic to unknown destinations will be allowed, in case
there are no services or ServiceEntries for the destination port</p>
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="MeshConfig-ExtensionProvider-OpenCensusAgentTracingProvider-TraceContext">MeshConfig.ExtensionProvider.OpenCensusAgentTracingProvider.TraceContext</h2>
<section>
<p>TraceContext selects the context propagation headers used for
distributed tracing.</p>
<table class="enum-values">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="MeshConfig-ExtensionProvider-OpenCensusAgentTracingProvider-TraceContext-W3C_TRACE_CONTEXT">
<td><code>W3C_TRACE_CONTEXT</code></td>
<td>
<p>Use W3C Trace Context propagation using the <code>traceparent</code> HTTP header.
See the
<a href="https://www.w3.org/TR/trace-context/">Trace Context documentation</a> for details.</p>
</td>
</tr>
<tr id="MeshConfig-ExtensionProvider-OpenCensusAgentTracingProvider-TraceContext-GRPC_BIN">
<td><code>GRPC_BIN</code></td>
<td>
<p>Use gRPC binary context propagation using the <code>grpc-trace-bin</code> http header.</p>
</td>
</tr>
<tr id="MeshConfig-ExtensionProvider-OpenCensusAgentTracingProvider-TraceContext-CLOUD_TRACE_CONTEXT">
<td><code>CLOUD_TRACE_CONTEXT</code></td>
<td>
<p>Use Cloud Trace context propagation using the
<code>X-Cloud-Trace-Context</code> http header.</p>
</td>
</tr>
<tr id="MeshConfig-ExtensionProvider-OpenCensusAgentTracingProvider-TraceContext-B3">
<td><code>B3</code></td>
<td>
<p>Use multi-header B3 context propagation using the <code>X-B3-TraceId</code>,
<code>X-B3-SpanId</code>, and <code>X-B3-Sampled</code> HTTP headers. See
<a href="https://github.com/openzipkin/b3-propagation">B3 header propagation README</a>
for details.</p>
</td>
</tr>
</tbody>