mirror of https://github.com/istio/istio.io.git
5064 lines
206 KiB
HTML
5064 lines
206 KiB
HTML
---
|
|
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/istio/istio' REPO
|
|
source_repo: https://github.com/istio/istio
|
|
title: istioctl
|
|
description: Istio control interface.
|
|
generator: pkg-collateral-docs
|
|
number_of_entries: 76
|
|
max_toc_level: 2
|
|
remove_toc_prefix: 'istioctl '
|
|
---
|
|
<p>Istio configuration command line utility for service operators to
|
|
debug and diagnose their Istio mesh.
|
|
</p>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-analyze">istioctl analyze</h2>
|
|
<p>Analyze Istio configuration and print validation messages</p>
|
|
<pre class="language-bash"><code>istioctl analyze <file>... [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--all-namespaces</code></td>
|
|
<td><code>-A</code></td>
|
|
<td>Analyze all namespaces </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--color</code></td>
|
|
<td></td>
|
|
<td>Default true. Disable with '=false' or set $TERM to dumb </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--failure-threshold <Level></code></td>
|
|
<td></td>
|
|
<td>The severity level of analysis at which to set a non-zero exit code. Valid values: [Info Warn Error] (default `Warn`)</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>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--meshConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>Overrides the mesh config values to use for analysis. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of [log json yaml] (default `log`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output-threshold <Level></code></td>
|
|
<td></td>
|
|
<td>The severity level of analysis at which to display messages. Valid values: [Info Warn Error] (default `Info`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--recursive</code></td>
|
|
<td><code>-R</code></td>
|
|
<td>Process directory arguments recursively. Useful when you want to analyze related manifests organized within the same directory. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--suppress <stringArray></code></td>
|
|
<td><code>-S</code></td>
|
|
<td>Suppress reporting a message code on a specific resource. Values are supplied in the form <code>=<resource> (e.g. '--suppress "IST0102=DestinationRule primary-dr.default"'). Can be repeated. You can include the wildcard character '*' to support a partial match (e.g. '--suppress "IST0102=DestinationRule *.default" ). (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--timeout <duration></code></td>
|
|
<td></td>
|
|
<td>the duration to wait before failing (default `30s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--use-kube</code></td>
|
|
<td><code>-k</code></td>
|
|
<td>Use live Kubernetes cluster for analysis. Set --use-kube=false to analyze files only. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--verbose</code></td>
|
|
<td><code>-v</code></td>
|
|
<td>Enable verbose output </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-analyze Examples">Examples</h3>
|
|
<pre class="language-bash"><code>
|
|
# Analyze the current live cluster
|
|
istioctl analyze
|
|
|
|
# Analyze the current live cluster, simulating the effect of applying additional yaml files
|
|
istioctl analyze a.yaml b.yaml my-app-config/
|
|
|
|
# Analyze the current live cluster, simulating the effect of applying a directory of config recursively
|
|
istioctl analyze --recursive my-istio-config/
|
|
|
|
# Analyze yaml files without connecting to a live cluster
|
|
istioctl analyze --use-kube=false a.yaml b.yaml my-app-config/
|
|
|
|
# Analyze the current live cluster and suppress PodMissingProxy for pod mypod in namespace 'testing'.
|
|
istioctl analyze -S "IST0103=Pod mypod.testing"
|
|
|
|
# Analyze the current live cluster and suppress PodMissingProxy for all pods in namespace 'testing',
|
|
# and suppress MisplacedAnnotation on deployment foobar in namespace default.
|
|
istioctl analyze -S "IST0103=Pod *.testing" -S "IST0107=Deployment foobar.default"
|
|
|
|
# List available analyzers
|
|
istioctl analyze -L
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-authn">istioctl authn</h2>
|
|
<p>
|
|
A group of commands used to interact with Istio authentication policies.
|
|
tls-check
|
|
</p>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-authn Examples">Examples</h3>
|
|
<pre class="language-bash"><code># Check whether TLS setting are matching between authentication policy and destination rules:
|
|
istioctl authn tls-check
|
|
</code></pre>
|
|
<h2 id="istioctl-authn-tls-check">istioctl authn tls-check</h2>
|
|
<p>
|
|
Check what authentication policies and destination rules pilot uses to config a proxy instance,
|
|
and check if TLS settings are compatible between them.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl authn tls-check <pod-name[.namespace]> [<service>] [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-authn-tls-check Examples">Examples</h3>
|
|
<pre class="language-bash"><code>
|
|
# Check settings for pod "foo-656bd7df7c-5zp4s" in namespace default:
|
|
istioctl authn tls-check foo-656bd7df7c-5zp4s.default
|
|
|
|
# Check settings for pod "foo-656bd7df7c-5zp4s" in namespace default, filtered on destination
|
|
service "bar" :
|
|
istioctl authn tls-check foo-656bd7df7c-5zp4s.default bar
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-authz">istioctl authz</h2>
|
|
<p>(authz is experimental. Use `istioctl experimental authz`)</p>
|
|
<pre class="language-bash"><code>istioctl authz [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-convert-ingress">istioctl convert-ingress</h2>
|
|
<p>Converts Ingresses into VirtualService configuration on a best effort basis. The output should be considered a starting point for your Istio configuration and probably require some minor modification. Warnings will be generated where configs cannot be converted perfectly. The input must be a Kubernetes Ingress. The conversion of v1alpha1 Istio rules has been removed from istioctl.</p>
|
|
<pre class="language-bash"><code>istioctl convert-ingress [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filenames <stringSlice></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Input filenames (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>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output filename (default `-`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-convert-ingress Examples">Examples</h3>
|
|
<pre class="language-bash"><code>istioctl convert-ingress -f samples/bookinfo/platform/kube/bookinfo-ingress.yaml
|
|
</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>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-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 <pod-name[.namespace]> [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--selector <string></code></td>
|
|
<td><code>-l</code></td>
|
|
<td>label selector (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-dashboard-controlz Examples">Examples</h3>
|
|
<pre class="language-bash"><code>istioctl dashboard controlz pilot-123-456.istio-system
|
|
</code></pre>
|
|
<h2 id="istioctl-dashboard-envoy">istioctl dashboard envoy</h2>
|
|
<p>Open the Envoy admin dashboard for a sidecar</p>
|
|
<pre class="language-bash"><code>istioctl dashboard envoy <pod-name[.namespace]> [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--selector <string></code></td>
|
|
<td><code>-l</code></td>
|
|
<td>label selector (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-dashboard-envoy Examples">Examples</h3>
|
|
<pre class="language-bash"><code>istioctl dashboard 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>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-dashboard-grafana Examples">Examples</h3>
|
|
<pre class="language-bash"><code>istioctl dashboard grafana
|
|
</code></pre>
|
|
<h2 id="istioctl-dashboard-jaeger">istioctl dashboard jaeger</h2>
|
|
<p>Open Istio's Jaeger dashboard</p>
|
|
<pre class="language-bash"><code>istioctl dashboard jaeger [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-dashboard-jaeger Examples">Examples</h3>
|
|
<pre class="language-bash"><code>istioctl dashboard 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>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-dashboard-kiali Examples">Examples</h3>
|
|
<pre class="language-bash"><code>istioctl dashboard 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>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-dashboard-prometheus Examples">Examples</h3>
|
|
<pre class="language-bash"><code>istioctl dashboard prometheus
|
|
</code></pre>
|
|
<h2 id="istioctl-dashboard-zipkin">istioctl dashboard zipkin</h2>
|
|
<p>Open Istio's Zipkin dashboard</p>
|
|
<pre class="language-bash"><code>istioctl dashboard zipkin [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-dashboard-zipkin Examples">Examples</h3>
|
|
<pre class="language-bash"><code>istioctl dashboard zipkin
|
|
</code></pre>
|
|
<h2 id="istioctl-deregister">istioctl deregister</h2>
|
|
<p>De-registers a service instance</p>
|
|
<pre class="language-bash"><code>istioctl deregister <svcname> <ip> [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-deregister Examples">Examples</h3>
|
|
<pre class="language-bash"><code># de-register an endpoint 172.17.0.2 from service my-svc:
|
|
istioctl deregister my-svc 172.17.0.2
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental">istioctl experimental</h2>
|
|
<p>Experimental commands that may be modified or deprecated</p>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-add-to-mesh">istioctl experimental add-to-mesh</h2>
|
|
<p>Add workloads into Istio service mesh</p>
|
|
<pre class="language-bash"><code>istioctl experimental add-to-mesh [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl experimental add [flags]
|
|
</code></pre></div>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfigMapName <string></code></td>
|
|
<td></td>
|
|
<td>ConfigMap name for Istio sidecar injection, key should be "config". (default `istio-sidecar-injector`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--meshConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--meshConfigMapName <string></code></td>
|
|
<td></td>
|
|
<td>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--valuesFile <string></code></td>
|
|
<td></td>
|
|
<td>injection values configuration filename. (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-add-to-mesh-deployment">istioctl experimental add-to-mesh deployment</h2>
|
|
<p>istioctl experimental add-to-mesh deployment restarts pods with the Istio sidecar. Use 'add-to-mesh'
|
|
to test deployments for compatibility with Istio. If your deployment does not function after
|
|
using 'add-to-mesh' you must re-deploy it and troubleshoot it for Istio compatibility.
|
|
See https://istio.io/docs/setup/kubernetes/additional-setup/requirements/
|
|
THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl experimental add-to-mesh deployment [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfigMapName <string></code></td>
|
|
<td></td>
|
|
<td>ConfigMap name for Istio sidecar injection, key should be "config". (default `istio-sidecar-injector`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--meshConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--meshConfigMapName <string></code></td>
|
|
<td></td>
|
|
<td>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--valuesFile <string></code></td>
|
|
<td></td>
|
|
<td>injection values configuration filename. (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-add-to-mesh-deployment Examples">Examples</h3>
|
|
<pre class="language-bash"><code>istioctl experimental add-to-mesh deployment productpage-v1
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-add-to-mesh-external-service">istioctl experimental add-to-mesh external-service</h2>
|
|
<p>istioctl experimental add-to-mesh external-service create a ServiceEntry and\
|
|
a Service without selector for the specified external service in Istio service mesh.
|
|
The typical usage scenario is Mesh Expansion on VMs.
|
|
THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl experimental add-to-mesh external-service <svcname> <ip>... [name1:]port1 [name2:]port2 ... [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--annotations <stringSlice></code></td>
|
|
<td><code>-a</code></td>
|
|
<td>List of string annotations to apply if creating a service/endpoint; e.g. -a foo=bar,x=y (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfigMapName <string></code></td>
|
|
<td></td>
|
|
<td>ConfigMap name for Istio sidecar injection, key should be "config". (default `istio-sidecar-injector`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--labels <stringSlice></code></td>
|
|
<td><code>-l</code></td>
|
|
<td>List of labels to apply if creating a service/endpoint; e.g. -l env=prod,vers=2 (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--meshConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--meshConfigMapName <string></code></td>
|
|
<td></td>
|
|
<td>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--serviceaccount <string></code></td>
|
|
<td><code>-s</code></td>
|
|
<td>Service account to link to the service (default `default`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--valuesFile <string></code></td>
|
|
<td></td>
|
|
<td>injection values configuration filename. (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-add-to-mesh-external-service Examples">Examples</h3>
|
|
<pre class="language-bash"><code>istioctl experimental add-to-mesh external-service vmhttp 172.12.23.125,172.12.23.126\
|
|
http:9080 tcp:8888 -l app=test,version=v1 -a env=stage -s stageAdmin
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-add-to-mesh-service">istioctl experimental add-to-mesh service</h2>
|
|
<p>istioctl experimental add-to-mesh service restarts pods with the Istio sidecar. Use 'add-to-mesh'
|
|
to test deployments for compatibility with Istio. If your service does not function after
|
|
using 'add-to-mesh' you must re-deploy it and troubleshoot it for Istio compatibility.
|
|
See https://istio.io/docs/setup/kubernetes/additional-setup/requirements/
|
|
THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl experimental add-to-mesh service [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfigMapName <string></code></td>
|
|
<td></td>
|
|
<td>ConfigMap name for Istio sidecar injection, key should be "config". (default `istio-sidecar-injector`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--meshConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--meshConfigMapName <string></code></td>
|
|
<td></td>
|
|
<td>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--valuesFile <string></code></td>
|
|
<td></td>
|
|
<td>injection values configuration filename. (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-add-to-mesh-service Examples">Examples</h3>
|
|
<pre class="language-bash"><code>istioctl experimental add-to-mesh service productpage
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-analyze">istioctl experimental analyze</h2>
|
|
<p>Analyze Istio configuration and print validation messages (analyze has graduated. Use `istioctl analyze`)</p>
|
|
<pre class="language-bash"><code>istioctl experimental analyze <file>... [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--all-namespaces</code></td>
|
|
<td><code>-A</code></td>
|
|
<td>Analyze all namespaces </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--color</code></td>
|
|
<td></td>
|
|
<td>Default true. Disable with '=false' or set $TERM to dumb </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--failure-threshold <Level></code></td>
|
|
<td></td>
|
|
<td>The severity level of analysis at which to set a non-zero exit code. Valid values: [Info Warn Error] (default `Warn`)</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>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--meshConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>Overrides the mesh config values to use for analysis. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of [log json yaml] (default `log`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output-threshold <Level></code></td>
|
|
<td></td>
|
|
<td>The severity level of analysis at which to display messages. Valid values: [Info Warn Error] (default `Info`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--recursive</code></td>
|
|
<td><code>-R</code></td>
|
|
<td>Process directory arguments recursively. Useful when you want to analyze related manifests organized within the same directory. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--suppress <stringArray></code></td>
|
|
<td><code>-S</code></td>
|
|
<td>Suppress reporting a message code on a specific resource. Values are supplied in the form <code>=<resource> (e.g. '--suppress "IST0102=DestinationRule primary-dr.default"'). Can be repeated. You can include the wildcard character '*' to support a partial match (e.g. '--suppress "IST0102=DestinationRule *.default" ). (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--timeout <duration></code></td>
|
|
<td></td>
|
|
<td>the duration to wait before failing (default `30s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--use-kube</code></td>
|
|
<td><code>-k</code></td>
|
|
<td>Use live Kubernetes cluster for analysis. Set --use-kube=false to analyze files only. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--verbose</code></td>
|
|
<td><code>-v</code></td>
|
|
<td>Enable verbose output </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-analyze Examples">Examples</h3>
|
|
<pre class="language-bash"><code>
|
|
# Analyze the current live cluster
|
|
istioctl analyze
|
|
|
|
# Analyze the current live cluster, simulating the effect of applying additional yaml files
|
|
istioctl analyze a.yaml b.yaml my-app-config/
|
|
|
|
# Analyze the current live cluster, simulating the effect of applying a directory of config recursively
|
|
istioctl analyze --recursive my-istio-config/
|
|
|
|
# Analyze yaml files without connecting to a live cluster
|
|
istioctl analyze --use-kube=false a.yaml b.yaml my-app-config/
|
|
|
|
# Analyze the current live cluster and suppress PodMissingProxy for pod mypod in namespace 'testing'.
|
|
istioctl analyze -S "IST0103=Pod mypod.testing"
|
|
|
|
# Analyze the current live cluster and suppress PodMissingProxy for all pods in namespace 'testing',
|
|
# and suppress MisplacedAnnotation on deployment foobar in namespace default.
|
|
istioctl analyze -S "IST0103=Pod *.testing" -S "IST0107=Deployment foobar.default"
|
|
|
|
# List available analyzers
|
|
istioctl analyze -L
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-authz">istioctl experimental authz</h2>
|
|
<p>Commands to inspect and interact with the authorization policies
|
|
check - check Envoy config dump for authorization configuration
|
|
convert - convert v1alpha1 RBAC policies to v1beta1 authorization policies
|
|
</p>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-authz Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Check Envoy authorization configuration for pod httpbin-88ddbcfdd-nt5jb:
|
|
istioctl x authz check httpbin-88ddbcfdd-nt5jb
|
|
|
|
# Convert the v1alpha1 RBAC policies in the current cluster:
|
|
istioctl x authz convert > authorization-policies.yaml
|
|
|
|
# Convert the v1alpha1 RBAC policies in the file with the given services and root namespace:
|
|
istioctl x authz convert -f rbac-policies.yaml -s my-service.yaml -r istio-system > authorization-policies.yaml
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-authz-check">istioctl experimental authz check</h2>
|
|
<p>Check reads the Envoy config dump and checks the filter configuration
|
|
related to authorization. For example, it shows whether or not the Envoy is configured
|
|
with authorization and the rules used in the authorization.</p>
|
|
<p>The Envoy config dump could be provided either by pod name or from a config dump file
|
|
(the whole output of http://localhost:15000/config_dump of an Envoy instance).</p>
|
|
<p>THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl experimental authz check <pod-name>[.<pod-namespace>] [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--all</code></td>
|
|
<td><code>-a</code></td>
|
|
<td>Show additional information (e.g. SNI and ALPN) </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>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>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-authz-check Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Check Envoy authorization configuration for pod httpbin-88ddbcfdd-nt5jb:
|
|
istioctl x authz check httpbin-88ddbcfdd-nt5jb
|
|
|
|
# Check Envoy authorization configuration from a config dump file:
|
|
istioctl x authz check -f httpbin_config_dump.json
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-authz-convert">istioctl experimental authz convert</h2>
|
|
<p>Convert Istio v1alpha1 RBAC policy to v1beta1 authorization policy. By default,
|
|
The command talks to Istio Pilot and Kubernetes API server to get all the information
|
|
needed for the conversion, including the v1alpha1 RBAC policies in the current cluster,
|
|
the value of the root namespace and the Kubernetes services that provide the mapping from the
|
|
service name to workload selector.</p>
|
|
<p>The tool can also be used in an offline mode when specified with flag -f. In this mode,
|
|
the tool doesn't access the network and all needed information is provided
|
|
through the command line.</p>
|
|
<p>Note: The converter tool makes a best effort attempt to keep the syntax unchanged during
|
|
the conversion. However, in some cases, strict mapping with equivalent syntax is not
|
|
possible (e.g., constraints no longer supported in the new workload oriented model).</p>
|
|
<p>PLEASE ALWAYS REVIEW THE CONVERTED POLICIES BEFORE APPLYING.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl experimental authz convert [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--allowNoClusterRbacConfig</code></td>
|
|
<td></td>
|
|
<td>Continue the conversion even if there is no ClusterRbacConfig in the cluster </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <stringSlice></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>The yaml file with v1alpha1 RBAC policies to be converted (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>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--rootNamespace <string></code></td>
|
|
<td><code>-r</code></td>
|
|
<td>Override the root namespace used in the conversion (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--service <stringSlice></code></td>
|
|
<td><code>-s</code></td>
|
|
<td>The yaml file with Kubernetes services for the mapping from the service name to workload selector, used with -f (default `[]`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-authz-convert Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Convert the v1alpha1 RBAC policy in the current cluster:
|
|
istioctl x authz convert > authorization-policies.yaml
|
|
|
|
# Convert the v1alpha1 RBAC policy in the given file:
|
|
istioctl x authz convert -f v1alpha1-policy-1.yaml,v1alpha1-policy-2.yaml
|
|
-s my-services.yaml -r my-root-namespace > authorization-policies.yaml
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-convert-ingress">istioctl experimental convert-ingress</h2>
|
|
<p>(convert-ingress has graduated. Use `istioctl convert-ingress`)</p>
|
|
<pre class="language-bash"><code>istioctl experimental convert-ingress [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-create-remote-secret">istioctl experimental create-remote-secret</h2>
|
|
<p>Create a secret with credentials to allow Istio to access remote Kubernetes apiservers</p>
|
|
<pre class="language-bash"><code>istioctl experimental create-remote-secret <cluster-name> [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--auth-plugin-config <stringToString></code></td>
|
|
<td></td>
|
|
<td>authenticator plug-in configuration. --auth-type=plugin must be set with this option (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--auth-plugin-name <string></code></td>
|
|
<td></td>
|
|
<td>authenticator plug-in name. --auth-type=plugin must be set with this option (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--auth-type <RemoteSecretAuthType></code></td>
|
|
<td></td>
|
|
<td>type of authentication to use. supported values = [bearer-token plugin] (default `bearer-token`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--service-account <string></code></td>
|
|
<td></td>
|
|
<td>create a secret with this service account's credentials. (default `istio-reader-service-account`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-create-remote-secret Examples">Examples</h3>
|
|
<pre class="language-bash"><code>
|
|
# Create a secret to access cluster c0's apiserver and install it in cluster c1.
|
|
istioctl --Kubeconfig=c0.yaml x create-remote-secret \
|
|
| kubectl -n istio-system --Kubeconfig=c1.yaml apply -f -
|
|
|
|
# Delete a secret that was previously installed in c1
|
|
istioctl --Kubeconfig=c0.yaml x create-remote-secret \
|
|
| kubectl -n istio-system --Kubeconfig=c1.yaml delete -f -
|
|
|
|
# Create a secret access a remote cluster with an auth plugin
|
|
istioctl --Kubeconfig=c0.yaml x create-remote-secret --auth-type=plugin --auth-plugin-name=gcp \
|
|
| kubectl -n istio-system --Kubeconfig=c1.yaml apply -f -
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-dashboard">istioctl experimental dashboard</h2>
|
|
<p>(dashboard has graduated. Use `istioctl dashboard`)</p>
|
|
<pre class="language-bash"><code>istioctl experimental dashboard [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-describe">istioctl experimental describe</h2>
|
|
<p>Describe resource and related Istio configuration</p>
|
|
<pre class="language-bash"><code>istioctl experimental describe [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl experimental des [flags]
|
|
</code></pre></div>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-describe-pod">istioctl experimental describe pod</h2>
|
|
<p>Analyzes pod, its Services, DestinationRules, and VirtualServices and reports
|
|
the configuration objects that affect that pod.</p>
|
|
<p>THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl experimental describe pod <pod> [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ignoreUnmeshed</code></td>
|
|
<td></td>
|
|
<td>Suppress warnings for unmeshed pods </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-describe-pod Examples">Examples</h3>
|
|
<pre class="language-bash"><code>istioctl experimental describe pod productpage-v1-c7765c886-7zzd4
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-describe-service">istioctl experimental describe service</h2>
|
|
<p>Analyzes service, pods, DestinationRules, and VirtualServices and reports
|
|
the configuration objects that affect that service.</p>
|
|
<p>THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl experimental describe service <svc> [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl experimental describe svc <svc> [flags]
|
|
</code></pre></div>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ignoreUnmeshed</code></td>
|
|
<td></td>
|
|
<td>Suppress warnings for unmeshed pods </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-describe-service Examples">Examples</h3>
|
|
<pre class="language-bash"><code>istioctl experimental describe service productpage
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-kube-uninject">istioctl experimental kube-uninject</h2>
|
|
<p></p>
|
|
<p>kube-uninject is used to prevent Istio from adding a sidecar and
|
|
also provides the inverse of "istioctl kube-inject -f".</p>
|
|
<p></p>
|
|
<pre class="language-bash"><code>istioctl experimental kube-uninject [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Input Kubernetes resource filename (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Modified output Kubernetes resource filename (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-kube-uninject Examples">Examples</h3>
|
|
<pre class="language-bash"><code>
|
|
# Update resources before applying.
|
|
kubectl apply -f <(istioctl experimental kube-uninject -f <resource.yaml>)
|
|
|
|
# Create a persistent version of the deployment by removing Envoy sidecar.
|
|
istioctl experimental kube-uninject -f deployment.yaml -o deployment-uninjected.yaml
|
|
|
|
# Update an existing deployment.
|
|
kubectl get deployment -o yaml | istioctl experimental kube-uninject -f - | kubectl apply -f -
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-metrics">istioctl experimental metrics</h2>
|
|
<p>
|
|
Prints the metrics for the specified service(s) when running in Kubernetes.</p>
|
|
<p>This command finds a Prometheus pod running in the specified istio system
|
|
namespace. It then executes a series of queries per requested workload to
|
|
find the following top-level workload metrics: total requests per second,
|
|
error rate, and request latency at p50, p90, and p99 percentiles. The
|
|
query results are printed to the console, organized by workload name.</p>
|
|
<p>All metrics returned are from server-side reports. This means that latencies
|
|
and error rates are from the perspective of the service itself and not of an
|
|
individual client (or aggregate set of clients). Rates and latencies are
|
|
calculated over a time interval of 1 minute.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl experimental metrics <workload name>...
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl experimental m <workload name>...
|
|
</code></pre></div>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-metrics Examples">Examples</h3>
|
|
<pre class="language-bash"><code>
|
|
# Retrieve workload metrics for productpage-v1 workload
|
|
istioctl experimental metrics productpage-v1
|
|
|
|
# Retrieve workload metrics for various services in the different namespaces
|
|
istioctl experimental metrics productpage-v1.foo reviews-v1.bar ratings-v1.baz
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-multicluster">istioctl experimental multicluster</h2>
|
|
<p>Commands to assist in managing a multi-cluster mesh</p>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-multicluster-apply">istioctl experimental multicluster apply</h2>
|
|
<p>Update clusters in a multi-cluster mesh based on mesh topology</p>
|
|
<pre class="language-bash"><code>istioctl experimental multicluster apply -f <mesh.yaml> [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>filename of the multicluster mesh description (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>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-multicluster-describe">istioctl experimental multicluster describe</h2>
|
|
<p>Describe status of the multi-cluster mesh's control plane' </p>
|
|
<pre class="language-bash"><code>istioctl experimental multicluster describe -f <mesh.yaml> [--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>--all</code></td>
|
|
<td></td>
|
|
<td>describe the status of all clustersByContext in the mesh </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>filename of the multicluster mesh description (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>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-multicluster-generate">istioctl experimental multicluster generate</h2>
|
|
<p>generate a cluster-specific control plane configuration based on the mesh description and runtime state</p>
|
|
<pre class="language-bash"><code>istioctl experimental multicluster generate -f <mesh.yaml> [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>filename of the multicluster mesh description (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--from <string></code></td>
|
|
<td></td>
|
|
<td>optional source configuration to generate multicluster aware configuration from (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>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--wait-for-gateways</code></td>
|
|
<td></td>
|
|
<td>wait for all cluster's istio-ingressgateway IPs to be ready before generating configuration. </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-post-install">istioctl experimental post-install</h2>
|
|
<p>Commands related to post-install</p>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-post-install-webhook">istioctl experimental post-install webhook</h2>
|
|
<p>webhook command to manage webhook configurations</p>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-post-install-webhook-disable">istioctl experimental post-install webhook disable</h2>
|
|
<p>Disable webhook configurations</p>
|
|
<pre class="language-bash"><code>istioctl experimental post-install webhook disable [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injection</code></td>
|
|
<td></td>
|
|
<td>Disable mutating webhook (default true). </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injection-config <string></code></td>
|
|
<td></td>
|
|
<td>The mutating webhook configuration to disable. (default `istio-sidecar-injector`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--validation</code></td>
|
|
<td></td>
|
|
<td>Disable validating webhook (default true). </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--validation-config <string></code></td>
|
|
<td></td>
|
|
<td>The validating webhook configuration to disable. (default `istio-galley`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-post-install-webhook-disable Examples">Examples</h3>
|
|
<pre class="language-bash"><code>
|
|
# Disable all webhooks
|
|
istioctl experimental post-install webhook disable
|
|
|
|
# Disable all webhooks except injection
|
|
istioctl experimental post-install webhook disable --injection=false
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-post-install-webhook-enable">istioctl experimental post-install webhook enable</h2>
|
|
<p>This command is used to enable webhook configurations after installing Istio.
|
|
For previous Istio versions (e.g., 1.2, 1.3, etc), this command is not needed
|
|
because in previous versions webhooks manage their own configurations.</p>
|
|
<pre class="language-bash"><code>istioctl experimental post-install webhook enable [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--ca-bundle-file <string></code></td>
|
|
<td></td>
|
|
<td>PEM encoded CA bundle which will be used to validate the webhook's server certificates. If this is empty, the kube-apisever's root CA is used if it can be confirmed to have signed the webhook's certificates. This condition is sometimes true but is not guaranteed (see https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping) (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injection</code></td>
|
|
<td></td>
|
|
<td>Enable injection webhook (default true). </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injection-path <string></code></td>
|
|
<td></td>
|
|
<td>The file path of the injection webhook configuration. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injection-service <string></code></td>
|
|
<td></td>
|
|
<td>The service name of the injection webhook to manage. (default `istio-pilot`)</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>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--read-cert-timeout <duration></code></td>
|
|
<td></td>
|
|
<td> Max time for waiting the webhook certificate to be readable. (default `1m0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--timeout <duration></code></td>
|
|
<td></td>
|
|
<td> Max time for checking the validating webhook server. If the validating webhook server is not readyin the given time, exit. Otherwise, apply the webhook configuration. (default `1m0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--validation</code></td>
|
|
<td></td>
|
|
<td>Enable validatation webhook (default true). </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--validation-path <string></code></td>
|
|
<td></td>
|
|
<td>The file path of the validation webhook configuration. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--validation-service <string></code></td>
|
|
<td></td>
|
|
<td>The service name of the validation webhook to manage. (default `istio-galley`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--webhook-secret <string></code></td>
|
|
<td></td>
|
|
<td>The name of an existing Kubernetes secret of a webhook. istioctl will verify that the webhook certificate is issued by the CA certificate. (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-post-install-webhook-enable Examples">Examples</h3>
|
|
<pre class="language-bash"><code>
|
|
# Enable the webhook configuration of Galley with the given webhook configuration
|
|
istioctl experimental post-install webhook enable --validation --webhook-secret istio.webhook.galley
|
|
--namespace istio-system --validation-path validatingwebhookconfiguration.yaml
|
|
|
|
# Enable the webhook configuration of Galley with the given webhook configuration and CA certificate
|
|
istioctl experimental post-install webhook enable --validation --webhook-secret istio.webhook.galley
|
|
--namespace istio-system --validation-path validatingwebhookconfiguration.yaml --ca-bundle-file ./k8s-ca-cert.pem
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-post-install-webhook-status">istioctl experimental post-install webhook status</h2>
|
|
<p>Get webhook configurations</p>
|
|
<pre class="language-bash"><code>istioctl experimental post-install webhook 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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injection</code></td>
|
|
<td></td>
|
|
<td>Display the injection webhook configuration. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injection-config <string></code></td>
|
|
<td></td>
|
|
<td>The name of the MutatingWebhookConfiguration to display. (default `istio-sidecar-injector`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--validation</code></td>
|
|
<td></td>
|
|
<td>Display the validating webhook configuration. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--validation-config <string></code></td>
|
|
<td></td>
|
|
<td>The name of the ValidatingWebhookConfiguration to display. (default `istio-galley`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-post-install-webhook-status Examples">Examples</h3>
|
|
<pre class="language-bash"><code>
|
|
# Display the webhook configuration of Galley
|
|
istioctl experimental post-install webhook status --validation --validation-config istio-galley
|
|
# Display the webhook configuration of Galley and Sidecar Injector
|
|
istioctl experimental post-install webhook status --validation --validation-config istio-galley
|
|
--injection --injection-config istio-sidecar-injector
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-remove-from-mesh">istioctl experimental remove-from-mesh</h2>
|
|
<p>Remove workloads from Istio service mesh</p>
|
|
<pre class="language-bash"><code>istioctl experimental remove-from-mesh [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl experimental rm [flags]
|
|
</code></pre></div>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-remove-from-mesh-deployment">istioctl experimental remove-from-mesh deployment</h2>
|
|
<p>istioctl experimental remove-from-mesh deployment restarts pods with the Istio sidecar un-injected.
|
|
THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl experimental remove-from-mesh deployment [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-remove-from-mesh-deployment Examples">Examples</h3>
|
|
<pre class="language-bash"><code>istioctl experimental remove-from-mesh deployment productpage-v1
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-remove-from-mesh-external-service">istioctl experimental remove-from-mesh external-service</h2>
|
|
<p>istioctl experimental remove-from-mesh external-service remove the ServiceEntry and\
|
|
the kubernetes Service for the specified external service(eg:services running on VM) from Istio service mesh.
|
|
The typical usage scenario is Mesh Expansion on VMs.
|
|
THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl experimental remove-from-mesh external-service <svcname> [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-remove-from-mesh-external-service Examples">Examples</h3>
|
|
<pre class="language-bash"><code>istioctl experimental remove-from-mesh external-service vmhttp
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-remove-from-mesh-service">istioctl experimental remove-from-mesh service</h2>
|
|
<p>istioctl experimental remove-from-mesh service restarts pods with the Istio sidecar un-injected.
|
|
THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl experimental remove-from-mesh service [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-remove-from-mesh-service Examples">Examples</h3>
|
|
<pre class="language-bash"><code>istioctl experimental remove-from-mesh service productpage
|
|
</code></pre>
|
|
<h2 id="istioctl-experimental-upgrade">istioctl experimental upgrade</h2>
|
|
<p>The upgrade command checks for upgrade version eligibility and, if eligible, upgrades the Istio control plane components in-place. Warning: traffic may be disrupted during upgrade. Please ensure PodDisruptionBudgets are defined to maintain service continuity.</p>
|
|
<pre class="language-bash"><code>istioctl experimental 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>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <stringSlice></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Path to file containing IstioOperator custom resource (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--force</code></td>
|
|
<td></td>
|
|
<td>Apply the upgrade without eligibility checks </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--logtostderr</code></td>
|
|
<td></td>
|
|
<td>Send logs to stderr. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--skip-confirmation</code></td>
|
|
<td><code>-y</code></td>
|
|
<td>If skip-confirmation is set, skips the prompting confirmation for value changes in this upgrade </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--verbose</code></td>
|
|
<td></td>
|
|
<td>Verbose output. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--versionsURI <string></code></td>
|
|
<td><code>-u</code></td>
|
|
<td>URI for operator versions to Istio versions map (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--wait</code></td>
|
|
<td><code>-w</code></td>
|
|
<td>Wait, if set will wait until all Pods, Services, and minimum number of Pods of a Deployment are in a ready state before the command exits. It will wait for a maximum duration of 10m0s </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-experimental-wait">istioctl experimental wait</h2>
|
|
<p>Waits for the specified condition to be true of an Istio resource.</p>
|
|
<pre class="language-bash"><code>istioctl experimental wait [flags] <type> <name>[.<namespace>]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--for <string></code></td>
|
|
<td></td>
|
|
<td>wait condition, must be 'distribution' or 'delete' (default `distribution`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--resource-version <string></code></td>
|
|
<td></td>
|
|
<td>wait for a specific version of config to become current, rather than using whatever is latest in kubernetes (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--threshold <float32></code></td>
|
|
<td></td>
|
|
<td>the ratio of distribution required for success (default `1`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--timeout <duration></code></td>
|
|
<td></td>
|
|
<td>the duration to wait before failing (default `30s`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-experimental-wait Examples">Examples</h3>
|
|
<pre class="language-bash"><code>
|
|
# Wait until the bookinfo virtual service has been distributed to all proxies in the mesh
|
|
istioctl experimental wait --for=distribution virtualservice bookinfo.default
|
|
|
|
# Wait until 99% of the proxies receive the distribution, timing out after 5 minutes
|
|
istioctl experimental wait --for=distribution --threshold=.99 --timeout=300 virtualservice bookinfo.default
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-kube-inject">istioctl kube-inject</h2>
|
|
<p></p>
|
|
<p>kube-inject manually injects the Envoy sidecar into Kubernetes
|
|
workloads. Unsupported resources are left unmodified so it is safe to
|
|
run kube-inject over a single file that contains multiple Service,
|
|
ConfigMap, Deployment, etc. definitions for a complex application. It's
|
|
best to do this when the resource is initially created.</p>
|
|
<p>k8s.io/docs/concepts/workloads/pods/pod-overview/#pod-templates is
|
|
updated for Job, DaemonSet, ReplicaSet, Pod and Deployment YAML resource
|
|
documents. Support for additional pod-based resource types can be
|
|
added as necessary.</p>
|
|
<p>The Istio project is continually evolving so the Istio sidecar
|
|
configuration may change unannounced. When in doubt re-run istioctl
|
|
kube-inject on deployments to get the most up-to-date changes.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl kube-inject [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Input Kubernetes resource filename (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfigMapName <string></code></td>
|
|
<td></td>
|
|
<td>ConfigMap name for Istio sidecar injection, key should be "config". (default `istio-sidecar-injector`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--meshConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--meshConfigMapName <string></code></td>
|
|
<td></td>
|
|
<td>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Modified output Kubernetes resource filename (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--valuesFile <string></code></td>
|
|
<td></td>
|
|
<td>injection values configuration filename. (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-kube-inject Examples">Examples</h3>
|
|
<pre class="language-bash"><code>
|
|
# Update resources on the fly before applying.
|
|
kubectl apply -f <(istioctl kube-inject -f <resource.yaml>)
|
|
|
|
# Create a persistent version of the deployment with Envoy sidecar
|
|
# injected.
|
|
istioctl kube-inject -f deployment.yaml -o deployment-injected.yaml
|
|
|
|
# Update an existing deployment.
|
|
kubectl get deployment -o yaml | istioctl kube-inject -f - | kubectl apply -f -
|
|
|
|
# Capture cluster configuration for later use with kube-inject
|
|
kubectl -n istio-system get cm istio-sidecar-injector -o jsonpath="{.data.config}" > /tmp/inj-template.tmpl
|
|
kubectl -n istio-system get cm istio -o jsonpath="{.data.mesh}" > /tmp/mesh.yaml
|
|
kubectl -n istio-system get cm istio-sidecar-injector -o jsonpath="{.data.values}" > /tmp/values.json
|
|
# Use kube-inject based on captured configuration
|
|
istioctl kube-inject -f samples/bookinfo/platform/kube/bookinfo.yaml \
|
|
--injectConfigFile /tmp/inj-template.tmpl \
|
|
--meshConfigFile /tmp/mesh.yaml \
|
|
--valuesFile /tmp/values.json
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-manifest">istioctl manifest</h2>
|
|
<p>The manifest subcommand generates, applies, diffs or migrates Istio manifests.</p>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--logtostderr</code></td>
|
|
<td></td>
|
|
<td>Send logs to stderr. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--verbose</code></td>
|
|
<td></td>
|
|
<td>Verbose output. </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-manifest-apply">istioctl manifest apply</h2>
|
|
<p>The apply subcommand generates an Istio install manifest and applies it to a cluster.</p>
|
|
<pre class="language-bash"><code>istioctl manifest 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>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <stringSlice></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Path to file containing IstioOperator custom resource
|
|
This flag can be specified multiple times to overlay multiple files. Multiple files are overlaid in left to right order. (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--force</code></td>
|
|
<td></td>
|
|
<td>Proceed even with validation errors </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--logtostderr</code></td>
|
|
<td></td>
|
|
<td>Send logs to stderr. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--readiness-timeout <duration></code></td>
|
|
<td></td>
|
|
<td>Maximum seconds to wait for all Istio resources to be ready. The --wait flag must be set for this flag to apply (default `5m0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--set <stringArray></code></td>
|
|
<td><code>-s</code></td>
|
|
<td>Override an IstioOperator value, e.g. to choose a profile
|
|
(--set profile=demo), enable or disable components (--set components.policy.enabled=true), or override Istio
|
|
settings (--set values.global.mtls.enabled=true). See documentation for more info:
|
|
https://istio.io/docs/reference/config/istio.operator.v1alpha12.pb/#IstioControlPlaneSpec (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--skip-confirmation</code></td>
|
|
<td><code>-y</code></td>
|
|
<td>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></td>
|
|
<td>Verbose output. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--wait</code></td>
|
|
<td><code>-w</code></td>
|
|
<td>Wait, if set will wait until all Pods, Services, and minimum number of Pods of a Deployment are in a ready state before the command exits. It will wait for a maximum duration of --readiness-timeout seconds </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-manifest-apply Examples">Examples</h3>
|
|
<pre class="language-bash"><code>istioctl manifest apply # installs the default profile on the current Kubernetes cluster context
|
|
istioctl manifest apply --set values.global.mtls.enabled=true --set values.global.controlPlaneSecurityEnabled=true
|
|
istioctl manifest apply --set profile=demo
|
|
istioctl manifest apply --set installPackagePath=~/istio-releases/istio-1.4.3/install/kubernetes/operator/charts
|
|
</code></pre>
|
|
<h2 id="istioctl-manifest-diff">istioctl manifest diff</h2>
|
|
<p>The diff subcommand compares manifests from two files or directories.</p>
|
|
<pre class="language-bash"><code>istioctl manifest diff <file|dir> <file|dir> [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--directory</code></td>
|
|
<td><code>-r</code></td>
|
|
<td>compare directory </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ignore <string></code></td>
|
|
<td></td>
|
|
<td>ignoreResources ignores all listed items during comparison. It uses the same list format as selectResources (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--logtostderr</code></td>
|
|
<td></td>
|
|
<td>Send logs to stderr. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--rename <string></code></td>
|
|
<td></td>
|
|
<td>renameResources identifies renamed resources before comparison.
|
|
The format of each renaming pair is A->B, all renaming pairs are comma separated.
|
|
e.g. Service:*:istio-pilot->Service:*:istio-control - rename istio-pilot service into istio-control (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--select <string></code></td>
|
|
<td></td>
|
|
<td>selectResources constrains the list of resources to compare to only the ones in this list, ignoring all others.
|
|
The format of each list item is "::" and the items are comma separated. The "*" character represents wildcard selection.
|
|
e.g.
|
|
Deployment:istio-system:* - compare all deployments in istio-system namespace
|
|
Service:*:istio-pilot - compare Services called "istio-pilot" in all namespaces (default `::`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--verbose</code></td>
|
|
<td></td>
|
|
<td>Verbose output. </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-manifest-generate">istioctl manifest generate</h2>
|
|
<p>The generate subcommand generates an Istio install manifest and outputs to the console by default.</p>
|
|
<pre class="language-bash"><code>istioctl manifest generate [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <stringSlice></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Path to file containing IstioOperator custom resource
|
|
This flag can be specified multiple times to overlay multiple files. Multiple files are overlaid in left to right order. (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--force</code></td>
|
|
<td></td>
|
|
<td>Proceed even with validation errors </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--logtostderr</code></td>
|
|
<td></td>
|
|
<td>Send logs to stderr. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Manifest output directory path (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--set <stringArray></code></td>
|
|
<td><code>-s</code></td>
|
|
<td>Override an IstioOperator value, e.g. to choose a profile
|
|
(--set profile=demo), enable or disable components (--set components.policy.enabled=true), or override Istio
|
|
settings (--set values.global.mtls.enabled=true). See documentation for more info:
|
|
https://istio.io/docs/reference/config/istio.operator.v1alpha12.pb/#IstioControlPlaneSpec (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--verbose</code></td>
|
|
<td></td>
|
|
<td>Verbose output. </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-manifest-migrate">istioctl manifest migrate</h2>
|
|
<p>The migrate subcommand migrates a configuration from Helm values or IstioControlPlane format to IstioOperator format.</p>
|
|
<pre class="language-bash"><code>istioctl manifest migrate [<filepath>] [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--logtostderr</code></td>
|
|
<td></td>
|
|
<td>Send logs to stderr. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--verbose</code></td>
|
|
<td></td>
|
|
<td>Verbose output. </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-manifest-versions">istioctl manifest versions</h2>
|
|
<p>List the versions of Istio recommended for use or supported for upgrade by this version of the operator binary.</p>
|
|
<pre class="language-bash"><code>istioctl manifest versions [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--logtostderr</code></td>
|
|
<td></td>
|
|
<td>Send logs to stderr. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--verbose</code></td>
|
|
<td></td>
|
|
<td>Verbose output. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--versionsURI <string></code></td>
|
|
<td><code>-u</code></td>
|
|
<td>URI for operator versions to Istio versions map (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-operator">istioctl operator</h2>
|
|
<p>The operator subcommand installs, removes and shows the status of the operator controller.</p>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-operator-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>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Path to file containing IstioOperator custom resource
|
|
This flag can be specified multiple times to overlay multiple files. Multiple files are overlaid in left to right order. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--hub <string></code></td>
|
|
<td></td>
|
|
<td>The hub for the operator controller image (default `unknown`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--logtostderr</code></td>
|
|
<td></td>
|
|
<td>Send logs to stderr. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--operatorNamespace <string></code></td>
|
|
<td></td>
|
|
<td>The namespace the operator controller is installed into (default `istio-operator`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--readiness-timeout <duration></code></td>
|
|
<td></td>
|
|
<td>Maximum seconds to wait for the Istio operator to be ready. The --wait flag must be set for this flag to apply (default `5m0s`)</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>--verbose</code></td>
|
|
<td></td>
|
|
<td>Verbose output. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--wait</code></td>
|
|
<td><code>-w</code></td>
|
|
<td>Wait, if set will wait until all Pods, Services, and minimum number of Pods of a Deployment are in a ready state before the command exits. It will wait for a maximum duration of --readiness-timeout seconds </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-operator-remove">istioctl operator remove</h2>
|
|
<p>The remove subcommand removes the Istio operator controller from the cluster.</p>
|
|
<pre class="language-bash"><code>istioctl operator remove [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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>--force</code></td>
|
|
<td></td>
|
|
<td>Proceed even with errors </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>--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>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--logtostderr</code></td>
|
|
<td></td>
|
|
<td>Send logs to stderr. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--operatorNamespace <string></code></td>
|
|
<td></td>
|
|
<td>The namespace the operator controller is installed into (default `istio-operator`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--readiness-timeout <duration></code></td>
|
|
<td></td>
|
|
<td>Maximum seconds to wait for the Istio operator to be ready. The --wait flag must be set for this flag to apply (default `5m0s`)</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>--verbose</code></td>
|
|
<td></td>
|
|
<td>Verbose output. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--wait</code></td>
|
|
<td><code>-w</code></td>
|
|
<td>Wait, if set will wait until all Pods, Services, and minimum number of Pods of a Deployment are in a ready state before the command exits. It will wait for a maximum duration of --readiness-timeout seconds </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-profile">istioctl profile</h2>
|
|
<p>The profile subcommand lists, dumps or diffs Istio configuration profiles.</p>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--logtostderr</code></td>
|
|
<td></td>
|
|
<td>Send logs to stderr. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--verbose</code></td>
|
|
<td></td>
|
|
<td>Verbose output. </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-profile Examples">Examples</h3>
|
|
<pre class="language-bash"><code>istioctl profile list
|
|
istioctl manifest apply --set profile=demo # Use a profile from the list
|
|
</code></pre>
|
|
<h2 id="istioctl-profile-diff">istioctl profile diff</h2>
|
|
<p>The diff subcommand displays the differences between two Istio configuration profiles.</p>
|
|
<pre class="language-bash"><code>istioctl profile diff <file1.yaml> <file2.yaml> [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--logtostderr</code></td>
|
|
<td></td>
|
|
<td>Send logs to stderr. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--verbose</code></td>
|
|
<td></td>
|
|
<td>Verbose output. </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<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>--config-path <string></code></td>
|
|
<td><code>-p</code></td>
|
|
<td>The path the root of the configuration subtree to dump e.g. trafficManagement.components.pilot. By default, dump whole tree (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <stringSlice></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Path to file containing IstioOperator custom resource
|
|
This flag can be specified multiple times to overlay multiple files. Multiple files are overlaid in left to right order. (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--helm-values</code></td>
|
|
<td></td>
|
|
<td>If set, dumps the Helm values that IstioControlPlaceSpec is translated to before manifests are rendered </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>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--logtostderr</code></td>
|
|
<td></td>
|
|
<td>Send logs to stderr. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--verbose</code></td>
|
|
<td></td>
|
|
<td>Verbose output. </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>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--logtostderr</code></td>
|
|
<td></td>
|
|
<td>Send logs to stderr. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--verbose</code></td>
|
|
<td></td>
|
|
<td>Verbose output. </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-proxy-config">istioctl proxy-config</h2>
|
|
<p>A group of commands used to retrieve information about proxy configuration from the Envoy config dump</p>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|short (default `short`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-config Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve information about proxy configuration from an Envoy instance.
|
|
istioctl proxy-config <clusters|listeners|routes|endpoints|bootstrap> <pod-name[.namespace]>
|
|
</code></pre>
|
|
<h2 id="istioctl-proxy-config-bootstrap">istioctl proxy-config bootstrap</h2>
|
|
<p>Retrieve information about bootstrap configuration for the Envoy instance in the specified pod.</p>
|
|
<pre class="language-bash"><code>istioctl proxy-config bootstrap [<pod-name[.namespace]>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl proxy-config b [<pod-name[.namespace]>] [flags]
|
|
</code></pre></div>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Envoy config dump JSON file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|short (default `short`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-config-bootstrap Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve full bootstrap configuration for a given pod from Envoy.
|
|
istioctl proxy-config bootstrap <pod-name[.namespace]>
|
|
|
|
# Retrieve full bootstrap without using Kubernetes API
|
|
ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
|
|
istioctl proxy-config bootstrap --file envoy-config.json
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-proxy-config-cluster">istioctl proxy-config cluster</h2>
|
|
<p>Retrieve information about cluster configuration for the Envoy instance in the specified pod.</p>
|
|
<pre class="language-bash"><code>istioctl proxy-config cluster [<pod-name[.namespace]>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl proxy-config clusters [<pod-name[.namespace]>] [flags]
|
|
istioctl proxy-config c [<pod-name[.namespace]>] [flags]
|
|
</code></pre></div>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--direction <string></code></td>
|
|
<td></td>
|
|
<td>Filter clusters by Direction field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Envoy config dump JSON file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--fqdn <string></code></td>
|
|
<td></td>
|
|
<td>Filter clusters by substring of Service FQDN field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--port <int></code></td>
|
|
<td></td>
|
|
<td>Filter clusters by Port field (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--subset <string></code></td>
|
|
<td></td>
|
|
<td>Filter clusters by substring of Subset field (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-config-cluster Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve summary about cluster configuration for a given pod from Envoy.
|
|
istioctl proxy-config clusters <pod-name[.namespace]>
|
|
|
|
# Retrieve cluster summary for clusters with port 9080.
|
|
istioctl proxy-config clusters <pod-name[.namespace]> --port 9080
|
|
|
|
# Retrieve full cluster dump for clusters that are inbound with a FQDN of details.default.svc.cluster.local.
|
|
istioctl proxy-config clusters <pod-name[.namespace]> --fqdn details.default.svc.cluster.local --direction inbound -o json
|
|
|
|
# Retrieve cluster summary without using Kubernetes API
|
|
ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
|
|
istioctl proxy-config clusters --file envoy-config.json
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-proxy-config-endpoint">istioctl proxy-config endpoint</h2>
|
|
<p>Retrieve information about endpoint configuration for the Envoy instance in the specified pod.</p>
|
|
<pre class="language-bash"><code>istioctl proxy-config endpoint [<pod-name[.namespace]>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl proxy-config endpoints [<pod-name[.namespace]>] [flags]
|
|
istioctl proxy-config ep [<pod-name[.namespace]>] [flags]
|
|
</code></pre></div>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--address <string></code></td>
|
|
<td></td>
|
|
<td>Filter endpoints by address field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--cluster <string></code></td>
|
|
<td></td>
|
|
<td>Filter endpoints by cluster name field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Envoy config dump JSON file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--port <int></code></td>
|
|
<td></td>
|
|
<td>Filter endpoints by Port field (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--status <string></code></td>
|
|
<td></td>
|
|
<td>Filter endpoints by status field (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-config-endpoint Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve full endpoint configuration for a given pod from Envoy.
|
|
istioctl proxy-config endpoint <pod-name[.namespace]>
|
|
|
|
# Retrieve endpoint summary for endpoint with port 9080.
|
|
istioctl proxy-config endpoint <pod-name[.namespace]> --port 9080
|
|
|
|
# Retrieve full endpoint with a address (172.17.0.2).
|
|
istioctl proxy-config endpoint <pod-name[.namespace]> --address 172.17.0.2 -o json
|
|
|
|
# Retrieve full endpoint with a cluster name (outbound|9411||zipkin.istio-system.svc.cluster.local).
|
|
istioctl proxy-config endpoint <pod-name[.namespace]> --cluster "outbound|9411||zipkin.istio-system.svc.cluster.local" -o json
|
|
# Retrieve full endpoint with the status (healthy).
|
|
istioctl proxy-config endpoint <pod-name[.namespace]> --status healthy -ojson
|
|
|
|
# Retrieve endpoint summary without using Kubernetes API
|
|
ssh <user@hostname> 'curl localhost:15000/clusters?format=json' > envoy-clusters.json
|
|
istioctl proxy-config endpoints --file envoy-clusters.json
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-proxy-config-listener">istioctl proxy-config listener</h2>
|
|
<p>Retrieve information about listener configuration for the Envoy instance in the specified pod.</p>
|
|
<pre class="language-bash"><code>istioctl proxy-config listener [<pod-name[.namespace]>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl proxy-config listeners [<pod-name[.namespace]>] [flags]
|
|
istioctl proxy-config l [<pod-name[.namespace]>] [flags]
|
|
</code></pre></div>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--address <string></code></td>
|
|
<td></td>
|
|
<td>Filter listeners by address field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Envoy config dump JSON file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--port <int></code></td>
|
|
<td></td>
|
|
<td>Filter listeners by Port field (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--type <string></code></td>
|
|
<td></td>
|
|
<td>Filter listeners by type field (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-config-listener Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve summary about listener configuration for a given pod from Envoy.
|
|
istioctl proxy-config listeners <pod-name[.namespace]>
|
|
|
|
# Retrieve listener summary for listeners with port 9080.
|
|
istioctl proxy-config listeners <pod-name[.namespace]> --port 9080
|
|
|
|
# Retrieve full listener dump for HTTP listeners with a wildcard address (0.0.0.0).
|
|
istioctl proxy-config listeners <pod-name[.namespace]> --type HTTP --address 0.0.0.0 -o json
|
|
|
|
# Retrieve listener summary without using Kubernetes API
|
|
ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
|
|
istioctl proxy-config listeners --file envoy-config.json
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-proxy-config-log">istioctl proxy-config log</h2>
|
|
<p>(experimental) Retrieve information about logging levels of the Envoy instance in the specified pod, and update optionally</p>
|
|
<pre class="language-bash"><code>istioctl proxy-config log <pod-name[.namespace]> [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl proxy-config o <pod-name[.namespace]> [flags]
|
|
</code></pre></div>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-logger level of messages to output, in the form of [<logger>:]<level>,[<logger>:]<level>,... where logger can be one of admin, aws, assert, backtrace, client, config, connection, conn_handler, dubbo, file, filter, forward_proxy, grpc, hc, health_checker, http, http2, hystrix, init, io, jwt, kafka, lua, main, misc, mongo, quic, pool, rbac, redis, router, runtime, stats, secret, tap, testing, thrift, tracing, upstream, udp, wasm and level can be one of [trace, debug, info, warning, error, critical, off] (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|short (default `short`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--reset</code></td>
|
|
<td><code>-r</code></td>
|
|
<td>Reset levels to default value (warning). </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-config-log Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve information about logging levels for a given pod from Envoy.
|
|
istioctl proxy-config log <pod-name[.namespace]>
|
|
|
|
# Update levels of the all loggers
|
|
istioctl proxy-config log <pod-name[.namespace]> --level none
|
|
|
|
# Update levels of the specified loggers.
|
|
istioctl proxy-config log <pod-name[.namespace]> --level http:debug,redis:debug
|
|
|
|
# Reset levels of all the loggers to default value (warning).
|
|
istioctl proxy-config log <pod-name[.namespace]> -r
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-proxy-config-route">istioctl proxy-config route</h2>
|
|
<p>Retrieve information about route configuration for the Envoy instance in the specified pod.</p>
|
|
<pre class="language-bash"><code>istioctl proxy-config route [<pod-name[.namespace]>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl proxy-config routes [<pod-name[.namespace]>] [flags]
|
|
istioctl proxy-config r [<pod-name[.namespace]>] [flags]
|
|
</code></pre></div>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Envoy config dump JSON file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--name <string></code></td>
|
|
<td></td>
|
|
<td>Filter listeners by route name field (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|short (default `short`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-config-route Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve summary about route configuration for a given pod from Envoy.
|
|
istioctl proxy-config routes <pod-name[.namespace]>
|
|
|
|
# Retrieve route summary for route 9080.
|
|
istioctl proxy-config route <pod-name[.namespace]> --name 9080
|
|
|
|
# Retrieve full route dump for route 9080
|
|
istioctl proxy-config route <pod-name[.namespace]> --name 9080 -o json
|
|
|
|
# Retrieve route summary without using Kubernetes API
|
|
ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
|
|
istioctl proxy-config routes --file envoy-config.json
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-proxy-config-secret">istioctl proxy-config secret</h2>
|
|
<p>(experimental) Retrieve information about secret configuration for the Envoy instance in the specified pod.</p>
|
|
<pre class="language-bash"><code>istioctl proxy-config secret [<pod-name[.namespace]>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl proxy-config s [<pod-name[.namespace]>] [flags]
|
|
</code></pre></div>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--file <string></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Envoy config dump JSON file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>Output format: one of json|short (default `short`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-config-secret Examples">Examples</h3>
|
|
<pre class="language-bash"><code> # Retrieve full secret configuration for a given pod from Envoy.
|
|
istioctl proxy-config secret <pod-name[.namespace]>
|
|
|
|
# Retrieve full bootstrap without using Kubernetes API
|
|
ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
|
|
istioctl proxy-config secret --file envoy-config.json
|
|
|
|
THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-proxy-status">istioctl proxy-status</h2>
|
|
<p>
|
|
Retrieves last sent and last acknowledged xDS sync from Pilot to each Envoy in the mesh</p>
|
|
<p></p>
|
|
<pre class="language-bash"><code>istioctl proxy-status [<pod-name[.namespace]>] [flags]
|
|
</code></pre>
|
|
<div class="aliases">
|
|
<pre class="language-bash"><code>istioctl ps [<pod-name[.namespace]>] [flags]
|
|
</code></pre></div>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--sds</code></td>
|
|
<td><code>-s</code></td>
|
|
<td>(experimental) Retrieve synchronization between active secrets on Envoy instance with those on corresponding node agents </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--sds-json</code></td>
|
|
<td></td>
|
|
<td>Determines whether SDS dump outputs JSON </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-proxy-status Examples">Examples</h3>
|
|
<pre class="language-bash"><code># Retrieve sync status for all Envoys in a mesh
|
|
istioctl proxy-status
|
|
|
|
# Retrieve sync diff for a single Envoy and Pilot
|
|
istioctl proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-register">istioctl register</h2>
|
|
<p>Registers a service instance (e.g. VM) joining the mesh</p>
|
|
<pre class="language-bash"><code>istioctl register <svcname> <ip> [name1:]port1 [name2:]port2 ... [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>List of string annotations to apply if creating a service/endpoint; e.g. -a foo=bar,test,x=y (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--labels <stringSlice></code></td>
|
|
<td><code>-l</code></td>
|
|
<td>List of labels to apply if creating a service/endpoint; e.g. -l env=prod,vers=2 (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--serviceaccount <string></code></td>
|
|
<td><code>-s</code></td>
|
|
<td>Service account to link to the service (default `default`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-upgrade">istioctl upgrade</h2>
|
|
<p>The upgrade command checks for upgrade version eligibility and, if eligible, upgrades the Istio control plane components in-place. Warning: traffic may be disrupted during upgrade. Please ensure PodDisruptionBudgets are defined to maintain service continuity.</p>
|
|
<pre class="language-bash"><code>istioctl upgrade [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dry-run</code></td>
|
|
<td></td>
|
|
<td>Console/log output only, make no changes. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <stringSlice></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Path to file containing IstioOperator custom resource (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--force</code></td>
|
|
<td></td>
|
|
<td>Apply the upgrade without eligibility checks </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--logtostderr</code></td>
|
|
<td></td>
|
|
<td>Send logs to stderr. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--skip-confirmation</code></td>
|
|
<td><code>-y</code></td>
|
|
<td>If skip-confirmation is set, skips the prompting confirmation for value changes in this upgrade </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--verbose</code></td>
|
|
<td></td>
|
|
<td>Verbose output. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--versionsURI <string></code></td>
|
|
<td><code>-u</code></td>
|
|
<td>URI for operator versions to Istio versions map (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--wait</code></td>
|
|
<td><code>-w</code></td>
|
|
<td>Wait, if set will wait until all Pods, Services, and minimum number of Pods of a Deployment are in a ready state before the command exits. It will wait for a maximum duration of 10m0s </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="istioctl-validate">istioctl validate</h2>
|
|
<p>Validate Istio policy and rules (NOTE: validate is deprecated and will be removed in 1.6. Use 'istioctl analyze' to validate configuration.)</p>
|
|
<pre class="language-bash"><code>istioctl validate -f FILENAME [options] [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--filename <stringSlice></code></td>
|
|
<td><code>-f</code></td>
|
|
<td>Names of files to validate (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--referential</code></td>
|
|
<td><code>-x</code></td>
|
|
<td>Enable structural validation for policy and telemetry </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-validate Examples">Examples</h3>
|
|
<pre class="language-bash"><code>
|
|
# Validate bookinfo-gateway.yaml
|
|
istioctl validate -f bookinfo-gateway.yaml
|
|
|
|
# Validate current deployments under 'default' namespace within the cluster
|
|
kubectl get deployments -o yaml |istioctl validate -f -
|
|
|
|
# Validate current services under 'default' namespace within the cluster
|
|
kubectl get services -o yaml |istioctl validate -f -
|
|
|
|
# Also see the related command 'istioctl analyze'
|
|
istioctl analyze samples/bookinfo/networking/bookinfo-gateway.yaml
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-verify-install">istioctl verify-install</h2>
|
|
<p>
|
|
verify-install verifies Istio installation status against the installation file
|
|
you specified when you installed Istio. It loops through all the installation
|
|
resources defined in your installation file and reports whether all of them are
|
|
in ready status. It will report failure when any of them are not ready.</p>
|
|
<p> If you do not specify installation file it will perform pre-check for your cluster
|
|
and report whether the cluster is ready for Istio installation.
|
|
</p>
|
|
<pre class="language-bash"><code>istioctl verify-install [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--enableVerbose</code></td>
|
|
<td></td>
|
|
<td>Enable verbose output </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>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--recursive</code></td>
|
|
<td><code>-R</code></td>
|
|
<td>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="istioctl-verify-install Examples">Examples</h3>
|
|
<pre class="language-bash"><code>
|
|
# Verify that Istio can be freshly installed
|
|
istioctl verify-install
|
|
|
|
# Verify the deployment matches a custom Istio deployment configuration
|
|
istioctl verify-install -f $HOME/istio.yaml
|
|
|
|
</code></pre>
|
|
<h2 id="istioctl-version">istioctl version</h2>
|
|
<p>Prints out build version information</p>
|
|
<pre class="language-bash"><code>istioctl version [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--context <string></code></td>
|
|
<td></td>
|
|
<td>The name of the kubeconfig context to use (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--istioNamespace <string></code></td>
|
|
<td><code>-i</code></td>
|
|
<td>Istio system namespace (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Kubernetes configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cache, citadelclient, configmapcontroller, default, googleca, grpcAdapter, installer, mcp, model, patch, processing, rbac, resource, sds, secretfetcher, source, stsclient, tpath, translator, util, validation, vault] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn,installer:warn,translator:warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Config namespace (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>One of 'yaml' or 'json'. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--remote</code></td>
|
|
<td></td>
|
|
<td>Use --remote=false to suppress control plane check </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--short</code></td>
|
|
<td><code>-s</code></td>
|
|
<td>Use --short=false to generate full version information </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="envvars">Environment variables</h2>
|
|
These environment variables affect the behavior of the <code>istioctl</code> command.
|
|
<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>BYPASS_OOP_MTLS_SAN_VERIFICATION</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>Whether or not to validate SANs for out-of-process adapters auth.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>GKE_CLUSTER_URL</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>The url of GKE cluster</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>INGRESS_GATEWAY_FALLBACK_SECRET</code></td>
|
|
<td>String</td>
|
|
<td><code>gateway-fallback</code></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>INGRESS_GATEWAY_NAMESPACE</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIOD_ADDR</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>Service name of istiod. If empty the istiod listener, certs will be disabled.</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_LANG</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>Selects the attribute expression language runtime for Mixer.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>JWT_POLICY</code></td>
|
|
<td>String</td>
|
|
<td><code>third-party-jwt</code></td>
|
|
<td>The JWT validation policy.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>K8S_INGRESS_NS</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>NAMESPACE</code></td>
|
|
<td>String</td>
|
|
<td><code>istio-system</code></td>
|
|
<td>namespace that nodeagent/citadel run in</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_BLOCK_HTTP_ON_443</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, any HTTP services will be blocked on HTTPS port (443). If this is disabled, any HTTP service on port 443 could block all external traffic</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_CERT_DIR</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_CERT_PROVIDER</code></td>
|
|
<td>String</td>
|
|
<td><code>citadel</code></td>
|
|
<td>the provider of Pilot DNS certificate.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_DEBOUNCE_AFTER</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>100ms</code></td>
|
|
<td>The delay added to config/registry events for debouncing. This will delay the push by at least this internal. If no change is detected within this period, the push will happen, otherwise we'll keep delaying until things settle, up to a max of PILOT_DEBOUNCE_MAX.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_DEBOUNCE_MAX</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>10s</code></td>
|
|
<td>The maximum amount of time to wait for events while debouncing. If events keep showing up with no breaks for this time, we'll trigger a push.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_DEBUG_ADSZ_CONFIG</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_DISTRIBUTION_HISTORY_RETENTION</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>1m0s</code></td>
|
|
<td>If enabled, Pilot will keep track of old versions of distributed config for this duration.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, Pilot will assign meaningful nonces to each Envoy configuration message, and allow users to interrogate which envoy has which config from the debug interface.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_CRD_VALIDATION</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, pilot will validate CRDs while retrieving CRDs from kubernetes cache.Use this flag to enable validation of CRDs in Pilot, especially in deployments that do not have galley installed.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_EDS_DEBOUNCE</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, Pilot will include EDS pushes in the push debouncing, configured by PILOT_DEBOUNCE_AFTER and PILOT_DEBOUNCE_MAX. EDS pushes may be delayed, but there will be fewer pushes. By default this is enabled</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_EDS_FOR_HEADLESS_SERVICES</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, for headless service in Kubernetes, pilot will send endpoints over EDS, allowing the sidecar to load balance among pods in the headless service. This feature should be enabled if applications access all services explicitly via a HTTP proxy port in the sidecar.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_FALLTHROUGH_ROUTE</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>EnableFallthroughRoute provides an option to add a final wildcard match for routes. When ALLOW_ANY traffic policy is used, a Passthrough cluster is used. When REGISTRY_ONLY traffic policy is used, a 502 error is returned.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_HEADLESS_SERVICE_POD_LISTENERS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, for a headless service/stateful set in Kubernetes, pilot will generate an outbound listener for each pod in a headless service. This feature should be disabled if headless services have a large number of pods.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_MYSQL_FILTER</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_PROTOCOL_SNIFFING_FOR_INBOUND</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, protocol sniffing will be used for inbound listeners whose port protocol is not specified or unsupported</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_PROTOCOL_SNIFFING_FOR_OUTBOUND</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, protocol sniffing will be used for outbound listeners whose port protocol is not specified or unsupported</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_REDIS_FILTER</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_ENABLE_TCP_METADATA_EXCHANGE</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, metadata exchange will be enabled for TCP using ALPN and Network Metadata Exchange filters in Envoy</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_FILTER_GATEWAY_CLUSTER_CONFIG</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_HTTP10</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>Enables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_INBOUND_PROTOCOL_DETECTION_TIMEOUT</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>1s</code></td>
|
|
<td>Protocol detection timeout for inbound listener</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_INITIAL_FETCH_TIMEOUT</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>0s</code></td>
|
|
<td>Specifies the initial_fetch_timeout for config. If this time is reached without a response to the config requested by Envoy, the Envoy will move on with the init phase. This prevents envoy from getting stuck waiting on config during startup.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_PUSH_THROTTLE</code></td>
|
|
<td>Integer</td>
|
|
<td><code>100</code></td>
|
|
<td>Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_RESPECT_DNS_TTL</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, DNS based clusters will respect the TTL of the DNS, rather than polling at a fixed rate. This option is only provided for backward compatibility purposes and will be removed in the near future.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_RESTRICT_POD_UP_TRAFFIC_LOOP</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, this will block inbound traffic from matching outbound listeners, which could result in an infinite loop of traffic. This option is only provided for backward compatibility purposes and will be removed in the near future.</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_SCOPE_PUSHES</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If enabled, pilot will attempt to limit unnecessary pushes by determining what proxies a config or endpoint update will impact.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_SIDECAR_USE_REMOTE_ADDRESS</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>UseRemoteAddress sets useRemoteAddress to true for side car outbound listeners.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_SKIP_VALIDATE_TRUST_DOMAIN</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>Skip validating the peer is from the same trust domain when mTLS is enabled in authentication policy</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_TRACE_SAMPLING</code></td>
|
|
<td>Floating-Point</td>
|
|
<td><code>100</code></td>
|
|
<td>Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 100, not recommended for production use.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PILOT_USE_ENDPOINT_SLICE</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>If enabled, Pilot will use EndpointSlices as the source of endpoints for Kubernetes services. By default, this is false, and Endpoints will be used. This requires the Kubernetes EndpointSlice controller to be enabled. Currently this is mutual exclusive - either Endpoints or EndpointSlices will be used</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>POD_NAME</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>SECRET_WATCHER_RESYNC_PERIOD</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>TERM</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>Specifies terminal type. Use 'dumb' to suppress color output</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>TERMINATION_DRAIN_DURATION_SECONDS</code></td>
|
|
<td>Integer</td>
|
|
<td><code>5</code></td>
|
|
<td>The amount of time allowed for connections to complete on pilot-agent shutdown. On receiving SIGTERM or SIGINT, pilot-agent tells the active Envoy to start draining, preventing any new connections and allowing existing connections to complete. It then sleeps for the TerminationDrainDuration and then kills any remaining active Envoy processes.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>USE_ISTIO_JWT_FILTER</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>Use the Istio JWT filter for JWT token verification.</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>endpoint_no_pod</code></td><td><code>LastValue</code></td><td>Endpoints without an associated pod.</td></tr>
|
|
<tr><td><code>galley_runtime_processor_event_span_duration_milliseconds</code></td><td><code>Distribution</code></td><td>The duration between each incoming event</td></tr>
|
|
<tr><td><code>galley_runtime_processor_events_processed_total</code></td><td><code>Count</code></td><td>The number of events that have been processed</td></tr>
|
|
<tr><td><code>galley_runtime_processor_snapshot_events_total</code></td><td><code>Distribution</code></td><td>The number of events per snapshot</td></tr>
|
|
<tr><td><code>galley_runtime_processor_snapshot_lifetime_duration_milliseconds</code></td><td><code>Distribution</code></td><td>The duration of each snapshot</td></tr>
|
|
<tr><td><code>galley_runtime_processor_snapshots_published_total</code></td><td><code>Count</code></td><td>The number of snapshots that have been published</td></tr>
|
|
<tr><td><code>galley_runtime_state_type_instances_total</code></td><td><code>LastValue</code></td><td>The number of type instances per type URL</td></tr>
|
|
<tr><td><code>galley_runtime_strategy_on_change_total</code></td><td><code>Count</code></td><td>The number of times the strategy's onChange has been called</td></tr>
|
|
<tr><td><code>galley_runtime_strategy_timer_max_time_reached_total</code></td><td><code>Count</code></td><td>The number of times the max time has been reached</td></tr>
|
|
<tr><td><code>galley_runtime_strategy_timer_quiesce_reached_total</code></td><td><code>Count</code></td><td>The number of times a quiesce has been reached</td></tr>
|
|
<tr><td><code>galley_runtime_strategy_timer_resets_total</code></td><td><code>Count</code></td><td>The number of times the timer has been reset</td></tr>
|
|
<tr><td><code>galley_source_kube_dynamic_converter_failure_total</code></td><td><code>Count</code></td><td>The number of times a dynamnic kubernetes source failed converting a resources</td></tr>
|
|
<tr><td><code>galley_source_kube_dynamic_converter_success_total</code></td><td><code>Count</code></td><td>The number of times a dynamic kubernetes source successfully converted a resource</td></tr>
|
|
<tr><td><code>galley_source_kube_event_error_total</code></td><td><code>Count</code></td><td>The number of times a kubernetes source encountered errored while handling an event</td></tr>
|
|
<tr><td><code>galley_source_kube_event_success_total</code></td><td><code>Count</code></td><td>The number of times a kubernetes source successfully handled an event</td></tr>
|
|
<tr><td><code>istio_build</code></td><td><code>LastValue</code></td><td>Istio component build info</td></tr>
|
|
<tr><td><code>istio_mcp_clients_total</code></td><td><code>LastValue</code></td><td>The number of streams currently connected.</td></tr>
|
|
<tr><td><code>istio_mcp_message_sizes_bytes</code></td><td><code>Distribution</code></td><td>Size of messages received from clients.</td></tr>
|
|
<tr><td><code>istio_mcp_reconnections</code></td><td><code>Sum</code></td><td>The number of times the sink has reconnected.</td></tr>
|
|
<tr><td><code>istio_mcp_recv_failures_total</code></td><td><code>Sum</code></td><td>The number of recv failures in the source.</td></tr>
|
|
<tr><td><code>istio_mcp_request_acks_total</code></td><td><code>Sum</code></td><td>The number of request acks received by the source.</td></tr>
|
|
<tr><td><code>istio_mcp_request_nacks_total</code></td><td><code>Sum</code></td><td>The number of request nacks received by the source.</td></tr>
|
|
<tr><td><code>istio_mcp_send_failures_total</code></td><td><code>Sum</code></td><td>The number of send failures in the source.</td></tr>
|
|
<tr><td><code>mixer_config_adapter_info_config_errors_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered during processing of the adapter info configuration.</td></tr>
|
|
<tr><td><code>mixer_config_adapter_info_configs_total</code></td><td><code>LastValue</code></td><td>The number of known adapters in the current config.</td></tr>
|
|
<tr><td><code>mixer_config_attributes_total</code></td><td><code>LastValue</code></td><td>The number of known attributes in the current config.</td></tr>
|
|
<tr><td><code>mixer_config_handler_configs_total</code></td><td><code>LastValue</code></td><td>The number of known handlers in the current config.</td></tr>
|
|
<tr><td><code>mixer_config_handler_validation_error_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered because handler validation returned error.</td></tr>
|
|
<tr><td><code>mixer_config_instance_config_errors_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered during processing of the instance configuration.</td></tr>
|
|
<tr><td><code>mixer_config_instance_configs_total</code></td><td><code>LastValue</code></td><td>The number of known instances in the current config.</td></tr>
|
|
<tr><td><code>mixer_config_rule_config_errors_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered during processing of the rule configuration.</td></tr>
|
|
<tr><td><code>mixer_config_rule_config_match_error_total</code></td><td><code>LastValue</code></td><td>The number of rule conditions that was not parseable.</td></tr>
|
|
<tr><td><code>mixer_config_rule_configs_total</code></td><td><code>LastValue</code></td><td>The number of known rules in the current config.</td></tr>
|
|
<tr><td><code>mixer_config_template_config_errors_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered during processing of the template configuration.</td></tr>
|
|
<tr><td><code>mixer_config_template_configs_total</code></td><td><code>LastValue</code></td><td>The number of known templates in the current config.</td></tr>
|
|
<tr><td><code>mixer_config_unsatisfied_action_handler_total</code></td><td><code>LastValue</code></td><td>The number of actions that failed due to handlers being unavailable.</td></tr>
|
|
<tr><td><code>mixer_dispatcher_destinations_per_request</code></td><td><code>Distribution</code></td><td>Number of handlers dispatched per request by Mixer</td></tr>
|
|
<tr><td><code>mixer_dispatcher_destinations_per_variety_total</code></td><td><code>LastValue</code></td><td>Number of Mixer adapter destinations by template variety type</td></tr>
|
|
<tr><td><code>mixer_dispatcher_instances_per_request</code></td><td><code>Distribution</code></td><td>Number of instances created per request by Mixer</td></tr>
|
|
<tr><td><code>mixer_handler_closed_handlers_total</code></td><td><code>LastValue</code></td><td>The number of handlers that were closed during config transition.</td></tr>
|
|
<tr><td><code>mixer_handler_daemons_total</code></td><td><code>LastValue</code></td><td>The current number of active daemon routines in a given adapter environment.</td></tr>
|
|
<tr><td><code>mixer_handler_handler_build_failures_total</code></td><td><code>LastValue</code></td><td>The number of handlers that failed creation during config transition.</td></tr>
|
|
<tr><td><code>mixer_handler_handler_close_failures_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered while closing handlers during config transition.</td></tr>
|
|
<tr><td><code>mixer_handler_new_handlers_total</code></td><td><code>LastValue</code></td><td>The number of handlers that were newly created during config transition.</td></tr>
|
|
<tr><td><code>mixer_handler_reused_handlers_total</code></td><td><code>LastValue</code></td><td>The number of handlers that were re-used during config transition.</td></tr>
|
|
<tr><td><code>mixer_handler_workers_total</code></td><td><code>LastValue</code></td><td>The current number of active worker routines in a given adapter environment.</td></tr>
|
|
<tr><td><code>mixer_runtime_dispatch_duration_seconds</code></td><td><code>Distribution</code></td><td>Duration in seconds for adapter dispatches handled by Mixer.</td></tr>
|
|
<tr><td><code>mixer_runtime_dispatches_total</code></td><td><code>Count</code></td><td>Total number of adapter dispatches handled by Mixer.</td></tr>
|
|
<tr><td><code>num_failed_outgoing_requests</code></td><td><code>Sum</code></td><td>Number of failed outgoing requests (e.g. to a token exchange server, CA, etc.)</td></tr>
|
|
<tr><td><code>num_outgoing_requests</code></td><td><code>Sum</code></td><td>Number of total outgoing requests (e.g. to a token exchange server, CA, etc.)</td></tr>
|
|
<tr><td><code>num_outgoing_retries</code></td><td><code>Sum</code></td><td>Number of outgoing retry requests (e.g. to a token exchange server, CA, etc.)</td></tr>
|
|
<tr><td><code>outgoing_latency</code></td><td><code>Sum</code></td><td>The latency of outgoing requests (e.g. to a token exchange server, CA, etc.) in milliseconds.</td></tr>
|
|
<tr><td><code>pilot_conflict_inbound_listener</code></td><td><code>LastValue</code></td><td>Number of conflicting inbound listeners.</td></tr>
|
|
<tr><td><code>pilot_conflict_outbound_listener_http_over_current_tcp</code></td><td><code>LastValue</code></td><td>Number of conflicting wildcard http listeners with current wildcard tcp listener.</td></tr>
|
|
<tr><td><code>pilot_conflict_outbound_listener_http_over_https</code></td><td><code>LastValue</code></td><td>Number of conflicting HTTP listeners with well known HTTPS ports</td></tr>
|
|
<tr><td><code>pilot_conflict_outbound_listener_tcp_over_current_http</code></td><td><code>LastValue</code></td><td>Number of conflicting wildcard tcp listeners with current wildcard http listener.</td></tr>
|
|
<tr><td><code>pilot_conflict_outbound_listener_tcp_over_current_tcp</code></td><td><code>LastValue</code></td><td>Number of conflicting tcp listeners with current tcp listener.</td></tr>
|
|
<tr><td><code>pilot_destrule_subsets</code></td><td><code>LastValue</code></td><td>Duplicate subsets across destination rules for same host</td></tr>
|
|
<tr><td><code>pilot_duplicate_envoy_clusters</code></td><td><code>LastValue</code></td><td>Duplicate envoy clusters caused by service entries with same hostname</td></tr>
|
|
<tr><td><code>pilot_eds_no_instances</code></td><td><code>LastValue</code></td><td>Number of clusters without instances.</td></tr>
|
|
<tr><td><code>pilot_endpoint_not_ready</code></td><td><code>LastValue</code></td><td>Endpoint found in unready state.</td></tr>
|
|
<tr><td><code>pilot_inbound_updates</code></td><td><code>Sum</code></td><td>Total number of updates received by pilot.</td></tr>
|
|
<tr><td><code>pilot_invalid_out_listeners</code></td><td><code>LastValue</code></td><td>Number of invalid outbound listeners.</td></tr>
|
|
<tr><td><code>pilot_jwks_resolver_network_fetch_fail_total</code></td><td><code>Sum</code></td><td>Total number of failed network fetch by pilot jwks resolver</td></tr>
|
|
<tr><td><code>pilot_jwks_resolver_network_fetch_success_total</code></td><td><code>Sum</code></td><td>Total number of successfully network fetch by pilot jwks resolver</td></tr>
|
|
<tr><td><code>pilot_k8s_cfg_events</code></td><td><code>Sum</code></td><td>Events from k8s config.</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_object_errors</code></td><td><code>LastValue</code></td><td>Errors converting k8s CRDs</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_rds_expired_nonce</code></td><td><code>Sum</code></td><td>Total number of RDS messages with an expired nonce.</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_k8s_object_errors</code></td><td><code>Sum</code></td><td>Total Errors converting k8s CRDs</td></tr>
|
|
<tr><td><code>pilot_total_rejected_configs</code></td><td><code>Sum</code></td><td>Total number of configs that Pilot had to reject or ignore.</td></tr>
|
|
<tr><td><code>pilot_total_xds_internal_errors</code></td><td><code>Sum</code></td><td>Total number of internal XDS errors in pilot.</td></tr>
|
|
<tr><td><code>pilot_total_xds_rejects</code></td><td><code>Sum</code></td><td>Total number of XDS responses from pilot rejected by proxy.</td></tr>
|
|
<tr><td><code>pilot_virt_services</code></td><td><code>LastValue</code></td><td>Total virtual services known to pilot.</td></tr>
|
|
<tr><td><code>pilot_vservice_dup_domain</code></td><td><code>LastValue</code></td><td>Virtual services with dup domains.</td></tr>
|
|
<tr><td><code>pilot_xds</code></td><td><code>LastValue</code></td><td>Number of endpoints connected to this pilot using XDS.</td></tr>
|
|
<tr><td><code>pilot_xds_cds_reject</code></td><td><code>LastValue</code></td><td>Pilot rejected CDS configs.</td></tr>
|
|
<tr><td><code>pilot_xds_eds_all_locality_endpoints</code></td><td><code>LastValue</code></td><td>Network endpoints for each cluster(across all localities), as of last push. Zero endpoints is an error.</td></tr>
|
|
<tr><td><code>pilot_xds_eds_instances</code></td><td><code>LastValue</code></td><td>Instances for each cluster(grouped by locality), as of last push. Zero instances is an error.</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_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_write_timeout</code></td><td><code>Sum</code></td><td>Pilot XDS response write timeouts.</td></tr>
|
|
<tr><td><code>sidecar_injection_failure_total</code></td><td><code>Sum</code></td><td>Total number of failed Side car injection requests.</td></tr>
|
|
<tr><td><code>sidecar_injection_requests_total</code></td><td><code>Sum</code></td><td>Total number of Side car injection requests.</td></tr>
|
|
<tr><td><code>sidecar_injection_skip_total</code></td><td><code>Sum</code></td><td>Total number of skipped injection requests.</td></tr>
|
|
<tr><td><code>sidecar_injection_success_total</code></td><td><code>Sum</code></td><td>Total number of successful Side car injection requests.</td></tr>
|
|
<tr><td><code>total_active_connections</code></td><td><code>Sum</code></td><td>The total number of active SDS connections.</td></tr>
|
|
<tr><td><code>total_push_errors</code></td><td><code>Sum</code></td><td>The total number of failed SDS pushes.</td></tr>
|
|
<tr><td><code>total_pushes</code></td><td><code>Sum</code></td><td>The total number of SDS pushes.</td></tr>
|
|
<tr><td><code>total_secret_update_failures</code></td><td><code>Sum</code></td><td>The total number of dynamic secret update failures reported by proxy.</td></tr>
|
|
<tr><td><code>total_stale_connections</code></td><td><code>Sum</code></td><td>The total number of stale SDS connections.</td></tr>
|
|
</tbody>
|
|
</table>
|