istio
/
istio.io
mirror of https://github.com/istio/istio.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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

This commit is contained in:
Istio Automation 2024-10-22 22:12:31 -04:00 committed by GitHub
parent fe9be7bcea
commit 957d1d02a0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 264 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
content/en/docs/reference/commands/install-cni/index.html
View File

@ -632,6 +632,12 @@ https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/security/ssl#fip
<td>If true, enables retry policy for inbound routes which automatically retries requests that were reset before it reaches the service.</td> <td>If true, enables retry policy for inbound routes which automatically retries requests that were reset before it reaches the service.</td>
</tr> </tr>
<tr> <tr>
<td><code>ENABLE_INGRESS_WAYPOINT_ROUTING</code></td>
<td>Boolean</td>
<td><code>false</code></td>
<td>If true, Gateways will call service waypoints if the &#39;istio.io/ingress-use-waypoint&#39; label set on the Service.</td>
</tr>
<tr>
<td><code>ENABLE_LEADER_ELECTION</code></td> <td><code>ENABLE_LEADER_ELECTION</code></td>
<td>Boolean</td> <td>Boolean</td>
<td><code>true</code></td> <td><code>true</code></td>

115
content/en/docs/reference/commands/istioctl/index.html
View File

@ -4,7 +4,7 @@ source_repo: https://github.com/istio/istio
title: istioctl title: istioctl
description: Istio control interface. description: Istio control interface.
generator: pkg-collateral-docs generator: pkg-collateral-docs
number_of_entries: 90 number_of_entries: 91
max_toc_level: 2 max_toc_level: 2
remove_toc_prefix: 'istioctl ' remove_toc_prefix: 'istioctl '
--- ---
@ -4455,6 +4455,113 @@ If set to true, the user is not prompted and a Yes response is assumed in all ca
# To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes. # To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes.
istioctl install --set &#34;values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default&#34; istioctl install --set &#34;values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default&#34;
</code></pre>
<h3 id="istioctl-manifest-translate">istioctl manifest translate</h3>
<p>The translate subcommand translates an Istio install manifest and outputs to the console by default.</p>
<pre class="language-bash"><code>istioctl manifest translate [flags]
</code></pre>
<table class="command-flags">
<thead>
<tr>
<th>Flags</th>
<th>Shorthand</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>--as &lt;string&gt;</code></td>
<td></td>
<td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td>
</tr>
<tr>
<td><code>--as-group &lt;stringArray&gt;</code></td>
<td></td>
<td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td>
</tr>
<tr>
<td><code>--as-uid &lt;string&gt;</code></td>
<td></td>
<td>UID to impersonate for the operation. (default ``)</td>
</tr>
<tr>
<td><code>--context &lt;string&gt;</code></td>
<td></td>
<td>Kubernetes configuration context (default ``)</td>
</tr>
<tr>
<td><code>--dry-run</code></td>
<td></td>
<td>Console/log output only, make no changes. </td>
</tr>
<tr>
<td><code>--filename &lt;stringSlice&gt;</code></td>
<td><code>-f</code></td>
<td>Path to file containing IstioOperator custom resource
This flag can be specified multiple times to overlay multiple files. Multiple files are overlaid in left to right order. (default `[]`)</td>
</tr>
<tr>
<td><code>--istioNamespace &lt;string&gt;</code></td>
<td><code>-i</code></td>
<td>Istio system namespace (default `istio-system`)</td>
</tr>
<tr>
<td><code>--kubeconfig &lt;string&gt;</code></td>
<td><code>-c</code></td>
<td>Kubernetes configuration file (default ``)</td>
</tr>
<tr>
<td><code>--manifests &lt;string&gt;</code></td>
<td><code>-d</code></td>
<td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.24.0/manifests).
(default ``)</td>
</tr>
<tr>
<td><code>--namespace &lt;string&gt;</code></td>
<td><code>-n</code></td>
<td>Kubernetes namespace (default ``)</td>
</tr>
<tr>
<td><code>--output &lt;string&gt;</code></td>
<td><code>-o</code></td>
<td>where to put translated outputs (default ``)</td>
</tr>
<tr>
<td><code>--revision &lt;string&gt;</code></td>
<td><code>-r</code></td>
<td>Target control plane revision for the command. (default ``)</td>
</tr>
<tr>
<td><code>--set &lt;stringArray&gt;</code></td>
<td><code>-s</code></td>
<td>Override an IstioOperator value, e.g. to choose a profile
(--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio
settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.24/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)</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>
<h4 id="istioctl-manifest-translate Examples">Examples</h4>
<pre class="language-bash"><code> # Translate an IstioOperator yaml file into helm values
istioctl manifest translate -f istio.yaml
# Translate a default Istio installation
istioctl manifest translate
# Enable Tracing
istioctl manifest translate --set meshConfig.enableTracing=true
# Translate the demo profile
istioctl manifest translate --set profile=demo
# To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes.
istioctl manifest translate --set &#34;values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default&#34;
</code></pre> </code></pre>
<h3 id="istioctl-options">istioctl options</h3> <h3 id="istioctl-options">istioctl options</h3>
<p>Displays istioctl global options</p> <p>Displays istioctl global options</p>
@ -7790,6 +7897,12 @@ https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/security/ssl#fip
<td>If true, enables retry policy for inbound routes which automatically retries requests that were reset before it reaches the service.</td> <td>If true, enables retry policy for inbound routes which automatically retries requests that were reset before it reaches the service.</td>
</tr> </tr>
<tr> <tr>
<td><code>ENABLE_INGRESS_WAYPOINT_ROUTING</code></td>
<td>Boolean</td>
<td><code>false</code></td>
<td>If true, Gateways will call service waypoints if the &#39;istio.io/ingress-use-waypoint&#39; label set on the Service.</td>
</tr>
<tr>
<td><code>ENABLE_LEADER_ELECTION</code></td> <td><code>ENABLE_LEADER_ELECTION</code></td>
<td>Boolean</td> <td>Boolean</td>
<td><code>true</code></td> <td><code>true</code></td>

6
content/en/docs/reference/commands/pilot-agent/index.html
View File

@ -989,6 +989,12 @@ https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/security/ssl#fip
<td>If true, enables retry policy for inbound routes which automatically retries requests that were reset before it reaches the service.</td> <td>If true, enables retry policy for inbound routes which automatically retries requests that were reset before it reaches the service.</td>
</tr> </tr>
<tr> <tr>
<td><code>ENABLE_INGRESS_WAYPOINT_ROUTING</code></td>
<td>Boolean</td>
<td><code>false</code></td>
<td>If true, Gateways will call service waypoints if the &#39;istio.io/ingress-use-waypoint&#39; label set on the Service.</td>
</tr>
<tr>
<td><code>ENABLE_LEADER_ELECTION</code></td> <td><code>ENABLE_LEADER_ELECTION</code></td>
<td>Boolean</td> <td>Boolean</td>
<td><code>true</code></td> <td><code>true</code></td>

6
content/en/docs/reference/commands/pilot-discovery/index.html
View File

@ -572,6 +572,12 @@ https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/security/ssl#fip
<td>If true, enables retry policy for inbound routes which automatically retries requests that were reset before it reaches the service.</td> <td>If true, enables retry policy for inbound routes which automatically retries requests that were reset before it reaches the service.</td>
</tr> </tr>
<tr> <tr>
<td><code>ENABLE_INGRESS_WAYPOINT_ROUTING</code></td>
<td>Boolean</td>
<td><code>false</code></td>
<td>If true, Gateways will call service waypoints if the &#39;istio.io/ingress-use-waypoint&#39; label set on the Service.</td>
</tr>
<tr>
<td><code>ENABLE_LEADER_ELECTION</code></td> <td><code>ENABLE_LEADER_ELECTION</code></td>
<td>Boolean</td> <td>Boolean</td>
<td><code>true</code></td> <td><code>true</code></td>

6
content/zh/docs/reference/commands/install-cni/index.html
View File

@ -632,6 +632,12 @@ https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/security/ssl#fip
<td>If true, enables retry policy for inbound routes which automatically retries requests that were reset before it reaches the service.</td> <td>If true, enables retry policy for inbound routes which automatically retries requests that were reset before it reaches the service.</td>
</tr> </tr>
<tr> <tr>
<td><code>ENABLE_INGRESS_WAYPOINT_ROUTING</code></td>
<td>Boolean</td>
<td><code>false</code></td>
<td>If true, Gateways will call service waypoints if the &#39;istio.io/ingress-use-waypoint&#39; label set on the Service.</td>
</tr>
<tr>
<td><code>ENABLE_LEADER_ELECTION</code></td> <td><code>ENABLE_LEADER_ELECTION</code></td>
<td>Boolean</td> <td>Boolean</td>
<td><code>true</code></td> <td><code>true</code></td>

115
content/zh/docs/reference/commands/istioctl/index.html
View File

@ -4,7 +4,7 @@ source_repo: https://github.com/istio/istio
title: istioctl title: istioctl
description: Istio control interface. description: Istio control interface.
generator: pkg-collateral-docs generator: pkg-collateral-docs
number_of_entries: 90 number_of_entries: 91
max_toc_level: 2 max_toc_level: 2
remove_toc_prefix: 'istioctl ' remove_toc_prefix: 'istioctl '
--- ---
@ -4455,6 +4455,113 @@ If set to true, the user is not prompted and a Yes response is assumed in all ca
# To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes. # To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes.
istioctl install --set &#34;values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default&#34; istioctl install --set &#34;values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default&#34;
</code></pre>
<h3 id="istioctl-manifest-translate">istioctl manifest translate</h3>
<p>The translate subcommand translates an Istio install manifest and outputs to the console by default.</p>
<pre class="language-bash"><code>istioctl manifest translate [flags]
</code></pre>
<table class="command-flags">
<thead>
<tr>
<th>Flags</th>
<th>Shorthand</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>--as &lt;string&gt;</code></td>
<td></td>
<td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td>
</tr>
<tr>
<td><code>--as-group &lt;stringArray&gt;</code></td>
<td></td>
<td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td>
</tr>
<tr>
<td><code>--as-uid &lt;string&gt;</code></td>
<td></td>
<td>UID to impersonate for the operation. (default ``)</td>
</tr>
<tr>
<td><code>--context &lt;string&gt;</code></td>
<td></td>
<td>Kubernetes configuration context (default ``)</td>
</tr>
<tr>
<td><code>--dry-run</code></td>
<td></td>
<td>Console/log output only, make no changes. </td>
</tr>
<tr>
<td><code>--filename &lt;stringSlice&gt;</code></td>
<td><code>-f</code></td>
<td>Path to file containing IstioOperator custom resource
This flag can be specified multiple times to overlay multiple files. Multiple files are overlaid in left to right order. (default `[]`)</td>
</tr>
<tr>
<td><code>--istioNamespace &lt;string&gt;</code></td>
<td><code>-i</code></td>
<td>Istio system namespace (default `istio-system`)</td>
</tr>
<tr>
<td><code>--kubeconfig &lt;string&gt;</code></td>
<td><code>-c</code></td>
<td>Kubernetes configuration file (default ``)</td>
</tr>
<tr>
<td><code>--manifests &lt;string&gt;</code></td>
<td><code>-d</code></td>
<td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.24.0/manifests).
(default ``)</td>
</tr>
<tr>
<td><code>--namespace &lt;string&gt;</code></td>
<td><code>-n</code></td>
<td>Kubernetes namespace (default ``)</td>
</tr>
<tr>
<td><code>--output &lt;string&gt;</code></td>
<td><code>-o</code></td>
<td>where to put translated outputs (default ``)</td>
</tr>
<tr>
<td><code>--revision &lt;string&gt;</code></td>
<td><code>-r</code></td>
<td>Target control plane revision for the command. (default ``)</td>
</tr>
<tr>
<td><code>--set &lt;stringArray&gt;</code></td>
<td><code>-s</code></td>
<td>Override an IstioOperator value, e.g. to choose a profile
(--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio
settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.24/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)</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>
<h4 id="istioctl-manifest-translate Examples">Examples</h4>
<pre class="language-bash"><code> # Translate an IstioOperator yaml file into helm values
istioctl manifest translate -f istio.yaml
# Translate a default Istio installation
istioctl manifest translate
# Enable Tracing
istioctl manifest translate --set meshConfig.enableTracing=true
# Translate the demo profile
istioctl manifest translate --set profile=demo
# To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes.
istioctl manifest translate --set &#34;values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default&#34;
</code></pre> </code></pre>
<h3 id="istioctl-options">istioctl options</h3> <h3 id="istioctl-options">istioctl options</h3>
<p>Displays istioctl global options</p> <p>Displays istioctl global options</p>
@ -7790,6 +7897,12 @@ https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/security/ssl#fip
<td>If true, enables retry policy for inbound routes which automatically retries requests that were reset before it reaches the service.</td> <td>If true, enables retry policy for inbound routes which automatically retries requests that were reset before it reaches the service.</td>
</tr> </tr>
<tr> <tr>
<td><code>ENABLE_INGRESS_WAYPOINT_ROUTING</code></td>
<td>Boolean</td>
<td><code>false</code></td>
<td>If true, Gateways will call service waypoints if the &#39;istio.io/ingress-use-waypoint&#39; label set on the Service.</td>
</tr>
<tr>
<td><code>ENABLE_LEADER_ELECTION</code></td> <td><code>ENABLE_LEADER_ELECTION</code></td>
<td>Boolean</td> <td>Boolean</td>
<td><code>true</code></td> <td><code>true</code></td>

6
content/zh/docs/reference/commands/pilot-agent/index.html
View File

@ -989,6 +989,12 @@ https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/security/ssl#fip
<td>If true, enables retry policy for inbound routes which automatically retries requests that were reset before it reaches the service.</td> <td>If true, enables retry policy for inbound routes which automatically retries requests that were reset before it reaches the service.</td>
</tr> </tr>
<tr> <tr>
<td><code>ENABLE_INGRESS_WAYPOINT_ROUTING</code></td>
<td>Boolean</td>
<td><code>false</code></td>
<td>If true, Gateways will call service waypoints if the &#39;istio.io/ingress-use-waypoint&#39; label set on the Service.</td>
</tr>
<tr>
<td><code>ENABLE_LEADER_ELECTION</code></td> <td><code>ENABLE_LEADER_ELECTION</code></td>
<td>Boolean</td> <td>Boolean</td>
<td><code>true</code></td> <td><code>true</code></td>

6
content/zh/docs/reference/commands/pilot-discovery/index.html
View File

@ -572,6 +572,12 @@ https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/security/ssl#fip
<td>If true, enables retry policy for inbound routes which automatically retries requests that were reset before it reaches the service.</td> <td>If true, enables retry policy for inbound routes which automatically retries requests that were reset before it reaches the service.</td>
</tr> </tr>
<tr> <tr>
<td><code>ENABLE_INGRESS_WAYPOINT_ROUTING</code></td>
<td>Boolean</td>
<td><code>false</code></td>
<td>If true, Gateways will call service waypoints if the &#39;istio.io/ingress-use-waypoint&#39; label set on the Service.</td>
</tr>
<tr>
<td><code>ENABLE_LEADER_ELECTION</code></td> <td><code>ENABLE_LEADER_ELECTION</code></td>
<td>Boolean</td> <td>Boolean</td>
<td><code>true</code></td> <td><code>true</code></td>