mirror of https://github.com/istio/istio.io.git
5517 lines
189 KiB
HTML
5517 lines
189 KiB
HTML
---
|
|
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/istio/istio' REPO
|
|
source_repo: https://github.com/istio/istio
|
|
title: istioctl
|
|
description: Istio control interface.
|
|
generator: pkg-collateral-docs
|
|
number_of_entries: 76
|
|
max_toc_level: 2
|
|
remove_toc_prefix: 'istioctl '
|
|
---
|
|
<p>Istio configuration command line utility for service operators to
|
|
debug and diagnose their Istio mesh.
|
|
</p>
|
|
<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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-analyze">istioctl analyze</h2>
|
|
<p>Analyze Istio configuration and print validation messages</p>
|
|
<pre class="language-bash"><code>istioctl analyze <file>... [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--all-namespaces</code></td>
|
|
<td><code>-A</code></td>
|
|
<td>Analyze all namespaces </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--color</code></td>
|
|
<td></td>
|
|
<td>Default true. Disable with '=false' or set $TERM to dumb </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--failure-threshold <Level></code></td>
|
|
<td></td>
|
|
<td>The severity level of analysis at which to set a non-zero exit code. Valid values: [Info Warning Error] (default `Error`)</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>--list-analyzers</code></td>
|
|
<td><code>-L</code></td>
|
|
<td>List the analyzers available to run. Suppresses normal execution. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--meshConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>Overrides the mesh config values to use for analysis. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of [log json yaml] (default `log`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output-threshold <Level></code></td>
|
|
<td></td>
|
|
<td>The severity level of analysis at which to display messages. Valid values: [Info Warning Error] (default `Info`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--recursive</code></td>
|
|
<td><code>-R</code></td>
|
|
<td>Process directory arguments recursively. Useful when you want to analyze related manifests organized within the same directory. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--suppress <stringArray></code></td>
|
|
<td><code>-S</code></td>
|
|
<td>Suppress reporting a message code on a specific resource. Values are supplied in the form <code>=<resource> (e.g. '--suppress "IST0102=DestinationRule primary-dr.default"'). Can be repeated. You can include the wildcard character '*' to support a partial match (e.g. '--suppress "IST0102=DestinationRule *.default" ). (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--timeout <duration></code></td>
|
|
<td></td>
|
|
<td>The duration to wait before failing (default `30s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--use-kube</code></td>
|
|
<td><code>-k</code></td>
|
|
<td>Use live Kubernetes cluster for analysis. Set --use-kube=false to analyze files only. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--verbose</code></td>
|
|
<td><code>-v</code></td>
|
|
<td>Enable verbose output </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-analyze Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Analyze the current live cluster
|
|
istioctl analyze
|
|
|
|
# Analyze the current live cluster, simulating the effect of applying additional yaml files
|
|
istioctl analyze a.yaml b.yaml my-app-config/
|
|
|
|
# Analyze the current live cluster, simulating the effect of applying a directory of config recursively
|
|
istioctl analyze --recursive my-istio-config/
|
|
|
|
# Analyze yaml files without connecting to a live cluster
|
|
istioctl analyze --use-kube=false a.yaml b.yaml my-app-config/
|
|
|
|
# Analyze the current live cluster and suppress PodMissingProxy for pod mypod in namespace 'testing'.
|
|
istioctl analyze -S "IST0103=Pod mypod.testing"
|
|
|
|
# Analyze the current live cluster and suppress PodMissingProxy for all pods in namespace 'testing',
|
|
# and suppress MisplacedAnnotation on deployment foobar in namespace default.
|
|
istioctl analyze -S "IST0103=Pod *.testing" -S "IST0107=Deployment foobar.default"
|
|
|
|
# List available analyzers
|
|
istioctl analyze -L
|
|
</code></pre>
|
|
<h2 id="istioctl-authz">istioctl authz</h2>
|
|
<p>(authz is experimental. Use `istioctl experimental authz`)</p>
|
|
<pre class="language-bash"><code>istioctl authz [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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-bug-report">istioctl bug-report</h2>
|
|
<p>bug-report selectively captures cluster information and logs into an archive to help diagnose problems.
|
|
Proxy logs can be filtered using:
|
|
--include|--exclude ns1,ns2.../dep1,dep2.../pod1,pod2.../cntr1,cntr.../lbl1=val1,lbl2=val2.../ann1=val1,ann2=val2...
|
|
where ns=namespace, dep=deployment, cntr=container, lbl=label, ann=annotation</p>
|
|
<p>The filter spec is interpreted as 'must be in (ns1 OR ns2) AND (dep1 OR dep2) AND (cntr1 OR cntr2)...'
|
|
The log will be included only if the container matches at least one include filter and does not match any exclude filters.
|
|
All parts of the filter are optional and can be omitted e.g. ns1//pod1 filters only for namespace ns1 and pod1.
|
|
All names except label and annotation keys support '*' glob matching pattern.</p>
|
|
<p>e.g.
|
|
--include ns1,ns2 (only namespaces ns1 and ns2)
|
|
--include n*//p*/l=v* (pods with name beginning with 'p' in namespaces beginning with 'n' and having label 'l' with value beginning with 'v'.)</p>
|
|
<pre class="language-bash"><code>istioctl bug-report [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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--critical-errs <stringSlice></code></td>
|
|
<td></td>
|
|
<td>List of comma separated glob patters to match against log error strings. If any pattern matches an error in the log, the logs is given the highest priority for archive inclusion. (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dir <string></code></td>
|
|
<td></td>
|
|
<td>Set a specific directory for temporary artifact storage. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Only log commands that would be run, don't fetch or write. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--duration <duration></code></td>
|
|
<td></td>
|
|
<td>How far to go back in time from end-time for log entries to include in the archive. Default is infinity. If set, start-time must be unset. (default `0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--end-time <string></code></td>
|
|
<td></td>
|
|
<td>End time for the range of log entries to include in the archive. Default is now. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--exclude <stringSlice></code></td>
|
|
<td></td>
|
|
<td>Spec for which pods' proxy logs to exclude from the archive, after the include spec is processed. See above for format and examples. (default `["kube-system, kube-public, kube-node-lease, local-path-storage"]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Path to a file containing configuration in YAML format. The file contents are applied over the default values and flag settings, with lists being replaced per JSON merge semantics. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--full-secrets</code></td>
|
|
<td></td>
|
|
<td>If set, secret contents are included in output. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ignore-errs <stringSlice></code></td>
|
|
<td></td>
|
|
<td>List of comma separated glob patters to match against log error strings. Any error matching these patters is ignored when calculating the log importance heuristic. (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--include <stringSlice></code></td>
|
|
<td></td>
|
|
<td>Spec for which pods' proxy logs to include in the archive. See above for format and examples. (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istio-namespace <string></code></td>
|
|
<td></td>
|
|
<td>Namespace where Istio control plane is installed. (default `istio-system`)</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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--start-time <string></code></td>
|
|
<td></td>
|
|
<td>Start time for the range of log entries to include in the archive. Default is the infinite past. If set, Since must be unset. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--timeout <duration></code></td>
|
|
<td></td>
|
|
<td>Maximum amount of time to spend fetching logs. When timeout is reached only the logs captured so far are saved to the archive. (default `30m0s`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-bug-report-version">istioctl bug-report version</h2>
|
|
<p>Prints out build version information</p>
|
|
<pre class="language-bash"><code>istioctl bug-report version [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>Name of the kubeconfig Context to use. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--critical-errs <stringSlice></code></td>
|
|
<td></td>
|
|
<td>List of comma separated glob patters to match against log error strings. If any pattern matches an error in the log, the logs is given the highest priority for archive inclusion. (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dir <string></code></td>
|
|
<td></td>
|
|
<td>Set a specific directory for temporary artifact storage. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Only log commands that would be run, don't fetch or write. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--duration <duration></code></td>
|
|
<td></td>
|
|
<td>How far to go back in time from end-time for log entries to include in the archive. Default is infinity. If set, start-time must be unset. (default `0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--end-time <string></code></td>
|
|
<td></td>
|
|
<td>End time for the range of log entries to include in the archive. Default is now. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--exclude <stringSlice></code></td>
|
|
<td></td>
|
|
<td>Spec for which pods' proxy logs to exclude from the archive, after the include spec is processed. See above for format and examples. (default `["kube-system, kube-public, kube-node-lease, local-path-storage"]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Path to a file containing configuration in YAML format. The file contents are applied over the default values and flag settings, with lists being replaced per JSON merge semantics. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--full-secrets</code></td>
|
|
<td></td>
|
|
<td>If set, secret contents are included in output. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ignore-errs <stringSlice></code></td>
|
|
<td></td>
|
|
<td>List of comma separated glob patters to match against log error strings. Any error matching these patters is ignored when calculating the log importance heuristic. (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--include <stringSlice></code></td>
|
|
<td></td>
|
|
<td>Spec for which pods' proxy logs to include in the archive. See above for format and examples. (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istio-namespace <string></code></td>
|
|
<td></td>
|
|
<td>Namespace where Istio control plane is installed. (default `istio-system`)</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>Path to kube config. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>One of 'yaml' or 'json'. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--short</code></td>
|
|
<td><code>-s</code></td>
|
|
<td>Use --short=false to generate full version information </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--start-time <string></code></td>
|
|
<td></td>
|
|
<td>Start time for the range of log entries to include in the archive. Default is the infinite past. If set, Since must be unset. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--timeout <duration></code></td>
|
|
<td></td>
|
|
<td>Maximum amount of time to spend fetching logs. When timeout is reached only the logs captured so far are saved to the archive. (default `30m0s`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-dashboard">istioctl dashboard</h2>
|
|
<p>Access to Istio web UIs</p>
|
|
<pre class="language-bash"><code>istioctl dashboard [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl dash [flags]
|
|
istioctl d [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>--address <string></code></td>
|
|
<td></td>
|
|
<td>Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--port <int></code></td>
|
|
<td><code>-p</code></td>
|
|
<td>Local port to listen to (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-dashboard-controlz">istioctl dashboard controlz</h2>
|
|
<p>Open the ControlZ web UI for a pod in the Istio control plane</p>
|
|
<pre class="language-bash"><code>istioctl dashboard controlz [<type>/]<name>[.<namespace>] [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--address <string></code></td>
|
|
<td></td>
|
|
<td>Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ctrlz_port <int></code></td>
|
|
<td></td>
|
|
<td>ControlZ port (default `9876`)</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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--port <int></code></td>
|
|
<td><code>-p</code></td>
|
|
<td>Local port to listen to (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--selector <string></code></td>
|
|
<td><code>-l</code></td>
|
|
<td>Label selector (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-dashboard-controlz Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Open ControlZ web UI for the istiod-123-456.istio-system pod
|
|
istioctl dashboard controlz istiod-123-456.istio-system
|
|
|
|
# Open ControlZ web UI for any Istiod pod
|
|
istioctl dashboard controlz deployment/istiod.istio-system
|
|
|
|
# with short syntax
|
|
istioctl dash controlz pilot-123-456.istio-system
|
|
istioctl d controlz pilot-123-456.istio-system
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-dashboard-envoy">istioctl dashboard envoy</h2>
|
|
<p>Open the Envoy admin dashboard for a sidecar</p>
|
|
<pre class="language-bash"><code>istioctl dashboard envoy [<type>/]<name>[.<namespace>] [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--address <string></code></td>
|
|
<td></td>
|
|
<td>Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--port <int></code></td>
|
|
<td><code>-p</code></td>
|
|
<td>Local port to listen to (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--selector <string></code></td>
|
|
<td><code>-l</code></td>
|
|
<td>Label selector (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-dashboard-envoy Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Open Envoy dashboard for the productpage-123-456.default pod
|
|
istioctl dashboard envoy productpage-123-456.default
|
|
|
|
# Open Envoy dashboard for one pod under a deployment
|
|
istioctl dashboard envoy deployment/productpage-v1
|
|
|
|
# with short syntax
|
|
istioctl dash envoy productpage-123-456.default
|
|
istioctl d envoy productpage-123-456.default
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-dashboard-grafana">istioctl dashboard grafana</h2>
|
|
<p>Open Istio's Grafana dashboard</p>
|
|
<pre class="language-bash"><code>istioctl dashboard grafana [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--address <string></code></td>
|
|
<td></td>
|
|
<td>Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--port <int></code></td>
|
|
<td><code>-p</code></td>
|
|
<td>Local port to listen to (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-dashboard-grafana Examples">Examples</h3>
|
|
<pre class="language-bash"><code> istioctl dashboard grafana
|
|
|
|
# with short syntax
|
|
istioctl dash grafana
|
|
istioctl d grafana
|
|
</code></pre>
|
|
<h2 id="istioctl-dashboard-jaeger">istioctl dashboard jaeger</h2>
|
|
<p>Open Istio's Jaeger dashboard</p>
|
|
<pre class="language-bash"><code>istioctl dashboard jaeger [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--address <string></code></td>
|
|
<td></td>
|
|
<td>Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--port <int></code></td>
|
|
<td><code>-p</code></td>
|
|
<td>Local port to listen to (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-dashboard-jaeger Examples">Examples</h3>
|
|
<pre class="language-bash"><code> istioctl dashboard jaeger
|
|
|
|
# with short syntax
|
|
istioctl dash jaeger
|
|
istioctl d jaeger
|
|
</code></pre>
|
|
<h2 id="istioctl-dashboard-kiali">istioctl dashboard kiali</h2>
|
|
<p>Open Istio's Kiali dashboard</p>
|
|
<pre class="language-bash"><code>istioctl dashboard kiali [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--address <string></code></td>
|
|
<td></td>
|
|
<td>Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--port <int></code></td>
|
|
<td><code>-p</code></td>
|
|
<td>Local port to listen to (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-dashboard-kiali Examples">Examples</h3>
|
|
<pre class="language-bash"><code> istioctl dashboard kiali
|
|
|
|
# with short syntax
|
|
istioctl dash kiali
|
|
istioctl d kiali
|
|
</code></pre>
|
|
<h2 id="istioctl-dashboard-prometheus">istioctl dashboard prometheus</h2>
|
|
<p>Open Istio's Prometheus dashboard</p>
|
|
<pre class="language-bash"><code>istioctl dashboard prometheus [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--address <string></code></td>
|
|
<td></td>
|
|
<td>Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--port <int></code></td>
|
|
<td><code>-p</code></td>
|
|
<td>Local port to listen to (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-dashboard-prometheus Examples">Examples</h3>
|
|
<pre class="language-bash"><code> istioctl dashboard prometheus
|
|
|
|
# with short syntax
|
|
istioctl dash prometheus
|
|
istioctl d prometheus
|
|
</code></pre>
|
|
<h2 id="istioctl-dashboard-zipkin">istioctl dashboard zipkin</h2>
|
|
<p>Open Istio's Zipkin dashboard</p>
|
|
<pre class="language-bash"><code>istioctl dashboard zipkin [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--address <string></code></td>
|
|
<td></td>
|
|
<td>Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--port <int></code></td>
|
|
<td><code>-p</code></td>
|
|
<td>Local port to listen to (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-dashboard-zipkin Examples">Examples</h3>
|
|
<pre class="language-bash"><code> istioctl dashboard zipkin
|
|
|
|
# with short syntax
|
|
istioctl dash zipkin
|
|
istioctl d zipkin
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental">istioctl experimental</h2>
|
|
<p>Experimental commands that may be modified or deprecated</p>
|
|
<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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-add-to-mesh">istioctl experimental add-to-mesh</h2>
|
|
<p>'istioctl experimental add-to-mesh' restarts pods with an Istio sidecar or configures meshed pod access to external services.
|
|
Use 'add-to-mesh' as an alternate to namespace-wide auto injection for troubleshooting compatibility.</p>
|
|
<p>The 'remove-from-mesh' command can be used to restart with the sidecar removed.</p>
|
|
<p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p>
|
|
<pre class="language-bash"><code>istioctl experimental add-to-mesh [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl experimental add [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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>Injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfigMapName <string></code></td>
|
|
<td></td>
|
|
<td>ConfigMap name for Istio sidecar injection, key should be "config". (default `istio-sidecar-injector`)</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>--meshConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>Mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--meshConfigMapName <string></code></td>
|
|
<td></td>
|
|
<td>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--valuesFile <string></code></td>
|
|
<td></td>
|
|
<td>Injection values configuration filename. (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-add-to-mesh Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Restart all productpage pods with an Istio sidecar
|
|
istioctl experimental add-to-mesh service productpage
|
|
|
|
# Restart just pods from the productpage-v1 deployment
|
|
istioctl experimental add-to-mesh deployment productpage-v1
|
|
|
|
# Restart just pods from the details-v1 deployment
|
|
istioctl x add deployment details-v1
|
|
|
|
# Control how meshed pods see an external service
|
|
istioctl experimental add-to-mesh external-service vmhttp 172.12.23.125,172.12.23.126 \
|
|
http:9080 tcp:8888 --labels app=test,version=v1 --annotations env=stage --serviceaccount stageAdmin
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-add-to-mesh-deployment">istioctl experimental add-to-mesh deployment</h2>
|
|
<p>'istioctl experimental add-to-mesh deployment' restarts pods with the Istio sidecar. Use 'add-to-mesh'
|
|
to test deployments for compatibility with Istio. It can be used instead of namespace-wide auto-injection of sidecars and is especially helpful for compatibility testing.</p>
|
|
<p>If your deployment does not function after using 'add-to-mesh' you must re-deploy it and troubleshoot it for Istio compatibility.
|
|
See https://istio.io/v1.9/docs/ops/deployment/requirements/</p>
|
|
<p>See also 'istioctl experimental remove-from-mesh deployment' which does the reverse.</p>
|
|
<p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p>
|
|
<pre class="language-bash"><code>istioctl experimental add-to-mesh deployment <deployment> [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl experimental add-to-mesh deploy <deployment> [flags]
|
|
istioctl experimental add-to-mesh dep <deployment> [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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>Injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfigMapName <string></code></td>
|
|
<td></td>
|
|
<td>ConfigMap name for Istio sidecar injection, key should be "config". (default `istio-sidecar-injector`)</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>--meshConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>Mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--meshConfigMapName <string></code></td>
|
|
<td></td>
|
|
<td>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td></td>
|
|
<td>Control plane revision (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--valuesFile <string></code></td>
|
|
<td></td>
|
|
<td>Injection values configuration filename. (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-add-to-mesh-deployment Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Restart pods from the productpage-v1 deployment with Istio sidecar
|
|
istioctl experimental add-to-mesh deployment productpage-v1
|
|
|
|
# Restart pods from the details-v1 deployment with Istio sidecar
|
|
istioctl x add-to-mesh deploy details-v1
|
|
|
|
# Restart pods from the ratings-v1 deployment with Istio sidecar
|
|
istioctl x add dep ratings-v1
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-add-to-mesh-external-service">istioctl experimental add-to-mesh external-service</h2>
|
|
<p>istioctl experimental add-to-mesh external-service create a ServiceEntry and
|
|
a Service without selector for the specified external service in Istio service mesh.
|
|
The typical usage scenario is Mesh Expansion on VMs.</p>
|
|
<p>See also 'istioctl experimental remove-from-mesh external-service' which does the reverse.</p>
|
|
<p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p>
|
|
<pre class="language-bash"><code>istioctl experimental add-to-mesh external-service <svcname> <ip> [name1:]port1 [[name2:]port2] ... [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl experimental add-to-mesh es <svcname> <ip> [name1:]port1 [[name2:]port2] ... [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>--annotations <stringSlice></code></td>
|
|
<td><code>-a</code></td>
|
|
<td>List of string annotations to apply if creating a service/endpoint; e.g. -a foo=bar,x=y (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>Injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfigMapName <string></code></td>
|
|
<td></td>
|
|
<td>ConfigMap name for Istio sidecar injection, key should be "config". (default `istio-sidecar-injector`)</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>--labels <stringSlice></code></td>
|
|
<td><code>-l</code></td>
|
|
<td>List of labels to apply if creating a service/endpoint; e.g. -l env=prod,vers=2 (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--meshConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>Mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--meshConfigMapName <string></code></td>
|
|
<td></td>
|
|
<td>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--serviceaccount <string></code></td>
|
|
<td><code>-s</code></td>
|
|
<td>Service account to link to the service (default `default`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--valuesFile <string></code></td>
|
|
<td></td>
|
|
<td>Injection values configuration filename. (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-add-to-mesh-external-service Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Control how meshed pods contact 172.12.23.125 and .126
|
|
istioctl experimental add-to-mesh external-service vmhttp 172.12.23.125,172.12.23.126 \
|
|
http:9080 tcp:8888 --labels app=test,version=v1 --annotations env=stage --serviceaccount stageAdmin
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-add-to-mesh-service">istioctl experimental add-to-mesh service</h2>
|
|
<p>istioctl experimental add-to-mesh service restarts pods with the Istio sidecar. Use 'add-to-mesh'
|
|
to test deployments for compatibility with Istio. It can be used instead of namespace-wide auto-injection of sidecars and is especially helpful for compatibility testing.</p>
|
|
<p>If your service does not function after using 'add-to-mesh' you must re-deploy it and troubleshoot it for Istio compatibility.
|
|
See https://istio.io/v1.9/docs/ops/deployment/requirements/</p>
|
|
<p>See also 'istioctl experimental remove-from-mesh service' which does the reverse.</p>
|
|
<p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p>
|
|
<pre class="language-bash"><code>istioctl experimental add-to-mesh service <service> [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl experimental add-to-mesh svc <service> [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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>Injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfigMapName <string></code></td>
|
|
<td></td>
|
|
<td>ConfigMap name for Istio sidecar injection, key should be "config". (default `istio-sidecar-injector`)</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>--meshConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>Mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--meshConfigMapName <string></code></td>
|
|
<td></td>
|
|
<td>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td></td>
|
|
<td>Control plane revision (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--valuesFile <string></code></td>
|
|
<td></td>
|
|
<td>Injection values configuration filename. (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-add-to-mesh-service Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Restart all productpage pods with an Istio sidecar
|
|
istioctl experimental add-to-mesh service productpage
|
|
|
|
# Restart all details-v1 pods with an Istio sidecar
|
|
istioctl x add-to-mesh svc details-v1
|
|
|
|
# Restart all ratings-v1 pods with an Istio sidecar
|
|
istioctl x add svc ratings-v1
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-authz">istioctl experimental authz</h2>
|
|
<p></p>
|
|
<p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p>
|
|
<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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-authz-check">istioctl experimental authz check</h2>
|
|
<p>Check prints the AuthorizationPolicy applied to a pod by directly checking
|
|
the Envoy configuration of the pod. The command is especially useful for inspecting
|
|
the policy propagation from Istiod to Envoy and the final AuthorizationPolicy list merged
|
|
from multiple sources (mesh-level, namespace-level and workload-level).</p>
|
|
<p>The command also supports reading from a standalone config dump file with flag -f.</p>
|
|
<pre class="language-bash"><code>istioctl experimental authz check [<type>/]<name>[.<namespace>] [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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>The json file with Envoy config dump to be checked (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-authz-check Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Check AuthorizationPolicy applied to pod httpbin-88ddbcfdd-nt5jb:
|
|
istioctl x authz check httpbin-88ddbcfdd-nt5jb
|
|
|
|
# Check AuthorizationPolicy applied to one pod under a deployment
|
|
istioctl proxy-status deployment/productpage-v1
|
|
|
|
# Check AuthorizationPolicy from Envoy config dump file:
|
|
istioctl x authz check -f httpbin_config_dump.json
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-config">istioctl experimental config</h2>
|
|
<p>Configure istioctl defaults</p>
|
|
<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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-config Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # list configuration parameters
|
|
istioctl config list
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-config-list">istioctl experimental config list</h2>
|
|
<p>List istio configurable defaults</p>
|
|
<pre class="language-bash"><code>istioctl experimental config list [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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-create-remote-secret">istioctl experimental create-remote-secret</h2>
|
|
<p>Create a secret with credentials to allow Istio to access remote Kubernetes apiservers</p>
|
|
<pre class="language-bash"><code>istioctl experimental create-remote-secret [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--auth-plugin-config <stringToString></code></td>
|
|
<td></td>
|
|
<td>Authenticator plug-in configuration. --auth-type=plugin must be set with this option (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--auth-plugin-name <string></code></td>
|
|
<td></td>
|
|
<td>Authenticator plug-in name. --auth-type=plugin must be set with this option (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--auth-type <RemoteSecretAuthType></code></td>
|
|
<td></td>
|
|
<td>Type of authentication to use. supported values = [bearer-token plugin] (default `bearer-token`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--create-service-account</code></td>
|
|
<td></td>
|
|
<td>If true, the service account needed for creating the remote secret will be created if it doesn't exist. </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.9.0/manifests)
|
|
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.9.0/istio-1.9.0-linux-amd64.tar.gz).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--name <string></code></td>
|
|
<td></td>
|
|
<td>Name of the local cluster whose credentials are stored in the secret. If a name is not specified the kube-system namespace's UUID of the local cluster will be used. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--service-account <string></code></td>
|
|
<td></td>
|
|
<td>Create a secret with this service account's credentials. Use "istio-reader-service-account" as default value if --type is "remote", use "istiod-service-account" as default value if --type is "config". (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--type <SecretType></code></td>
|
|
<td></td>
|
|
<td>Type of the generated secret. supported values = [remote config] (default `remote`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-create-remote-secret Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Create a secret to access cluster c0's apiserver and install it in cluster c1.
|
|
istioctl --kubeconfig=c0.yaml x create-remote-secret --name c0 \
|
|
| kubectl --kubeconfig=c1.yaml apply -f -
|
|
|
|
# Delete a secret that was previously installed in c1
|
|
istioctl --kubeconfig=c0.yaml x create-remote-secret --name c0 \
|
|
| kubectl --kubeconfig=c1.yaml delete -f -
|
|
|
|
# Create a secret access a remote cluster with an auth plugin
|
|
istioctl --kubeconfig=c0.yaml x create-remote-secret --name c0 --auth-type=plugin --auth-plugin-name=gcp \
|
|
| kubectl --kubeconfig=c1.yaml apply -f -
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-describe">istioctl experimental describe</h2>
|
|
<p>Describe resource and related Istio configuration</p>
|
|
<pre class="language-bash"><code>istioctl experimental describe [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl experimental des [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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-describe-pod">istioctl experimental describe pod</h2>
|
|
<p>Analyzes pod, its Services, DestinationRules, and VirtualServices and reports
|
|
the configuration objects that affect that pod.</p>
|
|
<p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p>
|
|
<pre class="language-bash"><code>istioctl experimental describe pod <pod> [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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ignoreUnmeshed</code></td>
|
|
<td></td>
|
|
<td>Suppress warnings for unmeshed pods </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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-describe-pod Examples">Examples</h3>
|
|
<pre class="language-bash"><code> istioctl experimental describe pod productpage-v1-c7765c886-7zzd4
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-describe-service">istioctl experimental describe service</h2>
|
|
<p>Analyzes service, pods, DestinationRules, and VirtualServices and reports
|
|
the configuration objects that affect that service.</p>
|
|
<p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p>
|
|
<pre class="language-bash"><code>istioctl experimental describe service <svc> [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl experimental describe svc <svc> [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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ignoreUnmeshed</code></td>
|
|
<td></td>
|
|
<td>Suppress warnings for unmeshed pods </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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-describe-service Examples">Examples</h3>
|
|
<pre class="language-bash"><code> istioctl experimental describe service productpage
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-injector">istioctl experimental injector</h2>
|
|
<p>List sidecar injector and sidecar versions</p>
|
|
<pre class="language-bash"><code>istioctl experimental injector [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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-injector Examples">Examples</h3>
|
|
<pre class="language-bash"><code> istioctl experimental injector list
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-injector-list">istioctl experimental injector list</h2>
|
|
<p>List sidecar injector and sidecar versions</p>
|
|
<pre class="language-bash"><code>istioctl experimental injector list [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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-injector-list Examples">Examples</h3>
|
|
<pre class="language-bash"><code> istioctl experimental injector list
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-istiod">istioctl experimental istiod</h2>
|
|
<p>A group of commands used to manage istiod configuration</p>
|
|
<pre class="language-bash"><code>istioctl experimental istiod [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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--selector <string></code></td>
|
|
<td><code>-l</code></td>
|
|
<td>label selector (default `app=istiod`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-istiod Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve information about istiod configuration.
|
|
istioctl experimental istiod log
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-istiod-log">istioctl experimental istiod log</h2>
|
|
<p>Retrieve or update logging levels of istiod components.</p>
|
|
<pre class="language-bash"><code>istioctl experimental istiod log [<pod-name>] [--level <scope>:<level>][--stack-trace-level <scope>:<level>]|[-r|--reset]|[--output|-o short|yaml] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl experimental istiod l [<pod-name>] [--level <scope>:<level>][--stack-trace-level <scope>:<level>]|[-r|--reset]|[--output|-o short|yaml] [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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ctrlz_port <int></code></td>
|
|
<td></td>
|
|
<td>ControlZ port (default `9876`)</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>--level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated list of output logging level for scopes in format <scope>:<level>[,<scope>:<level>,...]Possible values for <level>: none, error, warn, info, debug (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--reset</code></td>
|
|
<td><code>-r</code></td>
|
|
<td>Reset levels to default value. (info) </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--selector <string></code></td>
|
|
<td><code>-l</code></td>
|
|
<td>label selector (default `app=istiod`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--stack-trace-level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated list of stack trace level for scopes in format <scope>:<stack-trace-level>[,<scope>:<stack-trace-level>,...] Possible values for <stack-trace-level>: none, error, warn, info, debug (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-istiod-log Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve information about istiod logging levels.
|
|
istioctl experimental istiod log
|
|
|
|
# Retrieve information about istiod logging levels on a specific control plane pod.
|
|
istioctl experimental istiod l istiod-5c868d8bdd-pmvgg
|
|
|
|
# Update levels of the specified loggers.
|
|
istioctl x istiod log --level ads:debug,authorization:debug
|
|
|
|
# Reset levels of all the loggers to default value (info).
|
|
istioctl x istiod log -r
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-kube-uninject">istioctl experimental kube-uninject</h2>
|
|
<p>
|
|
kube-uninject is used to prevent Istio from adding a sidecar and
|
|
also provides the inverse of "istioctl kube-inject -f".
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl experimental kube-uninject [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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Input Kubernetes resource filename (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Modified output Kubernetes resource filename (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-kube-uninject Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Update resources before applying.
|
|
kubectl apply -f <(istioctl experimental kube-uninject -f <resource.yaml>)
|
|
|
|
# Create a persistent version of the deployment by removing Envoy sidecar.
|
|
istioctl experimental kube-uninject -f deployment.yaml -o deployment-uninjected.yaml
|
|
|
|
# Update an existing deployment.
|
|
kubectl get deployment -o yaml | istioctl experimental kube-uninject -f - | kubectl apply -f -
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-metrics">istioctl experimental metrics</h2>
|
|
<p>
|
|
Prints the metrics for the specified service(s) when running in Kubernetes.</p>
|
|
<p>This command finds a Prometheus pod running in the specified istio system
|
|
namespace. It then executes a series of queries per requested workload to
|
|
find the following top-level workload metrics: total requests per second,
|
|
error rate, and request latency at p50, p90, and p99 percentiles. The
|
|
query results are printed to the console, organized by workload name.</p>
|
|
<p>All metrics returned are from server-side reports. This means that latencies
|
|
and error rates are from the perspective of the service itself and not of an
|
|
individual client (or aggregate set of clients). Rates and latencies are
|
|
calculated over a time interval of 1 minute.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl experimental metrics <workload name>...
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl experimental m <workload name>...
|
|
</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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-metrics Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve workload metrics for productpage-v1 workload
|
|
istioctl experimental metrics productpage-v1
|
|
|
|
# Retrieve workload metrics for various services in the different namespaces
|
|
istioctl experimental metrics productpage-v1.foo reviews-v1.bar ratings-v1.baz
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-precheck">istioctl experimental precheck</h2>
|
|
<p>
|
|
precheck inspects a Kubernetes cluster for Istio install requirements.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl experimental precheck [-f <deployment or istio operator file>] [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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <stringSlice></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Istio YAML installation file. (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--recursive</code></td>
|
|
<td><code>-R</code></td>
|
|
<td>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td></td>
|
|
<td>Control plane revision (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-precheck Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Verify that Istio can be installed
|
|
istioctl experimental precheck
|
|
|
|
# Verify the deployment matches a custom Istio deployment configuration
|
|
istioctl x precheck --set profile=demo
|
|
|
|
# Verify the deployment matches the Istio Operator deployment definition
|
|
istioctl x precheck -f iop.yaml
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-proxy-status">istioctl experimental proxy-status</h2>
|
|
<p>
|
|
Retrieves last sent and last acknowledged xDS sync from Istiod to each Envoy in the mesh
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl experimental proxy-status [<type>/]<name>[.<namespace>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl experimental ps [<type>/]<name>[.<namespace>] [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>--authority <string></code></td>
|
|
<td></td>
|
|
<td>XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--cert-dir <string></code></td>
|
|
<td></td>
|
|
<td>XDS Endpoint certificate directory (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--insecure</code></td>
|
|
<td></td>
|
|
<td>Skip server certificate and domain verification. (NOT SECURE!) </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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--plaintext</code></td>
|
|
<td></td>
|
|
<td>Use plain-text HTTP/2 when connecting to server (no TLS). </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td></td>
|
|
<td>Control plane revision (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--timeout <duration></code></td>
|
|
<td></td>
|
|
<td>The duration to wait before failing (default `30s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--xds-address <string></code></td>
|
|
<td></td>
|
|
<td>XDS Endpoint (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--xds-label <string></code></td>
|
|
<td></td>
|
|
<td>Istiod pod label selector (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--xds-port <int></code></td>
|
|
<td></td>
|
|
<td>Istiod pod port (default `15012`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-proxy-status Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve sync status for all Envoys in a mesh
|
|
istioctl x proxy-status
|
|
|
|
# Retrieve sync diff for a single Envoy and Istiod
|
|
istioctl x proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system
|
|
|
|
# SECURITY OPTIONS
|
|
|
|
# Retrieve proxy status information directly from the control plane, using token security
|
|
# (This is the usual way to get the proxy-status with an out-of-cluster control plane.)
|
|
istioctl x ps --xds-address istio.cloudprovider.example.com:15012
|
|
|
|
# Retrieve proxy status information via Kubernetes config, using token security
|
|
# (This is the usual way to get the proxy-status with an in-cluster control plane.)
|
|
istioctl x proxy-status
|
|
|
|
# Retrieve proxy status information directly from the control plane, using RSA certificate security
|
|
# (Certificates must be obtained before this step. The --cert-dir flag lets istioctl bypass the Kubernetes API server.)
|
|
istioctl x ps --xds-address istio.example.com:15012 --cert-dir ~/.istio-certs
|
|
|
|
# Retrieve proxy status information via XDS from specific control plane in multi-control plane in-cluster configuration
|
|
# (Select a specific control plane in an in-cluster canary Istio configuration.)
|
|
istioctl x ps --xds-label istio.io/rev=default
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-remove-from-mesh">istioctl experimental remove-from-mesh</h2>
|
|
<p>'istioctl experimental remove-from-mesh' restarts pods without an Istio sidecar or removes external service access configuration.
|
|
Use 'remove-from-mesh' to quickly test uninjected behavior as part of compatibility troubleshooting.
|
|
The 'add-to-mesh' command can be used to add or restore the sidecar.</p>
|
|
<p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p>
|
|
<pre class="language-bash"><code>istioctl experimental remove-from-mesh [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl experimental rm [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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-remove-from-mesh Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Restart all productpage pods without an Istio sidecar
|
|
istioctl experimental remove-from-mesh service productpage
|
|
|
|
# Restart all details-v1 pods without an Istio sidecar
|
|
istioctl x rm service details-v1
|
|
|
|
# Restart all ratings-v1 pods without an Istio sidecar
|
|
istioctl x rm deploy ratings-v1
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-remove-from-mesh-deployment">istioctl experimental remove-from-mesh deployment</h2>
|
|
<p>'istioctl experimental remove-from-mesh deployment' restarts pods with the Istio sidecar un-injected.
|
|
'remove-from-mesh' is a compatibility troubleshooting tool.</p>
|
|
<p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p>
|
|
<pre class="language-bash"><code>istioctl experimental remove-from-mesh deployment <deployment> [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl experimental remove-from-mesh deploy <deployment> [flags]
|
|
istioctl experimental remove-from-mesh dep <deployment> [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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-remove-from-mesh-deployment Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Restart all productpage-v1 pods without an Istio sidecar
|
|
istioctl experimental remove-from-mesh deployment productpage-v1
|
|
|
|
# Restart all details-v1 pods without an Istio sidecar
|
|
istioctl x remove-from-mesh deploy details-v1
|
|
|
|
# Restart all ratings-v1 pods without an Istio sidecar
|
|
istioctl x rm dep ratings-v1
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-remove-from-mesh-external-service">istioctl experimental remove-from-mesh external-service</h2>
|
|
<p>'istioctl experimental remove-from-mesh external-service' removes the ServiceEntry and
|
|
the Kubernetes Service for the specified external service (e.g. services running on a VM) from Istio service mesh.
|
|
The typical usage scenario is Mesh Expansion on VMs.</p>
|
|
<p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p>
|
|
<pre class="language-bash"><code>istioctl experimental remove-from-mesh external-service <svcname> [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl experimental remove-from-mesh es <svcname> [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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-remove-from-mesh-external-service Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Remove "vmhttp" service entry rules
|
|
istioctl experimental remove-from-mesh external-service vmhttp
|
|
|
|
# Remove "vmhttp" service entry rules
|
|
istioctl x remove-from-mesh es vmhttp
|
|
|
|
# Remove "vmhttp" service entry rules
|
|
istioctl x rm es vmhttp
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-remove-from-mesh-service">istioctl experimental remove-from-mesh service</h2>
|
|
<p>'istioctl experimental remove-from-mesh service' restarts pods with the Istio sidecar un-injected.
|
|
'remove-from-mesh' is a compatibility troubleshooting tool.</p>
|
|
<p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p>
|
|
<pre class="language-bash"><code>istioctl experimental remove-from-mesh service <service> [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl experimental remove-from-mesh svc <service> [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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-remove-from-mesh-service Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Restart all productpage pods without an Istio sidecar
|
|
istioctl experimental remove-from-mesh service productpage
|
|
|
|
# Restart all details-v1 pods without an Istio sidecar
|
|
istioctl x remove-from-mesh svc details-v1
|
|
|
|
# Restart all ratings-v1 pods without an Istio sidecar
|
|
istioctl x rm svc ratings-v1
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-sidecar-bootstrap">istioctl experimental sidecar-bootstrap</h2>
|
|
<p>(experimental) Takes in one or more WorkloadEntries generates identities for them, and copies to
|
|
the particular identities to the workloads over SSH. Optionally allowing for saving the certificates locally
|
|
for use in CI like environments, and starting istio-proxy where no special configuration is needed.
|
|
This allows for workloads to participate in the Istio mesh.</p>
|
|
<p>To autenticate to a remote node you can use either SSH Keys, or SSH Passwords. If using passwords you
|
|
must have a TTY for you to be asked your password, we do not accept an argument for it so it
|
|
cannot be left inside your shell history.</p>
|
|
<p>Copying is performed with scp, and as such is required if you'd like to copy a file over.
|
|
If SCP is not at the standard path "/usr/bin/scp", you should provide it's location with
|
|
the "--remote-scp-path" option.</p>
|
|
<p>In order to start Istio on the remote node you must have docker installed on the remote node.
|
|
Istio will be started on the host network as a docker container in capture mode.</p>
|
|
<pre class="language-bash"><code>istioctl experimental sidecar-bootstrap <workloadEntry>.<namespace> [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--all</code></td>
|
|
<td><code>-a</code></td>
|
|
<td>Attempt to bootstrap all workload entries </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--duration <duration></code></td>
|
|
<td></td>
|
|
<td>(experimental) Duration the certificates generated are valid for. (default `8760h0m0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ignore-host-keys</code></td>
|
|
<td></td>
|
|
<td>(experimental) Ignore host keys on the remote host </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istio-image <string></code></td>
|
|
<td></td>
|
|
<td>(experimental) The Istio proxy image to start up when starting Istio (default `istio/proxyv2:latest`)</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>--local-dir <string></code></td>
|
|
<td><code>-d</code></td>
|
|
<td>Directory to place certs in locally as opposed to copying (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--mutual-tls</code></td>
|
|
<td></td>
|
|
<td>(experimental) Enable mutual TLS if starting Istio-Proxy. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--organization <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>(experimental) The organization to use on the certificate, defaults to the same as the root cert. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--remote-directory <string></code></td>
|
|
<td></td>
|
|
<td>(experimental) The directory to create on the remote machine. (default `/var/run/istio`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--remote-scp-path <string></code></td>
|
|
<td></td>
|
|
<td>(experimental) The scp binary location on the target machine if not at /usr/bin/scp (default `/usr/bin/scp`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--spiffe-trust-domain <string></code></td>
|
|
<td></td>
|
|
<td>(experimental) The SPIFFE trust domain for the generated certs (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ssh-key <string></code></td>
|
|
<td><code>-k</code></td>
|
|
<td>(experimental) The location of the SSH key (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ssh-port <int></code></td>
|
|
<td></td>
|
|
<td>(experimental) The port to SSH to the machine on (default `22`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ssh-user <string></code></td>
|
|
<td><code>-u</code></td>
|
|
<td>(experimental) The user to SSH as, defaults to the current user (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--start-istio-proxy</code></td>
|
|
<td></td>
|
|
<td>Start Istio proxy on a remote host after copying certs </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--timeout <duration></code></td>
|
|
<td></td>
|
|
<td>(experimental) The timeout for copying certificates (default `1m0s`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-sidecar-bootstrap Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Copy certificates to a WorkloadEntry named "we" in the "ns" namespace:
|
|
istioctl x sidecar-bootstrap we.ns
|
|
|
|
# Copy certificates, and start istio to a WorkloadEntry named "we" in the "ns" namespace:
|
|
istioctl x sidecar-bootstrap we.ns --start-istio-proxy
|
|
|
|
# Generate Certs locally, but do not copy them to a WorkloadEntry named "we" in the "ns" namespace:
|
|
istioctl x sidecar-bootstrap we.ns --local-dir path/where/i/want/certs/
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-uninstall">istioctl experimental uninstall</h2>
|
|
<p>The uninstall command uninstalls Istio from a cluster</p>
|
|
<pre class="language-bash"><code>istioctl experimental uninstall [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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>The filename of the IstioOperator CR. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--force</code></td>
|
|
<td></td>
|
|
<td>Proceed even with validation errors. </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.9.0/manifests)
|
|
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.9.0/istio-1.9.0-linux-amd64.tar.gz).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--purge</code></td>
|
|
<td></td>
|
|
<td>Delete all Istio related sources for all versions </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td><code>-r</code></td>
|
|
<td>Target control plane revision for the command. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--set <stringArray></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.policy.enabled=true), or override Istio
|
|
settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.9/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (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>Verbose output. </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-uninstall Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Uninstall a single control plane by revision
|
|
istioctl x uninstall --revision foo
|
|
|
|
# Uninstall a single control plane by iop file
|
|
istioctl x uninstall -f iop.yaml
|
|
|
|
# Uninstall all control planes and shared resources
|
|
istioctl x uninstall --purge
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-version">istioctl experimental version</h2>
|
|
<p>Prints out build version information</p>
|
|
<pre class="language-bash"><code>istioctl experimental version [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--authority <string></code></td>
|
|
<td></td>
|
|
<td>XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--cert-dir <string></code></td>
|
|
<td></td>
|
|
<td>XDS Endpoint certificate directory (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--insecure</code></td>
|
|
<td></td>
|
|
<td>Skip server certificate and domain verification. (NOT SECURE!) </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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>One of 'yaml' or 'json'. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--plaintext</code></td>
|
|
<td></td>
|
|
<td>Use plain-text HTTP/2 when connecting to server (no TLS). </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--remote</code></td>
|
|
<td></td>
|
|
<td>Use --remote=false to suppress control plane check </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td></td>
|
|
<td>Control plane revision (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--short</code></td>
|
|
<td><code>-s</code></td>
|
|
<td>Use --short=false to generate full version information </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--timeout <duration></code></td>
|
|
<td></td>
|
|
<td>The duration to wait before failing (default `30s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--xds-address <string></code></td>
|
|
<td></td>
|
|
<td>XDS Endpoint (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--xds-label <string></code></td>
|
|
<td></td>
|
|
<td>Istiod pod label selector (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--xds-port <int></code></td>
|
|
<td></td>
|
|
<td>Istiod pod port (default `15012`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-version Examples">Examples</h3>
|
|
<pre class="language-bash"><code># Retrieve version information directly from the control plane, using token security
|
|
# (This is the usual way to get the control plane version with an out-of-cluster control plane.)
|
|
istioctl x version --xds-address istio.cloudprovider.example.com:15012
|
|
|
|
# Retrieve version information via Kubernetes config, using token security
|
|
# (This is the usual way to get the control plane version with an in-cluster control plane.)
|
|
istioctl x version
|
|
|
|
# Retrieve version information directly from the control plane, using RSA certificate security
|
|
# (Certificates must be obtained before this step. The --cert-dir flag lets istioctl bypass the Kubernetes API server.)
|
|
istioctl x version --xds-address istio.example.com:15012 --cert-dir ~/.istio-certs
|
|
|
|
# Retrieve version information via XDS from specific control plane in multi-control plane in-cluster configuration
|
|
# (Select a specific control plane in an in-cluster canary Istio configuration.)
|
|
istioctl x version --xds-label istio.io/rev=default
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-wait">istioctl experimental wait</h2>
|
|
<p>Waits for the specified condition to be true of an Istio resource.</p>
|
|
<pre class="language-bash"><code>istioctl experimental wait [flags] <type> <name>[.<namespace>]
|
|
</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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--for <string></code></td>
|
|
<td></td>
|
|
<td>Wait condition, must be 'distribution' or 'delete' (default `distribution`)</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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--resource-version <string></code></td>
|
|
<td></td>
|
|
<td>Wait for a specific version of config to become current, rather than using whatever is latest in kubernetes (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td></td>
|
|
<td>Control plane revision (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--threshold <float32></code></td>
|
|
<td></td>
|
|
<td>The ratio of distribution required for success (default `1`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--timeout <duration></code></td>
|
|
<td></td>
|
|
<td>The duration to wait before failing (default `30s`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-wait Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Wait until the bookinfo virtual service has been distributed to all proxies in the mesh
|
|
istioctl experimental wait --for=distribution virtualservice bookinfo.default
|
|
|
|
# Wait until 99% of the proxies receive the distribution, timing out after 5 minutes
|
|
istioctl experimental wait --for=distribution --threshold=.99 --timeout=300 virtualservice bookinfo.default
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-workload">istioctl experimental workload</h2>
|
|
<p>Commands to assist in configuring and deploying workloads running on VMs and other non-Kubernetes environments</p>
|
|
<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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-workload Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # workload group yaml generation
|
|
workload group create
|
|
|
|
# workload entry configuration generation
|
|
workload entry configure
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-workload-entry">istioctl experimental workload entry</h2>
|
|
<p>Commands dealing with WorkloadEntry resources</p>
|
|
<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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-workload-entry Examples">Examples</h3>
|
|
<pre class="language-bash"><code>entry configure -f workloadgroup.yaml -o outputDir
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-workload-entry-configure">istioctl experimental workload entry configure</h2>
|
|
<p>Generates all the required configuration files for workload instance on a VM or non-Kubernetes environment from a WorkloadGroup artifact.
|
|
This includes a MeshConfig resource, the cluster.env file, and necessary certificates and security tokens.
|
|
Configure requires either the WorkloadGroup artifact path or its location on the API server.</p>
|
|
<pre class="language-bash"><code>istioctl experimental workload entry configure [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--autoregister</code></td>
|
|
<td></td>
|
|
<td>Creates a WorkloadEntry upon connection to istiod (if enabled in pilot). </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--capture-dns</code></td>
|
|
<td></td>
|
|
<td>Enables the capture of outgoing DNS packets on port 53, redirecting to istio-agent </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--clusterID <string></code></td>
|
|
<td></td>
|
|
<td>The ID used to identify the cluster (default `Kubernetes`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>filename of the WorkloadGroup artifact. Leave this field empty if using the API server (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ingressIP <string></code></td>
|
|
<td></td>
|
|
<td>IP address of the ingress gateway (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ingressService <string></code></td>
|
|
<td></td>
|
|
<td>Name of the Service to be used as the ingress gateway, in the format <service>.<namespace>. If no namespace is provided, the default istio-system namespace will be used. (default `istio-eastwestgateway`)</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>--name <string></code></td>
|
|
<td></td>
|
|
<td>The name of the workload group (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output directory for generated files (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td></td>
|
|
<td>Control plane revision (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--tokenDuration <int></code></td>
|
|
<td></td>
|
|
<td>The token duration in seconds (default: 1 hour) (default `3600`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-workload-entry-configure Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # configure example using a local WorkloadGroup artifact
|
|
configure -f workloadgroup.yaml -o config
|
|
|
|
# configure example using the API server
|
|
configure --name foo --namespace bar -o config
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-workload-group">istioctl experimental workload group</h2>
|
|
<p>Commands dealing with WorkloadGroup resources</p>
|
|
<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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-workload-group Examples">Examples</h3>
|
|
<pre class="language-bash"><code>group create --name foo --namespace bar --labels app=foobar
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-workload-group-create">istioctl experimental workload group create</h2>
|
|
<p>Creates a WorkloadGroup resource that provides a template for associated WorkloadEntries.
|
|
The default output is serialized YAML, which can be piped into 'kubectl apply -f -' to send the artifact to the API Server.</p>
|
|
<pre class="language-bash"><code>istioctl experimental workload group create [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--annotations <stringSlice></code></td>
|
|
<td><code>-a</code></td>
|
|
<td>The annotations to apply to the workload instances (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (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>--labels <stringSlice></code></td>
|
|
<td><code>-l</code></td>
|
|
<td>The labels to apply to the workload instances; e.g. -l env=prod,vers=2 (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--name <string></code></td>
|
|
<td></td>
|
|
<td>The name of the workload group (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ports <stringSlice></code></td>
|
|
<td><code>-p</code></td>
|
|
<td>The incoming ports exposed by the workload instance (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--serviceAccount <string></code></td>
|
|
<td><code>-s</code></td>
|
|
<td>The service identity to associate with the workload instances (default `default`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-workload-group-create Examples">Examples</h3>
|
|
<pre class="language-bash"><code>create --name foo --namespace bar --labels app=foo,bar=baz --ports grpc=3550,http=8080 --annotations annotation=foobar --serviceAccount sa
|
|
</code></pre>
|
|
<h2 id="istioctl-install">istioctl install</h2>
|
|
<p>The install command generates an Istio install manifest and applies it to a cluster.</p>
|
|
<pre class="language-bash"><code>istioctl install [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl apply [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>--charts <string></code></td>
|
|
<td></td>
|
|
<td>Deprecated, use --manifests instead. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (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 <stringSlice></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>--force</code></td>
|
|
<td></td>
|
|
<td>Proceed even with validation errors. </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.9.0/manifests)
|
|
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.9.0/istio-1.9.0-linux-amd64.tar.gz).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--readiness-timeout <duration></code></td>
|
|
<td></td>
|
|
<td>Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td><code>-r</code></td>
|
|
<td>Target control plane revision for the command. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--set <stringArray></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.policy.enabled=true), or override Istio
|
|
settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.9/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (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>--verify</code></td>
|
|
<td></td>
|
|
<td>Verify the Istio control plane after installation/in-place upgrade </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-install Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Apply a default Istio installation
|
|
istioctl install
|
|
|
|
# Enable Tracing
|
|
istioctl install --set meshConfig.enableTracing=true
|
|
|
|
# Generate the demo profile and don't wait for confirmation
|
|
istioctl install --set profile=demo --skip-confirmation
|
|
|
|
# To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes.
|
|
istioctl install --set "values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default"
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-kube-inject">istioctl kube-inject</h2>
|
|
<p>
|
|
kube-inject manually injects the Envoy sidecar into Kubernetes
|
|
workloads. Unsupported resources are left unmodified so it is safe to
|
|
run kube-inject over a single file that contains multiple Service,
|
|
ConfigMap, Deployment, etc. definitions for a complex application. It's
|
|
best to do this when the resource is initially created.</p>
|
|
<p>k8s.io/docs/concepts/workloads/pods/pod-overview/#pod-templates is
|
|
updated for Job, DaemonSet, ReplicaSet, Pod and Deployment YAML resource
|
|
documents. Support for additional pod-based resource types can be
|
|
added as necessary.</p>
|
|
<p>The Istio project is continually evolving so the Istio sidecar
|
|
configuration may change unannounced. When in doubt re-run istioctl
|
|
kube-inject on deployments to get the most up-to-date changes.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl kube-inject [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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Input Kubernetes resource filename (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>Injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfigMapName <string></code></td>
|
|
<td></td>
|
|
<td>ConfigMap name for Istio sidecar injection, key should be "config". (default `istio-sidecar-injector`)</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>--meshConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>Mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--meshConfigMapName <string></code></td>
|
|
<td></td>
|
|
<td>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Modified output Kubernetes resource filename (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td></td>
|
|
<td>Control plane revision (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--valuesFile <string></code></td>
|
|
<td></td>
|
|
<td>injection values configuration filename. (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-kube-inject Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Update resources on the fly before applying.
|
|
kubectl apply -f <(istioctl kube-inject -f <resource.yaml>)
|
|
|
|
# Create a persistent version of the deployment with Envoy sidecar injected.
|
|
istioctl kube-inject -f deployment.yaml -o deployment-injected.yaml
|
|
|
|
# Update an existing deployment.
|
|
kubectl get deployment -o yaml | istioctl kube-inject -f - | kubectl apply -f -
|
|
|
|
# Capture cluster configuration for later use with kube-inject
|
|
kubectl -n istio-system get cm istio-sidecar-injector -o jsonpath="{.data.config}" > /tmp/inj-template.tmpl
|
|
kubectl -n istio-system get cm istio -o jsonpath="{.data.mesh}" > /tmp/mesh.yaml
|
|
kubectl -n istio-system get cm istio-sidecar-injector -o jsonpath="{.data.values}" > /tmp/values.json
|
|
|
|
# Use kube-inject based on captured configuration
|
|
istioctl kube-inject -f samples/bookinfo/platform/kube/bookinfo.yaml \
|
|
--injectConfigFile /tmp/inj-template.tmpl \
|
|
--meshConfigFile /tmp/mesh.yaml \
|
|
--valuesFile /tmp/values.json
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-manifest">istioctl manifest</h2>
|
|
<p>The manifest command generates and diffs Istio manifests.</p>
|
|
<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>The name of the kubeconfig context to use (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>--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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-manifest-diff">istioctl manifest diff</h2>
|
|
<p>The diff subcommand compares manifests from two files or directories.</p>
|
|
<pre class="language-bash"><code>istioctl manifest diff <file|dir> <file|dir> [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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--directory</code></td>
|
|
<td><code>-r</code></td>
|
|
<td>Compare directory. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ignore <string></code></td>
|
|
<td></td>
|
|
<td>Ignore all listed items during comparison, using the same list format as selectResources. (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--rename <string></code></td>
|
|
<td></td>
|
|
<td>Rename resources before comparison.
|
|
The format of each renaming pair is A->B, all renaming pairs are comma separated.
|
|
e.g. Service:*:istiod->Service:*:istio-control - rename istiod service into istio-control (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--select <string></code></td>
|
|
<td></td>
|
|
<td>Constrain the list of resources to compare to only the ones in this list, ignoring all others.
|
|
The format of each list item is "::" and the items are comma separated. The "*" character represents wildcard selection.
|
|
e.g.
|
|
Deployment:istio-system:* - compare all deployments in istio-system namespace
|
|
Service:*:istiod - compare Services called "istiod" in all namespaces (default `::`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--verbose</code></td>
|
|
<td><code>-v</code></td>
|
|
<td>Verbose output. </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-manifest-generate">istioctl manifest generate</h2>
|
|
<p>The generate subcommand generates an Istio install manifest and outputs to the console by default.</p>
|
|
<pre class="language-bash"><code>istioctl manifest generate [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--charts <string></code></td>
|
|
<td></td>
|
|
<td>Deprecated, use --manifests instead. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--component <stringSlice></code></td>
|
|
<td></td>
|
|
<td>Specify which component to generate manifests for. (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (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 <stringSlice></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>--force</code></td>
|
|
<td></td>
|
|
<td>Proceed even with validation errors. </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.9.0/manifests)
|
|
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.9.0/istio-1.9.0-linux-amd64.tar.gz).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Manifest output directory path. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td><code>-r</code></td>
|
|
<td>Target control plane revision for the command. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--set <stringArray></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.policy.enabled=true), or override Istio
|
|
settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.9/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-manifest-generate Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Generate a default Istio installation
|
|
istioctl manifest generate
|
|
|
|
# Enable Tracing
|
|
istioctl manifest generate --set meshConfig.enableTracing=true
|
|
|
|
# Generate the demo profile
|
|
istioctl manifest generate --set profile=demo
|
|
|
|
# To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes.
|
|
istioctl manifest generate --set "values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default"
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-manifest-install">istioctl manifest install</h2>
|
|
<p>The install command generates an Istio install manifest and applies it to a cluster.</p>
|
|
<pre class="language-bash"><code>istioctl manifest install [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl manifest apply [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>--charts <string></code></td>
|
|
<td></td>
|
|
<td>Deprecated, use --manifests instead. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (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 <stringSlice></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>--force</code></td>
|
|
<td></td>
|
|
<td>Proceed even with validation errors. </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.9.0/manifests)
|
|
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.9.0/istio-1.9.0-linux-amd64.tar.gz).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--readiness-timeout <duration></code></td>
|
|
<td></td>
|
|
<td>Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td><code>-r</code></td>
|
|
<td>Target control plane revision for the command. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--set <stringArray></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.policy.enabled=true), or override Istio
|
|
settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.9/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (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>--verify</code></td>
|
|
<td></td>
|
|
<td>Verify the Istio control plane after installation/in-place upgrade </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-manifest-install Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Apply a default Istio installation
|
|
istioctl install
|
|
|
|
# Enable Tracing
|
|
istioctl install --set meshConfig.enableTracing=true
|
|
|
|
# Generate the demo profile and don't wait for confirmation
|
|
istioctl install --set profile=demo --skip-confirmation
|
|
|
|
# To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes.
|
|
istioctl install --set "values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default"
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-operator">istioctl operator</h2>
|
|
<p>The operator command installs, dumps, removes and shows the status of the operator controller.</p>
|
|
<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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-operator-dump">istioctl operator dump</h2>
|
|
<p>The dump subcommand dumps the Istio operator controller manifest.</p>
|
|
<pre class="language-bash"><code>istioctl operator dump [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--charts <string></code></td>
|
|
<td></td>
|
|
<td>Deprecated, use --manifests instead. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (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>--hub <string></code></td>
|
|
<td></td>
|
|
<td>The hub for the operator controller image. (default `unknown`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--imagePullSecrets <stringSlice></code></td>
|
|
<td></td>
|
|
<td>The imagePullSecrets are used to pull the operator image from the private registry,
|
|
could be secret list separated by comma, eg. '--imagePullSecrets imagePullSecret1,imagePullSecret2' (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.9.0/manifests)
|
|
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.9.0/istio-1.9.0-linux-amd64.tar.gz).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--operatorNamespace <string></code></td>
|
|
<td></td>
|
|
<td>The namespace the operator controller is installed into. (default `istio-operator`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td><code>-r</code></td>
|
|
<td>Target control plane revision for the command. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--tag <string></code></td>
|
|
<td></td>
|
|
<td>The tag for the operator controller image. (default `unknown`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-operator-init">istioctl operator init</h2>
|
|
<p>The init subcommand installs the Istio operator controller in the cluster.</p>
|
|
<pre class="language-bash"><code>istioctl operator init [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--charts <string></code></td>
|
|
<td></td>
|
|
<td>Deprecated, use --manifests instead. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (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 <string></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>--hub <string></code></td>
|
|
<td></td>
|
|
<td>The hub for the operator controller image. (default `unknown`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--imagePullSecrets <stringSlice></code></td>
|
|
<td></td>
|
|
<td>The imagePullSecrets are used to pull the operator image from the private registry,
|
|
could be secret list separated by comma, eg. '--imagePullSecrets imagePullSecret1,imagePullSecret2' (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.9.0/manifests)
|
|
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.9.0/istio-1.9.0-linux-amd64.tar.gz).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--operatorNamespace <string></code></td>
|
|
<td></td>
|
|
<td>The namespace the operator controller is installed into. (default `istio-operator`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td><code>-r</code></td>
|
|
<td>Target revision for the operator. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--tag <string></code></td>
|
|
<td></td>
|
|
<td>The tag for the operator controller image. (default `unknown`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--watchedNamespaces <string></code></td>
|
|
<td></td>
|
|
<td>The namespaces the operator controller watches, could be namespace list separated by comma, eg. 'ns1,ns2' (default `istio-system`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-operator-remove">istioctl operator remove</h2>
|
|
<p>The remove subcommand removes the Istio operator controller from the cluster.</p>
|
|
<pre class="language-bash"><code>istioctl operator remove [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>The name of the kubeconfig context to use (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>--force</code></td>
|
|
<td></td>
|
|
<td>Proceed even with validation errors. </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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--operatorNamespace <string></code></td>
|
|
<td></td>
|
|
<td>The namespace the operator controller is installed into. (default `istio-operator`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td><code>-r</code></td>
|
|
<td>Target control plane revision for the command. (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-options">istioctl options</h2>
|
|
<p>Displays istioctl global options</p>
|
|
<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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-profile">istioctl profile</h2>
|
|
<p>The profile command lists, dumps or diffs Istio configuration profiles.</p>
|
|
<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>The name of the kubeconfig context to use (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>--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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-profile Examples">Examples</h3>
|
|
<pre class="language-bash"><code>istioctl profile list
|
|
istioctl install --set profile=demo # Use a profile from the list
|
|
</code></pre>
|
|
<h2 id="istioctl-profile-diff">istioctl profile diff</h2>
|
|
<p>The diff subcommand displays the differences between two Istio configuration profiles.</p>
|
|
<pre class="language-bash"><code>istioctl profile diff <file1.yaml> <file2.yaml> [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--charts <string></code></td>
|
|
<td></td>
|
|
<td>Deprecated, use --manifests instead. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (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>--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.9.0/manifests)
|
|
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.9.0/istio-1.9.0-linux-amd64.tar.gz).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-profile-diff Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Profile diff by providing yaml files
|
|
istioctl profile diff manifests/profiles/default.yaml manifests/profiles/demo.yaml
|
|
|
|
# Profile diff by providing a profile name
|
|
istioctl profile diff default demo
|
|
</code></pre>
|
|
<h2 id="istioctl-profile-dump">istioctl profile dump</h2>
|
|
<p>The dump subcommand dumps the values in an Istio configuration profile.</p>
|
|
<pre class="language-bash"><code>istioctl profile dump [<profile>] [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--charts <string></code></td>
|
|
<td></td>
|
|
<td>Deprecated, use --manifests instead. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--config-path <string></code></td>
|
|
<td><code>-p</code></td>
|
|
<td>The path the root of the configuration subtree to dump e.g. components.pilot. By default, dump whole tree (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (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 <stringSlice></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 <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.9.0/manifests)
|
|
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.9.0/istio-1.9.0-linux-amd64.tar.gz).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|flags (default `yaml`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-profile-list">istioctl profile list</h2>
|
|
<p>The list subcommand lists the available Istio configuration profiles.</p>
|
|
<pre class="language-bash"><code>istioctl profile list [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--charts <string></code></td>
|
|
<td></td>
|
|
<td>Deprecated, use --manifests instead. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (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>--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.9.0/manifests)
|
|
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.9.0/istio-1.9.0-linux-amd64.tar.gz).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-proxy-config">istioctl proxy-config</h2>
|
|
<p>A group of commands used to retrieve information about proxy configuration from the Envoy config dump</p>
|
|
<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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|short (default `short`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-config Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve information about proxy configuration from an Envoy instance.
|
|
istioctl proxy-config <clusters|listeners|routes|endpoints|bootstrap|log|secret> <pod-name[.namespace]>
|
|
</code></pre>
|
|
<h2 id="istioctl-proxy-config-bootstrap">istioctl proxy-config bootstrap</h2>
|
|
<p>Retrieve information about bootstrap configuration for the Envoy instance in the specified pod.</p>
|
|
<pre class="language-bash"><code>istioctl proxy-config bootstrap [<type>/]<name>[.<namespace>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl proxy-config b [<type>/]<name>[.<namespace>] [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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Envoy config dump JSON file (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|short (default `short`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-config-bootstrap Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve full bootstrap configuration for a given pod from Envoy.
|
|
istioctl proxy-config bootstrap <pod-name[.namespace]>
|
|
|
|
# Retrieve full bootstrap without using Kubernetes API
|
|
ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
|
|
istioctl proxy-config bootstrap --file envoy-config.json
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-proxy-config-cluster">istioctl proxy-config cluster</h2>
|
|
<p>Retrieve information about cluster configuration for the Envoy instance in the specified pod.</p>
|
|
<pre class="language-bash"><code>istioctl proxy-config cluster [<type>/]<name>[.<namespace>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl proxy-config clusters [<type>/]<name>[.<namespace>] [flags]
|
|
istioctl proxy-config c [<type>/]<name>[.<namespace>] [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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--direction <string></code></td>
|
|
<td></td>
|
|
<td>Filter clusters by Direction field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Envoy config dump JSON file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--fqdn <string></code></td>
|
|
<td></td>
|
|
<td>Filter clusters by substring of Service FQDN field (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--port <int></code></td>
|
|
<td></td>
|
|
<td>Filter clusters by Port field (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--subset <string></code></td>
|
|
<td></td>
|
|
<td>Filter clusters by substring of Subset field (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-config-cluster Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve summary about cluster configuration for a given pod from Envoy.
|
|
istioctl proxy-config clusters <pod-name[.namespace]>
|
|
|
|
# Retrieve cluster summary for clusters with port 9080.
|
|
istioctl proxy-config clusters <pod-name[.namespace]> --port 9080
|
|
|
|
# Retrieve full cluster dump for clusters that are inbound with a FQDN of details.default.svc.cluster.local.
|
|
istioctl proxy-config clusters <pod-name[.namespace]> --fqdn details.default.svc.cluster.local --direction inbound -o json
|
|
|
|
# Retrieve cluster summary without using Kubernetes API
|
|
ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
|
|
istioctl proxy-config clusters --file envoy-config.json
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-proxy-config-endpoint">istioctl proxy-config endpoint</h2>
|
|
<p>Retrieve information about endpoint configuration for the Envoy instance in the specified pod.</p>
|
|
<pre class="language-bash"><code>istioctl proxy-config endpoint [<type>/]<name>[.<namespace>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl proxy-config endpoints [<type>/]<name>[.<namespace>] [flags]
|
|
istioctl proxy-config ep [<type>/]<name>[.<namespace>] [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>--address <string></code></td>
|
|
<td></td>
|
|
<td>Filter endpoints by address field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--cluster <string></code></td>
|
|
<td></td>
|
|
<td>Filter endpoints by cluster name field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Envoy config dump JSON file (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--port <int></code></td>
|
|
<td></td>
|
|
<td>Filter endpoints by Port field (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--status <string></code></td>
|
|
<td></td>
|
|
<td>Filter endpoints by status field (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-config-endpoint Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve full endpoint configuration for a given pod from Envoy.
|
|
istioctl proxy-config endpoint <pod-name[.namespace]>
|
|
|
|
# Retrieve endpoint summary for endpoint with port 9080.
|
|
istioctl proxy-config endpoint <pod-name[.namespace]> --port 9080
|
|
|
|
# Retrieve full endpoint with a address (172.17.0.2).
|
|
istioctl proxy-config endpoint <pod-name[.namespace]> --address 172.17.0.2 -o json
|
|
|
|
# Retrieve full endpoint with a cluster name (outbound|9411||zipkin.istio-system.svc.cluster.local).
|
|
istioctl proxy-config endpoint <pod-name[.namespace]> --cluster "outbound|9411||zipkin.istio-system.svc.cluster.local" -o json
|
|
# Retrieve full endpoint with the status (healthy).
|
|
istioctl proxy-config endpoint <pod-name[.namespace]> --status healthy -ojson
|
|
|
|
# Retrieve endpoint summary without using Kubernetes API
|
|
ssh <user@hostname> 'curl localhost:15000/clusters?format=json' > envoy-clusters.json
|
|
istioctl proxy-config endpoints --file envoy-clusters.json
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-proxy-config-listener">istioctl proxy-config listener</h2>
|
|
<p>Retrieve information about listener configuration for the Envoy instance in the specified pod.</p>
|
|
<pre class="language-bash"><code>istioctl proxy-config listener [<type>/]<name>[.<namespace>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl proxy-config listeners [<type>/]<name>[.<namespace>] [flags]
|
|
istioctl proxy-config l [<type>/]<name>[.<namespace>] [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>--address <string></code></td>
|
|
<td></td>
|
|
<td>Filter listeners by address field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Envoy config dump JSON file (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--port <int></code></td>
|
|
<td></td>
|
|
<td>Filter listeners by Port field (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--type <string></code></td>
|
|
<td></td>
|
|
<td>Filter listeners by type field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--verbose</code></td>
|
|
<td></td>
|
|
<td>Output more information </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-config-listener Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve summary about listener configuration for a given pod from Envoy.
|
|
istioctl proxy-config listeners <pod-name[.namespace]>
|
|
|
|
# Retrieve listener summary for listeners with port 9080.
|
|
istioctl proxy-config listeners <pod-name[.namespace]> --port 9080
|
|
|
|
# Retrieve full listener dump for HTTP listeners with a wildcard address (0.0.0.0).
|
|
istioctl proxy-config listeners <pod-name[.namespace]> --type HTTP --address 0.0.0.0 -o json
|
|
|
|
# Retrieve listener summary without using Kubernetes API
|
|
ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
|
|
istioctl proxy-config listeners --file envoy-config.json
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-proxy-config-log">istioctl proxy-config log</h2>
|
|
<p>(experimental) Retrieve information about logging levels of the Envoy instance in the specified pod, and update optionally</p>
|
|
<pre class="language-bash"><code>istioctl proxy-config log [<type>/]<name>[.<namespace>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl proxy-config o [<type>/]<name>[.<namespace>] [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>The name of the kubeconfig context to use (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>--level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-logger level of messages to output, in the form of [<logger>:]<level>,[<logger>:]<level>,... where logger can be one of admin, aws, assert, backtrace, client, config, connection, conn_handler, dubbo, file, filter, forward_proxy, grpc, hc, health_checker, http, http2, hystrix, init, io, jwt, kafka, lua, main, misc, mongo, quic, pool, rbac, redis, router, runtime, stats, secret, tap, testing, thrift, tracing, upstream, udp, wasm and level can be one of [trace, debug, info, warning, error, critical, off] (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--reset</code></td>
|
|
<td><code>-r</code></td>
|
|
<td>Reset levels to default value (warning). </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--selector <string></code></td>
|
|
<td><code>-l</code></td>
|
|
<td>Label selector (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-config-log Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve information about logging levels for a given pod from Envoy.
|
|
istioctl proxy-config log <pod-name[.namespace]>
|
|
|
|
# Update levels of the all loggers
|
|
istioctl proxy-config log <pod-name[.namespace]> --level none
|
|
|
|
# Update levels of the specified loggers.
|
|
istioctl proxy-config log <pod-name[.namespace]> --level http:debug,redis:debug
|
|
|
|
# Reset levels of all the loggers to default value (warning).
|
|
istioctl proxy-config log <pod-name[.namespace]> -r
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-proxy-config-route">istioctl proxy-config route</h2>
|
|
<p>Retrieve information about route configuration for the Envoy instance in the specified pod.</p>
|
|
<pre class="language-bash"><code>istioctl proxy-config route [<type>/]<name>[.<namespace>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl proxy-config routes [<type>/]<name>[.<namespace>] [flags]
|
|
istioctl proxy-config r [<type>/]<name>[.<namespace>] [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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Envoy config dump JSON file (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>--name <string></code></td>
|
|
<td></td>
|
|
<td>Filter listeners by route name field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--verbose</code></td>
|
|
<td></td>
|
|
<td>Output more information </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-config-route Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve summary about route configuration for a given pod from Envoy.
|
|
istioctl proxy-config routes <pod-name[.namespace]>
|
|
|
|
# Retrieve route summary for route 9080.
|
|
istioctl proxy-config route <pod-name[.namespace]> --name 9080
|
|
|
|
# Retrieve full route dump for route 9080
|
|
istioctl proxy-config route <pod-name[.namespace]> --name 9080 -o json
|
|
|
|
# Retrieve route summary without using Kubernetes API
|
|
ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
|
|
istioctl proxy-config routes --file envoy-config.json
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-proxy-config-secret">istioctl proxy-config secret</h2>
|
|
<p>(experimental) Retrieve information about secret configuration for the Envoy instance in the specified pod.</p>
|
|
<p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p>
|
|
<pre class="language-bash"><code>istioctl proxy-config secret [<type>/]<name>[.<namespace>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl proxy-config secrets [<type>/]<name>[.<namespace>] [flags]
|
|
istioctl proxy-config s [<type>/]<name>[.<namespace>] [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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Envoy config dump JSON file (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|short (default `short`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-config-secret Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve full secret configuration for a given pod from Envoy.
|
|
istioctl proxy-config secret <pod-name[.namespace]>
|
|
|
|
# Retrieve full bootstrap without using Kubernetes API
|
|
ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
|
|
istioctl proxy-config secret --file envoy-config.json
|
|
</code></pre>
|
|
<h2 id="istioctl-proxy-status">istioctl proxy-status</h2>
|
|
<p>
|
|
Retrieves last sent and last acknowledged xDS sync from Istiod to each Envoy in the mesh</p>
|
|
<p></p>
|
|
<pre class="language-bash"><code>istioctl proxy-status [<type>/]<name>[.<namespace>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl ps [<type>/]<name>[.<namespace>] [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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Envoy config dump JSON file (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td></td>
|
|
<td>Control plane revision (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-status Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve sync status for all Envoys in a mesh
|
|
istioctl proxy-status
|
|
|
|
# Retrieve sync diff for a single Envoy and Istiod
|
|
istioctl proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system
|
|
|
|
# Retrieve sync diff between Istiod and one pod under a deployment
|
|
istioctl proxy-status deployment/productpage-v1
|
|
|
|
# Write proxy config-dump to file, and compare to Istio control plane
|
|
kubectl port-forward -n istio-system istio-egressgateway-59585c5b9c-ndc59 15000 &
|
|
curl localhost:15000/config_dump > cd.json
|
|
istioctl proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system --file cd.json
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-upgrade">istioctl upgrade</h2>
|
|
<p>The upgrade command checks for upgrade version eligibility and, if eligible, upgrades the Istio control plane components in-place. Warning: traffic may be disrupted during upgrade. Please ensure PodDisruptionBudgets are defined to maintain service continuity.</p>
|
|
<pre class="language-bash"><code>istioctl upgrade [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--charts <string></code></td>
|
|
<td></td>
|
|
<td>Deprecated, use --manifests instead. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (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 <stringSlice></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>--force</code></td>
|
|
<td></td>
|
|
<td>Apply the upgrade without eligibility checks </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.9.0/manifests)
|
|
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.9.0/istio-1.9.0-linux-amd64.tar.gz).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--readiness-timeout <duration></code></td>
|
|
<td></td>
|
|
<td>Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--set <stringArray></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.policy.enabled=true), or override Istio
|
|
settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.9/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--skip-confirmation</code></td>
|
|
<td><code>-y</code></td>
|
|
<td>If skip-confirmation is set, skips the prompting confirmation for value changes in this upgrade </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--verify</code></td>
|
|
<td></td>
|
|
<td>Verify the Istio control plane after installation/in-place upgrade </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-validate">istioctl validate</h2>
|
|
<p>Validate Istio policy and rules files</p>
|
|
<pre class="language-bash"><code>istioctl validate -f FILENAME [options] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl v -f FILENAME [options] [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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <stringSlice></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Names of files to validate (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config 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>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-validate Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Validate bookinfo-gateway.yaml
|
|
istioctl validate -f samples/bookinfo/networking/bookinfo-gateway.yaml
|
|
|
|
# Validate bookinfo-gateway.yaml with shorthand syntax
|
|
istioctl v -f samples/bookinfo/networking/bookinfo-gateway.yaml
|
|
|
|
# Validate current deployments under 'default' namespace within the cluster
|
|
kubectl get deployments -o yaml | istioctl validate -f -
|
|
|
|
# Validate current services under 'default' namespace within the cluster
|
|
kubectl get services -o yaml | istioctl validate -f -
|
|
|
|
# Also see the related command 'istioctl analyze'
|
|
istioctl analyze samples/bookinfo/networking/bookinfo-gateway.yaml
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-verify-install">istioctl verify-install</h2>
|
|
<p>
|
|
verify-install verifies Istio installation status against the installation file
|
|
you specified when you installed Istio. It loops through all the installation
|
|
resources defined in your installation file and reports whether all of them are
|
|
in ready status. It will report failure when any of them are not ready.</p>
|
|
<p>If you do not specify an installation it will check for an IstioOperator resource
|
|
and will verify if pods and services defined in it are present.</p>
|
|
<p>Note: For verifying whether your cluster is ready for Istio installation, see
|
|
istioctl experimental precheck.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl verify-install [-f <deployment or istio operator file>] [--revision <revision>] [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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <stringSlice></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Istio YAML installation file. (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.9.0/manifests)
|
|
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.9.0/istio-1.9.0-linux-amd64.tar.gz).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td></td>
|
|
<td>Control plane revision (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-verify-install Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Verify that Istio is installed correctly via Istio Operator
|
|
istioctl verify-install
|
|
|
|
# Verify the deployment matches a custom Istio deployment configuration
|
|
istioctl verify-install -f $HOME/istio.yaml
|
|
|
|
# Verify the deployment matches the Istio Operator deployment definition
|
|
istioctl verify-install --revision <canary>
|
|
</code></pre>
|
|
<h2 id="istioctl-version">istioctl version</h2>
|
|
<p>Prints out build version information</p>
|
|
<pre class="language-bash"><code>istioctl version [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>The name of the kubeconfig context to use (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>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>One of 'yaml' or 'json'. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--remote</code></td>
|
|
<td></td>
|
|
<td>Use --remote=false to suppress control plane check </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td></td>
|
|
<td>Control plane revision (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--short</code></td>
|
|
<td><code>-s</code></td>
|
|
<td>Use --short=false to generate full version information </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="envvars">Environment variables</h2>
|
|
These environment variables affect the behavior of the <code>istioctl</code> command. Please use with caution as these environment variables are experimental and can change anytime.
|
|
<table class="envvars">
|
|
<thead>
|
|
<tr>
|
|
<th>Variable Name</th>
|
|
<th>Type</th>
|
|
<th>Default Value</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>CENTRAL_ISTIOD</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If this is set to true, one Istiod will control remote clusters including CA.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>CLUSTER_ID</code></td>
|
|
<td>String</td>
|
|
<td><code>Kubernetes</code></td>
|
|
<td>Defines the cluster and service registry that this Istiod instance is belongs to</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_ADMIN_ENDPOINTS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If this is set to true, dangerous admin endpoins will be exposed on the debug interface. Not recommended for production.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_CA_SERVER</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If this is set to false, will not create CA server in istiod.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_DEBUG_ON_HTTP</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If this is set to false, the debug interface will not be ebabled on Http, recommended for production</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_LEGACY_FSGROUP_INJECTION</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If true, Istiod will set the pod fsGroup to 1337 on injection. This is required for Kubernetes 1.18 and older (see https://github.com/kubernetes/kubernetes/issues/57923 for details) unless JWT_POLICY is "first-party-jwt".</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_WASM_TELEMETRY</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, Wasm-based telemetry will be enabled.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>EXTERNAL_ISTIOD</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If this is set to true, one Istiod will control remote clusters including CA.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>INJECTION_WEBHOOK_CONFIG_NAME</code></td>
|
|
<td>String</td>
|
|
<td><code>istio-sidecar-injector</code></td>
|
|
<td>Name of the mutatingwebhookconfiguration to patch, if istioctl is not used.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIOCONFIG</code></td>
|
|
<td>String</td>
|
|
<td><code>$HOME/.istioctl/config.yaml</code></td>
|
|
<td>Default values for istioctl flags</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIOCTL_AUTHORITY</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>The istioctl --authority override</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIOCTL_CERT_DIR</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>The istioctl --cert-dir override</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIOCTL_INSECURE</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>The istioctl --insecure override</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIOCTL_ISTIONAMESPACE</code></td>
|
|
<td>String</td>
|
|
<td><code>istio-system</code></td>
|
|
<td>The istioctl --istioNamespace override</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIOCTL_PLAINTEXT</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>The istioctl --plaintext override</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIOCTL_PREFER_EXPERIMENTAL</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>The istioctl should use experimental subcommand variants</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIOCTL_XDS_ADDRESS</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>The istioctl --xds-address override</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIOCTL_XDS_PORT</code></td>
|
|
<td>Integer</td>
|
|
<td><code>15012</code></td>
|
|
<td>The istioctl --xds-port override</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIOD_CUSTOM_HOST</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>Custom host name of istiod that istiod signs the server cert.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIOD_ENABLE_SDS_SERVER</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, Istiod will serve SDS for credentialName secrets (rather than in-proxy). To ensure proper security, PILOT_ENABLE_XDS_IDENTITY_CHECK=true is required as well.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIO_DEFAULT_REQUEST_TIMEOUT</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>0s</code></td>
|
|
<td>Default Http and gRPC Request timeout</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIO_GPRC_MAXRECVMSGSIZE</code></td>
|
|
<td>Integer</td>
|
|
<td><code>4194304</code></td>
|
|
<td>Sets the max receive buffer size of gRPC stream in bytes.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIO_GPRC_MAXSTREAMS</code></td>
|
|
<td>Integer</td>
|
|
<td><code>100000</code></td>
|
|
<td>Sets the maximum number of concurrent grpc streams.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIO_PROMETHEUS_ANNOTATIONS</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>JWT_POLICY</code></td>
|
|
<td>String</td>
|
|
<td><code>third-party-jwt</code></td>
|
|
<td>The JWT validation policy.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>K8S_INGRESS_NS</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ALLOW_METADATA_CERTS_DR_MUTUAL_TLS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If true, Pilot will allow certs specified in Metadata to override DR certs in MUTUAL TLS mode. This is only enabled for migration and will be removed soon.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_CERT_PROVIDER</code></td>
|
|
<td>String</td>
|
|
<td><code>istiod</code></td>
|
|
<td>The provider of Pilot DNS certificate.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_DEBOUNCE_AFTER</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>100ms</code></td>
|
|
<td>The delay added to config/registry events for debouncing. This will delay the push by at least this internal. If no change is detected within this period, the push will happen, otherwise we'll keep delaying until things settle, up to a max of PILOT_DEBOUNCE_MAX.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_DEBOUNCE_MAX</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>10s</code></td>
|
|
<td>The maximum amount of time to wait for events while debouncing. If events keep showing up with no breaks for this time, we'll trigger a push.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_DISTRIBUTION_HISTORY_RETENTION</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>1m0s</code></td>
|
|
<td>If enabled, Pilot will keep track of old versions of distributed config for this duration.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLED_SERVICE_APIS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If this is set to true, support for Kubernetes service-apis (github.com/kubernetes-sigs/service-apis) will be enabled. This feature is currently experimental, and is off by default.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_ANALYSIS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, pilot will run istio analyzers and write analysis errors to the Status field of any Istio Resources</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, Pilot will assign meaningful nonces to each Envoy configuration message, and allow users to interrogate which envoy has which config from the debug interface.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_CRD_VALIDATION</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, pilot will validate CRDs while retrieving CRDs from kubernetes cache.Use this flag to enable validation of CRDs in Pilot, especially in deployments that do not have galley installed.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_EDS_DEBOUNCE</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, Pilot will include EDS pushes in the push debouncing, configured by PILOT_DEBOUNCE_AFTER and PILOT_DEBOUNCE_MAX. EDS pushes may be delayed, but there will be fewer pushes. By default this is enabled</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_EDS_FOR_HEADLESS_SERVICES</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, for headless service in Kubernetes, pilot will send endpoints over EDS, allowing the sidecar to load balance among pods in the headless service. This feature should be enabled if applications access all services explicitly via a HTTP proxy port in the sidecar.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_FLOW_CONTROL</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, pilot will wait for the completion of a receive operation beforeexecuting a push operation. This is a form of flow control and is useful inenvironments with high rates of push requests to each gateway. By default,this is false.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_HEADLESS_SERVICE_POD_LISTENERS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, for a headless service/stateful set in Kubernetes, pilot will generate an outbound listener for each pod in a headless service. This feature should be disabled if headless services have a large number of pods.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_ISTIO_TAGS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>Determines whether or not trace spans generated by Envoy will include Istio-specific tags.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_K8S_SELECT_WORKLOAD_ENTRIES</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, Kubernetes services with selectors will select workload entries with matching labels. It is safe to disable it if you are quite sure you don't need this feature</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_LOOP_BLOCKER</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, Envoy will be configured to prevent traffic directly the the inbound/outbound ports (15001/15006). This prevents traffic loops. This option will be removed, and considered always enabled, in 1.9.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_MYSQL_FILTER</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_PROTOCOL_SNIFFING_FOR_INBOUND</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, protocol sniffing will be used for inbound listeners whose port protocol is not specified or unsupported</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_PROTOCOL_SNIFFING_FOR_OUTBOUND</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, protocol sniffing will be used for outbound listeners whose port protocol is not specified or unsupported</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_REDIS_FILTER</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_SERVICEENTRY_SELECT_PODS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, service entries with selectors will select pods from the cluster. It is safe to disable it if you are quite sure you don't need this feature</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_STATUS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, pilot will update the CRD Status field of all istio resources with reconciliation status.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_THRIFT_FILTER</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>EnableThriftFilter enables injection of `envoy.filters.network.thrift_proxy` in the filter chain.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_VIRTUAL_SERVICE_DELEGATE</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If set to false, virtualService delegate will not be supported.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_WORKLOAD_ENTRY_AUTOREGISTRATION</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>Enables auto-registering WorkloadEntries based on associated WorkloadGroups upon XDS connection by the workload.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_WORKLOAD_ENTRY_HEALTHCHECKS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>Enables automatic health checks of WorkloadEntries based on the config provided in the associated WorkloadGroup</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_XDS_CACHE</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If true, Pilot will cache XDS responses.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_XDS_IDENTITY_CHECK</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, pilot will authorize XDS clients, to ensure they are acting only as namespaces they have permissions for.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENDPOINT_TELEMETRY_LABEL</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If true, pilot will add telemetry related metadata to Endpoint resource, which will be consumed by telemetry filter.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_FILTER_GATEWAY_CLUSTER_CONFIG</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_FLOW_CONTROL_TIMEOUT</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>15s</code></td>
|
|
<td>If set, the max amount of time to delay a push by. Depends on PILOT_ENABLE_FLOW_CONTROL.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_HTTP10</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>Enables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_INBOUND_PROTOCOL_DETECTION_TIMEOUT</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>1s</code></td>
|
|
<td>Protocol detection timeout for inbound listener</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_INITIAL_FETCH_TIMEOUT</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>0s</code></td>
|
|
<td>Specifies the initial_fetch_timeout for config. If this time is reached without a response to the config requested by Envoy, the Envoy will move on with the init phase. This prevents envoy from getting stuck waiting on config during startup.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_PUSH_THROTTLE</code></td>
|
|
<td>Integer</td>
|
|
<td><code>100</code></td>
|
|
<td>Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_SCOPE_GATEWAY_TO_NAMESPACE</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, a gateway workload can only select gateway resources in the same namespace. Gateways with same selectors in different namespaces will not be applicable.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_SIDECAR_ENABLE_INBOUND_TLS_V2</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If true, Pilot will set the TLS version on server side as TLSv1_2 and also enforce strong cipher suites</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_SIDECAR_USE_REMOTE_ADDRESS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>UseRemoteAddress sets useRemoteAddress to true for side car outbound listeners.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_SKIP_VALIDATE_TRUST_DOMAIN</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>Skip validating the peer is from the same trust domain when mTLS is enabled in authentication policy</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_STATUS_BURST</code></td>
|
|
<td>Integer</td>
|
|
<td><code>500</code></td>
|
|
<td>If status is enabled, controls the Burst rate with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config Burst</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_STATUS_QPS</code></td>
|
|
<td>Floating-Point</td>
|
|
<td><code>100</code></td>
|
|
<td>If status is enabled, controls the QPS with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config QPS</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_TRACE_SAMPLING</code></td>
|
|
<td>Floating-Point</td>
|
|
<td><code>1</code></td>
|
|
<td>Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 1.0.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_USE_ENDPOINT_SLICE</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, Pilot will use EndpointSlices as the source of endpoints for Kubernetes services. By default, this is false, and Endpoints will be used. This requires the Kubernetes EndpointSlice controller to be enabled. Currently this is mutual exclusive - either Endpoints or EndpointSlices will be used</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_WORKLOAD_ENTRY_GRACE_PERIOD</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>10s</code></td>
|
|
<td>The amount of time an auto-registered workload can remain disconnected from all Pilot instances before the associated WorkloadEntry is cleaned up.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_XDS_CACHE_SIZE</code></td>
|
|
<td>Integer</td>
|
|
<td><code>20000</code></td>
|
|
<td>The maximum number of cache entries for the XDS cache. If the size is <= 0, the cache will have no upper bound.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_XDS_CACHE_STATS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If true, Pilot will collect metrics for XDS cache efficiency.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_XDS_SEND_TIMEOUT</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>5s</code></td>
|
|
<td>The timeout to send the XDS configuration to proxies. After this timeout is reached, Pilot will discard that push.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>POD_NAME</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>REQUIRE_3P_TOKEN</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>Reject k8s default tokens, without audience. If false, default K8S token will be accepted</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>SPIFFE_BUNDLE_ENDPOINTS</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>The SPIFFE bundle trust domain to endpoint mappings. Istiod retrieves the root certificate from each SPIFFE bundle endpoint and uses it to verify client certifiates from that trust domain. The endpoint must be compliant to the SPIFFE Bundle Endpoint standard. For details, please refer to https://github.com/spiffe/spiffe/blob/master/standards/SPIFFE_Trust_Domain_and_Bundle.md . No need to configure this for root certificates issued via Istiod or web-PKI based root certificates. Use || between <trustdomain, endpoint> tuples. Use | as delimiter between trust domain and endpoint in each tuple. For example: foo|https://url/for/foo||bar|https://url/for/bar</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>TERM</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>Specifies terminal type. Use 'dumb' to suppress color output</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>TERMINATION_DRAIN_DURATION_SECONDS</code></td>
|
|
<td>Integer</td>
|
|
<td><code>5</code></td>
|
|
<td>The amount of time allowed for connections to complete on pilot-agent shutdown. On receiving SIGTERM or SIGINT, pilot-agent tells the active Envoy to start draining, preventing any new connections and allowing existing connections to complete. It then sleeps for the TerminationDrainDuration and then kills any remaining active Envoy processes.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>TOKEN_AUDIENCES</code></td>
|
|
<td>String</td>
|
|
<td><code>istio-ca</code></td>
|
|
<td>A list of comma separated audiences to check in the JWT token before issuing a certificate. The token is accepted if it matches with one of the audiences</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>XDS_AUTH</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If true, will authenticate XDS clients.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="metrics">Exported metrics</h2>
|
|
<table class="metrics">
|
|
<thead>
|
|
<tr><th>Metric Name</th><th>Type</th><th>Description</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr><td><code>cache_flush_total</code></td><td><code>Sum</code></td><td>number of times operator cache was flushed</td></tr>
|
|
<tr><td><code>cr_deletion_total</code></td><td><code>Sum</code></td><td>Number of IstioOperator CR deleted</td></tr>
|
|
<tr><td><code>cr_merge_failure_total</code></td><td><code>Sum</code></td><td>Number of IstioOperator CR merge failures</td></tr>
|
|
<tr><td><code>cr_validation_error_total</code></td><td><code>Sum</code></td><td>Number of IstioOperator CR validation failures</td></tr>
|
|
<tr><td><code>endpoint_no_pod</code></td><td><code>LastValue</code></td><td>Endpoints without an associated pod.</td></tr>
|
|
<tr><td><code>galley_runtime_processor_event_span_duration_milliseconds</code></td><td><code>Distribution</code></td><td>The duration between each incoming event</td></tr>
|
|
<tr><td><code>galley_runtime_processor_events_processed_total</code></td><td><code>Count</code></td><td>The number of events that have been processed</td></tr>
|
|
<tr><td><code>galley_runtime_processor_snapshot_events_total</code></td><td><code>Distribution</code></td><td>The number of events per snapshot</td></tr>
|
|
<tr><td><code>galley_runtime_processor_snapshot_lifetime_duration_milliseconds</code></td><td><code>Distribution</code></td><td>The duration of each snapshot</td></tr>
|
|
<tr><td><code>galley_runtime_processor_snapshots_published_total</code></td><td><code>Count</code></td><td>The number of snapshots that have been published</td></tr>
|
|
<tr><td><code>galley_runtime_state_type_instances_total</code></td><td><code>LastValue</code></td><td>The number of type instances per type URL</td></tr>
|
|
<tr><td><code>galley_runtime_strategy_on_change_total</code></td><td><code>Count</code></td><td>The number of times the strategy's onChange has been called</td></tr>
|
|
<tr><td><code>galley_runtime_strategy_timer_max_time_reached_total</code></td><td><code>Count</code></td><td>The number of times the max time has been reached</td></tr>
|
|
<tr><td><code>galley_runtime_strategy_timer_quiesce_reached_total</code></td><td><code>Count</code></td><td>The number of times a quiesce has been reached</td></tr>
|
|
<tr><td><code>galley_runtime_strategy_timer_resets_total</code></td><td><code>Count</code></td><td>The number of times the timer has been reset</td></tr>
|
|
<tr><td><code>galley_source_kube_dynamic_converter_failure_total</code></td><td><code>Count</code></td><td>The number of times a dynamnic kubernetes source failed converting a resources</td></tr>
|
|
<tr><td><code>galley_source_kube_dynamic_converter_success_total</code></td><td><code>Count</code></td><td>The number of times a dynamic kubernetes source successfully converted a resource</td></tr>
|
|
<tr><td><code>galley_source_kube_event_error_total</code></td><td><code>Count</code></td><td>The number of times a kubernetes source encountered errored while handling an event</td></tr>
|
|
<tr><td><code>galley_source_kube_event_success_total</code></td><td><code>Count</code></td><td>The number of times a kubernetes source successfully handled an event</td></tr>
|
|
<tr><td><code>galley_validation_config_delete_error</code></td><td><code>Count</code></td><td>k8s webhook configuration delete error</td></tr>
|
|
<tr><td><code>galley_validation_config_load</code></td><td><code>Count</code></td><td>k8s webhook configuration (re)loads</td></tr>
|
|
<tr><td><code>galley_validation_config_load_error</code></td><td><code>Count</code></td><td>k8s webhook configuration (re)load error</td></tr>
|
|
<tr><td><code>galley_validation_config_update_error</code></td><td><code>Count</code></td><td>k8s webhook configuration update error</td></tr>
|
|
<tr><td><code>galley_validation_config_updates</code></td><td><code>Count</code></td><td>k8s webhook configuration updates</td></tr>
|
|
<tr><td><code>get_cr_error_total</code></td><td><code>Sum</code></td><td>Number of times fetching CR from apiserver failed</td></tr>
|
|
<tr><td><code>istio_build</code></td><td><code>LastValue</code></td><td>Istio component build info</td></tr>
|
|
<tr><td><code>legacy_path_translation_total</code></td><td><code>Sum</code></td><td>Number of times a legacy API path is translated</td></tr>
|
|
<tr><td><code>manifest_patch_error_total</code></td><td><code>Sum</code></td><td>Number of times K8S patch overlays failed</td></tr>
|
|
<tr><td><code>manifest_render_error_total</code></td><td><code>Sum</code></td><td>Number of times error occurred during rendering output manifest</td></tr>
|
|
<tr><td><code>num_failed_outgoing_requests</code></td><td><code>Sum</code></td><td>Number of failed outgoing requests (e.g. to a token exchange server, CA, etc.)</td></tr>
|
|
<tr><td><code>num_file_secret_failures_total</code></td><td><code>Sum</code></td><td>Number of times secret generation failed for files</td></tr>
|
|
<tr><td><code>num_file_watcher_failures_total</code></td><td><code>Sum</code></td><td>Number of times file watcher failed to add watchers</td></tr>
|
|
<tr><td><code>num_outgoing_requests</code></td><td><code>Sum</code></td><td>Number of total outgoing requests (e.g. to a token exchange server, CA, etc.)</td></tr>
|
|
<tr><td><code>num_outgoing_retries</code></td><td><code>Sum</code></td><td>Number of outgoing retry requests (e.g. to a token exchange server, CA, etc.)</td></tr>
|
|
<tr><td><code>outgoing_latency</code></td><td><code>Sum</code></td><td>The latency of outgoing requests (e.g. to a token exchange server, CA, etc.) in milliseconds.</td></tr>
|
|
<tr><td><code>owned_resource_total</code></td><td><code>LastValue</code></td><td>Number of resources currently owned by the operator</td></tr>
|
|
<tr><td><code>pilot_conflict_inbound_listener</code></td><td><code>LastValue</code></td><td>Number of conflicting inbound listeners.</td></tr>
|
|
<tr><td><code>pilot_conflict_outbound_listener_http_over_current_tcp</code></td><td><code>LastValue</code></td><td>Number of conflicting wildcard http listeners with current wildcard tcp listener.</td></tr>
|
|
<tr><td><code>pilot_conflict_outbound_listener_tcp_over_current_http</code></td><td><code>LastValue</code></td><td>Number of conflicting wildcard tcp listeners with current wildcard http listener.</td></tr>
|
|
<tr><td><code>pilot_conflict_outbound_listener_tcp_over_current_tcp</code></td><td><code>LastValue</code></td><td>Number of conflicting tcp listeners with current tcp listener.</td></tr>
|
|
<tr><td><code>pilot_destrule_subsets</code></td><td><code>LastValue</code></td><td>Duplicate subsets across destination rules for same host</td></tr>
|
|
<tr><td><code>pilot_duplicate_envoy_clusters</code></td><td><code>LastValue</code></td><td>Duplicate envoy clusters caused by service entries with same hostname</td></tr>
|
|
<tr><td><code>pilot_eds_no_instances</code></td><td><code>LastValue</code></td><td>Number of clusters without instances.</td></tr>
|
|
<tr><td><code>pilot_endpoint_not_ready</code></td><td><code>LastValue</code></td><td>Endpoint found in unready state.</td></tr>
|
|
<tr><td><code>pilot_inbound_updates</code></td><td><code>Sum</code></td><td>Total number of updates received by pilot.</td></tr>
|
|
<tr><td><code>pilot_invalid_out_listeners</code></td><td><code>LastValue</code></td><td>Number of invalid outbound listeners.</td></tr>
|
|
<tr><td><code>pilot_jwks_resolver_network_fetch_fail_total</code></td><td><code>Sum</code></td><td>Total number of failed network fetch by pilot jwks resolver</td></tr>
|
|
<tr><td><code>pilot_jwks_resolver_network_fetch_success_total</code></td><td><code>Sum</code></td><td>Total number of successfully network fetch by pilot jwks resolver</td></tr>
|
|
<tr><td><code>pilot_k8s_endpoints_pending_pod</code></td><td><code>LastValue</code></td><td>Number of endpoints that do not currently have any corresponding pods.</td></tr>
|
|
<tr><td><code>pilot_k8s_endpoints_with_no_pods</code></td><td><code>Sum</code></td><td>Endpoints that does not have any corresponding pods.</td></tr>
|
|
<tr><td><code>pilot_k8s_reg_events</code></td><td><code>Sum</code></td><td>Events from k8s registry.</td></tr>
|
|
<tr><td><code>pilot_no_ip</code></td><td><code>LastValue</code></td><td>Pods not found in the endpoint table, possibly invalid.</td></tr>
|
|
<tr><td><code>pilot_proxy_convergence_time</code></td><td><code>Distribution</code></td><td>Delay in seconds between config change and a proxy receiving all required configuration.</td></tr>
|
|
<tr><td><code>pilot_proxy_queue_time</code></td><td><code>Distribution</code></td><td>Time in seconds, a proxy is in the push queue before being dequeued.</td></tr>
|
|
<tr><td><code>pilot_push_triggers</code></td><td><code>Sum</code></td><td>Total number of times a push was triggered, labeled by reason for the push.</td></tr>
|
|
<tr><td><code>pilot_services</code></td><td><code>LastValue</code></td><td>Total services known to pilot.</td></tr>
|
|
<tr><td><code>pilot_total_rejected_configs</code></td><td><code>Sum</code></td><td>Total number of configs that Pilot had to reject or ignore.</td></tr>
|
|
<tr><td><code>pilot_total_xds_internal_errors</code></td><td><code>Sum</code></td><td>Total number of internal XDS errors in pilot.</td></tr>
|
|
<tr><td><code>pilot_total_xds_rejects</code></td><td><code>Sum</code></td><td>Total number of XDS responses from pilot rejected by proxy.</td></tr>
|
|
<tr><td><code>pilot_virt_services</code></td><td><code>LastValue</code></td><td>Total virtual services known to pilot.</td></tr>
|
|
<tr><td><code>pilot_vservice_dup_domain</code></td><td><code>LastValue</code></td><td>Virtual services with dup domains.</td></tr>
|
|
<tr><td><code>pilot_xds</code></td><td><code>LastValue</code></td><td>Number of endpoints connected to this pilot using XDS.</td></tr>
|
|
<tr><td><code>pilot_xds_cds_reject</code></td><td><code>LastValue</code></td><td>Pilot rejected CDS configs.</td></tr>
|
|
<tr><td><code>pilot_xds_delayed_push_timeouts_total</code></td><td><code>Sum</code></td><td>Total number of XDS pushes that are delayed and timed out</td></tr>
|
|
<tr><td><code>pilot_xds_delayed_pushes_total</code></td><td><code>Sum</code></td><td>Total number of XDS pushes that are delayed.</td></tr>
|
|
<tr><td><code>pilot_xds_eds_reject</code></td><td><code>LastValue</code></td><td>Pilot rejected EDS.</td></tr>
|
|
<tr><td><code>pilot_xds_expired_nonce</code></td><td><code>Sum</code></td><td>Total number of XDS requests with an expired nonce.</td></tr>
|
|
<tr><td><code>pilot_xds_lds_reject</code></td><td><code>LastValue</code></td><td>Pilot rejected LDS.</td></tr>
|
|
<tr><td><code>pilot_xds_push_context_errors</code></td><td><code>Sum</code></td><td>Number of errors (timeouts) initiating push context.</td></tr>
|
|
<tr><td><code>pilot_xds_push_time</code></td><td><code>Distribution</code></td><td>Total time in seconds Pilot takes to push lds, rds, cds and eds.</td></tr>
|
|
<tr><td><code>pilot_xds_pushes</code></td><td><code>Sum</code></td><td>Pilot build and send errors for lds, rds, cds and eds.</td></tr>
|
|
<tr><td><code>pilot_xds_rds_reject</code></td><td><code>LastValue</code></td><td>Pilot rejected RDS.</td></tr>
|
|
<tr><td><code>pilot_xds_send_time</code></td><td><code>Distribution</code></td><td>Total time in seconds Pilot takes to send generated configuration.</td></tr>
|
|
<tr><td><code>pilot_xds_write_timeout</code></td><td><code>Sum</code></td><td>Pilot XDS response write timeouts.</td></tr>
|
|
<tr><td><code>render_manifest_total</code></td><td><code>Sum</code></td><td>Number of component manifests rendered</td></tr>
|
|
<tr><td><code>resource_creation_total</code></td><td><code>Sum</code></td><td>Number of resources created by the operator</td></tr>
|
|
<tr><td><code>resource_deletion_total</code></td><td><code>Sum</code></td><td>Number of resources deleted by the operator</td></tr>
|
|
<tr><td><code>resource_prune_total</code></td><td><code>Sum</code></td><td>Number of resources pruned by the operator</td></tr>
|
|
<tr><td><code>resource_update_total</code></td><td><code>Sum</code></td><td>Number of resources updated by the operator</td></tr>
|
|
<tr><td><code>scrape_failures_total</code></td><td><code>Sum</code></td><td>The total number of failed scrapes.</td></tr>
|
|
<tr><td><code>scrapes_total</code></td><td><code>Sum</code></td><td>The total number of scrapes.</td></tr>
|
|
<tr><td><code>sidecar_injection_failure_total</code></td><td><code>Sum</code></td><td>Total number of failed sidecar injection requests.</td></tr>
|
|
<tr><td><code>sidecar_injection_requests_total</code></td><td><code>Sum</code></td><td>Total number of sidecar injection requests.</td></tr>
|
|
<tr><td><code>sidecar_injection_skip_total</code></td><td><code>Sum</code></td><td>Total number of skipped sidecar injection requests.</td></tr>
|
|
<tr><td><code>sidecar_injection_success_total</code></td><td><code>Sum</code></td><td>Total number of successful sidecar injection requests.</td></tr>
|
|
<tr><td><code>startup_duration_seconds</code></td><td><code>LastValue</code></td><td>The time from the process starting to being marked ready.</td></tr>
|
|
<tr><td><code>version</code></td><td><code>LastValue</code></td><td>Version of operator binary</td></tr>
|
|
<tr><td><code>xds_cache_evictions</code></td><td><code>Sum</code></td><td>Total number of xds cache evictions.</td></tr>
|
|
<tr><td><code>xds_cache_reads</code></td><td><code>Sum</code></td><td>Total number of xds cache xdsCacheReads.</td></tr>
|
|
<tr><td><code>xds_cache_size</code></td><td><code>LastValue</code></td><td>Current size of xds cache</td></tr>
|
|
</tbody>
|
|
</table>
|