Skip to content

Commit

Permalink
Automator: update istio.io@ reference docs (#15962)
Browse files Browse the repository at this point in the history
  • Loading branch information
istio-testing authored Nov 20, 2024
1 parent a2c2fc8 commit 8bbbf92
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 168 deletions.
82 changes: 1 addition & 81 deletions content/en/docs/reference/commands/pilot-agent/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
title: pilot-agent
description: Istio Pilot agent.
generator: pkg-collateral-docs
number_of_entries: 13
number_of_entries: 12
max_toc_level: 2
remove_toc_prefix: 'pilot-agent '
---
Expand Down Expand Up @@ -277,86 +277,6 @@ <h4>macOS:</h4>
</tr>
</tbody>
</table>
<h3 id="pilot-agent-istio-clean-iptables">pilot-agent istio-clean-iptables</h3>
<p>Script responsible for cleaning up iptables rules</p>
<pre class="language-bash"><code>pilot-agent istio-clean-iptables [flags]
</code></pre>
<table class="command-flags">
<thead>
<tr>
<th>Flags</th>
<th>Shorthand</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>--capture-all-dns</code></td>
<td></td>
<td>Instead of only capturing DNS traffic to DNS server IP, capture all DNS traffic at port 53. This setting is only effective when redirect dns is enabled. </td>
</tr>
<tr>
<td><code>--dry-run</code></td>
<td><code>-n</code></td>
<td>Do not call any external dependencies like iptables. </td>
</tr>
<tr>
<td><code>--istio-inbound-interception-mode &lt;string&gt;</code></td>
<td><code>-m</code></td>
<td>The mode used to redirect inbound connections to Envoy, either &#34;REDIRECT&#34; or &#34;TPROXY&#34;. (default ``)</td>
</tr>
<tr>
<td><code>--istio-inbound-tproxy-mark &lt;string&gt;</code></td>
<td><code>-t</code></td>
<td> (default ``)</td>
</tr>
<tr>
<td><code>--log_as_json</code></td>
<td></td>
<td>Whether to format output as JSON or in plain console-friendly format </td>
</tr>
<tr>
<td><code>--log_caller &lt;string&gt;</code></td>
<td></td>
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, all, ca, cache, citadelclient, default, dns, gcecred, grpc, healthcheck, iptables, klog, mockcred, monitoring, sds, security, spiffe, validation, wasm, xdsproxy] (default ``)</td>
</tr>
<tr>
<td><code>--log_output_level &lt;string&gt;</code></td>
<td></td>
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... where scope can be one of [ads, all, ca, cache, citadelclient, default, dns, gcecred, grpc, healthcheck, iptables, klog, mockcred, monitoring, sds, security, spiffe, validation, wasm, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default ``)</td>
</tr>
<tr>
<td><code>--log_stacktrace_level &lt;string&gt;</code></td>
<td></td>
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope:level&gt;,... where scope can be one of [ads, all, ca, cache, citadelclient, default, dns, gcecred, grpc, healthcheck, iptables, klog, mockcred, monitoring, sds, security, spiffe, validation, wasm, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
</tr>
<tr>
<td><code>--log_target &lt;stringArray&gt;</code></td>
<td></td>
<td>The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`)</td>
</tr>
<tr>
<td><code>--proxy-gid &lt;string&gt;</code></td>
<td><code>-g</code></td>
<td>Specify the GID of the user for which the redirection is not applied (same default value as -u param). (default ``)</td>
</tr>
<tr>
<td><code>--proxy-uid &lt;string&gt;</code></td>
<td><code>-u</code></td>
<td>Specify the UID of the user for which the redirection is not applied. Typically, this is the UID of the proxy container. (default ``)</td>
</tr>
<tr>
<td><code>--redirect-dns</code></td>
<td></td>
<td>Enable capture of dns traffic by istio-agent. </td>
</tr>
<tr>
<td><code>--vklog &lt;Level&gt;</code></td>
<td></td>
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
</tr>
</tbody>
</table>
<h3 id="pilot-agent-istio-iptables">pilot-agent istio-iptables</h3>
<p>istio-iptables is responsible for setting up port forwarding for Istio Sidecar.</p>
<pre class="language-bash"><code>pilot-agent istio-iptables [flags]
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/reference/config/labels/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ <h2 id="IoIstioDataplaneMode">istio.io/dataplane-mode</h2>
</tr>
<tr>
<th>Feature Status</th>
<td>Beta</td>
<td>Stable</td>
</tr>
<tr>
<th>Resource Types</th>
Expand Down Expand Up @@ -132,7 +132,7 @@ <h2 id="IoIstioUseWaypoint">istio.io/use-waypoint</h2>
</tr>
<tr>
<th>Feature Status</th>
<td>Beta</td>
<td>Stable</td>
</tr>
<tr>
<th>Resource Types</th>
Expand Down Expand Up @@ -183,7 +183,7 @@ <h2 id="IoIstioWaypointFor">istio.io/waypoint-for</h2>
</tr>
<tr>
<th>Feature Status</th>
<td>Beta</td>
<td>Stable</td>
</tr>
<tr>
<th>Resource Types</th>
Expand Down
82 changes: 1 addition & 81 deletions content/zh/docs/reference/commands/pilot-agent/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
title: pilot-agent
description: Istio Pilot agent.
generator: pkg-collateral-docs
number_of_entries: 13
number_of_entries: 12
max_toc_level: 2
remove_toc_prefix: 'pilot-agent '
---
Expand Down Expand Up @@ -277,86 +277,6 @@ <h4>macOS:</h4>
</tr>
</tbody>
</table>
<h3 id="pilot-agent-istio-clean-iptables">pilot-agent istio-clean-iptables</h3>
<p>Script responsible for cleaning up iptables rules</p>
<pre class="language-bash"><code>pilot-agent istio-clean-iptables [flags]
</code></pre>
<table class="command-flags">
<thead>
<tr>
<th>Flags</th>
<th>Shorthand</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>--capture-all-dns</code></td>
<td></td>
<td>Instead of only capturing DNS traffic to DNS server IP, capture all DNS traffic at port 53. This setting is only effective when redirect dns is enabled. </td>
</tr>
<tr>
<td><code>--dry-run</code></td>
<td><code>-n</code></td>
<td>Do not call any external dependencies like iptables. </td>
</tr>
<tr>
<td><code>--istio-inbound-interception-mode &lt;string&gt;</code></td>
<td><code>-m</code></td>
<td>The mode used to redirect inbound connections to Envoy, either &#34;REDIRECT&#34; or &#34;TPROXY&#34;. (default ``)</td>
</tr>
<tr>
<td><code>--istio-inbound-tproxy-mark &lt;string&gt;</code></td>
<td><code>-t</code></td>
<td> (default ``)</td>
</tr>
<tr>
<td><code>--log_as_json</code></td>
<td></td>
<td>Whether to format output as JSON or in plain console-friendly format </td>
</tr>
<tr>
<td><code>--log_caller &lt;string&gt;</code></td>
<td></td>
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, all, ca, cache, citadelclient, default, dns, gcecred, grpc, healthcheck, iptables, klog, mockcred, monitoring, sds, security, spiffe, validation, wasm, xdsproxy] (default ``)</td>
</tr>
<tr>
<td><code>--log_output_level &lt;string&gt;</code></td>
<td></td>
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... where scope can be one of [ads, all, ca, cache, citadelclient, default, dns, gcecred, grpc, healthcheck, iptables, klog, mockcred, monitoring, sds, security, spiffe, validation, wasm, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default ``)</td>
</tr>
<tr>
<td><code>--log_stacktrace_level &lt;string&gt;</code></td>
<td></td>
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope:level&gt;,... where scope can be one of [ads, all, ca, cache, citadelclient, default, dns, gcecred, grpc, healthcheck, iptables, klog, mockcred, monitoring, sds, security, spiffe, validation, wasm, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
</tr>
<tr>
<td><code>--log_target &lt;stringArray&gt;</code></td>
<td></td>
<td>The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`)</td>
</tr>
<tr>
<td><code>--proxy-gid &lt;string&gt;</code></td>
<td><code>-g</code></td>
<td>Specify the GID of the user for which the redirection is not applied (same default value as -u param). (default ``)</td>
</tr>
<tr>
<td><code>--proxy-uid &lt;string&gt;</code></td>
<td><code>-u</code></td>
<td>Specify the UID of the user for which the redirection is not applied. Typically, this is the UID of the proxy container. (default ``)</td>
</tr>
<tr>
<td><code>--redirect-dns</code></td>
<td></td>
<td>Enable capture of dns traffic by istio-agent. </td>
</tr>
<tr>
<td><code>--vklog &lt;Level&gt;</code></td>
<td></td>
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
</tr>
</tbody>
</table>
<h3 id="pilot-agent-istio-iptables">pilot-agent istio-iptables</h3>
<p>istio-iptables is responsible for setting up port forwarding for Istio Sidecar.</p>
<pre class="language-bash"><code>pilot-agent istio-iptables [flags]
Expand Down
6 changes: 3 additions & 3 deletions content/zh/docs/reference/config/labels/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ <h2 id="IoIstioDataplaneMode">istio.io/dataplane-mode</h2>
</tr>
<tr>
<th>Feature Status</th>
<td>Beta</td>
<td>Stable</td>
</tr>
<tr>
<th>Resource Types</th>
Expand Down Expand Up @@ -132,7 +132,7 @@ <h2 id="IoIstioUseWaypoint">istio.io/use-waypoint</h2>
</tr>
<tr>
<th>Feature Status</th>
<td>Beta</td>
<td>Stable</td>
</tr>
<tr>
<th>Resource Types</th>
Expand Down Expand Up @@ -183,7 +183,7 @@ <h2 id="IoIstioWaypointFor">istio.io/waypoint-for</h2>
</tr>
<tr>
<th>Feature Status</th>
<td>Beta</td>
<td>Stable</td>
</tr>
<tr>
<th>Resource Types</th>
Expand Down

0 comments on commit 8bbbf92

Please sign in to comment.