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

This commit is contained in:
Istio Automation 2024-12-03 21:18:37 -05:00 committed by GitHub
parent c9e00c7284
commit d9ec4c06a0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 144 additions and 2 deletions

View File

@ -3672,6 +3672,10 @@ Note: currently all headers are enabled by default.</p>
attemptCount:
disabled: true
</code></pre>
<p>Below shows an example of preserving the header case for HTTP 1.x requests</p>
<pre><code class="language-yaml">proxyHeaders:
perserveHttp1HeaderCase: true
</code></pre>
<p>Some headers are enabled by default, and require explicitly disabling. See below for an example of disabling all default-enabled headers:</p>
<pre><code class="language-yaml">proxyHeaders:
forwardedClientCert: SANITIZE
@ -4134,6 +4138,25 @@ No
By default, the behavior is unspecified.
If IN_MESH, these headers will not be appended to outbound requests from sidecars to services not in-mesh.</p>
</td>
<td>
No
</td>
</tr>
<tr id="ProxyConfig-ProxyHeaders-preserve_http1_header_case">
<td><code><a href="#ProxyConfig-ProxyHeaders-preserve_http1_header_case">preserveHttp1HeaderCase</a></code></td>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#boolvalue">BoolValue</a></code></td>
<td>
<p>When true, the original case of HTTP/1.x headers will be preserved
as they pass through the proxy, rather than normalizing them to lowercase.
This field is particularly useful for applications that require case-sensitive
headers for interoperability with downstream systems or APIs that expect specific
casing.
The preserve_http1_header_case option only applies to HTTP/1.x traffic, as HTTP/2 requires all headers
to be lowercase per the protocol specification. Envoy will ignore this field for HTTP/2
requests and automatically normalize headers to lowercase, ensuring compliance with HTTP/2
standards.</p>
</td>
<td>
No

View File

@ -8,7 +8,7 @@ layout: protoc-gen-docs
generator: protoc-gen-docs
schema: istio.networking.v1alpha3.WorkloadGroup
aliases: [/docs/reference/config/networking/v1alpha3/workload-group]
number_of_entries: 7
number_of_entries: 8
---
<p><code>WorkloadGroup</code> describes a collection of workload instances.
It provides a specification that the workload instances can use to bootstrap
@ -213,6 +213,17 @@ No
<td>
<p>Health is determined by how the command that is executed exited.</p>
</td>
<td>
No
</td>
</tr>
<tr id="ReadinessProbe-grpc" class="oneof">
<td><code><a href="#ReadinessProbe-grpc">grpc</a></code></td>
<td><code><a href="#GrpcHealthCheckConfig">GrpcHealthCheckConfig (oneof)</a></code></td>
<td>
<p>GRPC call is made and response/error is used to determine health.</p>
</td>
<td>
No
@ -285,6 +296,43 @@ No
<p>Headers the proxy will pass on to make the request.
Allows repeated headers.</p>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="GrpcHealthCheckConfig">GrpcHealthCheckConfig</h2>
<section>
<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="GrpcHealthCheckConfig-port">
<td><code><a href="#GrpcHealthCheckConfig-port">port</a></code></td>
<td><code>uint32</code></td>
<td>
<p>Port on which the endpoint lives.</p>
</td>
<td>
No
</td>
</tr>
<tr id="GrpcHealthCheckConfig-service">
<td><code><a href="#GrpcHealthCheckConfig-service">service</a></code></td>
<td><code>string</code></td>
<td>
<p>Service is the fully qualified name of the service to send the grpc health check request</p>
</td>
<td>
No

View File

@ -3672,6 +3672,10 @@ Note: currently all headers are enabled by default.</p>
attemptCount:
disabled: true
</code></pre>
<p>Below shows an example of preserving the header case for HTTP 1.x requests</p>
<pre><code class="language-yaml">proxyHeaders:
perserveHttp1HeaderCase: true
</code></pre>
<p>Some headers are enabled by default, and require explicitly disabling. See below for an example of disabling all default-enabled headers:</p>
<pre><code class="language-yaml">proxyHeaders:
forwardedClientCert: SANITIZE
@ -4134,6 +4138,25 @@ No
By default, the behavior is unspecified.
If IN_MESH, these headers will not be appended to outbound requests from sidecars to services not in-mesh.</p>
</td>
<td>
No
</td>
</tr>
<tr id="ProxyConfig-ProxyHeaders-preserve_http1_header_case">
<td><code><a href="#ProxyConfig-ProxyHeaders-preserve_http1_header_case">preserveHttp1HeaderCase</a></code></td>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#boolvalue">BoolValue</a></code></td>
<td>
<p>When true, the original case of HTTP/1.x headers will be preserved
as they pass through the proxy, rather than normalizing them to lowercase.
This field is particularly useful for applications that require case-sensitive
headers for interoperability with downstream systems or APIs that expect specific
casing.
The preserve_http1_header_case option only applies to HTTP/1.x traffic, as HTTP/2 requires all headers
to be lowercase per the protocol specification. Envoy will ignore this field for HTTP/2
requests and automatically normalize headers to lowercase, ensuring compliance with HTTP/2
standards.</p>
</td>
<td>
No

View File

@ -8,7 +8,7 @@ layout: protoc-gen-docs
generator: protoc-gen-docs
schema: istio.networking.v1alpha3.WorkloadGroup
aliases: [/zh/docs/reference/config/networking/v1alpha3/workload-group]
number_of_entries: 7
number_of_entries: 8
---
<p><code>WorkloadGroup</code> describes a collection of workload instances.
It provides a specification that the workload instances can use to bootstrap
@ -213,6 +213,17 @@ No
<td>
<p>Health is determined by how the command that is executed exited.</p>
</td>
<td>
No
</td>
</tr>
<tr id="ReadinessProbe-grpc" class="oneof">
<td><code><a href="#ReadinessProbe-grpc">grpc</a></code></td>
<td><code><a href="#GrpcHealthCheckConfig">GrpcHealthCheckConfig (oneof)</a></code></td>
<td>
<p>GRPC call is made and response/error is used to determine health.</p>
</td>
<td>
No
@ -285,6 +296,43 @@ No
<p>Headers the proxy will pass on to make the request.
Allows repeated headers.</p>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="GrpcHealthCheckConfig">GrpcHealthCheckConfig</h2>
<section>
<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="GrpcHealthCheckConfig-port">
<td><code><a href="#GrpcHealthCheckConfig-port">port</a></code></td>
<td><code>uint32</code></td>
<td>
<p>Port on which the endpoint lives.</p>
</td>
<td>
No
</td>
</tr>
<tr id="GrpcHealthCheckConfig-service">
<td><code><a href="#GrpcHealthCheckConfig-service">service</a></code></td>
<td><code>string</code></td>
<td>
<p>Service is the fully qualified name of the service to send the grpc health check request</p>
</td>
<td>
No