Skip to content

Commit af59aa0

Browse files
istio-testingistio-testing
authored
Automator: update istio.io@ reference docs (#16934)
1 parent ab5e66e commit af59aa0

File tree

2 files changed

+302
-2
lines changed
  • content
    • en/docs/reference/config/networking/envoy-filter
    • zh/docs/reference/config/networking/envoy-filter

2 files changed

+302
-2
lines changed

‎content/en/docs/reference/config/networking/envoy-filter/index.html‎

Lines changed: 151 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
generator: protoc-gen-docs
99
schema: istio.networking.v1alpha3.EnvoyFilter
1010
aliases: [/docs/reference/config/networking/v1alpha3/envoy-filter]
11-
number_of_entries: 18
11+
number_of_entries: 22
1212
---
1313
<p><code>EnvoyFilter</code> provides a mechanism to customize the Envoy
1414
configuration generated by istiod. Use EnvoyFilter to modify
@@ -983,6 +983,139 @@ <h4 id="EnvoyFilter-ListenerMatch-SubFilterMatch">SubFilterMatch</h4>
983983
<td>
984984
<p>The filter name to match on.</p>
985985

986+
</td>
987+
</tr>
988+
</tbody>
989+
</table>
990+
</section>
991+
<h3 id="EnvoyFilter-WaypointMatch">WaypointMatch</h3>
992+
<section>
993+
<table class="message-fields">
994+
<thead>
995+
<tr>
996+
<th>Field</th>
997+
<th>Description</th>
998+
</tr>
999+
</thead>
1000+
<tbody>
1001+
<tr id="EnvoyFilter-WaypointMatch-port_number">
1002+
<td><div class="field"><div class="name"><code><a href="#EnvoyFilter-WaypointMatch-port_number">portNumber</a></code></div>
1003+
<div class="type">uint32</div>
1004+
</div></td>
1005+
<td>
1006+
<p>The service port to match on.
1007+
If not specified, matches all ports.</p>
1008+
1009+
</td>
1010+
</tr>
1011+
<tr id="EnvoyFilter-WaypointMatch-route">
1012+
<td><div class="field"><div class="name"><code><a href="#EnvoyFilter-WaypointMatch-route">route</a></code></div>
1013+
<div class="type"><a href="#EnvoyFilter-WaypointMatch-RouteMatch">RouteMatch</a></div>
1014+
</div></td>
1015+
<td>
1016+
<p>Match a specific route.</p>
1017+
1018+
</td>
1019+
</tr>
1020+
<tr id="EnvoyFilter-WaypointMatch-filter">
1021+
<td><div class="field"><div class="name"><code><a href="#EnvoyFilter-WaypointMatch-filter">filter</a></code></div>
1022+
<div class="type"><a href="#EnvoyFilter-WaypointMatch-FilterMatch">FilterMatch</a></div>
1023+
</div></td>
1024+
<td>
1025+
<p>The name of a specific filter to apply the patch to.
1026+
Set this to <code>envoy.filters.network.http_connection_manager</code>
1027+
to add a filter or apply a patch to the HTTP connection manager.</p>
1028+
1029+
</td>
1030+
</tr>
1031+
</tbody>
1032+
</table>
1033+
</section>
1034+
<h4 id="EnvoyFilter-WaypointMatch-RouteMatch">RouteMatch</h4>
1035+
<section>
1036+
<p>Conditions specified in <code>RouteMatch</code> must be met for the patch
1037+
to be applied to a route.</p>
1038+
1039+
<table class="message-fields">
1040+
<thead>
1041+
<tr>
1042+
<th>Field</th>
1043+
<th>Description</th>
1044+
</tr>
1045+
</thead>
1046+
<tbody>
1047+
<tr id="EnvoyFilter-WaypointMatch-RouteMatch-name">
1048+
<td><div class="field"><div class="name"><code><a href="#EnvoyFilter-WaypointMatch-RouteMatch-name">name</a></code></div>
1049+
<div class="type">string</div>
1050+
</div></td>
1051+
<td>
1052+
<p>The Route objects generated by default are named as
1053+
default. Route objects generated using a virtual service
1054+
will carry the name used in the virtual service&rsquo;s HTTP
1055+
routes.</p>
1056+
1057+
</td>
1058+
</tr>
1059+
</tbody>
1060+
</table>
1061+
</section>
1062+
<h4 id="EnvoyFilter-WaypointMatch-FilterMatch">FilterMatch</h4>
1063+
<section>
1064+
<p>Conditions to match a specific filter within a filter chain.</p>
1065+
1066+
<table class="message-fields">
1067+
<thead>
1068+
<tr>
1069+
<th>Field</th>
1070+
<th>Description</th>
1071+
</tr>
1072+
</thead>
1073+
<tbody>
1074+
<tr id="EnvoyFilter-WaypointMatch-FilterMatch-name">
1075+
<td><div class="field"><div class="name"><code><a href="#EnvoyFilter-WaypointMatch-FilterMatch-name">name</a></code></div>
1076+
<div class="type">string</div>
1077+
</div></td>
1078+
<td>
1079+
<p>The filter name to match on.
1080+
For standard Envoy filters, <a href="https://www.envoyproxy.io/docs/envoy/latest/version_history/v1.14.0#deprecated">canonical filter</a>
1081+
names should be used.</p>
1082+
1083+
</td>
1084+
</tr>
1085+
<tr id="EnvoyFilter-WaypointMatch-FilterMatch-sub_filter">
1086+
<td><div class="field"><div class="name"><code><a href="#EnvoyFilter-WaypointMatch-FilterMatch-sub_filter">subFilter</a></code></div>
1087+
<div class="type"><a href="#EnvoyFilter-WaypointMatch-FilterMatch-SubFilterMatch">SubFilterMatch</a></div>
1088+
</div></td>
1089+
<td>
1090+
<p>The next level filter within this filter to match on.
1091+
Typically used for HTTP Connection Manager filters.</p>
1092+
1093+
</td>
1094+
</tr>
1095+
</tbody>
1096+
</table>
1097+
</section>
1098+
<h5 id="EnvoyFilter-WaypointMatch-FilterMatch-SubFilterMatch">SubFilterMatch</h5>
1099+
<section>
1100+
<p>Conditions to match a specific filter within another
1101+
filter. This field is typically useful to match a HTTP filter
1102+
inside the <code>envoy.filters.network.http_connection_manager</code> network filter.</p>
1103+
1104+
<table class="message-fields">
1105+
<thead>
1106+
<tr>
1107+
<th>Field</th>
1108+
<th>Description</th>
1109+
</tr>
1110+
</thead>
1111+
<tbody>
1112+
<tr id="EnvoyFilter-WaypointMatch-FilterMatch-SubFilterMatch-name">
1113+
<td><div class="field"><div class="name"><code><a href="#EnvoyFilter-WaypointMatch-FilterMatch-SubFilterMatch-name">name</a></code></div>
1114+
<div class="type">string</div>
1115+
</div></td>
1116+
<td>
1117+
<p>The filter name to match on.</p>
1118+
9861119
</td>
9871120
</tr>
9881121
</tbody>
@@ -1247,6 +1380,16 @@ <h3 id="EnvoyFilter-EnvoyConfigObjectMatch">EnvoyConfigObjectMatch</h3>
12471380
<td>
12481381
<p>Match on envoy cluster attributes.</p>
12491382

1383+
</td>
1384+
</tr>
1385+
<tr id="EnvoyFilter-EnvoyConfigObjectMatch-waypoint" class="oneof">
1386+
<td><div class="field"><div class="name"><code><a href="#EnvoyFilter-EnvoyConfigObjectMatch-waypoint">waypoint</a></code></div>
1387+
<div class="type"><a href="#EnvoyFilter-WaypointMatch">WaypointMatch (oneof)</a></div>
1388+
</div></td>
1389+
<td>
1390+
<p>Match on waypoint attributes.
1391+
Only work when patch context is WAYPOINT.</p>
1392+
12501393
</td>
12511394
</tr>
12521395
</tbody>
@@ -1446,6 +1589,13 @@ <h3 id="EnvoyFilter-PatchContext">PatchContext</h3>
14461589
<td>
14471590
<p>Gateway listener/route/cluster.</p>
14481591

1592+
</td>
1593+
</tr>
1594+
<tr id="EnvoyFilter-PatchContext-WAYPOINT">
1595+
<td><code><a href="#EnvoyFilter-PatchContext-WAYPOINT">WAYPOINT</a></code></td>
1596+
<td>
1597+
<p>Waypoint listener/route/cluster.</p>
1598+
14491599
</td>
14501600
</tr>
14511601
</tbody>

‎content/zh/docs/reference/config/networking/envoy-filter/index.html‎

Lines changed: 151 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
generator: protoc-gen-docs
99
schema: istio.networking.v1alpha3.EnvoyFilter
1010
aliases: [/zh/docs/reference/config/networking/v1alpha3/envoy-filter]
11-
number_of_entries: 18
11+
number_of_entries: 22
1212
---
1313
<p><code>EnvoyFilter</code> provides a mechanism to customize the Envoy
1414
configuration generated by istiod. Use EnvoyFilter to modify
@@ -983,6 +983,139 @@ <h4 id="EnvoyFilter-ListenerMatch-SubFilterMatch">SubFilterMatch</h4>
983983
<td>
984984
<p>The filter name to match on.</p>
985985

986+
</td>
987+
</tr>
988+
</tbody>
989+
</table>
990+
</section>
991+
<h3 id="EnvoyFilter-WaypointMatch">WaypointMatch</h3>
992+
<section>
993+
<table class="message-fields">
994+
<thead>
995+
<tr>
996+
<th>Field</th>
997+
<th>Description</th>
998+
</tr>
999+
</thead>
1000+
<tbody>
1001+
<tr id="EnvoyFilter-WaypointMatch-port_number">
1002+
<td><div class="field"><div class="name"><code><a href="#EnvoyFilter-WaypointMatch-port_number">portNumber</a></code></div>
1003+
<div class="type">uint32</div>
1004+
</div></td>
1005+
<td>
1006+
<p>The service port to match on.
1007+
If not specified, matches all ports.</p>
1008+
1009+
</td>
1010+
</tr>
1011+
<tr id="EnvoyFilter-WaypointMatch-route">
1012+
<td><div class="field"><div class="name"><code><a href="#EnvoyFilter-WaypointMatch-route">route</a></code></div>
1013+
<div class="type"><a href="#EnvoyFilter-WaypointMatch-RouteMatch">RouteMatch</a></div>
1014+
</div></td>
1015+
<td>
1016+
<p>Match a specific route.</p>
1017+
1018+
</td>
1019+
</tr>
1020+
<tr id="EnvoyFilter-WaypointMatch-filter">
1021+
<td><div class="field"><div class="name"><code><a href="#EnvoyFilter-WaypointMatch-filter">filter</a></code></div>
1022+
<div class="type"><a href="#EnvoyFilter-WaypointMatch-FilterMatch">FilterMatch</a></div>
1023+
</div></td>
1024+
<td>
1025+
<p>The name of a specific filter to apply the patch to.
1026+
Set this to <code>envoy.filters.network.http_connection_manager</code>
1027+
to add a filter or apply a patch to the HTTP connection manager.</p>
1028+
1029+
</td>
1030+
</tr>
1031+
</tbody>
1032+
</table>
1033+
</section>
1034+
<h4 id="EnvoyFilter-WaypointMatch-RouteMatch">RouteMatch</h4>
1035+
<section>
1036+
<p>Conditions specified in <code>RouteMatch</code> must be met for the patch
1037+
to be applied to a route.</p>
1038+
1039+
<table class="message-fields">
1040+
<thead>
1041+
<tr>
1042+
<th>Field</th>
1043+
<th>Description</th>
1044+
</tr>
1045+
</thead>
1046+
<tbody>
1047+
<tr id="EnvoyFilter-WaypointMatch-RouteMatch-name">
1048+
<td><div class="field"><div class="name"><code><a href="#EnvoyFilter-WaypointMatch-RouteMatch-name">name</a></code></div>
1049+
<div class="type">string</div>
1050+
</div></td>
1051+
<td>
1052+
<p>The Route objects generated by default are named as
1053+
default. Route objects generated using a virtual service
1054+
will carry the name used in the virtual service&rsquo;s HTTP
1055+
routes.</p>
1056+
1057+
</td>
1058+
</tr>
1059+
</tbody>
1060+
</table>
1061+
</section>
1062+
<h4 id="EnvoyFilter-WaypointMatch-FilterMatch">FilterMatch</h4>
1063+
<section>
1064+
<p>Conditions to match a specific filter within a filter chain.</p>
1065+
1066+
<table class="message-fields">
1067+
<thead>
1068+
<tr>
1069+
<th>Field</th>
1070+
<th>Description</th>
1071+
</tr>
1072+
</thead>
1073+
<tbody>
1074+
<tr id="EnvoyFilter-WaypointMatch-FilterMatch-name">
1075+
<td><div class="field"><div class="name"><code><a href="#EnvoyFilter-WaypointMatch-FilterMatch-name">name</a></code></div>
1076+
<div class="type">string</div>
1077+
</div></td>
1078+
<td>
1079+
<p>The filter name to match on.
1080+
For standard Envoy filters, <a href="https://www.envoyproxy.io/docs/envoy/latest/version_history/v1.14.0#deprecated">canonical filter</a>
1081+
names should be used.</p>
1082+
1083+
</td>
1084+
</tr>
1085+
<tr id="EnvoyFilter-WaypointMatch-FilterMatch-sub_filter">
1086+
<td><div class="field"><div class="name"><code><a href="#EnvoyFilter-WaypointMatch-FilterMatch-sub_filter">subFilter</a></code></div>
1087+
<div class="type"><a href="#EnvoyFilter-WaypointMatch-FilterMatch-SubFilterMatch">SubFilterMatch</a></div>
1088+
</div></td>
1089+
<td>
1090+
<p>The next level filter within this filter to match on.
1091+
Typically used for HTTP Connection Manager filters.</p>
1092+
1093+
</td>
1094+
</tr>
1095+
</tbody>
1096+
</table>
1097+
</section>
1098+
<h5 id="EnvoyFilter-WaypointMatch-FilterMatch-SubFilterMatch">SubFilterMatch</h5>
1099+
<section>
1100+
<p>Conditions to match a specific filter within another
1101+
filter. This field is typically useful to match a HTTP filter
1102+
inside the <code>envoy.filters.network.http_connection_manager</code> network filter.</p>
1103+
1104+
<table class="message-fields">
1105+
<thead>
1106+
<tr>
1107+
<th>Field</th>
1108+
<th>Description</th>
1109+
</tr>
1110+
</thead>
1111+
<tbody>
1112+
<tr id="EnvoyFilter-WaypointMatch-FilterMatch-SubFilterMatch-name">
1113+
<td><div class="field"><div class="name"><code><a href="#EnvoyFilter-WaypointMatch-FilterMatch-SubFilterMatch-name">name</a></code></div>
1114+
<div class="type">string</div>
1115+
</div></td>
1116+
<td>
1117+
<p>The filter name to match on.</p>
1118+
9861119
</td>
9871120
</tr>
9881121
</tbody>
@@ -1247,6 +1380,16 @@ <h3 id="EnvoyFilter-EnvoyConfigObjectMatch">EnvoyConfigObjectMatch</h3>
12471380
<td>
12481381
<p>Match on envoy cluster attributes.</p>
12491382

1383+
</td>
1384+
</tr>
1385+
<tr id="EnvoyFilter-EnvoyConfigObjectMatch-waypoint" class="oneof">
1386+
<td><div class="field"><div class="name"><code><a href="#EnvoyFilter-EnvoyConfigObjectMatch-waypoint">waypoint</a></code></div>
1387+
<div class="type"><a href="#EnvoyFilter-WaypointMatch">WaypointMatch (oneof)</a></div>
1388+
</div></td>
1389+
<td>
1390+
<p>Match on waypoint attributes.
1391+
Only work when patch context is WAYPOINT.</p>
1392+
12501393
</td>
12511394
</tr>
12521395
</tbody>
@@ -1446,6 +1589,13 @@ <h3 id="EnvoyFilter-PatchContext">PatchContext</h3>
14461589
<td>
14471590
<p>Gateway listener/route/cluster.</p>
14481591

1592+
</td>
1593+
</tr>
1594+
<tr id="EnvoyFilter-PatchContext-WAYPOINT">
1595+
<td><code><a href="#EnvoyFilter-PatchContext-WAYPOINT">WAYPOINT</a></code></td>
1596+
<td>
1597+
<p>Waypoint listener/route/cluster.</p>
1598+
14491599
</td>
14501600
</tr>
14511601
</tbody>

0 commit comments

Comments
 (0)