mirror of https://github.com/istio/istio.io.git
7977 lines
262 KiB
HTML
7977 lines
262 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: 98
|
|
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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-admin">istioctl admin</h2>
|
|
<p>A group of commands used to manage istiod configuration</p>
|
|
<pre class="language-bash"><code>istioctl admin [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl istiod [flags]
|
|
</code></pre></div>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</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>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-admin Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve information about istiod configuration.
|
|
istioctl admin log
|
|
</code></pre>
|
|
<h2 id="istioctl-admin-log">istioctl admin log</h2>
|
|
<p>Retrieve or update logging levels of istiod components.</p>
|
|
<pre class="language-bash"><code>istioctl admin log [<pod-name>]|[-r|--revision] [--level <scope>:<level>][--stack-trace-level <scope>:<level>]|[--reset]|[--output|-o short|json|yaml] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl admin l [<pod-name>]|[-r|--revision] [--level <scope>:<level>][--stack-trace-level <scope>:<level>]|[--reset]|[--output|-o short|json|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>Kubernetes configuration context (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 the format of <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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--reset</code></td>
|
|
<td></td>
|
|
<td>Reset levels to default value. (info) </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td><code>-r</code></td>
|
|
<td>Control plane revision (default ``)</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 the format of <scope>:<stack-trace-level>[,<scope>:<stack-trace-level>,...]. Possible values for <stack-trace-level>: none, error, warn, info, debug (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-admin-log Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve information about istiod logging levels.
|
|
istioctl admin log
|
|
|
|
# Retrieve information about istiod logging levels on a specific control plane pod.
|
|
istioctl admin l istiod-5c868d8bdd-pmvgg
|
|
|
|
# Update levels of the specified loggers.
|
|
istioctl admin log --level ads:debug,authorization:debug
|
|
|
|
# Retrieve information about istiod logging levels for a specified revision.
|
|
istioctl admin log --revision v1
|
|
|
|
# Reset levels of all the loggers to default value (info).
|
|
istioctl admin log --reset
|
|
|
|
</code></pre>
|
|
<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>Kubernetes configuration context (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>--ignore-unknown</code></td>
|
|
<td></td>
|
|
<td>Don't complain about un-parseable input documents, for cases where analyze should run only on k8s compliant inputs. </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>Kubernetes 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>--revision <string></code></td>
|
|
<td></td>
|
|
<td>analyze a specific revision deployed. (default `default`)</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>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-analyze Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Analyze the current live cluster
|
|
istioctl analyze
|
|
|
|
# Analyze the current live cluster for a specific revision
|
|
istioctl analyze --revision 1-16
|
|
|
|
# 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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-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.../lbl1=val1,lbl2=val2.../ann1=val1,ann2=val2.../cntr1,cntr...
|
|
where ns=namespace, dep=deployment, lbl=label, ann=annotation, cntr=container</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>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 patterns 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 pod's proxy logs to exclude from the archive, after the include spec is processed. See above for format and examples. (default `["kube-node-lease,kube-public,kube-system,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 patterns to match against log error strings. Any error matching these patterns is ignored when calculating the log importance heuristic. (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--include <stringSlice></code></td>
|
|
<td></td>
|
|
<td>Spec for which pod's 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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output-dir <string></code></td>
|
|
<td></td>
|
|
<td>Set a specific directory for output archive file. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--rq-concurrency <int></code></td>
|
|
<td></td>
|
|
<td>Set the concurrency limit of requests to the Kubernetes API server, defaults to 32. (default `0`)</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, --duration 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>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-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 patterns 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 pod's proxy logs to exclude from the archive, after the include spec is processed. See above for format and examples. (default `["kube-node-lease,kube-public,kube-system,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 patterns to match against log error strings. Any error matching these patterns is ignored when calculating the log importance heuristic. (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--include <stringSlice></code></td>
|
|
<td></td>
|
|
<td>Spec for which pod's 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>Kubernetes 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>--output-dir <string></code></td>
|
|
<td></td>
|
|
<td>Set a specific directory for output archive file. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--rq-concurrency <int></code></td>
|
|
<td></td>
|
|
<td>Set the concurrency limit of requests to the Kubernetes API server, defaults to 32. (default `0`)</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, --duration 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>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-completion">istioctl completion</h2>
|
|
<p>Generate the autocompletion script for istioctl for the specified shell.
|
|
See each sub-command's help for details on how to use the generated script.
|
|
</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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-completion-bash">istioctl completion bash</h2>
|
|
<p>Generate the autocompletion script for the bash shell.</p>
|
|
<p>This script depends on the 'bash-completion' package.
|
|
If it is not installed already, you can install it via your OS's package manager.</p>
|
|
<p>To load completions in your current shell session:</p>
|
|
<p> source <(istioctl completion bash)</p>
|
|
<p>To load completions for every new session, execute once:</p>
|
|
<p>#### Linux:</p>
|
|
<p> istioctl completion bash > /etc/bash_completion.d/istioctl</p>
|
|
<p>#### macOS:</p>
|
|
<p> istioctl completion bash > $(brew --prefix)/etc/bash_completion.d/istioctl</p>
|
|
<p>You will need to start a new shell for this setup to take effect.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl completion bash
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--no-descriptions</code></td>
|
|
<td></td>
|
|
<td>disable completion descriptions </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-completion-fish">istioctl completion fish</h2>
|
|
<p>Generate the autocompletion script for the fish shell.</p>
|
|
<p>To load completions in your current shell session:</p>
|
|
<p> istioctl completion fish | source</p>
|
|
<p>To load completions for every new session, execute once:</p>
|
|
<p> istioctl completion fish > ~/.config/fish/completions/istioctl.fish</p>
|
|
<p>You will need to start a new shell for this setup to take effect.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl completion fish [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--no-descriptions</code></td>
|
|
<td></td>
|
|
<td>disable completion descriptions </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-completion-powershell">istioctl completion powershell</h2>
|
|
<p>Generate the autocompletion script for powershell.</p>
|
|
<p>To load completions in your current shell session:</p>
|
|
<p> istioctl completion powershell | Out-String | Invoke-Expression</p>
|
|
<p>To load completions for every new session, add the output of the above command
|
|
to your powershell profile.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl completion powershell [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--no-descriptions</code></td>
|
|
<td></td>
|
|
<td>disable completion descriptions </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-completion-zsh">istioctl completion zsh</h2>
|
|
<p>Generate the autocompletion script for the zsh shell.</p>
|
|
<p>If shell completion is not already enabled in your environment you will need
|
|
to enable it. You can execute the following once:</p>
|
|
<p> echo "autoload -U compinit; compinit" >> ~/.zshrc</p>
|
|
<p>To load completions in your current shell session:</p>
|
|
<p> source <(istioctl completion zsh)</p>
|
|
<p>To load completions for every new session, execute once:</p>
|
|
<p>#### Linux:</p>
|
|
<p> istioctl completion zsh > "${fpath[1]}/_istioctl"</p>
|
|
<p>#### macOS:</p>
|
|
<p> istioctl completion zsh > $(brew --prefix)/share/zsh/site-functions/_istioctl</p>
|
|
<p>You will need to start a new shell for this setup to take effect.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl completion zsh [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--no-descriptions</code></td>
|
|
<td></td>
|
|
<td>disable completion descriptions </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-create-remote-secret">istioctl 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 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>Kubernetes configuration context (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.24.0/manifests). (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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--secret-name <string></code></td>
|
|
<td></td>
|
|
<td>The name of the specific secret to use from the service-account. Needed when there are multiple secrets in the service account. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--server <string></code></td>
|
|
<td></td>
|
|
<td>The address and port of the Kubernetes API server. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--service-account <string></code></td>
|
|
<td></td>
|
|
<td>Create a secret with this service account's credentials. Default value is "istio-reader-service-account" if --type is "remote", "istiod" 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>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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 create-remote-secret --name c0 \
|
|
| kubectl --kubeconfig=c1.yaml apply -f -
|
|
|
|
# Delete a secret that was previously installed in c1
|
|
istioctl --kubeconfig=c0.yaml 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 create-remote-secret --name c0 --auth-type=plugin --auth-plugin-name=gcp \
|
|
| kubectl --kubeconfig=c1.yaml apply -f -
|
|
</code></pre>
|
|
<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>--browser</code></td>
|
|
<td></td>
|
|
<td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes 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>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-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>--browser</code></td>
|
|
<td></td>
|
|
<td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (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>Kubernetes 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>
|
|
<tr>
|
|
<td><code>--selector <string></code></td>
|
|
<td><code>-l</code></td>
|
|
<td>Label selector (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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 the istiod-56dd66799-jfdvs pod in a custom namespace
|
|
istioctl dashboard controlz istiod-123-456 -n custom-ns
|
|
|
|
# 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>
|
|
<p>Note: envoy command is deprecated and can be replaced with proxy command, e.g. `istioctl dashboard proxy --help`
|
|
</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>--browser</code></td>
|
|
<td></td>
|
|
<td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes 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>
|
|
<tr>
|
|
<td><code>--selector <string></code></td>
|
|
<td><code>-l</code></td>
|
|
<td>Label selector (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ui-port <int></code></td>
|
|
<td></td>
|
|
<td>The component dashboard UI port. (default `15000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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>--browser</code></td>
|
|
<td></td>
|
|
<td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes 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>
|
|
<tr>
|
|
<td><code>--ui-port <int></code></td>
|
|
<td></td>
|
|
<td>The component dashboard UI port. (default `3000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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-istiod-debug">istioctl dashboard istiod-debug</h2>
|
|
<p>Open the debug web UI for a Istio control plane pod</p>
|
|
<pre class="language-bash"><code>istioctl dashboard istiod-debug [<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>--browser</code></td>
|
|
<td></td>
|
|
<td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes 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>
|
|
<tr>
|
|
<td><code>--selector <string></code></td>
|
|
<td><code>-l</code></td>
|
|
<td>Label selector (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-dashboard-istiod-debug Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Open Istio debug web UI for the istiod-123-456.istio-system pod
|
|
istioctl dashboard istiod-debug istiod-123-456.istio-system
|
|
|
|
# Open Istio debug web UI for the istiod-56dd66799-jfdvs pod in a custom namespace
|
|
istioctl dashboard istiod-debug istiod-123-456 -n custom-ns
|
|
|
|
# Open Istio debug web UI for any Istiod pod
|
|
istioctl dashboard istiod-debug deployment/istiod.istio-system
|
|
|
|
# with short syntax
|
|
istioctl dash istiod-debug pilot-123-456.istio-system
|
|
istioctl d istiod-debug pilot-123-456.istio-system
|
|
|
|
</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>--browser</code></td>
|
|
<td></td>
|
|
<td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes 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>
|
|
<tr>
|
|
<td><code>--ui-port <int></code></td>
|
|
<td></td>
|
|
<td>The component dashboard UI port. (default `16686`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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>--browser</code></td>
|
|
<td></td>
|
|
<td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes 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>
|
|
<tr>
|
|
<td><code>--ui-port <int></code></td>
|
|
<td></td>
|
|
<td>The component dashboard UI port. (default `20001`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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>--browser</code></td>
|
|
<td></td>
|
|
<td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes 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>
|
|
<tr>
|
|
<td><code>--ui-port <int></code></td>
|
|
<td></td>
|
|
<td>The component dashboard UI port. (default `9090`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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-proxy">istioctl dashboard proxy</h2>
|
|
<p>Open the admin dashboard for a proxy, like envoy and ztunnel pods</p>
|
|
<pre class="language-bash"><code>istioctl dashboard proxy [<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>--browser</code></td>
|
|
<td></td>
|
|
<td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes 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>
|
|
<tr>
|
|
<td><code>--selector <string></code></td>
|
|
<td><code>-l</code></td>
|
|
<td>Label selector (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ui-port <int></code></td>
|
|
<td></td>
|
|
<td>The component dashboard UI port. (default `15000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-dashboard-proxy Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Open envoy admin dashboard for the productpage-123-456.default pod
|
|
istioctl dashboard proxy productpage-123-456.default
|
|
|
|
# Open envoy admin dashboard for one pod under a deployment
|
|
istioctl dashboard proxy deployment/productpage-v1
|
|
|
|
# Open dashboard for the ztunnel-bwh89.istio-system pod
|
|
istioctl dashboard proxy ztunnel-bwh89.istio-system
|
|
|
|
# Open dashboard for a waypoint pod
|
|
istioctl dashboard proxy namespace-istio-waypoint-869b56b69c-7khz4
|
|
|
|
# with short syntax
|
|
istioctl dash proxy ztunnel-bwh89.istio-system
|
|
istioctl d proxy ztunnel-bwh89.istio-system
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-dashboard-skywalking">istioctl dashboard skywalking</h2>
|
|
<p>Open the Istio dashboard in the SkyWalking UI</p>
|
|
<pre class="language-bash"><code>istioctl dashboard skywalking [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>--browser</code></td>
|
|
<td></td>
|
|
<td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes 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>
|
|
<tr>
|
|
<td><code>--ui-port <int></code></td>
|
|
<td></td>
|
|
<td>The component dashboard UI port. (default `8080`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-dashboard-skywalking Examples">Examples</h3>
|
|
<pre class="language-bash"><code> istioctl dashboard skywalking
|
|
|
|
# with short syntax
|
|
istioctl dash skywalking
|
|
istioctl d skywalking
|
|
</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>--browser</code></td>
|
|
<td></td>
|
|
<td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes 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>
|
|
<tr>
|
|
<td><code>--ui-port <int></code></td>
|
|
<td></td>
|
|
<td>The component dashboard UI port. (default `9411`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-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>Kubernetes configuration context (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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-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 x authz check 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-check-inject">istioctl experimental check-inject</h2>
|
|
<p>
|
|
Checks associated resources of the given resource, and running webhooks to examine whether the pod can be or will be injected or not.</p>
|
|
<pre class="language-bash"><code>istioctl experimental check-inject [<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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--labels <string></code></td>
|
|
<td><code>-l</code></td>
|
|
<td>Check namespace and label pairs injection status, split multiple labels by commas (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-check-inject Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Check the injection status of a pod
|
|
istioctl experimental check-inject details-v1-fcff6c49c-kqnfk.test
|
|
|
|
# Check the injection status of a pod under a deployment
|
|
istioctl x check-inject deployment/details-v1
|
|
|
|
# Check the injection status of a pod under a deployment in namespace test
|
|
istioctl x check-inject deployment/details-v1 -n test
|
|
|
|
# Check the injection status of label pairs in a specific namespace before actual injection
|
|
istioctl x check-inject -n test -l app=helloworld,version=v1
|
|
|
|
</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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-config Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # list configuration parameters
|
|
istioctl experimental 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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-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>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl experimental describe po <pod> [flags]
|
|
</code></pre></div>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-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>Kubernetes configuration context (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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-describe-service Examples">Examples</h3>
|
|
<pre class="language-bash"><code> istioctl experimental describe service productpage
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-envoy-stats">istioctl experimental envoy-stats</h2>
|
|
<p>Retrieve Envoy emitted metrics for the specified pod.</p>
|
|
<pre class="language-bash"><code>istioctl experimental envoy-stats [<type>/]<name>[.<namespace>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl experimental es [<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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|short|prom|prom-merged (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--proxy-admin-port <int></code></td>
|
|
<td></td>
|
|
<td>Envoy proxy admin port (default `15000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--type <string></code></td>
|
|
<td><code>-t</code></td>
|
|
<td>Where to grab the stats: one of server|clusters (default `server`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-envoy-stats Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve Envoy emitted metrics for the specified pod.
|
|
istioctl experimental envoy-stats <pod-name[.namespace]>
|
|
|
|
# Retrieve Envoy server metrics in prometheus format
|
|
istioctl experimental envoy-stats <pod-name[.namespace]> --output prom
|
|
|
|
# Retrieve Envoy server metrics in prometheus format with custom proxy admin port
|
|
istioctl experimental envoy-stats <pod-name[.namespace]> --output prom --proxy-admin-port 15000
|
|
|
|
# Retrieve Envoy server metrics in prometheus format with merged application metrics
|
|
istioctl experimental envoy-stats <pod-name[.namespace]> --output prom-merged
|
|
|
|
# Retrieve Envoy cluster metrics
|
|
istioctl experimental envoy-stats <pod-name[.namespace]> --type clusters
|
|
|
|
</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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-injector-list Examples">Examples</h3>
|
|
<pre class="language-bash"><code> istioctl experimental injector list
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-internal-debug">istioctl experimental internal-debug</h2>
|
|
<p>
|
|
Retrieves the debug information from Istiod or Pods in the mesh using the service account from the pod if --cert-dir is empty.
|
|
By default it will use the default serviceAccount from (istio-system) namespace if the pod is not specified.</p>
|
|
<p>
|
|
THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p>
|
|
<pre class="language-bash"><code>istioctl experimental internal-debug [<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>--all</code></td>
|
|
<td></td>
|
|
<td>Send the same request to all instances of Istiod. Only applicable for in-cluster deployment. </td>
|
|
</tr>
|
|
<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>Kubernetes configuration context (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>Kubernetes 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><code>-r</code></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>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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-internal-debug Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve sync status for all Envoys in a mesh
|
|
istioctl x internal-debug syncz
|
|
|
|
# Retrieve sync diff for a single Envoy and Istiod
|
|
istioctl x internal-debug syncz istio-egressgateway-59585c5b9c-ndc59.istio-system
|
|
|
|
# SECURITY OPTIONS
|
|
|
|
# Retrieve syncz debug information directly from the control plane, using token security
|
|
# (This is the usual way to get the debug information with an out-of-cluster control plane.)
|
|
istioctl x internal-debug syncz --xds-address istio.cloudprovider.example.com:15012
|
|
|
|
# Retrieve syncz debug information via Kubernetes config, using token security
|
|
# (This is the usual way to get the debug information with an in-cluster control plane.)
|
|
istioctl x internal-debug syncz
|
|
|
|
# Retrieve syncz debug 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 internal-debug syncz --xds-address istio.example.com:15012 --cert-dir ~/.istio-certs
|
|
|
|
# Retrieve syncz 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 internal-debug syncz --xds-label istio.io/rev=default
|
|
|
|
</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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--duration <duration></code></td>
|
|
<td><code>-d</code></td>
|
|
<td>Duration of query metrics, default value is 1m. (default `1m0s`)</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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-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 with custom duration
|
|
istioctl experimental metrics productpage-v1 -d 2m
|
|
|
|
# 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 and upgrade requirements.</p>
|
|
<pre class="language-bash"><code>istioctl experimental precheck [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--from-version <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>check changes since the provided version (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>Kubernetes 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 precheck at which to display messages. Valid values: [Info Warning Error] (default `Warning`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td><code>-r</code></td>
|
|
<td>Control plane revision (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--skip-controlplane</code></td>
|
|
<td></td>
|
|
<td>skip checking the control plane </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-precheck Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Verify that Istio can be installed or upgraded
|
|
istioctl x precheck
|
|
|
|
# Check only a single namespace
|
|
istioctl x precheck --namespace default
|
|
|
|
# Check for behavioral changes since a specific version
|
|
istioctl x precheck --from-version 1.10
|
|
</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>Kubernetes configuration context (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>--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>Kubernetes 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><code>-r</code></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>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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>
|
|
<tr>
|
|
<td><code>--xds-via-agents</code></td>
|
|
<td></td>
|
|
<td>Access Istiod via the tap service of each agent </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--xds-via-agents-limit <xds-via-agent></code></td>
|
|
<td></td>
|
|
<td>Maximum number of pods being visited by istioctl when xds-via-agent flag is true.To iterate all the agent pods without limit, set to 0 (default `100`)</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 proxy-status
|
|
|
|
# Retrieve sync status for Envoys in a specific namespace
|
|
istioctl proxy-status --namespace foo
|
|
|
|
# Retrieve sync diff for a single Envoy and Istiod
|
|
istioctl 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 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 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 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 ps --xds-label istio.io/rev=default
|
|
|
|
</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>Kubernetes configuration context (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>Kubernetes 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><code>-r</code></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>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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-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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-workload Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # workload group yaml generation
|
|
istioctl x workload group create
|
|
|
|
# workload entry configuration generation
|
|
istioctl x 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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-workload-entry Examples">Examples</h3>
|
|
<pre class="language-bash"><code> istioctl x workload 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 ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--externalIP <string></code></td>
|
|
<td></td>
|
|
<td>External IP address of the workload (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>--internalIP <string></code></td>
|
|
<td></td>
|
|
<td>Internal IP address of the workload (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>The name of the workload group (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>The namespace that the workload instances belong to (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><code>-r</code></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>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-workload-entry-configure Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # configure example using a local WorkloadGroup artifact
|
|
istioctl x workload entry configure -f workloadgroup.yaml -o config
|
|
|
|
# configure example using the API server
|
|
istioctl x workload entry 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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-workload-group Examples">Examples</h3>
|
|
<pre class="language-bash"><code> istioctl x workload 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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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>The namespace that the workload instances will belong to (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>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-workload-group-create Examples">Examples</h3>
|
|
<pre class="language-bash"><code> istioctl x workload group 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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <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.24.0/manifests).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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.cni.enabled=true), or override Istio
|
|
settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.24/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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 Istio 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. When in
|
|
doubt re-run istioctl kube-inject on deployments to get the most up-to-date changes.</p>
|
|
<p>It's best to do kube-inject when the resource is initially created.
|
|
</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>--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>Kubernetes configuration context (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>--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>--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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--operatorFileName <string></code></td>
|
|
<td></td>
|
|
<td>Path to file containing IstioOperator custom resources. If configs from files like meshConfigFile, valuesFile are provided, they will be overridden by iop config values. (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>--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><code>-r</code></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>--valuesFile <string></code></td>
|
|
<td></td>
|
|
<td>Injection values configuration filename. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--webhookConfig <string></code></td>
|
|
<td></td>
|
|
<td>MutatingWebhookConfiguration name for Istio (default `istio-sidecar-injector`)</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-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 Istio 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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-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>--cluster-specific</code></td>
|
|
<td></td>
|
|
<td>If enabled, the current cluster will be checked for cluster-specific setting detection. </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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <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.24.0/manifests).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>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.cni.enabled=true), or override Istio
|
|
settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.24/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <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.24.0/manifests).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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.cni.enabled=true), or override Istio
|
|
settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.24/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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.24.0/manifests).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--operatorNamespace <string></code></td>
|
|
<td></td>
|
|
<td>The namespace the operator controller is installed into. (default `istio-operator`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml (default `yaml`)</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>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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-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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <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.24.0/manifests).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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>Kubernetes 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>--purge</code></td>
|
|
<td></td>
|
|
<td>Remove all versions of 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>--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>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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-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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <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.24.0/manifests).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|flags (default `yaml`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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.24.0/manifests).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--proxy-admin-port <int></code></td>
|
|
<td></td>
|
|
<td>Envoy proxy admin port (default `15000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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-all">istioctl proxy-config all</h2>
|
|
<p>Retrieve information about all configuration for the Envoy instance in the specified pod.</p>
|
|
<pre class="language-bash"><code>istioctl proxy-config all [<type>/]<name>[.<namespace>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl proxy-config a [<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>Kubernetes configuration context (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 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>--name <string></code></td>
|
|
<td></td>
|
|
<td>Filter routes by route name field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--port <int></code></td>
|
|
<td></td>
|
|
<td>Filter clusters and listeners by Port field (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--proxy-admin-port <int></code></td>
|
|
<td></td>
|
|
<td>Envoy proxy admin port (default `15000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--subset <string></code></td>
|
|
<td></td>
|
|
<td>Filter clusters by substring of Subset field (default ``)</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>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-config-all Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve summary about all configuration for a given pod from Envoy.
|
|
istioctl proxy-config all <pod-name[.namespace]>
|
|
|
|
# Retrieve full cluster dump as JSON
|
|
istioctl proxy-config all <pod-name[.namespace]> -o json
|
|
|
|
# Retrieve full cluster dump with short syntax
|
|
istioctl pc a <pod-name[.namespace]>
|
|
|
|
# Retrieve cluster summary without using Kubernetes API
|
|
ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
|
|
istioctl proxy-config all --file envoy-config.json
|
|
|
|
</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>Kubernetes configuration context (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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|short (default `json`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--proxy-admin-port <int></code></td>
|
|
<td></td>
|
|
<td>Envoy proxy admin port (default `15000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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
|
|
|
|
# Show a human-readable Istio and Envoy version summary
|
|
istioctl proxy-config bootstrap <pod-name[.namespace]> -o short
|
|
|
|
</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>Kubernetes configuration context (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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|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>--proxy-admin-port <int></code></td>
|
|
<td></td>
|
|
<td>Envoy proxy admin port (default `15000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--subset <string></code></td>
|
|
<td></td>
|
|
<td>Filter clusters by substring of Subset field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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-ecds">istioctl proxy-config ecds</h2>
|
|
<p>Retrieve information about typed extension configuration for the Envoy instance in the specified pod.</p>
|
|
<pre class="language-bash"><code>istioctl proxy-config ecds [<type>/]<name>[.<namespace>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl proxy-config ec [<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>Kubernetes configuration context (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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--proxy-admin-port <int></code></td>
|
|
<td></td>
|
|
<td>Envoy proxy admin port (default `15000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-config-ecds Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve full typed extension configuration for a given pod from Envoy.
|
|
istioctl proxy-config ecds <pod-name[.namespace]>
|
|
|
|
# Retrieve endpoint summary without using Kubernetes API
|
|
ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
|
|
istioctl proxy-config ecds --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>Kubernetes configuration context (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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|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>--proxy-admin-port <int></code></td>
|
|
<td></td>
|
|
<td>Envoy proxy admin port (default `15000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--status <string></code></td>
|
|
<td></td>
|
|
<td>Filter endpoints by status field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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>Kubernetes configuration context (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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|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>--proxy-admin-port <int></code></td>
|
|
<td></td>
|
|
<td>Envoy proxy admin port (default `15000`)</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>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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>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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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>,... or <level> to change all active loggers, where logger components can be listed by running "istioctl proxy-config log <pod-name[.namespace]>"or referred from https://github.com/envoyproxy/envoy/blob/main/source/common/common/logger.h, 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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--proxy-admin-port <int></code></td>
|
|
<td></td>
|
|
<td>Envoy proxy admin port (default `15000`)</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>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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-rootca-compare">istioctl proxy-config rootca-compare</h2>
|
|
<p>Compare ROOTCA values for given 2 pods to check the connectivity between them.</p>
|
|
<p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p>
|
|
<pre class="language-bash"><code>istioctl proxy-config rootca-compare [pod/]<name-1>[.<namespace-1>] [pod/]<name-2>[.<namespace-2>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl proxy-config rc [pod/]<name-1>[.<namespace-1>] [pod/]<name-2>[.<namespace-2>] [flags]
|
|
</code></pre></div>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--proxy-admin-port <int></code></td>
|
|
<td></td>
|
|
<td>Envoy proxy admin port (default `15000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-config-rootca-compare Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Compare ROOTCA values for given 2 pods to check the connectivity between them.
|
|
istioctl proxy-config rootca-compare <pod-name-1[.namespace]> <pod-name-2[.namespace]>
|
|
</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>Kubernetes configuration context (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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--proxy-admin-port <int></code></td>
|
|
<td></td>
|
|
<td>Envoy proxy admin port (default `15000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--verbose</code></td>
|
|
<td></td>
|
|
<td>Output more information </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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>Retrieve information about secret configuration for the Envoy instance in the specified pod.</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>Kubernetes configuration context (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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--proxy-admin-port <int></code></td>
|
|
<td></td>
|
|
<td>Envoy proxy admin port (default `15000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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>
|
|
<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>--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>Kubernetes configuration context (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>--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>Kubernetes 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><code>-r</code></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>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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-proxy-status Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve sync status for all Envoys in a mesh
|
|
istioctl proxy-status
|
|
|
|
# Retrieve sync status for Envoys in a specific namespace
|
|
istioctl proxy-status --namespace foo
|
|
|
|
# Retrieve sync diff for a single Envoy and Istiod
|
|
istioctl 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 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 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 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 ps --xds-label istio.io/rev=default
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-remote-clusters">istioctl remote-clusters</h2>
|
|
<p>Lists the remote clusters each istiod instance is connected to.</p>
|
|
<pre class="language-bash"><code>istioctl remote-clusters [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td><code>-r</code></td>
|
|
<td>Control plane revision (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-tag">istioctl tag</h2>
|
|
<p>Command group used to interact with revision tags. Revision tags allow for the creation of mutable aliases
|
|
referring to control plane revisions for sidecar injection.</p>
|
|
<p>With revision tags, rather than relabeling a namespace from "istio.io/rev=revision-a" to "istio.io/rev=revision-b" to
|
|
change which control plane revision handles injection, it's possible to create a revision tag "prod" and label our
|
|
namespace "istio.io/rev=prod". The "prod" revision tag could point to "1-7-6" initially and then be changed to point to "1-8-1"
|
|
at some later point.</p>
|
|
<p>This allows operators to change which Istio control plane revision should handle injection for a namespace or set of namespaces
|
|
without manual relabeling of the "istio.io/rev" tag.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl tag [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-tag-generate">istioctl tag generate</h2>
|
|
<p>Create a revision tag and output to the command's stdout. Tag an Istio control plane revision for use with namespace istio.io/rev
|
|
injection labels.</p>
|
|
<pre class="language-bash"><code>istioctl tag generate <revision-tag> [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--auto-inject-namespaces</code></td>
|
|
<td></td>
|
|
<td>If set to true, the sidecars should be automatically injected into all namespaces by default </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--manifests <string></code></td>
|
|
<td><code>-d</code></td>
|
|
<td>Specify a path to a directory of charts and profiles
|
|
(e.g. ~/Downloads/istio-1.24.0/manifests). (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--overwrite</code></td>
|
|
<td></td>
|
|
<td>If true, allow revision tags to be overwritten, otherwise reject revision tag updates that
|
|
overwrite existing revision tags. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td><code>-r</code></td>
|
|
<td>Control plane revision to reference from a given revision tag (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--skip-confirmation</code></td>
|
|
<td><code>-y</code></td>
|
|
<td>The skipConfirmation determines whether the user is prompted for confirmation.
|
|
If set to true, the user is not prompted and a Yes response is assumed in all cases. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--webhook-name <string></code></td>
|
|
<td></td>
|
|
<td>Name to use for a revision tag's mutating webhook configuration. (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-tag-generate Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Create a revision tag from the "1-8-0" revision
|
|
istioctl tag generate prod --revision 1-8-0 > tag.yaml
|
|
|
|
# Apply the tag to cluster
|
|
kubectl apply -f tag.yaml
|
|
|
|
# Point namespace "test-ns" at the revision pointed to by the "prod" revision tag
|
|
kubectl label ns test-ns istio.io/rev=prod
|
|
|
|
# Rollout namespace "test-ns" to update workloads to the "1-8-0" revision
|
|
kubectl rollout restart deployments -n test-ns
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-tag-list">istioctl tag list</h2>
|
|
<p>List existing revision tags</p>
|
|
<pre class="language-bash"><code>istioctl tag list [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl tag show [flags]
|
|
</code></pre></div>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format for tag description (available formats: table,json) (default `table`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-tag-list Examples">Examples</h3>
|
|
<pre class="language-bash"><code>istioctl tag list
|
|
</code></pre>
|
|
<h2 id="istioctl-tag-remove">istioctl tag remove</h2>
|
|
<p>Remove Istio control plane revision tag.</p>
|
|
<p>Removing a revision tag should be done with care. Removing a revision tag will disrupt sidecar injection in namespaces
|
|
that reference the tag in an "istio.io/rev" label. Verify that there are no remaining namespaces referencing a
|
|
revision tag before removing using the "istioctl tag list" command.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl tag remove <revision-tag> [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl tag delete <revision-tag> [flags]
|
|
</code></pre></div>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (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>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-tag-remove Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Remove the revision tag "prod"
|
|
istioctl tag remove prod
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-tag-set">istioctl tag set</h2>
|
|
<p>Create or modify revision tags. Tag an Istio control plane revision for use with namespace istio.io/rev
|
|
injection labels.</p>
|
|
<pre class="language-bash"><code>istioctl tag set <revision-tag> [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--auto-inject-namespaces</code></td>
|
|
<td></td>
|
|
<td>If set to true, the sidecars should be automatically injected into all namespaces by default </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--manifests <string></code></td>
|
|
<td><code>-d</code></td>
|
|
<td>Specify a path to a directory of charts and profiles
|
|
(e.g. ~/Downloads/istio-1.24.0/manifests). (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--overwrite</code></td>
|
|
<td></td>
|
|
<td>If true, allow revision tags to be overwritten, otherwise reject revision tag updates that
|
|
overwrite existing revision tags. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td><code>-r</code></td>
|
|
<td>Control plane revision to reference from a given revision tag (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--skip-confirmation</code></td>
|
|
<td><code>-y</code></td>
|
|
<td>The skipConfirmation determines whether the user is prompted for confirmation.
|
|
If set to true, the user is not prompted and a Yes response is assumed in all cases. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--webhook-name <string></code></td>
|
|
<td></td>
|
|
<td>Name to use for a revision tag's mutating webhook configuration. (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-tag-set Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Create a revision tag from the "1-8-0" revision
|
|
istioctl tag set prod --revision 1-8-0
|
|
|
|
# Point namespace "test-ns" at the revision pointed to by the "prod" revision tag
|
|
kubectl label ns test-ns istio.io/rev=prod
|
|
|
|
# Change the revision tag to reference the "1-8-1" revision
|
|
istioctl tag set prod --revision 1-8-1 --overwrite
|
|
|
|
# Make revision "1-8-1" the default revision, both resulting in that revision handling injection for "istio-injection=enabled"
|
|
# and validating resources cluster-wide
|
|
istioctl tag set default --revision 1-8-1
|
|
|
|
# Rollout namespace "test-ns" to update workloads to the "1-8-1" revision
|
|
kubectl rollout restart deployments -n test-ns
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-uninstall">istioctl uninstall</h2>
|
|
<p>The uninstall command uninstalls Istio from a cluster</p>
|
|
<pre class="language-bash"><code>istioctl 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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <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.24.0/manifests).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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.cni.enabled=true), or override Istio
|
|
settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.24/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-uninstall Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Uninstall a single control plane by revision
|
|
istioctl uninstall --revision foo
|
|
|
|
# Uninstall a single control plane by iop file
|
|
istioctl uninstall -f iop.yaml
|
|
|
|
# Uninstall all control planes and shared resources
|
|
istioctl uninstall --purge
|
|
</code></pre>
|
|
<h2 id="istioctl-upgrade">istioctl upgrade</h2>
|
|
<p>The upgrade command is an alias for the install command</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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <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.24.0/manifests).
|
|
(default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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.cni.enabled=true), or override Istio
|
|
settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.24/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <stringSlice></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Inputs 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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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 all yaml files under samples/bookinfo/networking directory
|
|
istioctl validate -f samples/bookinfo/networking
|
|
|
|
# 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>Kubernetes configuration context (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.24.0/manifests). (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td><code>-r</code></td>
|
|
<td>Control plane revision (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-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>
|
|
|
|
# Verify the installation of specific revision
|
|
istioctl verify-install -r 1-9-0
|
|
</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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>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><code>-r</code></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>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-waypoint">istioctl waypoint</h2>
|
|
<p>A group of commands used to manage waypoint configuration</p>
|
|
<pre class="language-bash"><code>istioctl waypoint [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--name <string></code></td>
|
|
<td></td>
|
|
<td>name of the waypoint (default `waypoint`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-waypoint Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Apply a waypoint to the current namespace
|
|
istioctl waypoint apply
|
|
|
|
# Generate a waypoint as yaml
|
|
istioctl waypoint generate --namespace default
|
|
|
|
# List all waypoints in a specific namespace
|
|
istioctl waypoint list --namespace default
|
|
</code></pre>
|
|
<h2 id="istioctl-waypoint-apply">istioctl waypoint apply</h2>
|
|
<p>Apply a waypoint configuration to the cluster</p>
|
|
<pre class="language-bash"><code>istioctl waypoint apply [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--enroll-namespace</code></td>
|
|
<td></td>
|
|
<td>If set, the namespace will be labeled with the waypoint name </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--for <string></code></td>
|
|
<td></td>
|
|
<td>Specify the traffic type [all none service workload] for the waypoint (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>name of the waypoint (default `waypoint`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--overwrite</code></td>
|
|
<td></td>
|
|
<td>Overwrite the existing Waypoint used by the namespace </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td><code>-r</code></td>
|
|
<td>The revision to label the waypoint with (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--wait</code></td>
|
|
<td><code>-w</code></td>
|
|
<td>Wait for the waypoint to be ready </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-waypoint-apply Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Apply a waypoint to the current namespace
|
|
istioctl waypoint apply
|
|
|
|
# Apply a waypoint to a specific namespace and wait for it to be ready
|
|
istioctl waypoint apply --namespace default --wait
|
|
</code></pre>
|
|
<h2 id="istioctl-waypoint-delete">istioctl waypoint delete</h2>
|
|
<p>Delete a waypoint configuration from the cluster</p>
|
|
<pre class="language-bash"><code>istioctl waypoint delete [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></td>
|
|
<td>Delete all waypoints in the namespace </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--name <string></code></td>
|
|
<td></td>
|
|
<td>name of the waypoint (default `waypoint`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-waypoint-delete Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Delete a waypoint from the default namespace
|
|
istioctl waypoint delete
|
|
|
|
# Delete a waypoint by name, which can obtain from istioctl waypoint list
|
|
istioctl waypoint delete waypoint-name --namespace default
|
|
|
|
# Delete several waypoints by name
|
|
istioctl waypoint delete waypoint-name1 waypoint-name2 --namespace default
|
|
|
|
# Delete all waypoints in a specific namespace
|
|
istioctl waypoint delete --all --namespace default
|
|
</code></pre>
|
|
<h2 id="istioctl-waypoint-generate">istioctl waypoint generate</h2>
|
|
<p>Generate a waypoint configuration as YAML</p>
|
|
<pre class="language-bash"><code>istioctl waypoint 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>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--for <string></code></td>
|
|
<td></td>
|
|
<td>Specify the traffic type [all none service workload] for the waypoint (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>name of the waypoint (default `waypoint`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--revision <string></code></td>
|
|
<td><code>-r</code></td>
|
|
<td>The revision to label the waypoint with (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-waypoint-generate Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Generate a waypoint as yaml
|
|
istioctl waypoint generate --namespace default
|
|
</code></pre>
|
|
<h2 id="istioctl-waypoint-list">istioctl waypoint list</h2>
|
|
<p>List managed waypoint configurations in the cluster</p>
|
|
<pre class="language-bash"><code>istioctl waypoint 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>--all-namespaces</code></td>
|
|
<td><code>-A</code></td>
|
|
<td>List all waypoints in all namespaces </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--name <string></code></td>
|
|
<td></td>
|
|
<td>name of the waypoint (default `waypoint`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-waypoint-list Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # List all waypoints in a specific namespace
|
|
istioctl waypoint list --namespace default
|
|
|
|
# List all waypoints in the cluster
|
|
istioctl waypoint list -A
|
|
</code></pre>
|
|
<h2 id="istioctl-waypoint-status">istioctl waypoint status</h2>
|
|
<p>Show the status of waypoints for the namespace provided or default namespace if none is provided</p>
|
|
<pre class="language-bash"><code>istioctl waypoint status [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--name <string></code></td>
|
|
<td></td>
|
|
<td>name of the waypoint (default `waypoint`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-waypoint-status Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Show the status of the waypoint in the default namespace
|
|
istioctl waypoint status
|
|
|
|
# Show the status of the waypoint in a specific namespace
|
|
istioctl waypoint status --namespace default
|
|
</code></pre>
|
|
<h2 id="istioctl-ztunnel-config">istioctl ztunnel-config</h2>
|
|
<p>A group of commands used to update or retrieve Ztunnel configuration from a Ztunnel instance.</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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-ztunnel-config Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve summary about workload configuration
|
|
istioctl ztunnel-config workload
|
|
|
|
# Retrieve summary about certificates
|
|
istioctl ztunnel-config certificates
|
|
</code></pre>
|
|
<h2 id="istioctl-ztunnel-config-all">istioctl ztunnel-config all</h2>
|
|
<p>Retrieve information about all configuration for the Ztunnel instance.</p>
|
|
<pre class="language-bash"><code>istioctl ztunnel-config all [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Ztunnel 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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--node <string></code></td>
|
|
<td></td>
|
|
<td>Filter workloads by node field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--proxy-admin-port <int></code></td>
|
|
<td></td>
|
|
<td>Ztunnel proxy admin port (default `15000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-ztunnel-config-all Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve summary about all configuration for a randomly chosen ztunnel.
|
|
istioctl ztunnel-config all
|
|
|
|
# Retrieve full configuration dump of workloads for a given Ztunnel instance.
|
|
istioctl ztunnel-config policies <ztunnel-name[.namespace]> -o json
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-ztunnel-config-certificate">istioctl ztunnel-config certificate</h2>
|
|
<p>Retrieve information about certificates for the Ztunnel instance.</p>
|
|
<pre class="language-bash"><code>istioctl ztunnel-config certificate [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl ztunnel-config certificates [flags]
|
|
istioctl ztunnel-config certs [flags]
|
|
istioctl ztunnel-config cert [flags]
|
|
</code></pre></div>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Ztunnel 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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--node <string></code></td>
|
|
<td></td>
|
|
<td>Filter workloads by node field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--proxy-admin-port <int></code></td>
|
|
<td></td>
|
|
<td>Ztunnel proxy admin port (default `15000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-ztunnel-config-certificate Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve summary about workload configuration for a randomly chosen ztunnel.
|
|
istioctl ztunnel-config certificates
|
|
|
|
# Retrieve full certificate dump of workloads for a given Ztunnel instance.
|
|
istioctl ztunnel-config certificates <ztunnel-name[.namespace]> -o json
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-ztunnel-config-log">istioctl ztunnel-config log</h2>
|
|
<p>Retrieve information about logging levels of the Ztunnel instance in the specified pod, and update optionally.</p>
|
|
<pre class="language-bash"><code>istioctl ztunnel-config log [<type>/]<name>[.<namespace>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl ztunnel-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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Ztunnel 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>--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>,... or <level> to change all active loggers, where logger components can be listed by running "istioctl ztunnel-config log <pod-name[.namespace]>", 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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--node <string></code></td>
|
|
<td></td>
|
|
<td>Filter workloads by node field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--proxy-admin-port <int></code></td>
|
|
<td></td>
|
|
<td>Ztunnel proxy admin port (default `15000`)</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>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-ztunnel-config-log Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve information about logging levels from all Ztunnel pods
|
|
istioctl ztunnel-config log
|
|
|
|
# Update levels of the all loggers for a specific Ztunnel pod
|
|
istioctl ztunnel-config log <pod-name[.namespace]> --level off
|
|
|
|
# Update levels of the specified loggers for all Ztunnl pods
|
|
istioctl ztunnel-config log --level access:debug,info
|
|
|
|
# Reset levels of all the loggers to default value (warning) for a specific Ztunnel pod.
|
|
istioctl ztunnel-config log <pod-name[.namespace]> -r
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-ztunnel-config-policy">istioctl ztunnel-config policy</h2>
|
|
<p>Retrieve information about policies for the Ztunnel instance.</p>
|
|
<pre class="language-bash"><code>istioctl ztunnel-config policy [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl ztunnel-config policies [flags]
|
|
istioctl ztunnel-config p [flags]
|
|
istioctl ztunnel-config pol [flags]
|
|
</code></pre></div>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Ztunnel 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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--node <string></code></td>
|
|
<td></td>
|
|
<td>Filter workloads by node field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--policy-namespace <string></code></td>
|
|
<td></td>
|
|
<td>Filter policies by namespace field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--proxy-admin-port <int></code></td>
|
|
<td></td>
|
|
<td>Ztunnel proxy admin port (default `15000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-ztunnel-config-policy Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve summary about policy configuration for a randomly chosen ztunnel.
|
|
istioctl ztunnel-config policies
|
|
|
|
# Retrieve full policy dump of workloads for a given Ztunnel instance.
|
|
istioctl ztunnel-config policies <ztunnel-name[.namespace]> -o json
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-ztunnel-config-service">istioctl ztunnel-config service</h2>
|
|
<p>Retrieve information about services for the Ztunnel instance.</p>
|
|
<pre class="language-bash"><code>istioctl ztunnel-config service [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl ztunnel-config services [flags]
|
|
istioctl ztunnel-config s [flags]
|
|
istioctl ztunnel-config 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>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Ztunnel 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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--node <string></code></td>
|
|
<td></td>
|
|
<td>Filter workloads by node field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--proxy-admin-port <int></code></td>
|
|
<td></td>
|
|
<td>Ztunnel proxy admin port (default `15000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--service-namespace <string></code></td>
|
|
<td></td>
|
|
<td>Filter services by namespace field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-ztunnel-config-service Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve summary about services configuration for a randomly chosen ztunnel.
|
|
istioctl ztunnel-config services
|
|
|
|
# Retrieve full certificate dump of workloads for a given Ztunnel instance.
|
|
istioctl ztunnel-config services <ztunnel-name[.namespace]> -o json
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-ztunnel-config-workload">istioctl ztunnel-config workload</h2>
|
|
<p>Retrieve information about workload configuration for the Ztunnel instance.</p>
|
|
<pre class="language-bash"><code>istioctl ztunnel-config workload [<type>/]<name>[.<namespace>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl ztunnel-config w [<type>/]<name>[.<namespace>] [flags]
|
|
istioctl ztunnel-config workloads [<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 workloads by address field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>Kubernetes configuration context (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Ztunnel 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>Kubernetes namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--node <string></code></td>
|
|
<td></td>
|
|
<td>Filter workloads by node field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|yaml|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--proxy-admin-port <int></code></td>
|
|
<td></td>
|
|
<td>Ztunnel proxy admin port (default `15000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vklog <Level></code></td>
|
|
<td></td>
|
|
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--workload-namespace <string></code></td>
|
|
<td></td>
|
|
<td>Filter workloads by namespace field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--workload-node <string></code></td>
|
|
<td></td>
|
|
<td>Filter workloads by node (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-ztunnel-config-workload Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve summary about workload configuration for a randomly chosen ztunnel.
|
|
istioctl ztunnel-config workload
|
|
|
|
# Retrieve summary of workloads on node XXXX for a given Ztunnel instance.
|
|
istioctl ztunnel-config workload <ztunnel-name[.namespace]> --node ambient-worker
|
|
|
|
# Retrieve full workload dump of workloads with address XXXX for a given Ztunnel instance.
|
|
istioctl ztunnel-config workload <ztunnel-name[.namespace]> --address 0.0.0.0 -o json
|
|
|
|
# Retrieve Ztunnel config dump separately and inspect from file.
|
|
kubectl exec -it $ZTUNNEL -n istio-system -- curl localhost:15000/config_dump > ztunnel-config.json
|
|
istioctl ztunnel-config workloads --file ztunnel-config.json
|
|
|
|
# Retrieve workload summary for a specific namespace
|
|
istioctl ztunnel-config workloads <ztunnel-name[.namespace]> --workloads-namespace foo
|
|
|
|
</code></pre>
|
|
<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>CA_TRUSTED_NODE_ACCOUNTS</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>If set, the list of service accounts that are allowed to use node authentication for CSRs. Node authentication allows an identity to create CSRs on behalf of other identities, but only if there is a pod running on the same node with that identity. This is intended for use with node proxies.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>CERT_SIGNER_DOMAIN</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>The cert signer domain info</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>CLOUD_PLATFORM</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>Cloud Platform on which proxy is running, if not specified, Istio will try to discover the platform. Valid platform values are aws, azure, gcp, none</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 belongs to</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>COMPLIANCE_POLICY</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>If set, applies policy-specific restrictions over all existing TLS
|
|
settings, including in-mesh mTLS and external TLS. Valid values are:
|
|
|
|
* '' or unset places no additional restrictions.
|
|
* 'fips-140-2' which enforces a version of the TLS protocol and a subset
|
|
of cipher suites overriding any user preferences or defaults for all runtime
|
|
components, including Envoy, gRPC Go SDK, and gRPC C++ SDK.
|
|
|
|
WARNING: Setting compliance policy in the control plane is a necessary but
|
|
not a sufficient requirement to achieve compliance. There are additional
|
|
steps necessary to claim compliance, including using the validated
|
|
cryptograhic modules (please consult
|
|
https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/security/ssl#fips-140-2).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_100_CONTINUE_HEADERS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, istiod will proxy 100-continue headers as is</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_AUTO_SNI</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, automatically set SNI when `DestinationRules` do not specify the same</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 enabled, recommended for production</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_DEFERRED_CLUSTER_CREATION</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, Istio will create clusters only when there are requests. This will save memory and CPU cycles in cases where there are lots of inactive clusters and > 1 worker thread</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_ENHANCED_RESOURCE_SCOPING</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, meshConfig.discoverySelectors will limit the CustomResource configurations(like Gateway,VirtualService,DestinationRule,Ingress, etc)that can be processed by pilot. This will also restrict the root-ca certificate distribution.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_EXTERNAL_NAME_ALIAS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, ExternalName Services will be treated as simple aliases: anywhere where we would match the concrete service, we also match the ExternalName. In general, this mirrors Kubernetes behavior more closely. However, it means that policies (routes and DestinationRule) cannot be applied to the ExternalName service. If disabled, ExternalName behaves in fairly unexpected manner. Port matters, while it does not in Kubernetes. If it is a TCP port, all traffic on that port will be matched, which can have disastrous consequences. Additionally, the destination is seen as an opaque destination; even if it is another service in the mesh, policies such as mTLS and load balancing will not be used when connecting to it.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_HCM_INTERNAL_NETWORKS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enable, endpoints defined in mesh networks will be configured as internal addresses in Http Connection Manager</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_INBOUND_RETRY_POLICY</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If true, enables retry policy for inbound routes which automatically retries requests that were reset before it reaches the service.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_LEADER_ELECTION</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled (default), starts a leader election client and gains leadership before executing controllers. If false, it assumes that only one instance of istiod is running and skips leader election.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_MCS_AUTO_EXPORT</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, istiod will automatically generate Kubernetes Multi-Cluster Services (MCS) ServiceExport resources for every service in the mesh. Services defined to be cluster-local in MeshConfig are excluded.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_MCS_CLUSTER_LOCAL</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, istiod will treat the host `<svc>.<namespace>.svc.cluster.local` as defined by the Kubernetes Multi-Cluster Services (MCS) spec. In this mode, requests to `cluster.local` will be routed to only those endpoints residing within the same cluster as the client. Requires that both ENABLE_MCS_SERVICE_DISCOVERY and ENABLE_MCS_HOST also be enabled.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_MCS_HOST</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, istiod will configure a Kubernetes Multi-Cluster Services (MCS) host (<svc>.<namespace>.svc.clusterset.local) for each service exported (via ServiceExport) in at least one cluster. Clients must, however, be able to successfully lookup these DNS hosts. That means that either Istio DNS interception must be enabled or an MCS controller must be used. Requires that ENABLE_MCS_SERVICE_DISCOVERY also be enabled.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_MCS_SERVICE_DISCOVERY</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, istiod will enable Kubernetes Multi-Cluster Services (MCS) service discovery mode. In this mode, service endpoints in a cluster will only be discoverable within the same cluster unless explicitly exported via ServiceExport.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_MULTICLUSTER_HEADLESS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If true, the DNS name table for a headless service will resolve to same-network endpoints in any cluster.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_NATIVE_SIDECARS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If set, used Kubernetes native Sidecar container support. Requires SidecarContainer feature flag.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_PROBE_KEEPALIVE_CONNECTIONS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, readiness probes will keep the connection from pilot-agent to the application alive. This mirrors older Istio versions' behaviors, but not kubelet's.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_RESOLUTION_NONE_TARGET_PORT</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, targetPort will be supported for resolution=NONE ServiceEntry</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_SELECTOR_BASED_K8S_GATEWAY_POLICY</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If disabled, Gateway API gateways will ignore workloadSelector policies, onlyapplying policies that select the gateway with a targetRef.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_TLS_ON_SIDECAR_INGRESS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, the TLS configuration on Sidecar.ingress will take effect</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ENABLE_VTPROTOBUF</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If true, will use optimized vtprotobuf based marshaling. Requires a build with -tags=vtprotobuf.</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>GCP_METADATA</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>Pipe separated GCP metadata, schemed as PROJECT_ID|PROJECT_NUMBER|CLUSTER_NAME|CLUSTER_ZONE</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>GCP_QUOTA_PROJECT</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>Allows specification of a quota project to be used in requests to GCP APIs.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>GRPC_KEEPALIVE_INTERVAL</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>30s</code></td>
|
|
<td>gRPC Keepalive Interval</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>GRPC_KEEPALIVE_TIMEOUT</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>10s</code></td>
|
|
<td>gRPC Keepalive Timeout</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>HTTP_STRIP_FRAGMENT_FROM_PATH_UNSAFE_IF_DISABLED</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>INBOUND_INTERCEPTION_MODE</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>The mode used to redirect inbound connections to Envoy, either "REDIRECT" or "TPROXY"</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>INBOUND_TPROXY_MARK</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td></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. Multiple custom host names are supported, and multiple values are separated by commas.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIO_AGENT_ENABLE_WASM_REMOTE_LOAD_CONVERSION</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, Istio agent will intercept ECDS resource update, downloads Wasm module, and replaces Wasm module remote load with downloaded local module file.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIO_BOOTSTRAP</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIO_DELTA_XDS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, pilot will only send the delta configs as opposed to the state of the world on a Resource Request. This feature uses the delta xds api, but does not currently send the actual deltas.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIO_DUAL_STACK</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If true, Istio will enable the Dual Stack feature.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIO_ENABLE_CONTROLLER_QUEUE_METRICS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, publishes metrics for queue depth, latency and processing times.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIO_ENABLE_HTTP2_PROBING</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, HTTP2 probes will be enabled for HTTPS probes, following Kubernetes</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIO_ENABLE_IPV4_OUTBOUND_LISTENER_FOR_IPV6_CLUSTERS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If true, pilot will configure an additional IPv4 listener for outbound traffic in IPv6 only clusters, e.g. AWS EKS IPv6 only clusters.</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_KUBE_CLIENT_CONTENT_TYPE</code></td>
|
|
<td>String</td>
|
|
<td><code>protobuf</code></td>
|
|
<td>The content type to use for Kubernetes clients. Defaults to protobuf. Valid options: [protobuf, json]</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIO_MULTIROOT_MESH</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, mesh will support certificates signed by more than one trustAnchor for ISTIO_MUTUAL mTLS</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIO_OUTBOUND_IPV4_LOOPBACK_CIDR</code></td>
|
|
<td>String</td>
|
|
<td><code>127.0.0.1/32</code></td>
|
|
<td>IPv4 CIDR range used to identify outbound traffic on loopback interface intended for application container</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIO_OUTBOUND_OWNER_GROUPS</code></td>
|
|
<td>String</td>
|
|
<td><code>*</code></td>
|
|
<td>Comma separated list of groups whose outgoing traffic is to be redirected to Envoy.
|
|
A group can be specified either by name or by a numeric GID.
|
|
The wildcard character "*" can be used to configure redirection of traffic from all groups.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIO_OUTBOUND_OWNER_GROUPS_EXCLUDE</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>Comma separated list of groups whose outgoing traffic is to be excluded from redirection to Envoy.
|
|
A group can be specified either by name or by a numeric GID.
|
|
Only applies when traffic from all groups (i.e. "*") is being redirected to Envoy.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIO_PROMETHEUS_ANNOTATIONS</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIO_WATCH_NAMESPACE</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>If set, limit Kubernetes watches to a single namespace. Warning: only a single namespace can be set.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIO_WORKLOAD_ENTRY_VALIDATE_IDENTITY</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, will validate the identity of a workload matches the identity of the WorkloadEntry it is associating with for health checks and auto registration. This flag is added for backwards compatibility only and will be removed in future releases</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>JWKS_RESOLVER_INSECURE_SKIP_VERIFY</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, istiod will skip verifying the certificate of the JWKS server.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>K_REVISION</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>KNative revision, set if running in knative</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>LABEL_CANONICAL_SERVICES_FOR_MESH_EXTERNAL_SERVICE_ENTRIES</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, metadata representing canonical services for ServiceEntry resources with a location of mesh_external will be populatedin the cluster metadata for those endpoints.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>LOCAL_CLUSTER_SECRET_WATCHER</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, the cluster secret watcher will watch the namespace of the external cluster instead of config cluster</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>MCS_API_GROUP</code></td>
|
|
<td>String</td>
|
|
<td><code>multicluster.x-k8s.io</code></td>
|
|
<td>The group to be used for the Kubernetes Multi-Cluster Services (MCS) API.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>MCS_API_VERSION</code></td>
|
|
<td>String</td>
|
|
<td><code>v1alpha1</code></td>
|
|
<td>The version to be used for the Kubernetes Multi-Cluster Services (MCS) API.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>METRICS_LOCALHOST_ACCESS_ONLY</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>This will disable metrics endpoint from outside of the pod, allowing only localhost access.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>METRIC_GRACEFUL_DELETION_INTERVAL</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>5m0s</code></td>
|
|
<td>Metric expiry graceful deletion interval. No-op if METRIC_ROTATION_INTERVAL is disabled.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>METRIC_ROTATION_INTERVAL</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>0s</code></td>
|
|
<td>Metric scope rotation interval, set to 0 to disable the metric scope rotation</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>MUTEX_PROFILE_FRACTION</code></td>
|
|
<td>Integer</td>
|
|
<td><code>1000</code></td>
|
|
<td>If set to a non-zero value, enables mutex profiling a rate of 1/MUTEX_PROFILE_FRACTION events. For example, '1000' will record 0.1% of events. Set to 0 to disable entirely.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PERSIST_OLDEST_FIRST_HEURISTIC_FOR_VIRTUAL_SERVICE_HOST_MATCHING</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, istiod will persist the oldest first heuristic for subtly conflicting traffic policy selection(such as with overlapping wildcard hosts)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ALLOW_SIDECAR_SERVICE_INBOUND_LISTENER_MERGE</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If set, it allows creating inbound listeners for service ports and sidecar ingress listeners </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ANALYSIS_INTERVAL</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>10s</code></td>
|
|
<td>If analysis is enabled, pilot will run istio analyzers using this value as interval in seconds Istio Resources</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_AUTO_ALLOW_WAYPOINT_POLICY</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, zTunnel will receive synthetic authorization policies for each workload ALLOW the Waypoint's identity. Unless other ALLOW policies are created, this effectively denies traffic that doesn't go through the waypoint.</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. K8S RA will be used for k8s.io/NAME. 'istiod' value will sign using Istio build in CA. Other values will not not generate TLS certs, but still distribute ./etc/certs/root-cert.pem. Only used if custom certificates are not mounted.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_CONVERT_SIDECAR_SCOPE_CONCURRENCY</code></td>
|
|
<td>Integer</td>
|
|
<td><code>1</code></td>
|
|
<td>Used to adjust the concurrency of SidecarScope conversions. When istiod is deployed on a multi-core CPU server, increasing this value will help to use the CPU to accelerate configuration push, but it also means that istiod will consume more CPU resources.</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 interval. 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_DISABLE_MX_ALPN</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If true, pilot will not put istio-peer-exchange ALPN into TLS handshake configuration.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_DRAINING_LABEL</code></td>
|
|
<td>String</td>
|
|
<td><code>istio.io/draining</code></td>
|
|
<td>If not empty, endpoints with the label value present will be sent with status DRAINING.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_ALPHA_GATEWAY_API</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If this is set to true, support for alpha APIs in the Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_ALPN_FILTER</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If true, pilot will add Istio ALPN filters, required for proper protocol sniffing.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_AMBIENT</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, ambient mode can be used. Individual flags configure fine grained enablement; this must be enabled for any ambient functionality.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_AMBIENT_WAYPOINTS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, controllers required for ambient will run. This is required to run ambient mesh.</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_CDS_CACHE</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If true, Pilot will cache CDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_CROSS_CLUSTER_WORKLOAD_ENTRY</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, pilot will read WorkloadEntry from other clusters, selectable by Services in that cluster.</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_GATEWAY_API</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If this is set to true, support for Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_GATEWAY_API_DEPLOYMENT_CONTROLLER</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If this is set to true, gateway-api resources will automatically provision in cluster deployment, services, etc</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_GATEWAY_API_GATEWAYCLASS_CONTROLLER</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If this is set to true, istiod will create and manage its default GatewayClasses</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_GATEWAY_API_STATUS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If this is set to true, gateway-api resources will have status written to them</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_IP_AUTOALLOCATE</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, pilot will start a controller that assigns IP addresses to ServiceEntry which do not have a user-supplied IP. This, when combined with DNS capture allows for tcp routing of traffic sent to the ServiceEntry.</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_METADATA_EXCHANGE</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If true, pilot will add metadata exchange filters, which will be consumed by telemetry filter.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_MONGO_FILTER</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>EnableMongoFilter enables injection of `envoy.filters.network.mongo_proxy` in the filter chain.</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_NODE_UNTAINT_CONTROLLERS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, controller that untaints nodes with cni pods ready will run. This should be enabled if you disabled ambient init containers.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_PERSISTENT_SESSION_FILTER</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, Istiod sets up persistent session filter for listeners, if services have 'PILOT_PERSISTENT_SESSION_LABEL' set.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_QUIC_LISTENERS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If true, QUIC listeners will be generated wherever there are listeners terminating TLS on gateways if the gateway service exposes a UDP port with the same number (for example 443/TCP and 443/UDP)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_RDS_CACHE</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If true, Pilot will cache RDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE.</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_ROUTE_COLLAPSE_OPTIMIZATION</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If true, Pilot will merge virtual hosts with the same routes into a single virtual host, as an optimization.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_SENDING_HBONE</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, HBONE will be allowed when sending to destinations.</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_SIDECAR_LISTENING_HBONE</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, HBONE support can be configured for proxies.</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_TELEMETRY_LABEL</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If true, pilot will add telemetry related metadata to cluster and endpoint resources, which will be consumed by telemetry filter.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_WORKLOAD_ENTRY_AUTOREGISTRATION</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</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>true</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_ENVOY_FILTER_STATS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If true, Pilot will collect metrics for envoy filter operations.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_FILTER_GATEWAY_CLUSTER_CONFIG</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, Pilot will send only clusters that referenced in gateway virtual services attached to gateway</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_GATEWAY_API_CONTROLLER_NAME</code></td>
|
|
<td>String</td>
|
|
<td><code>istio.io/gateway-controller</code></td>
|
|
<td>Gateway API controller name. istiod will only reconcile Gateway API resources referencing a GatewayClass with this controller name</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_GATEWAY_API_DEFAULT_GATEWAYCLASS_NAME</code></td>
|
|
<td>String</td>
|
|
<td><code>istio</code></td>
|
|
<td>Name of the default GatewayClass</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_INSECURE_MULTICLUSTER_KUBECONFIG_OPTIONS</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>Comma separated list of potentially insecure kubeconfig authentication options that are allowed for multicluster authentication.Support values: all authProviders (`gcp`, `azure`, `exec`, `openstack`), `clientKey`, `clientCertificate`, `tokenFile`, and `exec`.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_JWT_ENABLE_REMOTE_JWKS</code></td>
|
|
<td>String</td>
|
|
<td><code>false</code></td>
|
|
<td>Mode of fetching JWKs from JwksUri in RequestAuthentication. Supported value: istiod, false, hybrid, true, envoy. The client fetching JWKs is as following: istiod/false - Istiod; hybrid/true - Envoy and fallback to Istiod if JWKs server is external; envoy - Envoy.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_JWT_PUB_KEY_REFRESH_INTERVAL</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>20m0s</code></td>
|
|
<td>The interval for istiod to fetch the jwks_uri for the jwks public key.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_MAX_REQUESTS_PER_SECOND</code></td>
|
|
<td>Floating-Point</td>
|
|
<td><code>0</code></td>
|
|
<td>Limits the number of incoming XDS requests per second. On larger machines this can be increased to handle more proxies concurrently. If set to 0 or unset, the max will be automatically determined based on the machine size</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_MULTI_NETWORK_DISCOVER_GATEWAY_API</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If true, Pilot will discover labeled Kubernetes gateway objects as multi-network gateways.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_PERSISTENT_SESSION_HEADER_LABEL</code></td>
|
|
<td>String</td>
|
|
<td><code>istio.io/persistent-session-header</code></td>
|
|
<td>If not empty, services with this label will use header based persistent sessions</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_PERSISTENT_SESSION_LABEL</code></td>
|
|
<td>String</td>
|
|
<td><code>istio.io/persistent-session</code></td>
|
|
<td>If not empty, services with this label will use cookie based persistent sessions</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_PREFER_SENDING_HBONE</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, HBONE will be preferred when sending to destinations. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_PUSH_THROTTLE</code></td>
|
|
<td>Integer</td>
|
|
<td><code>0</code></td>
|
|
<td>Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes. If set to 0 or unset, the max will be automatically determined based on the machine size</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_REMOTE_CLUSTER_TIMEOUT</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>30s</code></td>
|
|
<td>After this timeout expires, pilot can become ready without syncing data from clusters added via remote-secrets. Setting the timeout to 0 disables this behavior.</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_SEND_UNHEALTHY_ENDPOINTS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, Pilot will include unhealthy endpoints in EDS pushes and even if they are sent Envoy does not use them for load balancing. To avoid, sending traffic to non ready endpoints, enabling this flag, disables panic threshold in Envoy i.e. Envoy does not load balance requests to unhealthy/non-ready hosts even if the percentage of healthy hosts fall below minimum health percentage(panic threshold).</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 sidecar 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_MAX_WORKERS</code></td>
|
|
<td>Integer</td>
|
|
<td><code>100</code></td>
|
|
<td>The maximum number of workers Pilot will use to keep configuration status up to date. Smaller numbers will result in higher status latency, but larger numbers may impact CPU in high scale environments.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_STATUS_QPS</code></td>
|
|
<td>Integer</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_STATUS_UPDATE_INTERVAL</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>500ms</code></td>
|
|
<td>Interval to update the XDS distribution status.</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_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_INDEX_CLEAR_INTERVAL</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>5s</code></td>
|
|
<td>The interval for xds cache index clearing.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_XDS_CACHE_SIZE</code></td>
|
|
<td>Integer</td>
|
|
<td><code>60000</code></td>
|
|
<td>The maximum number of cache entries for the XDS cache.</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>PLATFORM</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>Platform where Istio is deployed. Possible values are "openshift" and "gcp"</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>RESOLVE_HOSTNAME_GATEWAYS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If true, hostnames in the LoadBalancer addresses of a Service will be resolved at the control plane for use in cross-network gateways.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>REWRITE_PROBE_LEGACY_LOCALHOST_DESTINATION</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, readiness probes will be sent to 'localhost'. Otherwise, they will be sent to the Pod's IP, matching Kubernetes' behavior.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>SHARED_MESH_CONFIG</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>Additional config map to load for shared MeshConfig settings. The standard mesh config will take precedence.</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>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>TRUSTED_GATEWAY_CIDR</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>If set, any connections from gateway to Istiod with this CIDR range are treated as trusted for using authentication mechanisms like XFCC. This can only be used when the network where Istiod and the authenticating gateways are running in a trusted/secure network</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>UNSAFE_ENABLE_ADMIN_ENDPOINTS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If this is set to true, dangerous admin endpoints will be exposed on the debug interface. Not recommended for production.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>UNSAFE_PILOT_ENABLE_DELTA_TEST</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, addition runtime tests for Delta XDS efficiency are added. These checks are extremely expensive, so this should be used only for testing, not production.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>UNSAFE_PILOT_ENABLE_RUNTIME_ASSERTIONS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, addition runtime asserts will be performed. These checks are both expensive and panic on failure. As a result, this should be used only for testing.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>USE_CACERTS_FOR_SELF_SIGNED_CA</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, istiod will use a secret named cacerts to store its self-signed istio-generated root certificate.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>VALIDATION_WEBHOOK_CONFIG_NAME</code></td>
|
|
<td>String</td>
|
|
<td><code>istio-istio-system</code></td>
|
|
<td>If not empty, the controller will automatically patch validatingwebhookconfiguration when the CA certificate changes. Only works in kubernetes environment.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>VERIFY_CERTIFICATE_AT_CLIENT</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, certificates received by the proxy will be verified against the OS CA certificate bundle.</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>
|
|
<tr>
|
|
<td><code>XDS_AUTH_PLAINTEXT</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>authenticate plain text requests - used if Istiod is running on a secure/trusted network</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>auto_registration_deletes_total</code></td><td><code>Sum</code></td><td>Total number of auto registration cleaned up by periodic timer.</td></tr>
|
|
<tr><td><code>auto_registration_errors_total</code></td><td><code>Sum</code></td><td>Total number of auto registration errors.</td></tr>
|
|
<tr><td><code>auto_registration_success_total</code></td><td><code>Sum</code></td><td>Total number of successful auto registrations.</td></tr>
|
|
<tr><td><code>auto_registration_unregister_total</code></td><td><code>Sum</code></td><td>Total number of unregistrations.</td></tr>
|
|
<tr><td><code>auto_registration_updates_total</code></td><td><code>Sum</code></td><td>Total number of auto registration updates.</td></tr>
|
|
<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>controller_sync_errors_total</code></td><td><code>Sum</code></td><td>Total number of errorMetric syncing controllers.</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>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>istiod_managed_clusters</code></td><td><code>LastValue</code></td><td>Number of clusters managed by istiod</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_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>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_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_debounce_time</code></td><td><code>Distribution</code></td><td>Delay in seconds between the first config enters debouncing and the merged push request is pushed into the push queue.</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_dns_cluster_without_endpoints</code></td><td><code>LastValue</code></td><td>DNS clusters without endpoints caused by the endpoint field in STRICT_DNS type cluster is not set or the corresponding subset cannot select any endpoint</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_envoy_filter_status</code></td><td><code>LastValue</code></td><td>Status of Envoy filters whether it was applied or errored.</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_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_cfg_events</code></td><td><code>Sum</code></td><td>Events from k8s config.</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_pushcontext_init_seconds</code></td><td><code>Distribution</code></td><td>Total time in seconds Pilot takes to init pushContext.</td></tr>
|
|
<tr><td><code>pilot_sds_certificate_errors_total</code></td><td><code>Sum</code></td><td>Total number of failures to fetch SDS key and certificate.</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_worker_queue_depth</code></td><td><code>LastValue</code></td><td>Depth of the controller queues</td></tr>
|
|
<tr><td><code>pilot_worker_queue_duration</code></td><td><code>Distribution</code></td><td>Time taken to process an item</td></tr>
|
|
<tr><td><code>pilot_worker_queue_latency</code></td><td><code>Distribution</code></td><td>Latency before the item is processed</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_config_size_bytes</code></td><td><code>Distribution</code></td><td>Distribution of configuration sizes pushed to clients</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>provider_lookup_cluster_failures</code></td><td><code>Sum</code></td><td>Number of times a cluster lookup failed</td></tr>
|
|
<tr><td><code>reconcile_request_total</code></td><td><code>Sum</code></td><td>Number of times requesting Reconcile</td></tr>
|
|
<tr><td><code>remote_cluster_sync_timeouts_total</code></td><td><code>Sum</code></td><td>Number of times remote clusters took too long to sync, causing slow startup that excludes remote clusters.</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>sidecar_injection_time_seconds</code></td><td><code>Distribution</code></td><td>Total time taken for injection in seconds.</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>wasm_cache_entries</code></td><td><code>LastValue</code></td><td>number of Wasm remote fetch cache entries.</td></tr>
|
|
<tr><td><code>wasm_cache_lookup_count</code></td><td><code>Sum</code></td><td>number of Wasm remote fetch cache lookups.</td></tr>
|
|
<tr><td><code>wasm_config_conversion_count</code></td><td><code>Sum</code></td><td>number of Wasm config conversion count and results, including success, no remote load, marshal failure, remote fetch failure, miss remote fetch hint.</td></tr>
|
|
<tr><td><code>wasm_config_conversion_duration</code></td><td><code>Distribution</code></td><td>Total time in milliseconds istio-agent spends on converting remote load in Wasm config.</td></tr>
|
|
<tr><td><code>wasm_remote_fetch_count</code></td><td><code>Sum</code></td><td>number of Wasm remote fetches and results, including success, download failure, and checksum mismatch.</td></tr>
|
|
<tr><td><code>webhook_patch_attempts_total</code></td><td><code>Sum</code></td><td>Webhook patching attempts</td></tr>
|
|
<tr><td><code>webhook_patch_failures_total</code></td><td><code>Sum</code></td><td>Webhook patching total failures</td></tr>
|
|
<tr><td><code>webhook_patch_retries_total</code></td><td><code>Sum</code></td><td>Webhook patching retries</td></tr>
|
|
<tr><td><code>xds_cache_dependent_config_size</code></td><td><code>LastValue</code></td><td>Current size of dependent configs</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>
|