mirror of https://github.com/istio/istio.io.git
Automator: update istio.io@ reference docs (#9047)
This commit is contained in:
parent
a38324b63e
commit
44e0690da9
|
@ -5499,6 +5499,12 @@ These environment variables affect the behavior of the <code>istioctl</code> com
|
|||
<td>If enabled, for a headless service/stateful set in Kubernetes, pilot will generate an outbound listener for each pod in a headless service. This feature should be disabled if headless services have a large number of pods.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>PILOT_ENABLE_INBOUND_PASSTHROUGH</code></td>
|
||||
<td>Boolean</td>
|
||||
<td><code>true</code></td>
|
||||
<td>If enabled, inbound clusters will be configured as ORIGINAL_DST clusters. When disabled, requests are always sent to localhost. The primary implication of this is that when enabled, binding to POD_IP will work while localhost will not; when disable, bind to POD_IP will not work, while localhost will. The enabled behavior matches the behavior without Istio enabled at all; this flag exists only for backwards compatibility. Regardless of this setting, the configuration can be overridden with the Sidecar.Ingress.DefaultEndpoint configuration.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>PILOT_ENABLE_ISTIO_TAGS</code></td>
|
||||
<td>Boolean</td>
|
||||
<td><code>true</code></td>
|
||||
|
|
|
@ -320,6 +320,12 @@ These environment variables affect the behavior of the <code>operator</code> com
|
|||
<td>If enabled, for a headless service/stateful set in Kubernetes, pilot will generate an outbound listener for each pod in a headless service. This feature should be disabled if headless services have a large number of pods.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>PILOT_ENABLE_INBOUND_PASSTHROUGH</code></td>
|
||||
<td>Boolean</td>
|
||||
<td><code>true</code></td>
|
||||
<td>If enabled, inbound clusters will be configured as ORIGINAL_DST clusters. When disabled, requests are always sent to localhost. The primary implication of this is that when enabled, binding to POD_IP will work while localhost will not; when disable, bind to POD_IP will not work, while localhost will. The enabled behavior matches the behavior without Istio enabled at all; this flag exists only for backwards compatibility. Regardless of this setting, the configuration can be overridden with the Sidecar.Ingress.DefaultEndpoint configuration.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>PILOT_ENABLE_ISTIO_TAGS</code></td>
|
||||
<td>Boolean</td>
|
||||
<td><code>true</code></td>
|
||||
|
|
|
@ -894,6 +894,12 @@ These environment variables affect the behavior of the <code>pilot-agent</code>
|
|||
<td>If enabled, for a headless service/stateful set in Kubernetes, pilot will generate an outbound listener for each pod in a headless service. This feature should be disabled if headless services have a large number of pods.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>PILOT_ENABLE_INBOUND_PASSTHROUGH</code></td>
|
||||
<td>Boolean</td>
|
||||
<td><code>true</code></td>
|
||||
<td>If enabled, inbound clusters will be configured as ORIGINAL_DST clusters. When disabled, requests are always sent to localhost. The primary implication of this is that when enabled, binding to POD_IP will work while localhost will not; when disable, bind to POD_IP will not work, while localhost will. The enabled behavior matches the behavior without Istio enabled at all; this flag exists only for backwards compatibility. Regardless of this setting, the configuration can be overridden with the Sidecar.Ingress.DefaultEndpoint configuration.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>PILOT_ENABLE_ISTIO_TAGS</code></td>
|
||||
<td>Boolean</td>
|
||||
<td><code>true</code></td>
|
||||
|
|
|
@ -729,6 +729,12 @@ These environment variables affect the behavior of the <code>pilot-discovery</co
|
|||
<td>If enabled, for a headless service/stateful set in Kubernetes, pilot will generate an outbound listener for each pod in a headless service. This feature should be disabled if headless services have a large number of pods.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>PILOT_ENABLE_INBOUND_PASSTHROUGH</code></td>
|
||||
<td>Boolean</td>
|
||||
<td><code>true</code></td>
|
||||
<td>If enabled, inbound clusters will be configured as ORIGINAL_DST clusters. When disabled, requests are always sent to localhost. The primary implication of this is that when enabled, binding to POD_IP will work while localhost will not; when disable, bind to POD_IP will not work, while localhost will. The enabled behavior matches the behavior without Istio enabled at all; this flag exists only for backwards compatibility. Regardless of this setting, the configuration can be overridden with the Sidecar.Ingress.DefaultEndpoint configuration.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>PILOT_ENABLE_ISTIO_TAGS</code></td>
|
||||
<td>Boolean</td>
|
||||
<td><code>true</code></td>
|
||||
|
|
|
@ -34,7 +34,7 @@ attribute is set.</p>
|
|||
</thead>
|
||||
<tbody>
|
||||
<tr id="AccessLogPolicyConfig-log_window_duration">
|
||||
<td><code>logWindowDuration</code></td>
|
||||
<td><code>log_window_duration</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>Optional. Allows specifying logging window for successful requests.
|
||||
|
@ -46,7 +46,7 @@ No
|
|||
</td>
|
||||
</tr>
|
||||
<tr id="AccessLogPolicyConfig-max_client_cache_size">
|
||||
<td><code>maxClientCacheSize</code></td>
|
||||
<td><code>max_client_cache_size</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>Optional. Allows specifying max client cache size.
|
||||
|
|
|
@ -162,7 +162,7 @@ No
|
|||
</thead>
|
||||
<tbody>
|
||||
<tr id="AttributeGeneration-output_attribute">
|
||||
<td><code>outputAttribute</code></td>
|
||||
<td><code>output_attribute</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The name of the attribute that is populated on a successful match.
|
||||
|
|
|
@ -22,7 +22,7 @@ number_of_entries: 2
|
|||
</thead>
|
||||
<tbody>
|
||||
<tr id="PluginConfig-max_peer_cache_size">
|
||||
<td><code>maxPeerCacheSize</code></td>
|
||||
<td><code>max_peer_cache_size</code></td>
|
||||
<td><code><a href="#google-protobuf-UInt32Value">UInt32Value</a></code></td>
|
||||
<td>
|
||||
<p>maximum size of the peer metadata cache.
|
||||
|
|
|
@ -55,7 +55,7 @@ No
|
|||
</thead>
|
||||
<tbody>
|
||||
<tr id="PluginConfig-max_log_batch_size_in_bytes">
|
||||
<td><code>maxLogBatchSizeInBytes</code></td>
|
||||
<td><code>max_log_batch_size_in_bytes</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>Optional. Allows configuration of the size of the LogWrite request. The
|
||||
|
@ -68,7 +68,7 @@ No
|
|||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-log_report_duration">
|
||||
<td><code>logReportDuration</code></td>
|
||||
<td><code>log_report_duration</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>Optional. Allows configuration of the time between calls out to the
|
||||
|
@ -82,7 +82,7 @@ No
|
|||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-enable_audit_log">
|
||||
<td><code>enableAuditLog</code></td>
|
||||
<td><code>enable_audit_log</code></td>
|
||||
<td><code>bool</code></td>
|
||||
<td>
|
||||
<p>Optional. Controls whether to export audit log.</p>
|
||||
|
@ -93,7 +93,7 @@ No
|
|||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-destination_service_name">
|
||||
<td><code>destinationServiceName</code></td>
|
||||
<td><code>destination_service_name</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Optional. FQDN of destination service that the request routed to, e.g.
|
||||
|
@ -106,7 +106,7 @@ No
|
|||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-enable_mesh_edges_reporting">
|
||||
<td><code>enableMeshEdgesReporting</code></td>
|
||||
<td><code>enable_mesh_edges_reporting</code></td>
|
||||
<td><code>bool</code></td>
|
||||
<td>
|
||||
<p>Optional. Controls whether or not to export mesh edges to a mesh edges
|
||||
|
@ -118,7 +118,7 @@ No
|
|||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-mesh_edges_reporting_duration">
|
||||
<td><code>meshEdgesReportingDuration</code></td>
|
||||
<td><code>mesh_edges_reporting_duration</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>Optional. Allows configuration of the time between calls out to the mesh
|
||||
|
@ -135,7 +135,7 @@ No
|
|||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-max_peer_cache_size">
|
||||
<td><code>maxPeerCacheSize</code></td>
|
||||
<td><code>max_peer_cache_size</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>maximum size of the peer metadata cache.
|
||||
|
@ -148,7 +148,7 @@ No
|
|||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-disable_host_header_fallback">
|
||||
<td><code>disableHostHeaderFallback</code></td>
|
||||
<td><code>disable_host_header_fallback</code></td>
|
||||
<td><code>bool</code></td>
|
||||
<td>
|
||||
<p>Optional: Disable using host header as a fallback if destination service is
|
||||
|
@ -161,7 +161,7 @@ No
|
|||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-max_edges_batch_size">
|
||||
<td><code>maxEdgesBatchSize</code></td>
|
||||
<td><code>max_edges_batch_size</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>Optional. Allows configuration of the number of traffic assertions to batch
|
||||
|
@ -173,7 +173,7 @@ No
|
|||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-disable_http_size_metrics">
|
||||
<td><code>disableHttpSizeMetrics</code></td>
|
||||
<td><code>disable_http_size_metrics</code></td>
|
||||
<td><code>bool</code></td>
|
||||
<td>
|
||||
<p>Optional. Allows disabling of reporting of the request and response size
|
||||
|
@ -186,7 +186,7 @@ No
|
|||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-enable_log_compression">
|
||||
<td><code>enableLogCompression</code></td>
|
||||
<td><code>enable_log_compression</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#boolvalue">BoolValue</a></code></td>
|
||||
<td>
|
||||
<p>Optional. Allows enabling log compression for stackdriver access logs.</p>
|
||||
|
@ -197,7 +197,7 @@ No
|
|||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-access_logging">
|
||||
<td><code>accessLogging</code></td>
|
||||
<td><code>access_logging</code></td>
|
||||
<td><code><a href="#PluginConfig-AccessLogging">AccessLogging</a></code></td>
|
||||
<td>
|
||||
<p>Optional. Controls what type of logs to export..</p>
|
||||
|
@ -208,20 +208,35 @@ No
|
|||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-custom_log_config">
|
||||
<td><code>customLogConfig</code></td>
|
||||
<td><code>custom_log_config</code></td>
|
||||
<td><code><a href="#CustomConfig">CustomConfig</a></code></td>
|
||||
<td>
|
||||
<p>(Optional) Collection of tag names and tag expressions to include in the
|
||||
logs. Conflicts are resolved by the tag name by overriding previously
|
||||
supplied values. Does not apply to audit logs.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-metric_expiry_duration">
|
||||
<td><code>metric_expiry_duration</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>Optional. Controls the metric expiry duration. If a metric time series is
|
||||
not updated for the given duration, it will be purged from time series
|
||||
cache as well as metric reporting. If this is not set or set to 0, time
|
||||
series will never be expired. This option is useful to avoid unbounded
|
||||
metric label explodes proxy memory.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-disable_server_access_logging" class="deprecated ">
|
||||
<td><code>disableServerAccessLogging</code></td>
|
||||
<td><code>disable_server_access_logging</code></td>
|
||||
<td><code>bool</code></td>
|
||||
<td>
|
||||
<p>Optional. Controls whether to export server access log.
|
||||
|
|
|
@ -54,7 +54,7 @@ No
|
|||
</td>
|
||||
</tr>
|
||||
<tr id="MetricConfig-tags_to_remove">
|
||||
<td><code>tagsToRemove</code></td>
|
||||
<td><code>tags_to_remove</code></td>
|
||||
<td><code>string[]</code></td>
|
||||
<td>
|
||||
<p>(Optional) A list of tags to remove.</p>
|
||||
|
@ -144,7 +144,8 @@ No
|
|||
<td>
|
||||
<p>next id: 7
|
||||
The following settings should be rarely used.
|
||||
Enable debug for this filter.</p>
|
||||
Enable debug for this filter.
|
||||
DEPRECATED.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
@ -152,7 +153,7 @@ No
|
|||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-max_peer_cache_size">
|
||||
<td><code>maxPeerCacheSize</code></td>
|
||||
<td><code>max_peer_cache_size</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>maximum size of the peer metadata cache.
|
||||
|
@ -166,7 +167,7 @@ No
|
|||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-stat_prefix">
|
||||
<td><code>statPrefix</code></td>
|
||||
<td><code>stat_prefix</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>prefix to add to stats emitted by the plugin.
|
||||
|
@ -178,7 +179,7 @@ No
|
|||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-field_separator">
|
||||
<td><code>fieldSeparator</code></td>
|
||||
<td><code>field_separator</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Stats api squashes dimensions in a single string.
|
||||
|
@ -192,7 +193,7 @@ No
|
|||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-value_separator">
|
||||
<td><code>valueSeparator</code></td>
|
||||
<td><code>value_separator</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>default: “==”</p>
|
||||
|
@ -203,7 +204,7 @@ No
|
|||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-disable_host_header_fallback">
|
||||
<td><code>disableHostHeaderFallback</code></td>
|
||||
<td><code>disable_host_header_fallback</code></td>
|
||||
<td><code>bool</code></td>
|
||||
<td>
|
||||
<p>Optional: Disable using host header as a fallback if destination service is
|
||||
|
@ -216,7 +217,7 @@ No
|
|||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-tcp_reporting_duration">
|
||||
<td><code>tcpReportingDuration</code></td>
|
||||
<td><code>tcp_reporting_duration</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>Optional. Allows configuration of the time between calls out to for TCP
|
||||
|
|
Loading…
Reference in New Issue