mirror of https://github.com/istio/istio.io.git
Automator: update istio.io@ reference docs (#13696)
This commit is contained in:
Istio Automation
GitHub
parent
e0e010f089
commit
f445e4ad67
|
|
@ -813,7 +813,7 @@ These environment variables affect the behavior of the <code>install-cni</code>
|
|||
<td><code>ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSH</code></td>
|
||||
<td>Boolean</td>
|
||||
<td><code>true</code></td>
|
||||
<td>If enabled, Istiod will not push changes on arbitraty annotation change.</td>
|
||||
<td>If enabled, Istiod will not push changes on arbitrary annotation change.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ISTIO_GPRC_MAXRECVMSGSIZE</code></td>
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ source_repo: https://github.com/istio/istio
|
|||
title: istioctl
|
||||
description: Istio control interface.
|
||||
generator: pkg-collateral-docs
|
||||
number_of_entries: 94
|
||||
number_of_entries: 99
|
||||
max_toc_level: 2
|
||||
remove_toc_prefix: 'istioctl '
|
||||
---
|
||||
|
|
@ -2742,6 +2742,409 @@ Retrieves last sent and last acknowledged xDS sync from Istiod to each Envoy in
|
|||
# View list of revisions including customizations, istiod and gateway pods
|
||||
istioctl x revision list -v
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-revision-tag">istioctl experimental revision tag</h2>
|
||||
<p>Command group used to interact with revision tags. Revision tags allow for the creation of mutable aliases
|
||||
referring to control plane revisions for sidecar injection.</p>
|
||||
<p>With revision tags, rather than relabeling a namespace from "istio.io/rev=revision-a" to "istio.io/rev=revision-b" to
|
||||
change which control plane revision handles injection, it's possible to create a revision tag "prod" and label our
|
||||
namespace "istio.io/rev=prod". The "prod" revision tag could point to "1-7-6" initially and then be changed to point to "1-8-1"
|
||||
at some later point.</p>
|
||||
<p>This allows operators to change which Istio control plane revision should handle injection for a namespace or set of namespaces
|
||||
without manual relabeling of the "istio.io/rev" tag.
|
||||
</p>
|
||||
<pre class="language-bash"><code>istioctl experimental revision tag [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>Kubernetes configuration context (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--manifests <string></code></td>
|
||||
<td><code>-d</code></td>
|
||||
<td>Specify a path to a directory of charts and profiles
|
||||
(e.g. ~/Downloads/istio-1.19.0/manifests).
|
||||
(default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Kubernetes namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--output <string></code></td>
|
||||
<td><code>-o</code></td>
|
||||
<td>Output format for revision description (available formats: table,json) (default `table`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--verbose</code></td>
|
||||
<td><code>-v</code></td>
|
||||
<td>Enable verbose output </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--vklog <Level></code></td>
|
||||
<td></td>
|
||||
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="istioctl-experimental-revision-tag-generate">istioctl experimental revision tag generate</h2>
|
||||
<p>Create a revision tag and output to the command's stdout. Tag an Istio control plane revision for use with namespace istio.io/rev
|
||||
injection labels.</p>
|
||||
<pre class="language-bash"><code>istioctl experimental revision tag generate <revision-tag> [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--auto-inject-namespaces</code></td>
|
||||
<td></td>
|
||||
<td>If set to true, the sidecars should be automatically injected into all namespaces by default </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>Kubernetes configuration context (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--manifests <string></code></td>
|
||||
<td><code>-d</code></td>
|
||||
<td>Specify a path to a directory of charts and profiles
|
||||
(e.g. ~/Downloads/istio-1.19.0/manifests). (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Kubernetes namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--output <string></code></td>
|
||||
<td><code>-o</code></td>
|
||||
<td>Output format for revision description (available formats: table,json) (default `table`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--overwrite</code></td>
|
||||
<td></td>
|
||||
<td>If true, allow revision tags to be overwritten, otherwise reject revision tag updates that
|
||||
overwrite existing revision tags. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--revision <string></code></td>
|
||||
<td><code>-r</code></td>
|
||||
<td>Control plane revision to reference from a given revision tag (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--skip-confirmation</code></td>
|
||||
<td><code>-y</code></td>
|
||||
<td>The skipConfirmation determines whether the user is prompted for confirmation.
|
||||
If set to true, the user is not prompted and a Yes response is assumed in all cases. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--verbose</code></td>
|
||||
<td><code>-v</code></td>
|
||||
<td>Enable verbose output </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--vklog <Level></code></td>
|
||||
<td></td>
|
||||
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--webhook-name <string></code></td>
|
||||
<td></td>
|
||||
<td>Name to use for a revision tag's mutating webhook configuration. (default ``)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="istioctl-experimental-revision-tag-generate Examples">Examples</h3>
|
||||
<pre class="language-bash"><code> # Create a revision tag from the "1-8-0" revision
|
||||
istioctl tag generate prod --revision 1-8-0 > tag.yaml
|
||||
|
||||
# Apply the tag to cluster
|
||||
kubectl apply -f tag.yaml
|
||||
|
||||
# Point namespace "test-ns" at the revision pointed to by the "prod" revision tag
|
||||
kubectl label ns test-ns istio.io/rev=prod
|
||||
|
||||
# Rollout namespace "test-ns" to update workloads to the "1-8-0" revision
|
||||
kubectl rollout restart deployments -n test-ns
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-revision-tag-list">istioctl experimental revision tag list</h2>
|
||||
<p>List existing revision tags</p>
|
||||
<pre class="language-bash"><code>istioctl experimental revision tag list [flags]
|
||||
</code></pre>
|
||||
<div class="aliases">
|
||||
<pre class="language-bash"><code>istioctl experimental revision tag show [flags]
|
||||
</code></pre></div>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>Kubernetes configuration context (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--manifests <string></code></td>
|
||||
<td><code>-d</code></td>
|
||||
<td>Specify a path to a directory of charts and profiles
|
||||
(e.g. ~/Downloads/istio-1.19.0/manifests).
|
||||
(default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Kubernetes namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--output <string></code></td>
|
||||
<td><code>-o</code></td>
|
||||
<td>Output format for revision description (available formats: table,json) (default `table`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--verbose</code></td>
|
||||
<td><code>-v</code></td>
|
||||
<td>Enable verbose output </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--vklog <Level></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="istioctl-experimental-revision-tag-list Examples">Examples</h3>
|
||||
<pre class="language-bash"><code>istioctl tag list
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-revision-tag-remove">istioctl experimental revision tag remove</h2>
|
||||
<p>Remove Istio control plane revision tag.</p>
|
||||
<p>Removing a revision tag should be done with care. Removing a revision tag will disrupt sidecar injection in namespaces
|
||||
that reference the tag in an "istio.io/rev" label. Verify that there are no remaining namespaces referencing a
|
||||
revision tag before removing using the "istioctl tag list" command.
|
||||
</p>
|
||||
<pre class="language-bash"><code>istioctl experimental revision tag remove <revision-tag> [flags]
|
||||
</code></pre>
|
||||
<div class="aliases">
|
||||
<pre class="language-bash"><code>istioctl experimental revision tag delete <revision-tag> [flags]
|
||||
</code></pre></div>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>Kubernetes configuration context (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--manifests <string></code></td>
|
||||
<td><code>-d</code></td>
|
||||
<td>Specify a path to a directory of charts and profiles
|
||||
(e.g. ~/Downloads/istio-1.19.0/manifests).
|
||||
(default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Kubernetes namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--output <string></code></td>
|
||||
<td><code>-o</code></td>
|
||||
<td>Output format for revision description (available formats: table,json) (default `table`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--skip-confirmation</code></td>
|
||||
<td><code>-y</code></td>
|
||||
<td>The skipConfirmation determines whether the user is prompted for confirmation.
|
||||
If set to true, the user is not prompted and a Yes response is assumed in all cases. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--verbose</code></td>
|
||||
<td><code>-v</code></td>
|
||||
<td>Enable verbose output </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--vklog <Level></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="istioctl-experimental-revision-tag-remove Examples">Examples</h3>
|
||||
<pre class="language-bash"><code> # Remove the revision tag "prod"
|
||||
istioctl tag remove prod
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-revision-tag-set">istioctl experimental revision tag set</h2>
|
||||
<p>Create or modify revision tags. Tag an Istio control plane revision for use with namespace istio.io/rev
|
||||
injection labels.</p>
|
||||
<pre class="language-bash"><code>istioctl experimental revision tag set <revision-tag> [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--auto-inject-namespaces</code></td>
|
||||
<td></td>
|
||||
<td>If set to true, the sidecars should be automatically injected into all namespaces by default </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>Kubernetes configuration context (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--manifests <string></code></td>
|
||||
<td><code>-d</code></td>
|
||||
<td>Specify a path to a directory of charts and profiles
|
||||
(e.g. ~/Downloads/istio-1.19.0/manifests). (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Kubernetes namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--output <string></code></td>
|
||||
<td><code>-o</code></td>
|
||||
<td>Output format for revision description (available formats: table,json) (default `table`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--overwrite</code></td>
|
||||
<td></td>
|
||||
<td>If true, allow revision tags to be overwritten, otherwise reject revision tag updates that
|
||||
overwrite existing revision tags. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--revision <string></code></td>
|
||||
<td><code>-r</code></td>
|
||||
<td>Control plane revision to reference from a given revision tag (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--skip-confirmation</code></td>
|
||||
<td><code>-y</code></td>
|
||||
<td>The skipConfirmation determines whether the user is prompted for confirmation.
|
||||
If set to true, the user is not prompted and a Yes response is assumed in all cases. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--verbose</code></td>
|
||||
<td><code>-v</code></td>
|
||||
<td>Enable verbose output </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--vklog <Level></code></td>
|
||||
<td></td>
|
||||
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--webhook-name <string></code></td>
|
||||
<td></td>
|
||||
<td>Name to use for a revision tag's mutating webhook configuration. (default ``)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="istioctl-experimental-revision-tag-set Examples">Examples</h3>
|
||||
<pre class="language-bash"><code> # Create a revision tag from the "1-8-0" revision
|
||||
istioctl tag set prod --revision 1-8-0
|
||||
|
||||
# Point namespace "test-ns" at the revision pointed to by the "prod" revision tag
|
||||
kubectl label ns test-ns istio.io/rev=prod
|
||||
|
||||
# Change the revision tag to reference the "1-8-1" revision
|
||||
istioctl tag set prod --revision 1-8-1 --overwrite
|
||||
|
||||
# Make revision "1-8-1" the default revision, both resulting in that revision handling injection for "istio-injection=enabled"
|
||||
# and validating resources cluster-wide
|
||||
istioctl tag set default --revision 1-8-1
|
||||
|
||||
# Rollout namespace "test-ns" to update workloads to the "1-8-1" revision
|
||||
kubectl rollout restart deployments -n test-ns
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-version">istioctl experimental version</h2>
|
||||
<p>Prints out build version information</p>
|
||||
|
|
@ -6267,6 +6670,11 @@ If set to true, the user is not prompted and a Yes response is assumed in all ca
|
|||
<td>Kubernetes namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--referential</code></td>
|
||||
<td><code>-x</code></td>
|
||||
<td>Enable structural validation for policy and telemetry </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--vklog <Level></code></td>
|
||||
<td></td>
|
||||
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
||||
|
|
@ -6699,7 +7107,7 @@ These environment variables affect the behavior of the <code>istioctl</code> com
|
|||
<td><code>ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSH</code></td>
|
||||
<td>Boolean</td>
|
||||
<td><code>true</code></td>
|
||||
<td>If enabled, Istiod will not push changes on arbitraty annotation change.</td>
|
||||
<td>If enabled, Istiod will not push changes on arbitrary annotation change.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ISTIO_GPRC_MAXRECVMSGSIZE</code></td>
|
||||
|
|
|
|||
|
|
@ -518,7 +518,7 @@ These environment variables affect the behavior of the <code>operator</code> com
|
|||
<td><code>ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSH</code></td>
|
||||
<td>Boolean</td>
|
||||
<td><code>true</code></td>
|
||||
<td>If enabled, Istiod will not push changes on arbitraty annotation change.</td>
|
||||
<td>If enabled, Istiod will not push changes on arbitrary annotation change.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ISTIO_GPRC_MAXRECVMSGSIZE</code></td>
|
||||
|
|
|
|||
|
|
@ -1367,7 +1367,7 @@ These environment variables affect the behavior of the <code>pilot-agent</code>
|
|||
<td><code>ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSH</code></td>
|
||||
<td>Boolean</td>
|
||||
<td><code>true</code></td>
|
||||
<td>If enabled, Istiod will not push changes on arbitraty annotation change.</td>
|
||||
<td>If enabled, Istiod will not push changes on arbitrary annotation change.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ISTIO_ENVOY_ENABLE_CORE_DUMP</code></td>
|
||||
|
|
|
|||
|
|
@ -686,7 +686,7 @@ These environment variables affect the behavior of the <code>pilot-discovery</co
|
|||
<td><code>ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSH</code></td>
|
||||
<td>Boolean</td>
|
||||
<td><code>true</code></td>
|
||||
<td>If enabled, Istiod will not push changes on arbitraty annotation change.</td>
|
||||
<td>If enabled, Istiod will not push changes on arbitrary annotation change.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ISTIO_GPRC_MAXRECVMSGSIZE</code></td>
|
||||
|
|
|
|||
|
|
@ -67,6 +67,26 @@ No
|
|||
<p>Connection timeout used by Envoy. (MUST BE >=1ms)
|
||||
Default timeout is 10s.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="MeshConfig-protocol_detection_timeout">
|
||||
<td><code>protocolDetectionTimeout</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>Automatic protocol detection uses a set of heuristics to
|
||||
determine whether the connection is using TLS or not (on the
|
||||
server side), as well as the application protocol being used
|
||||
(e.g., http vs tcp). These heuristics rely on the client sending
|
||||
the first bits of data. For server first protocols like MySQL,
|
||||
MongoDB, etc. Envoy will timeout on the protocol detection after
|
||||
the specified period, defaulting to non mTLS plain TCP
|
||||
traffic. Set this field to tweak the period that Envoy will wait
|
||||
for the client to send the first bits of data. (MUST BE >=1ms or
|
||||
0s to disable). Default detection timeout is 0s (no timeout).</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
|
|
|
|||
|
|
@ -813,7 +813,7 @@ These environment variables affect the behavior of the <code>install-cni</code>
|
|||
<td><code>ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSH</code></td>
|
||||
<td>Boolean</td>
|
||||
<td><code>true</code></td>
|
||||
<td>If enabled, Istiod will not push changes on arbitraty annotation change.</td>
|
||||
<td>If enabled, Istiod will not push changes on arbitrary annotation change.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ISTIO_GPRC_MAXRECVMSGSIZE</code></td>
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ source_repo: https://github.com/istio/istio
|
|||
title: istioctl
|
||||
description: Istio control interface.
|
||||
generator: pkg-collateral-docs
|
||||
number_of_entries: 94
|
||||
number_of_entries: 99
|
||||
max_toc_level: 2
|
||||
remove_toc_prefix: 'istioctl '
|
||||
---
|
||||
|
|
@ -2742,6 +2742,409 @@ Retrieves last sent and last acknowledged xDS sync from Istiod to each Envoy in
|
|||
# View list of revisions including customizations, istiod and gateway pods
|
||||
istioctl x revision list -v
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-revision-tag">istioctl experimental revision tag</h2>
|
||||
<p>Command group used to interact with revision tags. Revision tags allow for the creation of mutable aliases
|
||||
referring to control plane revisions for sidecar injection.</p>
|
||||
<p>With revision tags, rather than relabeling a namespace from "istio.io/rev=revision-a" to "istio.io/rev=revision-b" to
|
||||
change which control plane revision handles injection, it's possible to create a revision tag "prod" and label our
|
||||
namespace "istio.io/rev=prod". The "prod" revision tag could point to "1-7-6" initially and then be changed to point to "1-8-1"
|
||||
at some later point.</p>
|
||||
<p>This allows operators to change which Istio control plane revision should handle injection for a namespace or set of namespaces
|
||||
without manual relabeling of the "istio.io/rev" tag.
|
||||
</p>
|
||||
<pre class="language-bash"><code>istioctl experimental revision tag [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>Kubernetes configuration context (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--manifests <string></code></td>
|
||||
<td><code>-d</code></td>
|
||||
<td>Specify a path to a directory of charts and profiles
|
||||
(e.g. ~/Downloads/istio-1.19.0/manifests).
|
||||
(default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Kubernetes namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--output <string></code></td>
|
||||
<td><code>-o</code></td>
|
||||
<td>Output format for revision description (available formats: table,json) (default `table`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--verbose</code></td>
|
||||
<td><code>-v</code></td>
|
||||
<td>Enable verbose output </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--vklog <Level></code></td>
|
||||
<td></td>
|
||||
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="istioctl-experimental-revision-tag-generate">istioctl experimental revision tag generate</h2>
|
||||
<p>Create a revision tag and output to the command's stdout. Tag an Istio control plane revision for use with namespace istio.io/rev
|
||||
injection labels.</p>
|
||||
<pre class="language-bash"><code>istioctl experimental revision tag generate <revision-tag> [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--auto-inject-namespaces</code></td>
|
||||
<td></td>
|
||||
<td>If set to true, the sidecars should be automatically injected into all namespaces by default </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>Kubernetes configuration context (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--manifests <string></code></td>
|
||||
<td><code>-d</code></td>
|
||||
<td>Specify a path to a directory of charts and profiles
|
||||
(e.g. ~/Downloads/istio-1.19.0/manifests). (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Kubernetes namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--output <string></code></td>
|
||||
<td><code>-o</code></td>
|
||||
<td>Output format for revision description (available formats: table,json) (default `table`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--overwrite</code></td>
|
||||
<td></td>
|
||||
<td>If true, allow revision tags to be overwritten, otherwise reject revision tag updates that
|
||||
overwrite existing revision tags. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--revision <string></code></td>
|
||||
<td><code>-r</code></td>
|
||||
<td>Control plane revision to reference from a given revision tag (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--skip-confirmation</code></td>
|
||||
<td><code>-y</code></td>
|
||||
<td>The skipConfirmation determines whether the user is prompted for confirmation.
|
||||
If set to true, the user is not prompted and a Yes response is assumed in all cases. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--verbose</code></td>
|
||||
<td><code>-v</code></td>
|
||||
<td>Enable verbose output </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--vklog <Level></code></td>
|
||||
<td></td>
|
||||
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--webhook-name <string></code></td>
|
||||
<td></td>
|
||||
<td>Name to use for a revision tag's mutating webhook configuration. (default ``)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="istioctl-experimental-revision-tag-generate Examples">Examples</h3>
|
||||
<pre class="language-bash"><code> # Create a revision tag from the "1-8-0" revision
|
||||
istioctl tag generate prod --revision 1-8-0 > tag.yaml
|
||||
|
||||
# Apply the tag to cluster
|
||||
kubectl apply -f tag.yaml
|
||||
|
||||
# Point namespace "test-ns" at the revision pointed to by the "prod" revision tag
|
||||
kubectl label ns test-ns istio.io/rev=prod
|
||||
|
||||
# Rollout namespace "test-ns" to update workloads to the "1-8-0" revision
|
||||
kubectl rollout restart deployments -n test-ns
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-revision-tag-list">istioctl experimental revision tag list</h2>
|
||||
<p>List existing revision tags</p>
|
||||
<pre class="language-bash"><code>istioctl experimental revision tag list [flags]
|
||||
</code></pre>
|
||||
<div class="aliases">
|
||||
<pre class="language-bash"><code>istioctl experimental revision tag show [flags]
|
||||
</code></pre></div>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>Kubernetes configuration context (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--manifests <string></code></td>
|
||||
<td><code>-d</code></td>
|
||||
<td>Specify a path to a directory of charts and profiles
|
||||
(e.g. ~/Downloads/istio-1.19.0/manifests).
|
||||
(default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Kubernetes namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--output <string></code></td>
|
||||
<td><code>-o</code></td>
|
||||
<td>Output format for revision description (available formats: table,json) (default `table`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--verbose</code></td>
|
||||
<td><code>-v</code></td>
|
||||
<td>Enable verbose output </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--vklog <Level></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="istioctl-experimental-revision-tag-list Examples">Examples</h3>
|
||||
<pre class="language-bash"><code>istioctl tag list
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-revision-tag-remove">istioctl experimental revision tag remove</h2>
|
||||
<p>Remove Istio control plane revision tag.</p>
|
||||
<p>Removing a revision tag should be done with care. Removing a revision tag will disrupt sidecar injection in namespaces
|
||||
that reference the tag in an "istio.io/rev" label. Verify that there are no remaining namespaces referencing a
|
||||
revision tag before removing using the "istioctl tag list" command.
|
||||
</p>
|
||||
<pre class="language-bash"><code>istioctl experimental revision tag remove <revision-tag> [flags]
|
||||
</code></pre>
|
||||
<div class="aliases">
|
||||
<pre class="language-bash"><code>istioctl experimental revision tag delete <revision-tag> [flags]
|
||||
</code></pre></div>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>Kubernetes configuration context (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--manifests <string></code></td>
|
||||
<td><code>-d</code></td>
|
||||
<td>Specify a path to a directory of charts and profiles
|
||||
(e.g. ~/Downloads/istio-1.19.0/manifests).
|
||||
(default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Kubernetes namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--output <string></code></td>
|
||||
<td><code>-o</code></td>
|
||||
<td>Output format for revision description (available formats: table,json) (default `table`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--skip-confirmation</code></td>
|
||||
<td><code>-y</code></td>
|
||||
<td>The skipConfirmation determines whether the user is prompted for confirmation.
|
||||
If set to true, the user is not prompted and a Yes response is assumed in all cases. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--verbose</code></td>
|
||||
<td><code>-v</code></td>
|
||||
<td>Enable verbose output </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--vklog <Level></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="istioctl-experimental-revision-tag-remove Examples">Examples</h3>
|
||||
<pre class="language-bash"><code> # Remove the revision tag "prod"
|
||||
istioctl tag remove prod
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-revision-tag-set">istioctl experimental revision tag set</h2>
|
||||
<p>Create or modify revision tags. Tag an Istio control plane revision for use with namespace istio.io/rev
|
||||
injection labels.</p>
|
||||
<pre class="language-bash"><code>istioctl experimental revision tag set <revision-tag> [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--auto-inject-namespaces</code></td>
|
||||
<td></td>
|
||||
<td>If set to true, the sidecars should be automatically injected into all namespaces by default </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>Kubernetes configuration context (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--manifests <string></code></td>
|
||||
<td><code>-d</code></td>
|
||||
<td>Specify a path to a directory of charts and profiles
|
||||
(e.g. ~/Downloads/istio-1.19.0/manifests). (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Kubernetes namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--output <string></code></td>
|
||||
<td><code>-o</code></td>
|
||||
<td>Output format for revision description (available formats: table,json) (default `table`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--overwrite</code></td>
|
||||
<td></td>
|
||||
<td>If true, allow revision tags to be overwritten, otherwise reject revision tag updates that
|
||||
overwrite existing revision tags. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--revision <string></code></td>
|
||||
<td><code>-r</code></td>
|
||||
<td>Control plane revision to reference from a given revision tag (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--skip-confirmation</code></td>
|
||||
<td><code>-y</code></td>
|
||||
<td>The skipConfirmation determines whether the user is prompted for confirmation.
|
||||
If set to true, the user is not prompted and a Yes response is assumed in all cases. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--verbose</code></td>
|
||||
<td><code>-v</code></td>
|
||||
<td>Enable verbose output </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--vklog <Level></code></td>
|
||||
<td></td>
|
||||
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--webhook-name <string></code></td>
|
||||
<td></td>
|
||||
<td>Name to use for a revision tag's mutating webhook configuration. (default ``)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="istioctl-experimental-revision-tag-set Examples">Examples</h3>
|
||||
<pre class="language-bash"><code> # Create a revision tag from the "1-8-0" revision
|
||||
istioctl tag set prod --revision 1-8-0
|
||||
|
||||
# Point namespace "test-ns" at the revision pointed to by the "prod" revision tag
|
||||
kubectl label ns test-ns istio.io/rev=prod
|
||||
|
||||
# Change the revision tag to reference the "1-8-1" revision
|
||||
istioctl tag set prod --revision 1-8-1 --overwrite
|
||||
|
||||
# Make revision "1-8-1" the default revision, both resulting in that revision handling injection for "istio-injection=enabled"
|
||||
# and validating resources cluster-wide
|
||||
istioctl tag set default --revision 1-8-1
|
||||
|
||||
# Rollout namespace "test-ns" to update workloads to the "1-8-1" revision
|
||||
kubectl rollout restart deployments -n test-ns
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-version">istioctl experimental version</h2>
|
||||
<p>Prints out build version information</p>
|
||||
|
|
@ -6267,6 +6670,11 @@ If set to true, the user is not prompted and a Yes response is assumed in all ca
|
|||
<td>Kubernetes namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--referential</code></td>
|
||||
<td><code>-x</code></td>
|
||||
<td>Enable structural validation for policy and telemetry </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--vklog <Level></code></td>
|
||||
<td></td>
|
||||
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
||||
|
|
@ -6699,7 +7107,7 @@ These environment variables affect the behavior of the <code>istioctl</code> com
|
|||
<td><code>ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSH</code></td>
|
||||
<td>Boolean</td>
|
||||
<td><code>true</code></td>
|
||||
<td>If enabled, Istiod will not push changes on arbitraty annotation change.</td>
|
||||
<td>If enabled, Istiod will not push changes on arbitrary annotation change.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ISTIO_GPRC_MAXRECVMSGSIZE</code></td>
|
||||
|
|
|
|||
|
|
@ -518,7 +518,7 @@ These environment variables affect the behavior of the <code>operator</code> com
|
|||
<td><code>ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSH</code></td>
|
||||
<td>Boolean</td>
|
||||
<td><code>true</code></td>
|
||||
<td>If enabled, Istiod will not push changes on arbitraty annotation change.</td>
|
||||
<td>If enabled, Istiod will not push changes on arbitrary annotation change.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ISTIO_GPRC_MAXRECVMSGSIZE</code></td>
|
||||
|
|
|
|||
|
|
@ -1367,7 +1367,7 @@ These environment variables affect the behavior of the <code>pilot-agent</code>
|
|||
<td><code>ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSH</code></td>
|
||||
<td>Boolean</td>
|
||||
<td><code>true</code></td>
|
||||
<td>If enabled, Istiod will not push changes on arbitraty annotation change.</td>
|
||||
<td>If enabled, Istiod will not push changes on arbitrary annotation change.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ISTIO_ENVOY_ENABLE_CORE_DUMP</code></td>
|
||||
|
|
|
|||
|
|
@ -686,7 +686,7 @@ These environment variables affect the behavior of the <code>pilot-discovery</co
|
|||
<td><code>ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSH</code></td>
|
||||
<td>Boolean</td>
|
||||
<td><code>true</code></td>
|
||||
<td>If enabled, Istiod will not push changes on arbitraty annotation change.</td>
|
||||
<td>If enabled, Istiod will not push changes on arbitrary annotation change.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ISTIO_GPRC_MAXRECVMSGSIZE</code></td>
|
||||
|
|
|
|||
|
|
@ -67,6 +67,26 @@ No
|
|||
<p>Connection timeout used by Envoy. (MUST BE >=1ms)
|
||||
Default timeout is 10s.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="MeshConfig-protocol_detection_timeout">
|
||||
<td><code>protocolDetectionTimeout</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>Automatic protocol detection uses a set of heuristics to
|
||||
determine whether the connection is using TLS or not (on the
|
||||
server side), as well as the application protocol being used
|
||||
(e.g., http vs tcp). These heuristics rely on the client sending
|
||||
the first bits of data. For server first protocols like MySQL,
|
||||
MongoDB, etc. Envoy will timeout on the protocol detection after
|
||||
the specified period, defaulting to non mTLS plain TCP
|
||||
traffic. Set this field to tweak the period that Envoy will wait
|
||||
for the client to send the first bits of data. (MUST BE >=1ms or
|
||||
0s to disable). Default detection timeout is 0s (no timeout).</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
|
|
|
|||
Loading…
Reference in New Issue