mirror of https://github.com/istio/proxy.git
Drop protoc docs generation (#6070)
This is not used anywhere. The make target also doesn't work (due to stackdriver removal) and no one complained which suggests no one has ran it for a long time
This commit is contained in:
John Howard
GitHub
parent
081e87a37b
commit
0cc7022f53
|
|
@ -109,29 +109,6 @@ lint: lint-copyright-banner format-go lint-go tidy-go lint-scripts gen-extension
|
|||
@scripts/check-repository.sh
|
||||
@scripts/check-style.sh
|
||||
|
||||
protoc = protoc -I common-protos -I extensions
|
||||
protoc_gen_docs_plugin := --docs_out=camel_case_fields=false,warnings=true,per_file=true,mode=html_fragment_with_front_matter:$(repo_dir)/
|
||||
|
||||
metadata_exchange_path := extensions/metadata_exchange
|
||||
metadata_exchange_protos := $(wildcard $(metadata_exchange_path)/*.proto)
|
||||
metadata_exchange_docs := $(metadata_exchange_protos:.proto=.pb.html)
|
||||
$(metadata_exchange_docs): $(metadata_exchange_protos)
|
||||
@$(protoc) -I ./extensions $(protoc_gen_docs_plugin)$(metadata_exchange_path) $^
|
||||
|
||||
stackdriver_path := extensions/stackdriver/config/v1alpha1
|
||||
stackdriver_protos := $(wildcard $(stackdriver_path)/*.proto)
|
||||
stackdriver_docs := $(stackdriver_protos:.proto=.pb.html)
|
||||
$(stackdriver_docs): $(stackdriver_protos)
|
||||
@$(protoc) -I ./extensions $(protoc_gen_docs_plugin)$(stackdriver_path) $^
|
||||
|
||||
accesslog_policy_path := extensions/access_log_policy/config/v1alpha1
|
||||
accesslog_policy_protos := $(wildcard $(accesslog_policy_path)/*.proto)
|
||||
accesslog_policy_docs := $(accesslog_policy_protos:.proto=.pb.html)
|
||||
$(accesslog_policy_docs): $(accesslog_policy_protos)
|
||||
@$(protoc) -I ./extensions $(protoc_gen_docs_plugin)$(accesslog_policy_path) $^
|
||||
|
||||
extensions-docs: $(metadata_exchange_docs) $(stackdriver_docs) $(accesslog_policy_docs)
|
||||
|
||||
test_release:
|
||||
ifeq "$(shell uname -m)" "x86_64"
|
||||
export BAZEL_BUILD_ARGS="$(BAZEL_BUILD_ARGS)" && ./scripts/release-binary.sh
|
||||
|
|
|
|||
|
|
@ -1,91 +0,0 @@
|
|||
---
|
||||
title: ALPN filter for overriding ALPN for upstream TLS connections.
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
number_of_entries: 3
|
||||
---
|
||||
<h2 id="FilterConfig">FilterConfig</h2>
|
||||
<section>
|
||||
<p>FilterConfig is the config for Istio-specific filter.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="FilterConfig-alpn_override">
|
||||
<td><div class="field"><div class="name"><code><a href="#FilterConfig-alpn_override">alpn_override</a></code></div>
|
||||
<div class="type"><a href="#FilterConfig-AlpnOverride">AlpnOverride[]</a></div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>Map from upstream protocol to list of ALPN</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h3 id="FilterConfig-AlpnOverride">AlpnOverride</h3>
|
||||
<section>
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="FilterConfig-AlpnOverride-upstream_protocol">
|
||||
<td><div class="field"><div class="name"><code><a href="#FilterConfig-AlpnOverride-upstream_protocol">upstream_protocol</a></code></div>
|
||||
<div class="type"><a href="#FilterConfig-Protocol">Protocol</a></div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>Upstream protocol</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="FilterConfig-AlpnOverride-alpn_override">
|
||||
<td><div class="field"><div class="name"><code><a href="#FilterConfig-AlpnOverride-alpn_override">alpn_override</a></code></div>
|
||||
<div class="type">string[]</div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>A list of ALPN that will override the ALPN for upstream TLS connections.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h3 id="FilterConfig-Protocol">Protocol</h3>
|
||||
<section>
|
||||
<p>Upstream protocols</p>
|
||||
|
||||
<table class="enum-values">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="FilterConfig-Protocol-HTTP10">
|
||||
<td><code><a href="#FilterConfig-Protocol-HTTP10">HTTP10</a></code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="FilterConfig-Protocol-HTTP11">
|
||||
<td><code><a href="#FilterConfig-Protocol-HTTP11">HTTP11</a></code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="FilterConfig-Protocol-HTTP2">
|
||||
<td><code><a href="#FilterConfig-Protocol-HTTP2">HTTP2</a></code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,257 +0,0 @@
|
|||
---
|
||||
title: Stats Config
|
||||
description: Configuration for Stats Filter.
|
||||
location: https://istio.io/docs/reference/config/proxy_extensions/stats.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
weight: 20
|
||||
number_of_entries: 5
|
||||
---
|
||||
<h2 id="MetricConfig">MetricConfig</h2>
|
||||
<section>
|
||||
<p>Metric instance configuration overrides.
|
||||
The metric value and the metric type are optional and permit changing the
|
||||
reported value for an existing metric.
|
||||
The standard metrics are optimized and reported through a “fast-path”.
|
||||
The customizations allow full configurability, at the cost of a “slower”
|
||||
path.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="MetricConfig-dimensions">
|
||||
<td><div class="field"><div class="name"><code><a href="#MetricConfig-dimensions">dimensions</a></code></div>
|
||||
<div class="type">map<string, string></div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>(Optional) Collection of tag names and tag expressions to include in the
|
||||
metric. Conflicts are resolved by the tag name by overriding previously
|
||||
supplied values.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="MetricConfig-name">
|
||||
<td><div class="field"><div class="name"><code><a href="#MetricConfig-name">name</a></code></div>
|
||||
<div class="type">string</div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>(Optional) Metric name to restrict the override to a metric. If not
|
||||
specified, applies to all.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="MetricConfig-tags_to_remove">
|
||||
<td><div class="field"><div class="name"><code><a href="#MetricConfig-tags_to_remove">tags_to_remove</a></code></div>
|
||||
<div class="type">string[]</div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>(Optional) A list of tags to remove.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="MetricConfig-match">
|
||||
<td><div class="field"><div class="name"><code><a href="#MetricConfig-match">match</a></code></div>
|
||||
<div class="type">string</div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>NOT IMPLEMENTED. (Optional) Conditional enabling the override.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="MetricConfig-drop">
|
||||
<td><div class="field"><div class="name"><code><a href="#MetricConfig-drop">drop</a></code></div>
|
||||
<div class="type">bool</div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>(Optional) If this is set to true, the metric(s) selected by this
|
||||
configuration will not be generated or reported.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="MetricDefinition">MetricDefinition</h2>
|
||||
<section>
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="MetricDefinition-name">
|
||||
<td><div class="field"><div class="name"><code><a href="#MetricDefinition-name">name</a></code></div>
|
||||
<div class="type">string</div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>Metric name.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="MetricDefinition-value">
|
||||
<td><div class="field"><div class="name"><code><a href="#MetricDefinition-value">value</a></code></div>
|
||||
<div class="type">string</div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>Metric value expression.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="MetricDefinition-type">
|
||||
<td><div class="field"><div class="name"><code><a href="#MetricDefinition-type">type</a></code></div>
|
||||
<div class="type"><a href="#MetricType">MetricType</a></div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>Metric type.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="PluginConfig">PluginConfig</h2>
|
||||
<section>
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="PluginConfig-disable_host_header_fallback">
|
||||
<td><div class="field"><div class="name"><code><a href="#PluginConfig-disable_host_header_fallback">disable_host_header_fallback</a></code></div>
|
||||
<div class="type">bool</div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>Disable using host header as a fallback if destination service is
|
||||
not available from the controlplane. Disable the fallback if the host
|
||||
header originates outsides the mesh, like at ingress.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-tcp_reporting_duration">
|
||||
<td><div class="field"><div class="name"><code><a href="#PluginConfig-tcp_reporting_duration">tcp_reporting_duration</a></code></div>
|
||||
<div class="type"><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>Allows configuration of the time between calls out to for TCP
|
||||
metrics reporting. The default duration is <code>5s</code>.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-metrics">
|
||||
<td><div class="field"><div class="name"><code><a href="#PluginConfig-metrics">metrics</a></code></div>
|
||||
<div class="type"><a href="#MetricConfig">MetricConfig[]</a></div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>Metric overrides.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-definitions">
|
||||
<td><div class="field"><div class="name"><code><a href="#PluginConfig-definitions">definitions</a></code></div>
|
||||
<div class="type"><a href="#MetricDefinition">MetricDefinition[]</a></div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>Metric definitions.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-reporter">
|
||||
<td><div class="field"><div class="name"><code><a href="#PluginConfig-reporter">reporter</a></code></div>
|
||||
<div class="type"><a href="#Reporter">Reporter</a></div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>Proxy deployment type.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-rotation_interval">
|
||||
<td><div class="field"><div class="name"><code><a href="#PluginConfig-rotation_interval">rotation_interval</a></code></div>
|
||||
<div class="type"><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>Metric scope rotation interval. Set to 0 to disable the metric scope rotation.
|
||||
Defaults to 0.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="PluginConfig-graceful_deletion_interval">
|
||||
<td><div class="field"><div class="name"><code><a href="#PluginConfig-graceful_deletion_interval">graceful_deletion_interval</a></code></div>
|
||||
<div class="type"><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>Metric expiry graceful deletion interval. No-op if the metric rotation is disabled.
|
||||
Defaults to 5m. Must be >=1s.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="MetricType">MetricType</h2>
|
||||
<section>
|
||||
<table class="enum-values">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="MetricType-COUNTER">
|
||||
<td><code><a href="#MetricType-COUNTER">COUNTER</a></code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="MetricType-GAUGE">
|
||||
<td><code><a href="#MetricType-GAUGE">GAUGE</a></code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="MetricType-HISTOGRAM">
|
||||
<td><code><a href="#MetricType-HISTOGRAM">HISTOGRAM</a></code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Reporter">Reporter</h2>
|
||||
<section>
|
||||
<p>Specifies the proxy deployment type.</p>
|
||||
|
||||
<table class="enum-values">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Reporter-UNSPECIFIED">
|
||||
<td><code><a href="#Reporter-UNSPECIFIED">UNSPECIFIED</a></code></td>
|
||||
<td>
|
||||
<p>Default value is inferred from the listener direction, as either client or
|
||||
server sidecar.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Reporter-SERVER_GATEWAY">
|
||||
<td><code><a href="#Reporter-SERVER_GATEWAY">SERVER_GATEWAY</a></code></td>
|
||||
<td>
|
||||
<p>Shared server gateway, e.g. “waypoint”.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,184 +0,0 @@
|
|||
---
|
||||
title: io.istio.http.peer_metadata
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
number_of_entries: 6
|
||||
---
|
||||
<h2 id="Config">Config</h2>
|
||||
<section>
|
||||
<p>Peer metadata provider filter. This filter encapsulates the discovery of the
|
||||
peer telemetry attributes for consumption by the telemetry filters.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Config-downstream_discovery">
|
||||
<td><div class="field"><div class="name"><code><a href="#Config-downstream_discovery">downstream_discovery</a></code></div>
|
||||
<div class="type"><a href="#Config-DiscoveryMethod">DiscoveryMethod[]</a></div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>The order of the derivation of the downstream peer metadata, in the precedence order.
|
||||
First successful lookup wins.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Config-upstream_discovery">
|
||||
<td><div class="field"><div class="name"><code><a href="#Config-upstream_discovery">upstream_discovery</a></code></div>
|
||||
<div class="type"><a href="#Config-DiscoveryMethod">DiscoveryMethod[]</a></div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>The order of the derivation of the upstream peer metadata, in the precedence order.
|
||||
First successful lookup wins.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Config-downstream_propagation">
|
||||
<td><div class="field"><div class="name"><code><a href="#Config-downstream_propagation">downstream_propagation</a></code></div>
|
||||
<div class="type"><a href="#Config-PropagationMethod">PropagationMethod[]</a></div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>Downstream injection of the metadata via a response header.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Config-upstream_propagation">
|
||||
<td><div class="field"><div class="name"><code><a href="#Config-upstream_propagation">upstream_propagation</a></code></div>
|
||||
<div class="type"><a href="#Config-PropagationMethod">PropagationMethod[]</a></div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>Upstream injection of the metadata via a request header.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Config-shared_with_upstream">
|
||||
<td><div class="field"><div class="name"><code><a href="#Config-shared_with_upstream">shared_with_upstream</a></code></div>
|
||||
<div class="type">bool</div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>True to enable sharing with the upstream.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Config-additional_labels">
|
||||
<td><div class="field"><div class="name"><code><a href="#Config-additional_labels">additional_labels</a></code></div>
|
||||
<div class="type">string[]</div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>Additional labels to be added to the peer metadata to help your understand the traffic.
|
||||
e.g. <code>role</code>, <code>location</code> etc.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h3 id="Config-Baggage">Baggage</h3>
|
||||
<section>
|
||||
<p>DEPRECATED.
|
||||
This method uses <code>baggage</code> header encoding.</p>
|
||||
|
||||
</section>
|
||||
<h3 id="Config-WorkloadDiscovery">WorkloadDiscovery</h3>
|
||||
<section>
|
||||
<p>This method uses the workload metadata xDS. Requires that the bootstrap extension is enabled.
|
||||
For downstream discovery, the remote address is the lookup key in xDS.
|
||||
For upstream discovery:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>If the upstream host address is an IP, this IP is used as the lookup key;</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>If the upstream host address is internal, uses the
|
||||
“filter_metadata.tunnel.destination” dynamic metadata value as the lookup key.</p>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</section>
|
||||
<h3 id="Config-IstioHeaders">IstioHeaders</h3>
|
||||
<section>
|
||||
<p>This method uses Istio HTTP metadata exchange headers, e.g. <code>x-envoy-peer-metadata</code>. Removes these headers if found.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Config-IstioHeaders-skip_external_clusters">
|
||||
<td><div class="field"><div class="name"><code><a href="#Config-IstioHeaders-skip_external_clusters">skip_external_clusters</a></code></div>
|
||||
<div class="type">bool</div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>Strip x-envoy-peer-metadata and x-envoy-peer-metadata-id headers on HTTP requests to services outside the mesh.
|
||||
Detects upstream clusters with <code>istio</code> and <code>external</code> filter metadata fields</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h3 id="Config-DiscoveryMethod">DiscoveryMethod</h3>
|
||||
<section>
|
||||
<p>An exhaustive list of the derivation methods.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Config-DiscoveryMethod-baggage" class="oneof oneof-start">
|
||||
<td><div class="field"><div class="name"><code><a href="#Config-DiscoveryMethod-baggage">baggage</a></code></div>
|
||||
<div class="type"><a href="#Config-Baggage">Baggage (oneof)</a></div>
|
||||
</div></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Config-DiscoveryMethod-workload_discovery" class="oneof">
|
||||
<td><div class="field"><div class="name"><code><a href="#Config-DiscoveryMethod-workload_discovery">workload_discovery</a></code></div>
|
||||
<div class="type"><a href="#Config-WorkloadDiscovery">WorkloadDiscovery (oneof)</a></div>
|
||||
</div></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Config-DiscoveryMethod-istio_headers" class="oneof">
|
||||
<td><div class="field"><div class="name"><code><a href="#Config-DiscoveryMethod-istio_headers">istio_headers</a></code></div>
|
||||
<div class="type"><a href="#Config-IstioHeaders">IstioHeaders (oneof)</a></div>
|
||||
</div></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h3 id="Config-PropagationMethod">PropagationMethod</h3>
|
||||
<section>
|
||||
<p>An exhaustive list of the metadata propagation methods.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Config-PropagationMethod-istio_headers" class="oneof oneof-start">
|
||||
<td><div class="field"><div class="name"><code><a href="#Config-PropagationMethod-istio_headers">istio_headers</a></code></div>
|
||||
<div class="type"><a href="#Config-IstioHeaders">IstioHeaders (oneof)</a></div>
|
||||
</div></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,51 +0,0 @@
|
|||
---
|
||||
title: envoy.tcp.metadataexchange.config
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
number_of_entries: 1
|
||||
---
|
||||
<h2 id="MetadataExchange">MetadataExchange</h2>
|
||||
<section>
|
||||
<p>[#protodoc-title: MetadataExchange protocol match and data transfer]
|
||||
MetadataExchange protocol match and data transfer</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="MetadataExchange-protocol">
|
||||
<td><div class="field"><div class="name"><code><a href="#MetadataExchange-protocol">protocol</a></code></div>
|
||||
<div class="type">string</div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>Protocol that Alpn should support on the server.
|
||||
[#comment:TODO(GargNupur): Make it a list.]</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="MetadataExchange-enable_discovery">
|
||||
<td><div class="field"><div class="name"><code><a href="#MetadataExchange-enable_discovery">enable_discovery</a></code></div>
|
||||
<div class="type">bool</div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>If true, will attempt to use WDS in case the prefix peer metadata is not available.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="MetadataExchange-additional_labels">
|
||||
<td><div class="field"><div class="name"><code><a href="#MetadataExchange-additional_labels">additional_labels</a></code></div>
|
||||
<div class="type">string[]</div>
|
||||
</div></td>
|
||||
<td>
|
||||
<p>Additional labels to be added to the peer metadata to help your understand the traffic.
|
||||
e.g. <code>role</code>, <code>location</code> etc.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
Loading…
Reference in New Issue