Install and configure Istio CNI plugin on a node, detect and repair pod which is broken by race condition.
+install-cni [flags]
+| Flags | +Description | +
|---|---|
--ambient-enabled |
+Whether ambient controller is enabled | +
--chained-cni-plugin |
+Whether to install CNI plugin as a chained or standalone | +
--cni-conf-name <string> |
+Name of the CNI configuration file (default ``) | +
--cni-net-dir <string> |
+Directory on the host where CNI network plugins are installed (default `/etc/cni/net.d`) | +
--cni-network-config <string> |
+CNI configuration template as a string (default ``) | +
--cni-network-config-file <string> |
+CNI config template as a file (default ``) | +
--ctrlz_address <string> |
+The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `localhost`) | +
--ctrlz_port <uint16> |
+The IP port to use for the ControlZ introspection facility (default `9876`) | +
--ebpf-enabled |
+Whether ebpf redirection is enabled | +
--kube-ca-file <string> |
+CA file for kubeconfig. Defaults to the same as install-cni pod (default ``) | +
--kubecfg-file-name <string> |
+Name of the kubeconfig file which CNI plugin will use when interacting with API server (default `ZZZ-istio-cni-kubeconfig`) | +
--kubeconfig-mode <int> |
+File mode of the kubeconfig file (default `384`) | +
--log-level <string> |
+Fallback value for log level in CNI config file, if not specified in helm template (default `warn`) | +
--log-uds-address <string> |
+The UDS server address which CNI plugin will copy log output to (default `/var/run/istio-cni/log.sock`) | +
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] (default ``) | +
--log_output_level <string> |
+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 [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--monitoring-port <int> |
+HTTP port to serve prometheus metrics (default `15014`) | +
--mounted-cni-net-dir <string> |
+Directory on the container where CNI networks are installed (default `/host/etc/cni/net.d`) | +
--repair-broken-pod-label-key <string> |
+The key portion of the label which will be set by the ace repair if label pods is true (default `cni.istio.io/uninitialized`) | +
--repair-broken-pod-label-value <string> |
+The value portion of the label which will be set by the race repair if label pods is true (default `true`) | +
--repair-delete-pods |
+Controller will delete pods when detecting pod broken by race condition | +
--repair-enabled |
+Whether to enable race condition repair or not | +
--repair-field-selectors <string> |
+A set of field selectors in label=value format that will be added to the pod list filters (default ``) | +
--repair-init-container-exit-code <int> |
+Expected exit code for the init container when crash-looping because of CNI misconfiguration (default `126`) | +
--repair-init-container-name <string> |
+The name of the istio init container (will crash-loop if CNI is not configured for the pod) (default `istio-validation`) | +
--repair-init-container-termination-message <string> |
+The expected termination message for the init container when crash-looping because of CNI misconfiguration (default ``) | +
--repair-label-pods |
+Controller will label pods when detecting pod broken by race condition | +
--repair-label-selectors <string> |
+A set of label selectors in label=value format that will be added to the pod list filters (default ``) | +
--repair-node-name <string> |
+The name of the managed node (will manage all nodes if unset) (default ``) | +
--repair-sidecar-annotation <string> |
+An annotation key that indicates this pod contains an istio sidecar. All pods without this annotation will be ignored.The value of the annotation is ignored. (default `sidecar.istio.io/status`) | +
--skip-tls-verify |
+Whether to use insecure TLS in kubeconfig file | +
Generate the autocompletion script for install-cni for the specified shell. +See each sub-command's help for details on how to use the generated script. +
+| Flags | +Description | +
|---|---|
--ctrlz_address <string> |
+The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `localhost`) | +
--ctrlz_port <uint16> |
+The IP port to use for the ControlZ introspection facility (default `9876`) | +
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] (default ``) | +
--log_output_level <string> |
+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 [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
Generate the autocompletion script for the bash shell.
+This script depends on the 'bash-completion' package. +If it is not installed already, you can install it via your OS's package manager.
+To load completions in your current shell session:
+source <(install-cni completion bash)
+To load completions for every new session, execute once:
+#### Linux:
+install-cni completion bash > /etc/bash_completion.d/install-cni
+#### macOS:
+install-cni completion bash > $(brew --prefix)/etc/bash_completion.d/install-cni
+You will need to start a new shell for this setup to take effect. +
+install-cni completion bash
+| Flags | +Description | +
|---|---|
--ctrlz_address <string> |
+The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `localhost`) | +
--ctrlz_port <uint16> |
+The IP port to use for the ControlZ introspection facility (default `9876`) | +
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] (default ``) | +
--log_output_level <string> |
+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 [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--no-descriptions |
+disable completion descriptions | +
Generate the autocompletion script for the fish shell.
+To load completions in your current shell session:
+install-cni completion fish | source
+To load completions for every new session, execute once:
+install-cni completion fish > ~/.config/fish/completions/install-cni.fish
+You will need to start a new shell for this setup to take effect. +
+install-cni completion fish [flags]
+| Flags | +Description | +
|---|---|
--ctrlz_address <string> |
+The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `localhost`) | +
--ctrlz_port <uint16> |
+The IP port to use for the ControlZ introspection facility (default `9876`) | +
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] (default ``) | +
--log_output_level <string> |
+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 [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--no-descriptions |
+disable completion descriptions | +
Generate the autocompletion script for powershell.
+To load completions in your current shell session:
+install-cni completion powershell | Out-String | Invoke-Expression
+To load completions for every new session, add the output of the above command +to your powershell profile. +
+install-cni completion powershell [flags]
+| Flags | +Description | +
|---|---|
--ctrlz_address <string> |
+The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `localhost`) | +
--ctrlz_port <uint16> |
+The IP port to use for the ControlZ introspection facility (default `9876`) | +
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] (default ``) | +
--log_output_level <string> |
+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 [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--no-descriptions |
+disable completion descriptions | +
Generate the autocompletion script for the zsh shell.
+If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once:
+echo "autoload -U compinit; compinit" >> ~/.zshrc
+To load completions in your current shell session:
+source <(install-cni completion zsh)
+To load completions for every new session, execute once:
+#### Linux:
+install-cni completion zsh > "${fpath[1]}/_install-cni"
+#### macOS:
+install-cni completion zsh > $(brew --prefix)/share/zsh/site-functions/_install-cni
+You will need to start a new shell for this setup to take effect. +
+install-cni completion zsh [flags]
+| Flags | +Description | +
|---|---|
--ctrlz_address <string> |
+The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `localhost`) | +
--ctrlz_port <uint16> |
+The IP port to use for the ControlZ introspection facility (default `9876`) | +
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] (default ``) | +
--log_output_level <string> |
+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 [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--no-descriptions |
+disable completion descriptions | +
Prints out build version information
+install-cni version [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--ctrlz_address <string> |
++ | The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `localhost`) | +
--ctrlz_port <uint16> |
++ | The IP port to use for the ControlZ introspection facility (default `9876`) | +
--log_as_json |
++ | Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
++ | Comma-separated list of scopes for which to include caller information, scopes can be any of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] (default ``) | +
--log_output_level <string> |
++ | 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 [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
++ | The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
++ | The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
++ | The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
++ | The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
++ | Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
++ | The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--output <string> |
+-o |
+One of 'yaml' or 'json'. (default ``) | +
--short |
+-s |
+Use --short=false to generate full version information | +
install-cni command. Please use with caution as these environment variables are experimental and can change anytime.
+| Variable Name | +Type | +Default Value | +Description | +
|---|---|---|---|
AMBIENT_ENABLED |
+Boolean | +false |
+Whether ambient controller is enabled | +
CA_TRUSTED_NODE_ACCOUNTS |
+String | + |
+If set, the list of service accounts that are allowed to use node authentication for CSRs. Node authentication allows an identity to create CSRs on behalf of other identities, but only if there is a pod running on the same node with that identity. This is intended for use with node proxies. | +
CERT_SIGNER_DOMAIN |
+String | + |
+The cert signer domain info | +
CHAINED_CNI_PLUGIN |
+Boolean | +true |
+Whether to install CNI plugin as a chained or standalone | +
CLUSTER_ID |
+String | +Kubernetes |
+Defines the cluster and service registry that this Istiod instance belongs to | +
CNI_CONF_NAME |
+String | + |
+Name of the CNI configuration file | +
CNI_NETWORK_CONFIG |
+String | + |
+CNI configuration template as a string | +
CNI_NETWORK_CONFIG_FILE |
+String | + |
+CNI config template as a file | +
CNI_NET_DIR |
+String | +/etc/cni/net.d |
+Directory on the host where CNI network plugins are installed | +
EBPF_ENABLED |
+Boolean | +false |
+Whether ebpf redirection is enabled | +
ENABLE_AUTO_SNI |
+Boolean | +false |
+If enabled, automatically set SNI when `DestinationRules` do not specify the same | +
ENABLE_CA_SERVER |
+Boolean | +true |
+If this is set to false, will not create CA server in istiod. | +
ENABLE_DEBUG_ON_HTTP |
+Boolean | +true |
+If this is set to false, the debug interface will not be enabled, recommended for production | +
ENABLE_ENHANCED_RESOURCE_SCOPING |
+Boolean | +false |
+If enabled, meshConfig.discoverySelectors will limit the CustomResource configurations(like Gateway,VirtualService,DestinationRule,Ingress, etc)that can be processed by pilot. This will also restrict the root-ca certificate distribution. | +
ENABLE_HCM_INTERNAL_NETWORKS |
+Boolean | +false |
+If enable, endpoints defined in mesh networks will be configured as internal addresses in Http Connection Manager | +
ENABLE_LEADER_ELECTION |
+Boolean | +true |
+If enabled (default), starts a leader election client and gains leadership before executing controllers. If false, it assumes that only one instance of istiod is running and skips leader election. | +
ENABLE_MCS_AUTO_EXPORT |
+Boolean | +false |
+If enabled, istiod will automatically generate Kubernetes Multi-Cluster Services (MCS) ServiceExport resources for every service in the mesh. Services defined to be cluster-local in MeshConfig are excluded. | +
ENABLE_MCS_CLUSTER_LOCAL |
+Boolean | +false |
+If enabled, istiod will treat the host `<svc>.<namespace>.svc.cluster.local` as defined by the Kubernetes Multi-Cluster Services (MCS) spec. In this mode, requests to `cluster.local` will be routed to only those endpoints residing within the same cluster as the client. Requires that both ENABLE_MCS_SERVICE_DISCOVERY and ENABLE_MCS_HOST also be enabled. | +
ENABLE_MCS_HOST |
+Boolean | +false |
+If enabled, istiod will configure a Kubernetes Multi-Cluster Services (MCS) host (<svc>.<namespace>.svc.clusterset.local) for each service exported (via ServiceExport) in at least one cluster. Clients must, however, be able to successfully lookup these DNS hosts. That means that either Istio DNS interception must be enabled or an MCS controller must be used. Requires that ENABLE_MCS_SERVICE_DISCOVERY also be enabled. | +
ENABLE_MCS_SERVICE_DISCOVERY |
+Boolean | +false |
+If enabled, istiod will enable Kubernetes Multi-Cluster Services (MCS) service discovery mode. In this mode, service endpoints in a cluster will only be discoverable within the same cluster unless explicitly exported via ServiceExport. | +
ENABLE_MULTICLUSTER_HEADLESS |
+Boolean | +true |
+If true, the DNS name table for a headless service will resolve to same-network endpoints in any cluster. | +
ENABLE_NATIVE_SIDECARS |
+Boolean | +false |
+If set, used Kubernetes native Sidecar container support. Requires SidecarContainer feature flag. | +
ENABLE_OPTIMIZED_CONFIG_REBUILD |
+Boolean | +true |
+If enabled, pilot will only rebuild config for resources that have changed | +
ENABLE_OTEL_BUILTIN_RESOURCE_LABELS |
+Boolean | +false |
+If enabled, envoy will send builtin lables(e.g. node_name) via OTel sink. | +
ENABLE_TLS_ON_SIDECAR_INGRESS |
+Boolean | +false |
+If enabled, the TLS configuration on Sidecar.ingress will take effect | +
EXTERNAL_ISTIOD |
+Boolean | +false |
+If this is set to true, one Istiod will control remote clusters including CA. | +
HOST_IP |
+String | + |
++ |
INBOUND_INTERCEPTION_MODE |
+String | + |
+The mode used to redirect inbound connections to Envoy, either "REDIRECT" or "TPROXY" | +
INBOUND_TPROXY_MARK |
+String | + |
++ |
INJECTION_WEBHOOK_CONFIG_NAME |
+String | +istio-sidecar-injector |
+Name of the mutatingwebhookconfiguration to patch, if istioctl is not used. | +
ISTIOD_CUSTOM_HOST |
+String | + |
+Custom host name of istiod that istiod signs the server cert. Multiple custom host names are supported, and multiple values are separated by commas. | +
ISTIO_AGENT_ENABLE_WASM_REMOTE_LOAD_CONVERSION |
+Boolean | +true |
+If enabled, Istio agent will intercept ECDS resource update, downloads Wasm module, and replaces Wasm module remote load with downloaded local module file. | +
ISTIO_DELTA_XDS |
+Boolean | +false |
+If enabled, pilot will only send the delta configs as opposed to the state of the world on a Resource Request. This feature uses the delta xds api, but does not currently send the actual deltas. | +
ISTIO_DUAL_STACK |
+Boolean | +false |
+If true, Istio will enable the Dual Stack feature. | +
ISTIO_ENABLE_CONTROLLER_QUEUE_METRICS |
+Boolean | +false |
+If enabled, publishes metrics for queue depth, latency and processing times. | +
ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSH |
+Boolean | +true |
+If enabled, Istiod will not push changes on arbitrary annotation change. | +
ISTIO_GPRC_MAXRECVMSGSIZE |
+Integer | +4194304 |
+Sets the max receive buffer size of gRPC stream in bytes. | +
ISTIO_GPRC_MAXSTREAMS |
+Integer | +100000 |
+Sets the maximum number of concurrent grpc streams. | +
ISTIO_KUBE_CLIENT_CONTENT_TYPE |
+String | +protobuf |
+The content type to use for Kubernetes clients. Defaults to protobuf. Valid options: [protobuf, json] | +
ISTIO_MULTIROOT_MESH |
+Boolean | +false |
+If enabled, mesh will support certificates signed by more than one trustAnchor for ISTIO_MUTUAL mTLS | +
ISTIO_OUTBOUND_OWNER_GROUPS |
+String | +* |
+Comma separated list of groups whose outgoing traffic is to be redirected to Envoy. +A group can be specified either by name or by a numeric GID. +The wildcard character "*" can be used to configure redirection of traffic from all groups. | +
ISTIO_OUTBOUND_OWNER_GROUPS_EXCLUDE |
+String | + |
+Comma separated list of groups whose outgoing traffic is to be excluded from redirection to Envoy. +A group can be specified either by name or by a numeric GID. +Only applies when traffic from all groups (i.e. "*") is being redirected to Envoy. | +
ISTIO_WATCH_NAMESPACE |
+String | + |
+If set, limit Kubernetes watches to a single namespace. Warning: only a single namespace can be set. | +
ISTIO_WORKLOAD_ENTRY_VALIDATE_IDENTITY |
+Boolean | +true |
+If enabled, will validate the identity of a workload matches the identity of the WorkloadEntry it is associating with for health checks and auto registration. This flag is added for backwards compatibility only and will be removed in future releases | +
JWKS_RESOLVER_INSECURE_SKIP_VERIFY |
+Boolean | +false |
+If enabled, istiod will skip verifying the certificate of the JWKS server. | +
JWT_POLICY |
+String | +third-party-jwt |
+The JWT validation policy. | +
KUBECFG_FILE_NAME |
+String | +ZZZ-istio-cni-kubeconfig |
+Name of the kubeconfig file which CNI plugin will use when interacting with API server | +
KUBECONFIG_MODE |
+Integer | +384 |
+File mode of the kubeconfig file | +
KUBE_CA_FILE |
+String | + |
+CA file for kubeconfig. Defaults to the same as install-cni pod | +
LABEL_CANONICAL_SERVICES_FOR_MESH_EXTERNAL_SERVICE_ENTRIES |
+Boolean | +false |
+If enabled, metadata representing canonical services for ServiceEntry resources with a location of mesh_external will be populatedin the cluster metadata for those endpoints. | +
LOCAL_CLUSTER_SECRET_WATCHER |
+Boolean | +false |
+If enabled, the cluster secret watcher will watch the namespace of the external cluster instead of config cluster | +
LOG_LEVEL |
+String | +warn |
+Fallback value for log level in CNI config file, if not specified in helm template | +
LOG_UDS_ADDRESS |
+String | +/var/run/istio-cni/log.sock |
+The UDS server address which CNI plugin will copy log output to | +
MCS_API_GROUP |
+String | +multicluster.x-k8s.io |
+The group to be used for the Kubernetes Multi-Cluster Services (MCS) API. | +
MCS_API_VERSION |
+String | +v1alpha1 |
+The version to be used for the Kubernets Multi-Cluster Services (MCS) API. | +
METRIC_GRACEFUL_DELETION_INTERVAL |
+Time Duration | +5m0s |
+Metric expiry graceful deletion interval. No-op if METRIC_ROTATION_INTERVAL is disabled. | +
METRIC_ROTATION_INTERVAL |
+Time Duration | +0s |
+Metric scope rotation interval, set to 0 to disable the metric scope rotation | +
MONITORING_PORT |
+Integer | +15014 |
+HTTP port to serve prometheus metrics | +
MOUNTED_CNI_NET_DIR |
+String | +/host/etc/cni/net.d |
+Directory on the container where CNI networks are installed | +
MUTEX_PROFILE_FRACTION |
+Integer | +1000 |
+If set to a non-zero value, enables mutex profiling a rate of 1/MUTEX_PROFILE_FRACTION events. For example, '1000' will record 0.1% of events. Set to 0 to disable entirely. | +
NATIVE_METADATA_EXCHANGE |
+Boolean | +true |
+If set, uses a native implementation of the HTTP metadata exchange filter | +
NODE_NAME |
+String | + |
++ |
PILOT_ALLOW_SIDECAR_SERVICE_INBOUND_LISTENER_MERGE |
+Boolean | +false |
+If set, it allows creating inbound listeners for service ports and sidecar ingress listeners | +
PILOT_ANALYSIS_INTERVAL |
+Time Duration | +10s |
+If analysis is enabled, pilot will run istio analyzers using this value as interval in seconds Istio Resources | +
PILOT_CERT_PROVIDER |
+String | +istiod |
+The provider of Pilot DNS certificate. | +
PILOT_DEBOUNCE_AFTER |
+Time Duration | +100ms |
+The delay added to config/registry events for debouncing. This will delay the push by at least this interval. If no change is detected within this period, the push will happen, otherwise we'll keep delaying until things settle, up to a max of PILOT_DEBOUNCE_MAX. | +
PILOT_DEBOUNCE_MAX |
+Time Duration | +10s |
+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. | +
PILOT_DISTRIBUTION_HISTORY_RETENTION |
+Time Duration | +1m0s |
+If enabled, Pilot will keep track of old versions of distributed config for this duration. | +
PILOT_DRAINING_LABEL |
+String | +istio.io/draining |
+If not empty, endpoints with the label value present will be sent with status DRAINING. | +
PILOT_ENABLE_ALPHA_GATEWAY_API |
+Boolean | +false |
+If this is set to true, support for alpha APIs in the Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed. | +
PILOT_ENABLE_ALPN_FILTER |
+Boolean | +true |
+If true, pilot will add Istio ALPN filters, required for proper protocol sniffing. | +
PILOT_ENABLE_AMBIENT_CONTROLLERS |
+Boolean | +false |
+If enabled, controllers required for ambient will run. This is required to run ambient mesh. | +
PILOT_ENABLE_ANALYSIS |
+Boolean | +false |
+If enabled, pilot will run istio analyzers and write analysis errors to the Status field of any Istio Resources | +
PILOT_ENABLE_CDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache CDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE. | +
PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING |
+Boolean | +false |
+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. | +
PILOT_ENABLE_CROSS_CLUSTER_WORKLOAD_ENTRY |
+Boolean | +true |
+If enabled, pilot will read WorkloadEntry from other clusters, selectable by Services in that cluster. | +
PILOT_ENABLE_EDS_DEBOUNCE |
+Boolean | +true |
+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 | +
PILOT_ENABLE_EDS_FOR_HEADLESS_SERVICES |
+Boolean | +false |
+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. | +
PILOT_ENABLE_GATEWAY_API |
+Boolean | +true |
+If this is set to true, support for Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed. | +
PILOT_ENABLE_GATEWAY_API_DEPLOYMENT_CONTROLLER |
+Boolean | +true |
+If this is set to true, gateway-api resources will automatically provision in cluster deployment, services, etc | +
PILOT_ENABLE_GATEWAY_API_GATEWAYCLASS_CONTROLLER |
+Boolean | +true |
+If this is set to true, istiod will create and manage its default GatewayClasses | +
PILOT_ENABLE_GATEWAY_API_STATUS |
+Boolean | +true |
+If this is set to true, gateway-api resources will have status written to them | +
PILOT_ENABLE_HBONE |
+Boolean | +false |
+If enabled, HBONE support can be configured for proxies. Note: proxies must opt in on a per-proxy basis with ENABLE_HBONE to actually get HBONE config, in addition to this flag. | +
PILOT_ENABLE_HEADLESS_SERVICE_POD_LISTENERS |
+Boolean | +true |
+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. | +
PILOT_ENABLE_INBOUND_PASSTHROUGH |
+Boolean | +true |
+If enabled, inbound clusters will be configured as ORIGINAL_DST clusters. When disabled, requests are always sent to localhost. The primary implication of this is that when enabled, binding to POD_IP will work while localhost will not; when disable, bind to POD_IP will not work, while localhost will. The enabled behavior matches the behavior without Istio enabled at all; this flag exists only for backwards compatibility. Regardless of this setting, the configuration can be overridden with the Sidecar.Ingress.DefaultEndpoint configuration. | +
PILOT_ENABLE_K8S_SELECT_WORKLOAD_ENTRIES |
+Boolean | +true |
+If enabled, Kubernetes services with selectors will select workload entries with matching labels. It is safe to disable it if you are quite sure you don't need this feature | +
PILOT_ENABLE_METADATA_EXCHANGE |
+Boolean | +true |
+If true, pilot will add metadata exchange filters, which will be consumed by telemetry filter. | +
PILOT_ENABLE_MONGO_FILTER |
+Boolean | +true |
+EnableMongoFilter enables injection of `envoy.filters.network.mongo_proxy` in the filter chain. | +
PILOT_ENABLE_MYSQL_FILTER |
+Boolean | +false |
+EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain. | +
PILOT_ENABLE_PERSISTENT_SESSION_FILTER |
+Boolean | +false |
+If enabled, Istiod sets up persistent session filter for listeners, if services have 'PILOT_PERSISTENT_SESSION_LABEL' set. | +
PILOT_ENABLE_QUIC_LISTENERS |
+Boolean | +false |
+If true, QUIC listeners will be generated wherever there are listeners terminating TLS on gateways if the gateway service exposes a UDP port with the same number (for example 443/TCP and 443/UDP) | +
PILOT_ENABLE_RDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache RDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE. | +
PILOT_ENABLE_REDIS_FILTER |
+Boolean | +false |
+EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain. | +
PILOT_ENABLE_ROUTE_COLLAPSE_OPTIMIZATION |
+Boolean | +true |
+If true, Pilot will merge virtual hosts with the same routes into a single virtual host, as an optimization. | +
PILOT_ENABLE_SERVICEENTRY_SELECT_PODS |
+Boolean | +true |
+If enabled, service entries with selectors will select pods from the cluster. It is safe to disable it if you are quite sure you don't need this feature | +
PILOT_ENABLE_STATUS |
+Boolean | +false |
+If enabled, pilot will update the CRD Status field of all istio resources with reconciliation status. | +
PILOT_ENABLE_TELEMETRY_LABEL |
+Boolean | +true |
+If true, pilot will add telemetry related metadata to cluster and endpoint resources, which will be consumed by telemetry filter. | +
PILOT_ENABLE_WORKLOAD_ENTRY_AUTOREGISTRATION |
+Boolean | +true |
+Enables auto-registering WorkloadEntries based on associated WorkloadGroups upon XDS connection by the workload. | +
PILOT_ENABLE_WORKLOAD_ENTRY_HEALTHCHECKS |
+Boolean | +true |
+Enables automatic health checks of WorkloadEntries based on the config provided in the associated WorkloadGroup | +
PILOT_ENABLE_XDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache XDS responses. | +
PILOT_ENABLE_XDS_IDENTITY_CHECK |
+Boolean | +true |
+If enabled, pilot will authorize XDS clients, to ensure they are acting only as namespaces they have permissions for. | +
PILOT_ENDPOINT_TELEMETRY_LABEL |
+Boolean | +true |
+If true, pilot will add telemetry related metadata to Endpoint resource, which will be consumed by telemetry filter. | +
PILOT_ENVOY_FILTER_STATS |
+Boolean | +false |
+If true, Pilot will collect metrics for envoy filter operations. | +
PILOT_FILTER_GATEWAY_CLUSTER_CONFIG |
+Boolean | +false |
+If enabled, Pilot will send only clusters that referenced in gateway virtual services attached to gateway | +
PILOT_HTTP10 |
+Boolean | +false |
+Enables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications. | +
PILOT_INSECURE_MULTICLUSTER_KUBECONFIG_OPTIONS |
+String | + |
+Comma separated list of potentially insecure kubeconfig authentication options that are allowed for multicluster authentication.Support values: all authProviders (`gcp`, `azure`, `exec`, `openstack`), `clientKey`, `clientCertificate`, `tokenFile`, and `exec`. | +
PILOT_JWT_ENABLE_REMOTE_JWKS |
+String | +false |
+Mode of fetching JWKs from JwksUri in RequestAuthentication. Supported value: istiod, false, hybrid, true, envoy. The client fetching JWKs is as following: istiod/false - Istiod; hybrid/true - Envoy and fallback to Istiod if JWKs server is external; envoy - Envoy. | +
PILOT_JWT_PUB_KEY_REFRESH_INTERVAL |
+Time Duration | +20m0s |
+The interval for istiod to fetch the jwks_uri for the jwks public key. | +
PILOT_MAX_REQUESTS_PER_SECOND |
+Floating-Point | +25 |
+Limits the number of incoming XDS requests per second. On larger machines this can be increased to handle more proxies concurrently. | +
PILOT_MULTI_NETWORK_DISCOVER_GATEWAY_API |
+Boolean | +false |
+If true, Pilot will discover labeled Kubernetes gateway objects as multi-network gateways. | +
PILOT_PERSISTENT_SESSION_HEADER_LABEL |
+String | +istio.io/persistent-session-header |
+If not empty, services with this label will use header based persistent sessions | +
PILOT_PERSISTENT_SESSION_LABEL |
+String | +istio.io/persistent-session |
+If not empty, services with this label will use cookie based persistent sessions | +
PILOT_PUSH_THROTTLE |
+Integer | +100 |
+Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes | +
PILOT_REMOTE_CLUSTER_TIMEOUT |
+Time Duration | +30s |
+After this timeout expires, pilot can become ready without syncing data from clusters added via remote-secrets. Setting the timeout to 0 disables this behavior. | +
PILOT_SCOPE_GATEWAY_TO_NAMESPACE |
+Boolean | +false |
+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. | +
PILOT_SEND_UNHEALTHY_ENDPOINTS |
+Boolean | +false |
+If enabled, Pilot will include unhealthy endpoints in EDS pushes and even if they are sent Envoy does not use them for load balancing. To avoid, sending traffic to non ready endpoints, enabling this flag, disables panic threshold in Envoy i.e. Envoy does not load balance requests to unhealthy/non-ready hosts even if the percentage of healthy hosts fall below minimum health percentage(panic threshold). | +
PILOT_SIDECAR_USE_REMOTE_ADDRESS |
+Boolean | +false |
+UseRemoteAddress sets useRemoteAddress to true for sidecar outbound listeners. | +
PILOT_SKIP_VALIDATE_TRUST_DOMAIN |
+Boolean | +false |
+Skip validating the peer is from the same trust domain when mTLS is enabled in authentication policy | +
PILOT_STATUS_BURST |
+Integer | +500 |
+If status is enabled, controls the Burst rate with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config Burst | +
PILOT_STATUS_MAX_WORKERS |
+Integer | +100 |
+The maximum number of workers Pilot will use to keep configuration status up to date. Smaller numbers will result in higher status latency, but larger numbers may impact CPU in high scale environments. | +
PILOT_STATUS_QPS |
+Integer | +100 |
+If status is enabled, controls the QPS with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config QPS | +
PILOT_STATUS_UPDATE_INTERVAL |
+Time Duration | +500ms |
+Interval to update the XDS distribution status. | +
PILOT_TRACE_SAMPLING |
+Floating-Point | +1 |
+Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 1.0. | +
PILOT_WORKLOAD_ENTRY_GRACE_PERIOD |
+Time Duration | +10s |
+The amount of time an auto-registered workload can remain disconnected from all Pilot instances before the associated WorkloadEntry is cleaned up. | +
PILOT_XDS_CACHE_INDEX_CLEAR_INTERVAL |
+Time Duration | +5s |
+The interval for xds cache index clearing. | +
PILOT_XDS_CACHE_SIZE |
+Integer | +60000 |
+The maximum number of cache entries for the XDS cache. | +
PILOT_XDS_CACHE_STATS |
+Boolean | +false |
+If true, Pilot will collect metrics for XDS cache efficiency. | +
PILOT_XDS_SEND_TIMEOUT |
+Time Duration | +0s |
+The timeout to send the XDS configuration to proxies. After this timeout is reached, Pilot will discard that push. | +
POD_NAME |
+String | + |
++ |
REPAIR_BROKEN_POD_LABEL_KEY |
+String | +cni.istio.io/uninitialized |
+The key portion of the label which will be set by the ace repair if label pods is true | +
REPAIR_BROKEN_POD_LABEL_VALUE |
+String | +true |
+The value portion of the label which will be set by the race repair if label pods is true | +
REPAIR_DELETE_PODS |
+Boolean | +false |
+Controller will delete pods when detecting pod broken by race condition | +
REPAIR_ENABLED |
+Boolean | +true |
+Whether to enable race condition repair or not | +
REPAIR_FIELD_SELECTORS |
+String | + |
+A set of field selectors in label=value format that will be added to the pod list filters | +
REPAIR_INIT_CONTAINER_EXIT_CODE |
+Integer | +126 |
+Expected exit code for the init container when crash-looping because of CNI misconfiguration | +
REPAIR_INIT_CONTAINER_NAME |
+String | +istio-validation |
+The name of the istio init container (will crash-loop if CNI is not configured for the pod) | +
REPAIR_INIT_CONTAINER_TERMINATION_MESSAGE |
+String | + |
+The expected termination message for the init container when crash-looping because of CNI misconfiguration | +
REPAIR_LABEL_PODS |
+Boolean | +false |
+Controller will label pods when detecting pod broken by race condition | +
REPAIR_LABEL_SELECTORS |
+String | + |
+A set of label selectors in label=value format that will be added to the pod list filters | +
REPAIR_NODE_NAME |
+String | + |
+The name of the managed node (will manage all nodes if unset) | +
REPAIR_SIDECAR_ANNOTATION |
+String | +sidecar.istio.io/status |
+An annotation key that indicates this pod contains an istio sidecar. All pods without this annotation will be ignored.The value of the annotation is ignored. | +
RESOLVE_HOSTNAME_GATEWAYS |
+Boolean | +true |
+If true, hostnames in the LoadBalancer addresses of a Service will be resolved at the control plane for use in cross-network gateways. | +
REVISION |
+String | + |
++ |
SHARED_MESH_CONFIG |
+String | + |
+Additional config map to load for shared MeshConfig settings. The standard mesh config will take precedence. | +
SKIP_TLS_VERIFY |
+Boolean | +false |
+Whether to use insecure TLS in kubeconfig file | +
SYSTEM_NAMESPACE |
+String | +istio-system |
+pod's namespace | +
TRUSTED_GATEWAY_CIDR |
+String | + |
+If set, any connections from gateway to Istiod with this CIDR range are treated as trusted for using authentication mechanisms like XFCC. This can only be used when the network where Istiod and the authenticating gateways are running in a trusted/secure network | +
UNSAFE_ENABLE_ADMIN_ENDPOINTS |
+Boolean | +false |
+If this is set to true, dangerous admin endpoints will be exposed on the debug interface. Not recommended for production. | +
UNSAFE_PILOT_ENABLE_DELTA_TEST |
+Boolean | +false |
+If enabled, addition runtime tests for Delta XDS efficiency are added. These checks are extremely expensive, so this should be used only for testing, not production. | +
UNSAFE_PILOT_ENABLE_RUNTIME_ASSERTIONS |
+Boolean | +false |
+If enabled, addition runtime asserts will be performed. These checks are both expensive and panic on failure. As a result, this should be used only for testing. | +
VALIDATION_WEBHOOK_CONFIG_NAME |
+String | +istio-istio-system |
+If not empty, the controller will automatically patch validatingwebhookconfiguration when the CA certificate changes. Only works in kubernetes environment. | +
VERIFY_CERTIFICATE_AT_CLIENT |
+Boolean | +false |
+If enabled, certificates received by the proxy will be verified against the OS CA certificate bundle. | +
VERIFY_SDS_CERTIFICATE |
+Boolean | +true |
+If enabled, certificates fetched from SDS server will be verified before sending back to proxy. | +
XDS_AUTH |
+Boolean | +true |
+If true, will authenticate XDS clients. | +
| Metric Name | Type | Description |
|---|---|---|
controller_sync_errors_total | Sum | Total number of errorMetric syncing controllers. |
endpoint_no_pod | LastValue | Endpoints without an associated pod. |
istio_build | LastValue | Istio component build info |
istio_cni_install_ready | LastValue | Whether the CNI plugin installation is ready or not |
istio_cni_installs_total | Sum | Total number of CNI plugins installed by the Istio CNI installer |
istio_cni_repair_pods_repaired_total | Sum | Total number of pods repaired by repair controller |
pilot_conflict_inbound_listener | LastValue | Number of conflicting inbound listeners. |
pilot_conflict_outbound_listener_tcp_over_current_tcp | LastValue | Number of conflicting tcp listeners with current tcp listener. |
pilot_destrule_subsets | LastValue | Duplicate subsets across destination rules for same host |
pilot_dns_cluster_without_endpoints | LastValue | DNS clusters without endpoints caused by the endpoint field in STRICT_DNS type cluster is not set or the corresponding subset cannot select any endpoint |
pilot_duplicate_envoy_clusters | LastValue | Duplicate envoy clusters caused by service entries with same hostname |
pilot_eds_no_instances | LastValue | Number of clusters without instances. |
pilot_endpoint_not_ready | LastValue | Endpoint found in unready state. |
pilot_jwks_resolver_network_fetch_fail_total | Sum | Total number of failed network fetch by pilot jwks resolver |
pilot_jwks_resolver_network_fetch_success_total | Sum | Total number of successfully network fetch by pilot jwks resolver |
pilot_no_ip | LastValue | Pods not found in the endpoint table, possibly invalid. |
pilot_total_rejected_configs | Sum | Total number of configs that Pilot had to reject or ignore. |
pilot_virt_services | LastValue | Total virtual services known to pilot. |
pilot_vservice_dup_domain | LastValue | Virtual services with dup domains. |
provider_lookup_cluster_failures | Sum | Number of times a cluster lookup failed |
xds_cache_dependent_config_size | LastValue | Current size of dependent configs |
xds_cache_evictions | Sum | Total number of xds cache evictions. |
xds_cache_reads | Sum | Total number of xds cache xdsCacheReads. |
xds_cache_size | LastValue | Current size of xds cache |
Istio configuration command line utility for service operators to +debug and diagnose their Istio mesh. +
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
A group of commands used to manage istiod configuration
+istioctl admin [flags]
+istioctl istiod [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--selector <string> |
+-l |
+label selector (default `app=istiod`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Retrieve information about istiod configuration.
+ istioctl admin log
+Retrieve or update logging levels of istiod components.
+istioctl admin log [<pod-name>]|[-r|--revision] [--level <scope>:<level>][--stack-trace-level <scope>:<level>]|[--reset]|[--output|-o short|json|yaml] [flags]
+istioctl admin l [<pod-name>]|[-r|--revision] [--level <scope>:<level>][--stack-trace-level <scope>:<level>]|[--reset]|[--output|-o short|json|yaml] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--ctrlz_port <int> |
++ | ControlZ port (default `9876`) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--level <string> |
++ | Comma-separated list of output logging level for scopes in format <scope>:<level>[,<scope>:<level>,...]Possible values for <level>: none, error, warn, info, debug (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--reset |
++ | Reset levels to default value. (info) | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--selector <string> |
+-l |
+label selector (default `app=istiod`) | +
--stack-trace-level <string> |
++ | Comma-separated list of stack trace level for scopes in format <scope>:<stack-trace-level>[,<scope>:<stack-trace-level>,...] Possible values for <stack-trace-level>: none, error, warn, info, debug (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Retrieve information about istiod logging levels.
+ istioctl admin log
+
+ # Retrieve information about istiod logging levels on a specific control plane pod.
+ istioctl admin l istiod-5c868d8bdd-pmvgg
+
+ # Update levels of the specified loggers.
+ istioctl admin log --level ads:debug,authorization:debug
+
+ # Retrieve information about istiod logging levels for a specified revision.
+ istioctl admin log --revision v1
+
+ # Reset levels of all the loggers to default value (info).
+ istioctl admin log --reset
+
+Analyze Istio configuration and print validation messages
+istioctl analyze <file>... [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--all-namespaces |
+-A |
+Analyze all namespaces | +
--color |
++ | Default true. Disable with '=false' or set $TERM to dumb | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--failure-threshold <Level> |
++ | The severity level of analysis at which to set a non-zero exit code. Valid values: [Info Warning Error] (default `Error`) | +
--ignore-unknown |
++ | Don't complain about un-parseable input documents, for cases where analyze should run only on k8s compliant inputs. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--list-analyzers |
+-L |
+List the analyzers available to run. Suppresses normal execution. | +
--meshConfigFile <string> |
++ | Overrides the mesh config values to use for analysis. (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of [log json yaml] (default `log`) | +
--output-threshold <Level> |
++ | The severity level of analysis at which to display messages. Valid values: [Info Warning Error] (default `Info`) | +
--recursive |
+-R |
+Process directory arguments recursively. Useful when you want to analyze related manifests organized within the same directory. | +
--revision <string> |
++ | analyze a specific revision deployed. (default `default`) | +
--suppress <stringArray> |
+-S |
+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 `[]`) | +
--timeout <duration> |
++ | The duration to wait before failing (default `30s`) | +
--use-kube |
+-k |
+Use live Kubernetes cluster for analysis. Set --use-kube=false to analyze files only. | +
--verbose |
+-v |
+Enable verbose output | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Analyze the current live cluster
+ istioctl analyze
+
+ # Analyze the current live cluster for a specific revision
+ istioctl analyze --revision 1-16
+
+ # Analyze the current live cluster, simulating the effect of applying additional yaml files
+ istioctl analyze a.yaml b.yaml my-app-config/
+
+ # Analyze the current live cluster, simulating the effect of applying a directory of config recursively
+ istioctl analyze --recursive my-istio-config/
+
+ # Analyze yaml files without connecting to a live cluster
+ istioctl analyze --use-kube=false a.yaml b.yaml my-app-config/
+
+ # Analyze the current live cluster and suppress PodMissingProxy for pod mypod in namespace 'testing'.
+ istioctl analyze -S "IST0103=Pod mypod.testing"
+
+ # Analyze the current live cluster and suppress PodMissingProxy for all pods in namespace 'testing',
+ # and suppress MisplacedAnnotation on deployment foobar in namespace default.
+ istioctl analyze -S "IST0103=Pod *.testing" -S "IST0107=Deployment foobar.default"
+
+ # List available analyzers
+ istioctl analyze -L
+(authz is experimental. Use `istioctl experimental authz`)
+istioctl authz [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
bug-report selectively captures cluster information and logs into an archive to help diagnose problems. +Proxy logs can be filtered using: + --include|--exclude ns1,ns2.../dep1,dep2.../pod1,pod2.../lbl1=val1,lbl2=val2.../ann1=val1,ann2=val2.../cntr1,cntr... +where ns=namespace, dep=deployment, lbl=label, ann=annotation, cntr=container
+The filter spec is interpreted as 'must be in (ns1 OR ns2) AND (dep1 OR dep2) AND (cntr1 OR cntr2)...' +The log will be included only if the container matches at least one include filter and does not match any exclude filters. +All parts of the filter are optional and can be omitted e.g. ns1//pod1 filters only for namespace ns1 and pod1. +All names except label and annotation keys support '*' glob matching pattern.
+e.g. +--include ns1,ns2 (only namespaces ns1 and ns2) +--include n*//p*/l=v* (pods with name beginning with 'p' in namespaces beginning with 'n' and having label 'l' with value beginning with 'v'.)
+istioctl bug-report [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Name of the kubeconfig Context to use. (default ``) | +
--critical-errs <stringSlice> |
++ | List of comma separated glob patterns to match against log error strings. If any pattern matches an error in the log, the logs is given the highest priority for archive inclusion. (default `[]`) | +
--dir <string> |
++ | Set a specific directory for temporary artifact storage. (default ``) | +
--dry-run |
++ | Only log commands that would be run, don't fetch or write. | +
--duration <duration> |
++ | How far to go back in time from end-time for log entries to include in the archive. Default is infinity. If set, --start-time must be unset. (default `0s`) | +
--end-time <string> |
++ | End time for the range of log entries to include in the archive. Default is now. (default ``) | +
--exclude <stringSlice> |
++ | Spec for which pod's proxy logs to exclude from the archive, after the include spec is processed. See above for format and examples. (default `["kube-node-lease,kube-public,kube-system,local-path-storage"]`) | +
--filename <string> |
+-f |
+Path to a file containing configuration in YAML format. The file contents are applied over the default values and flag settings, with lists being replaced per JSON merge semantics. (default ``) | +
--full-secrets |
++ | If set, secret contents are included in output. | +
--ignore-errs <stringSlice> |
++ | List of comma separated glob patterns to match against log error strings. Any error matching these patterns is ignored when calculating the log importance heuristic. (default `[]`) | +
--include <stringSlice> |
++ | Spec for which pod's proxy logs to include in the archive. See above for format and examples. (default `[]`) | +
--istio-namespace <string> |
++ | Namespace where Istio control plane is installed. (default `istio-system`) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Path to kube config. (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output-dir <string> |
++ | Set a specific directory for output archive file. (default ``) | +
--rps-limit <int> |
++ | Requests per second limit to the Kubernetes API server, defaults to 10.A higher limit can make bug report collection much faster. (default `0`) | +
--start-time <string> |
++ | Start time for the range of log entries to include in the archive. Default is the infinite past. If set, --duration must be unset. (default ``) | +
--timeout <duration> |
++ | Maximum amount of time to spend fetching logs. When timeout is reached only the logs captured so far are saved to the archive. (default `30m0s`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Prints out build version information
+istioctl bug-report version [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Name of the kubeconfig Context to use. (default ``) | +
--critical-errs <stringSlice> |
++ | List of comma separated glob patterns to match against log error strings. If any pattern matches an error in the log, the logs is given the highest priority for archive inclusion. (default `[]`) | +
--dir <string> |
++ | Set a specific directory for temporary artifact storage. (default ``) | +
--dry-run |
++ | Only log commands that would be run, don't fetch or write. | +
--duration <duration> |
++ | How far to go back in time from end-time for log entries to include in the archive. Default is infinity. If set, --start-time must be unset. (default `0s`) | +
--end-time <string> |
++ | End time for the range of log entries to include in the archive. Default is now. (default ``) | +
--exclude <stringSlice> |
++ | Spec for which pod's proxy logs to exclude from the archive, after the include spec is processed. See above for format and examples. (default `["kube-node-lease,kube-public,kube-system,local-path-storage"]`) | +
--filename <string> |
+-f |
+Path to a file containing configuration in YAML format. The file contents are applied over the default values and flag settings, with lists being replaced per JSON merge semantics. (default ``) | +
--full-secrets |
++ | If set, secret contents are included in output. | +
--ignore-errs <stringSlice> |
++ | List of comma separated glob patterns to match against log error strings. Any error matching these patterns is ignored when calculating the log importance heuristic. (default `[]`) | +
--include <stringSlice> |
++ | Spec for which pod's proxy logs to include in the archive. See above for format and examples. (default `[]`) | +
--istio-namespace <string> |
++ | Namespace where Istio control plane is installed. (default `istio-system`) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Path to kube config. (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+One of 'yaml' or 'json'. (default ``) | +
--output-dir <string> |
++ | Set a specific directory for output archive file. (default ``) | +
--rps-limit <int> |
++ | Requests per second limit to the Kubernetes API server, defaults to 10.A higher limit can make bug report collection much faster. (default `0`) | +
--short |
+-s |
+Use --short=false to generate full version information | +
--start-time <string> |
++ | Start time for the range of log entries to include in the archive. Default is the infinite past. If set, --duration must be unset. (default ``) | +
--timeout <duration> |
++ | Maximum amount of time to spend fetching logs. When timeout is reached only the logs captured so far are saved to the archive. (default `30m0s`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for istioctl for the specified shell. +See each sub-command's help for details on how to use the generated script. +
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the bash shell.
+This script depends on the 'bash-completion' package. +If it is not installed already, you can install it via your OS's package manager.
+To load completions in your current shell session:
+source <(istioctl completion bash)
+To load completions for every new session, execute once:
+#### Linux:
+istioctl completion bash > /etc/bash_completion.d/istioctl
+#### macOS:
+istioctl completion bash > $(brew --prefix)/etc/bash_completion.d/istioctl
+You will need to start a new shell for this setup to take effect. +
+istioctl completion bash
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--no-descriptions |
++ | disable completion descriptions | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the fish shell.
+To load completions in your current shell session:
+istioctl completion fish | source
+To load completions for every new session, execute once:
+istioctl completion fish > ~/.config/fish/completions/istioctl.fish
+You will need to start a new shell for this setup to take effect. +
+istioctl completion fish [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--no-descriptions |
++ | disable completion descriptions | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for powershell.
+To load completions in your current shell session:
+istioctl completion powershell | Out-String | Invoke-Expression
+To load completions for every new session, add the output of the above command +to your powershell profile. +
+istioctl completion powershell [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--no-descriptions |
++ | disable completion descriptions | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the zsh shell.
+If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once:
+echo "autoload -U compinit; compinit" >> ~/.zshrc
+To load completions in your current shell session:
+source <(istioctl completion zsh)
+To load completions for every new session, execute once:
+#### Linux:
+istioctl completion zsh > "${fpath[1]}/_istioctl"
+#### macOS:
+istioctl completion zsh > $(brew --prefix)/share/zsh/site-functions/_istioctl
+You will need to start a new shell for this setup to take effect. +
+istioctl completion zsh [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--no-descriptions |
++ | disable completion descriptions | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Create a secret with credentials to allow Istio to access remote Kubernetes apiservers
+istioctl create-remote-secret [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--auth-plugin-config <stringToString> |
++ | Authenticator plug-in configuration. --auth-type=plugin must be set with this option (default `[]`) | +
--auth-plugin-name <string> |
++ | Authenticator plug-in name. --auth-type=plugin must be set with this option (default ``) | +
--auth-type <RemoteSecretAuthType> |
++ | Type of authentication to use. supported values = [bearer-token plugin] (default `bearer-token`) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--create-service-account |
++ | If true, the service account needed for creating the remote secret will be created if it doesn't exist. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). (default ``) | +
--name <string> |
++ | Name of the local cluster whose credentials are stored in the secret. If a name is not specified the kube-system namespace's UUID of the local cluster will be used. (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--secret-name <string> |
++ | The name of the specific secret to use from the service-account. Needed when there are multiple secrets in the service account. (default ``) | +
--server <string> |
++ | The address and port of the Kubernetes API server. (default ``) | +
--service-account <string> |
++ | Create a secret with this service account's credentials. Default value is "istio-reader-service-account" if --type is "remote", "istiod" if --type is "config". (default ``) | +
--type <SecretType> |
++ | Type of the generated secret. supported values = [remote config] (default `remote`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Create a secret to access cluster c0's apiserver and install it in cluster c1.
+ istioctl --kubeconfig=c0.yaml create-remote-secret --name c0 \
+ | kubectl --kubeconfig=c1.yaml apply -f -
+
+ # Delete a secret that was previously installed in c1
+ istioctl --kubeconfig=c0.yaml create-remote-secret --name c0 \
+ | kubectl --kubeconfig=c1.yaml delete -f -
+
+ # Create a secret access a remote cluster with an auth plugin
+ istioctl --kubeconfig=c0.yaml create-remote-secret --name c0 --auth-type=plugin --auth-plugin-name=gcp \
+ | kubectl --kubeconfig=c1.yaml apply -f -
+Access to Istio web UIs
+istioctl dashboard [flags]
+istioctl dash [flags]
+istioctl d [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`) | +
--browser |
++ | When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`) | +
--port <int> |
+-p |
+Local port to listen to (default `0`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Open the ControlZ web UI for a pod in the Istio control plane
+istioctl dashboard controlz [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`) | +
--browser |
++ | When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--ctrlz_port <int> |
++ | ControlZ port (default `9876`) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`) | +
--port <int> |
+-p |
+Local port to listen to (default `0`) | +
--selector <string> |
+-l |
+Label selector (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Open ControlZ web UI for the istiod-123-456.istio-system pod
+ istioctl dashboard controlz istiod-123-456.istio-system
+
+ # Open ControlZ web UI for the istiod-56dd66799-jfdvs pod in a custom namespace
+ istioctl dashboard controlz istiod-123-456 -n custom-ns
+
+ # Open ControlZ web UI for any Istiod pod
+ istioctl dashboard controlz deployment/istiod.istio-system
+
+ # with short syntax
+ istioctl dash controlz pilot-123-456.istio-system
+ istioctl d controlz pilot-123-456.istio-system
+
+Open the Envoy admin dashboard for a sidecar
+istioctl dashboard envoy [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`) | +
--browser |
++ | When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Namespace where the addon is running, if not specified, istio-system would be used (default ``) | +
--port <int> |
+-p |
+Local port to listen to (default `0`) | +
--selector <string> |
+-l |
+Label selector (default ``) | +
--ui-port <int> |
++ | The component dashboard UI port. (default `15000`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Open Envoy dashboard for the productpage-123-456.default pod
+ istioctl dashboard envoy productpage-123-456.default
+
+ # Open Envoy dashboard for one pod under a deployment
+ istioctl dashboard envoy deployment/productpage-v1
+
+ # with short syntax
+ istioctl dash envoy productpage-123-456.default
+ istioctl d envoy productpage-123-456.default
+
+Open Istio's Grafana dashboard
+istioctl dashboard grafana [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`) | +
--browser |
++ | When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`) | +
--port <int> |
+-p |
+Local port to listen to (default `0`) | +
--ui-port <int> |
++ | The component dashboard UI port. (default `3000`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl dashboard grafana
+
+ # with short syntax
+ istioctl dash grafana
+ istioctl d grafana
+Open Istio's Jaeger dashboard
+istioctl dashboard jaeger [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`) | +
--browser |
++ | When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`) | +
--port <int> |
+-p |
+Local port to listen to (default `0`) | +
--ui-port <int> |
++ | The component dashboard UI port. (default `16686`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl dashboard jaeger
+
+ # with short syntax
+ istioctl dash jaeger
+ istioctl d jaeger
+Open Istio's Kiali dashboard
+istioctl dashboard kiali [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`) | +
--browser |
++ | When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`) | +
--port <int> |
+-p |
+Local port to listen to (default `0`) | +
--ui-port <int> |
++ | The component dashboard UI port. (default `20001`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl dashboard kiali
+
+ # with short syntax
+ istioctl dash kiali
+ istioctl d kiali
+Open Istio's Prometheus dashboard
+istioctl dashboard prometheus [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`) | +
--browser |
++ | When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`) | +
--port <int> |
+-p |
+Local port to listen to (default `0`) | +
--ui-port <int> |
++ | The component dashboard UI port. (default `9090`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl dashboard prometheus
+
+ # with short syntax
+ istioctl dash prometheus
+ istioctl d prometheus
+Open the Istio dashboard in the SkyWalking UI
+istioctl dashboard skywalking [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`) | +
--browser |
++ | When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`) | +
--port <int> |
+-p |
+Local port to listen to (default `0`) | +
--ui-port <int> |
++ | The component dashboard UI port. (default `8080`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl dashboard skywalking
+
+ # with short syntax
+ istioctl dash skywalking
+ istioctl d skywalking
+Open Istio's Zipkin dashboard
+istioctl dashboard zipkin [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`) | +
--browser |
++ | When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`) | +
--port <int> |
+-p |
+Local port to listen to (default `0`) | +
--ui-port <int> |
++ | The component dashboard UI port. (default `9411`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl dashboard zipkin
+
+ # with short syntax
+ istioctl dash zipkin
+ istioctl d zipkin
+Experimental commands that may be modified or deprecated
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Check prints the AuthorizationPolicy applied to a pod by directly checking +the Envoy configuration of the pod. The command is especially useful for inspecting +the policy propagation from Istiod to Envoy and the final AuthorizationPolicy list merged +from multiple sources (mesh-level, namespace-level and workload-level).
+The command also supports reading from a standalone config dump file with flag -f.
+istioctl experimental authz check [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--file <string> |
+-f |
+The json file with Envoy config dump to be checked (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Check AuthorizationPolicy applied to pod httpbin-88ddbcfdd-nt5jb:
+ istioctl x authz check httpbin-88ddbcfdd-nt5jb
+
+ # Check AuthorizationPolicy applied to one pod under a deployment
+ istioctl x authz check deployment/productpage-v1
+
+ # Check AuthorizationPolicy from Envoy config dump file:
+ istioctl x authz check -f httpbin_config_dump.json
++Checks associated resources of the given resource, and running webhooks to examine whether the pod can be or will be injected or not.
+istioctl experimental check-inject [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--labels <string> |
+-l |
+Check namespace and label pairs injection status, split multiple labels by commas (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Check the injection status of a pod
+ istioctl experimental check-inject details-v1-fcff6c49c-kqnfk.test
+
+ # Check the injection status of a pod under a deployment
+ istioctl x check-inject deployment/details-v1
+
+ # Check the injection status of a pod under a deployment in namespace test
+ istioctl x check-inject deployment/details-v1 -n test
+
+ # Check the injection status of label pairs in a specific namespace before actual injection
+ istioctl x check-inject -n test -l app=helloworld,version=v1
+
+Configure istioctl defaults
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# list configuration parameters
+ istioctl experimental config list
+List istio configurable defaults
+istioctl experimental config list [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Describe resource and related Istio configuration
+istioctl experimental describe [flags]
+istioctl experimental des [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Analyzes pod, its Services, DestinationRules, and VirtualServices and reports +the configuration objects that affect that pod.
+THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
+istioctl experimental describe pod <pod> [flags]
+istioctl experimental describe po <pod> [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--ignoreUnmeshed |
++ | Suppress warnings for unmeshed pods | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl experimental describe pod productpage-v1-c7765c886-7zzd4
+Analyzes service, pods, DestinationRules, and VirtualServices and reports +the configuration objects that affect that service.
+THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
+istioctl experimental describe service <svc> [flags]
+istioctl experimental describe svc <svc> [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--ignoreUnmeshed |
++ | Suppress warnings for unmeshed pods | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl experimental describe service productpage
+Retrieve Envoy emitted metrics for the specified pod.
+istioctl experimental envoy-stats [<type>/]<name>[.<namespace>] [flags]
+istioctl experimental es [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|prom|prom-merged (default `short`) | +
--type <string> |
+-t |
+Where to grab the stats: one of server|clusters (default `server`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Retrieve Envoy emitted metrics for the specified pod.
+ istioctl experimental envoy-stats <pod-name[.namespace]>
+
+ # Retrieve Envoy server metrics in prometheus format
+ istioctl experimental envoy-stats <pod-name[.namespace]> --output prom
+
+ # Retrieve Envoy server metrics in prometheus format with merged application metrics
+ istioctl experimental envoy-stats <pod-name[.namespace]> --output prom-merged
+
+ # Retrieve Envoy cluster metrics
+ istioctl experimental envoy-stats <pod-name[.namespace]> --type clusters
+
+List sidecar injector and sidecar versions
+istioctl experimental injector [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl experimental injector list
+List sidecar injector and sidecar versions
+istioctl experimental injector list [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl experimental injector list
++Retrieves the debug information from Istiod or Pods in the mesh using the service account from the pod if --cert-dir is empty. +By default it will use the default serviceAccount from (istio-system) namespace if the pod is not specified.
++THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
+istioctl experimental internal-debug [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--all |
++ | Send the same request to all instances of Istiod. Only applicable for in-cluster deployment. | +
--authority <string> |
++ | XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``) | +
--cert-dir <string> |
++ | XDS Endpoint certificate directory (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--insecure |
++ | Skip server certificate and domain verification. (NOT SECURE!) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--plaintext |
++ | Use plain-text HTTP/2 when connecting to server (no TLS). | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--timeout <duration> |
++ | The duration to wait before failing (default `30s`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
--xds-address <string> |
++ | XDS Endpoint (default ``) | +
--xds-label <string> |
++ | Istiod pod label selector (default ``) | +
--xds-port <int> |
++ | Istiod pod port (default `15012`) | +
# Retrieve sync status for all Envoys in a mesh
+ istioctl x internal-debug syncz
+
+ # Retrieve sync diff for a single Envoy and Istiod
+ istioctl x internal-debug syncz istio-egressgateway-59585c5b9c-ndc59.istio-system
+
+ # SECURITY OPTIONS
+
+ # Retrieve syncz debug information directly from the control plane, using token security
+ # (This is the usual way to get the debug information with an out-of-cluster control plane.)
+ istioctl x internal-debug syncz --xds-address istio.cloudprovider.example.com:15012
+
+ # Retrieve syncz debug information via Kubernetes config, using token security
+ # (This is the usual way to get the debug information with an in-cluster control plane.)
+ istioctl x internal-debug syncz
+
+ # Retrieve syncz debug information directly from the control plane, using RSA certificate security
+ # (Certificates must be obtained before this step. The --cert-dir flag lets istioctl bypass the Kubernetes API server.)
+ istioctl x internal-debug syncz --xds-address istio.example.com:15012 --cert-dir ~/.istio-certs
+
+ # Retrieve syncz information via XDS from specific control plane in multi-control plane in-cluster configuration
+ # (Select a specific control plane in an in-cluster canary Istio configuration.)
+ istioctl x internal-debug syncz --xds-label istio.io/rev=default
+
++Prints the metrics for the specified service(s) when running in Kubernetes.
+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.
+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. +
+istioctl experimental metrics <workload name>...
+istioctl experimental m <workload name>...
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--duration <duration> |
+-d |
+Duration of query metrics, default value is 1m. (default `1m0s`) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Retrieve workload metrics for productpage-v1 workload
+ istioctl experimental metrics productpage-v1
+
+ # Retrieve workload metrics for various services with custom duration
+ istioctl experimental metrics productpage-v1 -d 2m
+
+ # Retrieve workload metrics for various services in the different namespaces
+ istioctl experimental metrics productpage-v1.foo reviews-v1.bar ratings-v1.baz
+precheck inspects a Kubernetes cluster for Istio install and upgrade requirements.
+istioctl experimental precheck [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of [log json yaml] (default `log`) | +
--output-threshold <Level> |
++ | The severity level of precheck at which to display messages. Valid values: [Info Warning Error] (default `Warning`) | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--skip-controlplane |
++ | skip checking the control plane | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Verify that Istio can be installed or upgraded
+ istioctl x precheck
+
+ # Check only a single namespace
+ istioctl x precheck --namespace default
++Retrieves last sent and last acknowledged xDS sync from Istiod to each Envoy in the mesh +
+istioctl experimental proxy-status [<type>/]<name>[.<namespace>] [flags]
+istioctl experimental ps [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--authority <string> |
++ | XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``) | +
--cert-dir <string> |
++ | XDS Endpoint certificate directory (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--file <string> |
+-f |
+Envoy config dump JSON file (default ``) | +
--insecure |
++ | Skip server certificate and domain verification. (NOT SECURE!) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--plaintext |
++ | Use plain-text HTTP/2 when connecting to server (no TLS). | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--timeout <duration> |
++ | The duration to wait before failing (default `30s`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
--xds-address <string> |
++ | XDS Endpoint (default ``) | +
--xds-label <string> |
++ | Istiod pod label selector (default ``) | +
--xds-port <int> |
++ | Istiod pod port (default `15012`) | +
--xds-via-agents |
++ | Access Istiod via the tap service of each agent | +
--xds-via-agents-limit <xds-via-agent> |
++ | Maximum number of pods being visited by istioctl when xds-via-agent flag is true.To iterate all the agent pods without limit, set to 0 (default `100`) | +
# Retrieve sync status for all Envoys in a mesh
+ istioctl x proxy-status
+
+ # Retrieve sync diff for a single Envoy and Istiod
+ istioctl x proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system
+
+ # SECURITY OPTIONS
+
+ # Retrieve proxy status information directly from the control plane, using token security
+ # (This is the usual way to get the proxy-status with an out-of-cluster control plane.)
+ istioctl x ps --xds-address istio.cloudprovider.example.com:15012
+
+ # Retrieve proxy status information via Kubernetes config, using token security
+ # (This is the usual way to get the proxy-status with an in-cluster control plane.)
+ istioctl x proxy-status
+
+ # Retrieve proxy status information directly from the control plane, using RSA certificate security
+ # (Certificates must be obtained before this step. The --cert-dir flag lets istioctl bypass the Kubernetes API server.)
+ istioctl x ps --xds-address istio.example.com:15012 --cert-dir ~/.istio-certs
+
+ # Retrieve proxy status information via XDS from specific control plane in multi-control plane in-cluster configuration
+ # (Select a specific control plane in an in-cluster canary Istio configuration.)
+ istioctl x ps --xds-label istio.io/rev=default
+
+The revision command provides a revision centric view of istio deployments. It provides insight into IstioOperator CRs defining the revision, istiod and gateway pods which are part of deployment of a particular revision.
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format for revision description (available formats: table,json) (default `table`) | +
--verbose |
+-v |
+Enable verbose output | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Show information about a revision, including customizations, istiod version and which pods/gateways are using it.
+istioctl experimental revision describe [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format for revision description (available formats: table,json) (default `table`) | +
--verbose |
+-v |
+Enable verbose output | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# View the details of a revision named 'canary'
+ istioctl x revision describe canary
+
+ # View the details of a revision named 'canary' and also the pods
+ # under that particular revision
+ istioctl x revision describe canary -v
+
+ # Get details about a revision in json format (default format is human-friendly table format)
+ istioctl x revision describe canary -v -o json
+
+Show list of control plane and gateway revisions that are currently installed in cluster
+istioctl experimental revision list [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format for revision description (available formats: table,json) (default `table`) | +
--verbose |
+-v |
+Enable verbose output | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# View summary of revisions installed in the current cluster
+ # which can be overridden with --context parameter.
+ istioctl x revision list
+
+ # View list of revisions including customizations, istiod and gateway pods
+ istioctl x revision list -v
+
+Prints out build version information
+istioctl experimental version [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--authority <string> |
++ | XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``) | +
--cert-dir <string> |
++ | XDS Endpoint certificate directory (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--insecure |
++ | Skip server certificate and domain verification. (NOT SECURE!) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+One of 'yaml' or 'json'. (default ``) | +
--plaintext |
++ | Use plain-text HTTP/2 when connecting to server (no TLS). | +
--remote |
++ | Use --remote=false to suppress control plane check | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--short |
+-s |
+Use --short=false to generate full version information | +
--timeout <duration> |
++ | The duration to wait before failing (default `30s`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
--xds-address <string> |
++ | XDS Endpoint (default ``) | +
--xds-label <string> |
++ | Istiod pod label selector (default ``) | +
--xds-port <int> |
++ | Istiod pod port (default `15012`) | +
# Retrieve version information directly from the control plane, using token security
+ # (This is the usual way to get the control plane version with an out-of-cluster control plane.)
+ istioctl x version --xds-address istio.cloudprovider.example.com:15012
+
+ # Retrieve version information via Kubernetes config, using token security
+ # (This is the usual way to get the control plane version with an in-cluster control plane.)
+ istioctl x version
+
+ # Retrieve version information directly from the control plane, using RSA certificate security
+ # (Certificates must be obtained before this step. The --cert-dir flag lets istioctl bypass the Kubernetes API server.)
+ istioctl x version --xds-address istio.example.com:15012 --cert-dir ~/.istio-certs
+
+ # Retrieve version information via XDS from specific control plane in multi-control plane in-cluster configuration
+ # (Select a specific control plane in an in-cluster canary Istio configuration.)
+ istioctl x version --xds-label istio.io/rev=default
+
+Waits for the specified condition to be true of an Istio resource.
+istioctl experimental wait [flags] <type> <name>[.<namespace>]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--for <string> |
++ | Wait condition, must be 'distribution' or 'delete' (default `distribution`) | +
--generation <string> |
++ | Wait for a specific generation of config to become current, rather than using whatever is latest in Kubernetes (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--threshold <float32> |
++ | The ratio of distribution required for success (default `1`) | +
--timeout <duration> |
++ | The duration to wait before failing (default `30s`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# 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=300s virtualservice bookinfo.default
+
+A group of commands used to manage waypoint configuration
+istioctl experimental waypoint [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--service-account <string> |
+-s |
+service account to create a waypoint for (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Apply a waypoint to the current namespace
+ istioctl x waypoint apply
+
+ # Generate a waypoint as yaml
+ istioctl x waypoint generate --service-account something --namespace default
+
+ # Delete a waypoint from a specific namespace for a specific service account
+ istioctl x waypoint delete --service-account something --namespace default
+
+ # List all waypoints in a specific namespace
+ istioctl x waypoint list --namespace default
+Apply a waypoint configuration to the cluster
+istioctl experimental waypoint apply [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--revision <string> |
+-r |
+The revision to label the waypoint with (default ``) | +
--service-account <string> |
+-s |
+service account to create a waypoint for (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Apply a waypoint to the current namespace
+ istioctl x waypoint apply
+
+ # Apply a waypoint to a specific namespace for a specific service account
+ istioctl x waypoint apply --service-account something --namespace default
+Delete a waypoint configuration from the cluster
+istioctl experimental waypoint delete [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--service-account <string> |
+-s |
+service account to create a waypoint for (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Delete a waypoint from the default namespace
+ istioctl x waypoint delete
+
+ # Delete a waypoint from a specific namespace for a specific service account
+ istioctl x waypoint delete --service-account something --namespace default
+
+ # Delete a waypoint by name, which can obtain from istioctl x waypoint list
+ istioctl x waypoint delete waypoint-name --namespace default
+Generate a waypoint configuration as YAML
+istioctl experimental waypoint generate [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--revision <string> |
+-r |
+The revision to label the waypoint with (default ``) | +
--service-account <string> |
+-s |
+service account to create a waypoint for (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Generate a waypoint as yaml
+ istioctl x waypoint generate --service-account something --namespace default
+List managed waypoint configurations in the cluster
+istioctl experimental waypoint list [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--all-namespaces |
+-A |
+List all waypoints in all namespaces | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--service-account <string> |
+-s |
+service account to create a waypoint for (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# List all waypoints in a specific namespace
+ istioctl x waypoint list --namespace default
+
+ # List all waypoints in the cluster
+ istioctl x waypoint list -A
+Commands to assist in configuring and deploying workloads running on VMs and other non-Kubernetes environments
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# workload group yaml generation
+ istioctl x workload group create
+
+ # workload entry configuration generation
+ istioctl x workload entry configure
+Commands dealing with WorkloadEntry resources
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl x workload entry configure -f workloadgroup.yaml -o outputDir
+Generates all the required configuration files for workload instance on a VM or non-Kubernetes environment from a WorkloadGroup artifact. +This includes a MeshConfig resource, the cluster.env file, and necessary certificates and security tokens. +Configure requires either the WorkloadGroup artifact path or its location on the API server.
+istioctl experimental workload entry configure [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--autoregister |
++ | Creates a WorkloadEntry upon connection to istiod (if enabled in pilot). | +
--capture-dns |
++ | Enables the capture of outgoing DNS packets on port 53, redirecting to istio-agent | +
--clusterID <string> |
++ | The ID used to identify the cluster (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--externalIP <string> |
++ | External IP address of the workload (default ``) | +
--file <string> |
+-f |
+filename of the WorkloadGroup artifact. Leave this field empty if using the API server (default ``) | +
--ingressIP <string> |
++ | IP address of the ingress gateway (default ``) | +
--ingressService <string> |
++ | Name of the Service to be used as the ingress gateway, in the format <service>.<namespace>. If no namespace is provided, the default istio-system namespace will be used. (default `istio-eastwestgateway`) | +
--internalIP <string> |
++ | Internal IP address of the workload (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--name <string> |
++ | The name of the workload group (default ``) | +
--namespace <string> |
+-n |
+The namespace that the workload instances belong to (default ``) | +
--output <string> |
+-o |
+Output directory for generated files (default ``) | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--tokenDuration <int> |
++ | The token duration in seconds (default: 1 hour) (default `3600`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# configure example using a local WorkloadGroup artifact
+ istioctl x workload entry configure -f workloadgroup.yaml -o config
+
+ # configure example using the API server
+ istioctl x workload entry configure --name foo --namespace bar -o config
+Commands dealing with WorkloadGroup resources
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl x workload group create --name foo --namespace bar --labels app=foobar
+Creates a WorkloadGroup resource that provides a template for associated WorkloadEntries. +The default output is serialized YAML, which can be piped into 'kubectl apply -f -' to send the artifact to the API Server.
+istioctl experimental workload group create [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--annotations <stringSlice> |
+-a |
+The annotations to apply to the workload instances (default `[]`) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--labels <stringSlice> |
+-l |
+The labels to apply to the workload instances; e.g. -l env=prod,vers=2 (default `[]`) | +
--name <string> |
++ | The name of the workload group (default ``) | +
--namespace <string> |
+-n |
+The namespace that the workload instances will belong to (default ``) | +
--ports <stringSlice> |
+-p |
+The incoming ports exposed by the workload instance (default `[]`) | +
--serviceAccount <string> |
+-s |
+The service identity to associate with the workload instances (default `default`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl x workload group create --name foo --namespace bar --labels app=foo,bar=baz --ports grpc=3550,http=8080 --annotations annotation=foobar --serviceAccount sa
+The install command generates an Istio install manifest and applies it to a cluster.
+istioctl install [flags]
+istioctl apply [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--charts <string> |
++ | Deprecated, use --manifests instead. (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--filename <stringSlice> |
+-f |
+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 `[]`) | +
--force |
++ | Proceed even with validation errors. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--readiness-timeout <duration> |
++ | Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`) | +
--revision <string> |
+-r |
+Target control plane revision for the command. (default ``) | +
--set <stringArray> |
+-s |
+Override an IstioOperator value, e.g. to choose a profile +(--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio +settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.20/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`) | +
--skip-confirmation |
+-y |
+The skipConfirmation determines whether the user is prompted for confirmation. +If set to true, the user is not prompted and a Yes response is assumed in all cases. | +
--verify |
++ | Verify the Istio control plane after installation/in-place upgrade | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Apply a default Istio installation
+ istioctl install
+
+ # Enable Tracing
+ istioctl install --set meshConfig.enableTracing=true
+
+ # Generate the demo profile and don't wait for confirmation
+ istioctl install --set profile=demo --skip-confirmation
+
+ # To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes.
+ istioctl install --set "values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default"
+
++kube-inject manually injects the Istio sidecar into Kubernetes +workloads. Unsupported resources are left unmodified so it is safe to +run kube-inject over a single file that contains multiple Service, +ConfigMap, Deployment, etc. definitions for a complex application. When in +doubt re-run istioctl kube-inject on deployments to get the most up-to-date changes.
+It's best to do kube-inject when the resource is initially created. +
+istioctl kube-inject [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--authority <string> |
++ | XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``) | +
--cert-dir <string> |
++ | XDS Endpoint certificate directory (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--filename <string> |
+-f |
+Input Kubernetes resource filename (default ``) | +
--injectConfigFile <string> |
++ | Injection configuration filename. Cannot be used with --injectConfigMapName (default ``) | +
--insecure |
++ | Skip server certificate and domain verification. (NOT SECURE!) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--meshConfigFile <string> |
++ | Mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``) | +
--meshConfigMapName <string> |
++ | ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--operatorFileName <string> |
++ | Path to file containing IstioOperator custom resources. If configs from files like meshConfigFile, valuesFile are provided, they will be overridden by iop config values. (default ``) | +
--output <string> |
+-o |
+Modified output Kubernetes resource filename (default ``) | +
--plaintext |
++ | Use plain-text HTTP/2 when connecting to server (no TLS). | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--timeout <duration> |
++ | The duration to wait before failing (default `30s`) | +
--valuesFile <string> |
++ | Injection values configuration filename. (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
--webhookConfig <string> |
++ | MutatingWebhookConfiguration name for Istio (default `istio-sidecar-injector`) | +
--xds-address <string> |
++ | XDS Endpoint (default ``) | +
--xds-label <string> |
++ | Istiod pod label selector (default ``) | +
--xds-port <int> |
++ | Istiod pod port (default `15012`) | +
# Update resources on the fly before applying.
+ kubectl apply -f <(istioctl kube-inject -f <resource.yaml>)
+
+ # Create a persistent version of the deployment with Istio sidecar injected.
+ istioctl kube-inject -f deployment.yaml -o deployment-injected.yaml
+
+ # Update an existing deployment.
+ kubectl get deployment -o yaml | istioctl kube-inject -f - | kubectl apply -f -
+
+ # Capture cluster configuration for later use with kube-inject
+ kubectl -n istio-system get cm istio-sidecar-injector -o jsonpath="{.data.config}" > /tmp/inj-template.tmpl
+ kubectl -n istio-system get cm istio -o jsonpath="{.data.mesh}" > /tmp/mesh.yaml
+ kubectl -n istio-system get cm istio-sidecar-injector -o jsonpath="{.data.values}" > /tmp/values.json
+
+ # Use kube-inject based on captured configuration
+ istioctl kube-inject -f samples/bookinfo/platform/kube/bookinfo.yaml \
+ --injectConfigFile /tmp/inj-template.tmpl \
+ --meshConfigFile /tmp/mesh.yaml \
+ --valuesFile /tmp/values.json
+
+The manifest command generates and diffs Istio manifests.
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
The diff subcommand compares manifests from two files or directories. The output is a list of +changed paths with the value changes shown as OLD-VALUE -> NEW-VALUE. +List order changes are shown as [OLD-INDEX->NEW-INDEX], with ? used where a list item is added or +removed.
+istioctl manifest diff <file|dir> <file|dir> [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--directory |
+-r |
+Compare directory. | +
--dry-run |
++ | Console/log output only, make no changes. | +
--ignore <string> |
++ | Ignore all listed items during comparison, using the same list format as selectResources. (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--rename <string> |
++ | Rename resources before comparison. +The format of each renaming pair is A->B, all renaming pairs are comma separated. +e.g. Service:*:istiod->Service:*:istio-control - rename istiod service into istio-control (default ``) | +
--select <string> |
++ | Constrain the list of resources to compare to only the ones in this list, ignoring all others. +The format of each list item is "::" and the items are comma separated. The "*" character represents wildcard selection. +e.g. + Deployment:istio-system:* - compare all deployments in istio-system namespace + Service:*:istiod - compare Services called "istiod" in all namespaces (default `::`) | +
--verbose |
+-v |
+Verbose output. | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
The generate subcommand generates an Istio install manifest and outputs to the console by default.
+istioctl manifest generate [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--charts <string> |
++ | Deprecated, use --manifests instead. (default ``) | +
--cluster-specific |
++ | If enabled, the current cluster will be checked for cluster-specific setting detection. | +
--component <stringSlice> |
++ | Specify which component to generate manifests for. (default `[]`) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--filename <stringSlice> |
+-f |
+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 `[]`) | +
--force |
++ | Proceed even with validation errors. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Manifest output directory path. (default ``) | +
--revision <string> |
+-r |
+Target control plane revision for the command. (default ``) | +
--set <stringArray> |
+-s |
+Override an IstioOperator value, e.g. to choose a profile +(--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio +settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.20/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Generate a default Istio installation
+ istioctl manifest generate
+
+ # Enable Tracing
+ istioctl manifest generate --set meshConfig.enableTracing=true
+
+ # Generate the demo profile
+ istioctl manifest generate --set profile=demo
+
+ # To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes.
+ istioctl manifest generate --set "values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default"
+
+The install command generates an Istio install manifest and applies it to a cluster.
+istioctl manifest install [flags]
+istioctl manifest apply [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--charts <string> |
++ | Deprecated, use --manifests instead. (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--filename <stringSlice> |
+-f |
+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 `[]`) | +
--force |
++ | Proceed even with validation errors. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--readiness-timeout <duration> |
++ | Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`) | +
--revision <string> |
+-r |
+Target control plane revision for the command. (default ``) | +
--set <stringArray> |
+-s |
+Override an IstioOperator value, e.g. to choose a profile +(--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio +settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.20/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`) | +
--skip-confirmation |
+-y |
+The skipConfirmation determines whether the user is prompted for confirmation. +If set to true, the user is not prompted and a Yes response is assumed in all cases. | +
--verify |
++ | Verify the Istio control plane after installation/in-place upgrade | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Apply a default Istio installation
+ istioctl install
+
+ # Enable Tracing
+ istioctl install --set meshConfig.enableTracing=true
+
+ # Generate the demo profile and don't wait for confirmation
+ istioctl install --set profile=demo --skip-confirmation
+
+ # To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes.
+ istioctl install --set "values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default"
+
+The operator command installs, dumps, removes and shows the status of the operator controller.
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
The dump subcommand dumps the Istio operator controller manifest.
+istioctl operator dump [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--charts <string> |
++ | Deprecated, use --manifests instead. (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--hub <string> |
++ | The hub for the operator controller image. (default `unknown`) | +
--imagePullSecrets <stringSlice> |
++ | The imagePullSecrets are used to pull the operator image from the private registry, +could be secret list separated by comma, eg. '--imagePullSecrets imagePullSecret1,imagePullSecret2' (default `[]`) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--operatorNamespace <string> |
++ | The namespace the operator controller is installed into. (default `istio-operator`) | +
--output <string> |
+-o |
+Output format: one of json|yaml (default `yaml`) | +
--revision <string> |
+-r |
+Target revision for the operator. (default ``) | +
--tag <string> |
++ | The tag for the operator controller image. (default `unknown`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
--watchedNamespaces <string> |
++ | The namespaces the operator controller watches, could be namespace list separated by comma, eg. 'ns1,ns2' (default `istio-system`) | +
The init subcommand installs the Istio operator controller in the cluster.
+istioctl operator init [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--charts <string> |
++ | Deprecated, use --manifests instead. (default ``) | +
--context <string> |
++ | The name of the kubeconfig context to use. (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--filename <string> |
+-f |
+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 ``) | +
--hub <string> |
++ | The hub for the operator controller image. (default `unknown`) | +
--imagePullSecrets <stringSlice> |
++ | The imagePullSecrets are used to pull the operator image from the private registry, +could be secret list separated by comma, eg. '--imagePullSecrets imagePullSecret1,imagePullSecret2' (default `[]`) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Path to kube config. (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--operatorNamespace <string> |
++ | The namespace the operator controller is installed into. (default `istio-operator`) | +
--revision <string> |
+-r |
+Target revision for the operator. (default ``) | +
--tag <string> |
++ | The tag for the operator controller image. (default `unknown`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
--watchedNamespaces <string> |
++ | The namespaces the operator controller watches, could be namespace list separated by comma, eg. 'ns1,ns2' (default `istio-system`) | +
The remove subcommand removes the Istio operator controller from the cluster.
+istioctl operator remove [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | The name of the kubeconfig context to use. (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--force |
++ | Proceed even with validation errors. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Path to kube config. (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--operatorNamespace <string> |
++ | The namespace the operator controller is installed into. (default `istio-operator`) | +
--purge |
++ | Remove all versions of Istio operator. | +
--revision <string> |
+-r |
+Target revision for the operator. (default ``) | +
--skip-confirmation |
+-y |
+The skipConfirmation determines whether the user is prompted for confirmation. +If set to true, the user is not prompted and a Yes response is assumed in all cases. | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Displays istioctl global options
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
The profile command lists, dumps or diffs Istio configuration profiles.
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl profile list
+istioctl install --set profile=demo # Use a profile from the list
+The diff subcommand displays the differences between two Istio configuration profiles.
+istioctl profile diff <profile|file1.yaml> <profile|file2.yaml> [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--charts <string> |
++ | Deprecated, use --manifests instead. (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Profile diff by providing yaml files
+ istioctl profile diff manifests/profiles/default.yaml manifests/profiles/demo.yaml
+
+ # Profile diff by providing a profile name
+ istioctl profile diff default demo
+The dump subcommand dumps the values in an Istio configuration profile.
+istioctl profile dump [<profile>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--charts <string> |
++ | Deprecated, use --manifests instead. (default ``) | +
--config-path <string> |
+-p |
+The path the root of the configuration subtree to dump e.g. components.pilot. By default, dump whole tree (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--filename <stringSlice> |
+-f |
+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 `[]`) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|flags (default `yaml`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
The list subcommand lists the available Istio configuration profiles.
+istioctl profile list [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--charts <string> |
++ | Deprecated, use --manifests instead. (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
A group of commands used to retrieve information about proxy configuration from the Envoy config dump
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Retrieve information about proxy configuration from an Envoy instance.
+ istioctl proxy-config <clusters|listeners|routes|endpoints|bootstrap|log|secret> <pod-name[.namespace]>
+Retrieve information about all configuration for the Envoy instance in the specified pod.
+istioctl proxy-config all [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config a [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Filter listeners by address field (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--direction <string> |
++ | Filter clusters by Direction field (default ``) | +
--file <string> |
+-f |
+Envoy config dump file (default ``) | +
--fqdn <string> |
++ | Filter clusters by substring of Service FQDN field (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--name <string> |
++ | Filter listeners by route name field (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--port <int> |
++ | Filter clusters and listeners by Port field (default `0`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--subset <string> |
++ | Filter clusters by substring of Subset field (default ``) | +
--type <string> |
++ | Filter listeners by type field (default ``) | +
--verbose |
++ | Output more information | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Retrieve summary about all configuration for a given pod from Envoy.
+ istioctl proxy-config all <pod-name[.namespace]>
+
+ # Retrieve full cluster dump as JSON
+ istioctl proxy-config all <pod-name[.namespace]> -o json
+
+ # Retrieve full cluster dump with short syntax
+ istioctl pc a <pod-name[.namespace]>
+
+ # Retrieve cluster summary without using Kubernetes API
+ ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
+ istioctl proxy-config all --file envoy-config.json
+
+Retrieve information about bootstrap configuration for the Envoy instance in the specified pod.
+istioctl proxy-config bootstrap [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config b [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--file <string> |
+-f |
+Envoy config dump JSON file (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `json`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Retrieve full bootstrap configuration for a given pod from Envoy.
+ istioctl proxy-config bootstrap <pod-name[.namespace]>
+
+ # Retrieve full bootstrap without using Kubernetes API
+ ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
+ istioctl proxy-config bootstrap --file envoy-config.json
+
+ # Show a human-readable Istio and Envoy version summary
+ istioctl proxy-config bootstrap -o short
+
+Retrieve information about cluster configuration for the Envoy instance in the specified pod.
+istioctl proxy-config cluster [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config clusters [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config c [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--direction <string> |
++ | Filter clusters by Direction field (default ``) | +
--file <string> |
+-f |
+Envoy config dump JSON file (default ``) | +
--fqdn <string> |
++ | Filter clusters by substring of Service FQDN field (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--port <int> |
++ | Filter clusters by Port field (default `0`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--subset <string> |
++ | Filter clusters by substring of Subset field (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# 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
+
+Retrieve information about typed extension configuration for the Envoy instance in the specified pod.
+istioctl proxy-config ecds [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config ec [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--file <string> |
+-f |
+Envoy config dump JSON file (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Retrieve full typed extension configuration for a given pod from Envoy.
+ istioctl proxy-config ecds <pod-name[.namespace]>
+
+ # Retrieve endpoint summary without using Kubernetes API
+ ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
+ istioctl proxy-config ecds --file envoy-config.json
+
+Retrieve information about endpoint configuration for the Envoy instance in the specified pod.
+istioctl proxy-config endpoint [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config endpoints [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config ep [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Filter endpoints by address field (default ``) | +
--cluster <string> |
++ | Filter endpoints by cluster name field (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--file <string> |
+-f |
+Envoy config dump JSON file (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--port <int> |
++ | Filter endpoints by Port field (default `0`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--status <string> |
++ | Filter endpoints by status field (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# 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
+
+Retrieve information about listener configuration for the Envoy instance in the specified pod.
+istioctl proxy-config listener [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config listeners [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config l [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Filter listeners by address field (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--file <string> |
+-f |
+Envoy config dump JSON file (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--port <int> |
++ | Filter listeners by Port field (default `0`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--type <string> |
++ | Filter listeners by type field (default ``) | +
--verbose |
++ | Output more information | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# 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
+
+Retrieve information about logging levels of the Envoy instance in the specified pod, and update optionally
+istioctl proxy-config log [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config o [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--level <string> |
++ | Comma-separated minimum per-logger level of messages to output, in the form of [<logger>:]<level>,[<logger>:]<level>,... where logger components can be listed by running "istioctl proxy-config log <pod-name[.namespace]>"or referred from https://github.com/envoyproxy/envoy/blob/main/source/common/common/logger.h, and level can be one of [trace, debug, info, warning, error, critical, off] (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--reset |
+-r |
+Reset levels to default value (warning). | +
--selector <string> |
+-l |
+Label selector (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# 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
+
+Compare ROOTCA values for given 2 pods to check the connectivity between them.
+THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
+istioctl proxy-config rootca-compare [pod/]<name-1>[.<namespace-1>] [pod/]<name-2>[.<namespace-2>] [flags]
+istioctl proxy-config rc [pod/]<name-1>[.<namespace-1>] [pod/]<name-2>[.<namespace-2>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Compare ROOTCA values for given 2 pods to check the connectivity between them.
+ istioctl proxy-config rootca-compare <pod-name-1[.namespace]> <pod-name-2[.namespace]>
+Retrieve information about route configuration for the Envoy instance in the specified pod.
+istioctl proxy-config route [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config routes [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config r [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--file <string> |
+-f |
+Envoy config dump JSON file (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--name <string> |
++ | Filter listeners by route name field (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--verbose |
++ | Output more information | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# 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
+
+Retrieve information about secret configuration for the Envoy instance in the specified pod.
+istioctl proxy-config secret [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config secrets [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config s [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--file <string> |
+-f |
+Envoy config dump JSON file (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# 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
++Retrieves last sent and last acknowledged xDS sync from Istiod to each Envoy in the mesh
+ +istioctl proxy-status [<type>/]<name>[.<namespace>] [flags]
+istioctl ps [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--file <string> |
+-f |
+Envoy config dump JSON file (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Retrieve sync status for all Envoys in a mesh
+ istioctl proxy-status
+
+ # Retrieve sync diff for a single Envoy and Istiod
+ istioctl proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system
+
+ # Retrieve sync diff between Istiod and one pod under a deployment
+ istioctl proxy-status deployment/productpage-v1
+
+ # Write proxy config-dump to file, and compare to Istio control plane
+ kubectl port-forward -n istio-system istio-egressgateway-59585c5b9c-ndc59 15000 &
+ curl localhost:15000/config_dump > cd.json
+ istioctl proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system --file cd.json
+
+Lists the remote clusters each istiod instance is connected to.
+istioctl remote-clusters [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Command group used to interact with revision tags. Revision tags allow for the creation of mutable aliases +referring to control plane revisions for sidecar injection.
+With revision tags, rather than relabeling a namespace from "istio.io/rev=revision-a" to "istio.io/rev=revision-b" to +change which control plane revision handles injection, it's possible to create a revision tag "prod" and label our +namespace "istio.io/rev=prod". The "prod" revision tag could point to "1-7-6" initially and then be changed to point to "1-8-1" +at some later point.
+This allows operators to change which Istio control plane revision should handle injection for a namespace or set of namespaces +without manual relabeling of the "istio.io/rev" tag. +
+istioctl tag [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Create a revision tag and output to the command's stdout. Tag an Istio control plane revision for use with namespace istio.io/rev +injection labels.
+istioctl tag generate <revision-tag> [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--auto-inject-namespaces |
++ | If set to true, the sidecars should be automatically injected into all namespaces by default | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--overwrite |
++ | If true, allow revision tags to be overwritten, otherwise reject revision tag updates that +overwrite existing revision tags. | +
--revision <string> |
+-r |
+Control plane revision to reference from a given revision tag (default ``) | +
--skip-confirmation |
+-y |
+The skipConfirmation determines whether the user is prompted for confirmation. +If set to true, the user is not prompted and a Yes response is assumed in all cases. | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
--webhook-name <string> |
++ | Name to use for a revision tag's mutating webhook configuration. (default ``) | +
# Create a revision tag from the "1-8-0" revision
+ istioctl tag generate prod --revision 1-8-0 > tag.yaml
+
+ # Apply the tag to cluster
+ kubectl apply -f tag.yaml
+
+ # Point namespace "test-ns" at the revision pointed to by the "prod" revision tag
+ kubectl label ns test-ns istio.io/rev=prod
+
+ # Rollout namespace "test-ns" to update workloads to the "1-8-0" revision
+ kubectl rollout restart deployments -n test-ns
+
+List existing revision tags
+istioctl tag list [flags]
+istioctl tag show [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl tag list
+Remove Istio control plane revision tag.
+Removing a revision tag should be done with care. Removing a revision tag will disrupt sidecar injection in namespaces +that reference the tag in an "istio.io/rev" label. Verify that there are no remaining namespaces referencing a +revision tag before removing using the "istioctl tag list" command. +
+istioctl tag remove <revision-tag> [flags]
+istioctl tag delete <revision-tag> [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--skip-confirmation |
+-y |
+The skipConfirmation determines whether the user is prompted for confirmation. +If set to true, the user is not prompted and a Yes response is assumed in all cases. | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Remove the revision tag "prod"
+ istioctl tag remove prod
+
+Create or modify revision tags. Tag an Istio control plane revision for use with namespace istio.io/rev +injection labels.
+istioctl tag set <revision-tag> [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--auto-inject-namespaces |
++ | If set to true, the sidecars should be automatically injected into all namespaces by default | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--overwrite |
++ | If true, allow revision tags to be overwritten, otherwise reject revision tag updates that +overwrite existing revision tags. | +
--revision <string> |
+-r |
+Control plane revision to reference from a given revision tag (default ``) | +
--skip-confirmation |
+-y |
+The skipConfirmation determines whether the user is prompted for confirmation. +If set to true, the user is not prompted and a Yes response is assumed in all cases. | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
--webhook-name <string> |
++ | Name to use for a revision tag's mutating webhook configuration. (default ``) | +
# Create a revision tag from the "1-8-0" revision
+ istioctl tag set prod --revision 1-8-0
+
+ # Point namespace "test-ns" at the revision pointed to by the "prod" revision tag
+ kubectl label ns test-ns istio.io/rev=prod
+
+ # Change the revision tag to reference the "1-8-1" revision
+ istioctl tag set prod --revision 1-8-1 --overwrite
+
+ # Make revision "1-8-1" the default revision, both resulting in that revision handling injection for "istio-injection=enabled"
+ # and validating resources cluster-wide
+ istioctl tag set default --revision 1-8-1
+
+ # Rollout namespace "test-ns" to update workloads to the "1-8-1" revision
+ kubectl rollout restart deployments -n test-ns
+
+The uninstall command uninstalls Istio from a cluster
+istioctl uninstall [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | The name of the kubeconfig context to use. (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--filename <string> |
+-f |
+The filename of the IstioOperator CR. (default ``) | +
--force |
++ | Proceed even with validation errors. | +
--istioNamespace <string> |
++ | The namespace of Istio Control Plane. (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Path to kube config. (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--purge |
++ | Delete all Istio related sources for all versions | +
--revision <string> |
+-r |
+Target control plane revision for the command. (default ``) | +
--set <stringArray> |
+-s |
+Override an IstioOperator value, e.g. to choose a profile +(--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio +settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.20/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`) | +
--skip-confirmation |
+-y |
+The skipConfirmation determines whether the user is prompted for confirmation. +If set to true, the user is not prompted and a Yes response is assumed in all cases. | +
--verbose |
+-v |
+Verbose output. | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Uninstall a single control plane by revision
+ istioctl uninstall --revision foo
+
+ # Uninstall a single control plane by iop file
+ istioctl uninstall -f iop.yaml
+
+ # Uninstall all control planes and shared resources
+ istioctl uninstall --purge
+The upgrade command is an alias for the install command that performs additional upgrade-related checks.
+istioctl upgrade [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--charts <string> |
++ | Deprecated, use --manifests instead. (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--filename <stringSlice> |
+-f |
+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 `[]`) | +
--force |
++ | Proceed even with validation errors. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--readiness-timeout <duration> |
++ | Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`) | +
--revision <string> |
+-r |
+Target control plane revision for the command. (default ``) | +
--set <stringArray> |
+-s |
+Override an IstioOperator value, e.g. to choose a profile +(--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio +settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.20/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`) | +
--skip-confirmation |
+-y |
+The skipConfirmation determines whether the user is prompted for confirmation. +If set to true, the user is not prompted and a Yes response is assumed in all cases. | +
--verify |
++ | Verify the Istio control plane after installation/in-place upgrade | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Validate Istio policy and rules files
+istioctl validate -f FILENAME [options] [flags]
+istioctl v -f FILENAME [options] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--filename <stringSlice> |
+-f |
+Inputs of files to validate (default `[]`) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Validate bookinfo-gateway.yaml
+ istioctl validate -f samples/bookinfo/networking/bookinfo-gateway.yaml
+
+ # Validate bookinfo-gateway.yaml with shorthand syntax
+ istioctl v -f samples/bookinfo/networking/bookinfo-gateway.yaml
+
+ # Validate all yaml files under samples/bookinfo/networking directory
+ istioctl validate -f samples/bookinfo/networking
+
+ # Validate current deployments under 'default' namespace within the cluster
+ kubectl get deployments -o yaml | istioctl validate -f -
+
+ # Validate current services under 'default' namespace within the cluster
+ kubectl get services -o yaml | istioctl validate -f -
+
+ # Also see the related command 'istioctl analyze'
+ istioctl analyze samples/bookinfo/networking/bookinfo-gateway.yaml
+
++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.
+If you do not specify an installation it will check for an IstioOperator resource +and will verify if pods and services defined in it are present.
+Note: For verifying whether your cluster is ready for Istio installation, see +istioctl experimental precheck. +
+istioctl verify-install [-f <deployment or istio operator file>] [--revision <revision>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--filename <stringSlice> |
+-f |
+Istio YAML installation file. (default `[]`) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Verify that Istio is installed correctly via Istio Operator
+ istioctl verify-install
+
+ # Verify the deployment matches a custom Istio deployment configuration
+ istioctl verify-install -f $HOME/istio.yaml
+
+ # Verify the deployment matches the Istio Operator deployment definition
+ istioctl verify-install --revision <canary>
+
+ # Verify the installation of specific revision
+ istioctl verify-install -r 1-9-0
+Prints out build version information
+istioctl version [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+One of 'yaml' or 'json'. (default ``) | +
--remote |
++ | Use --remote=false to suppress control plane check | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--short |
+-s |
+Use --short=false to generate full version information | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl command. Please use with caution as these environment variables are experimental and can change anytime.
+| Variable Name | +Type | +Default Value | +Description | +
|---|---|---|---|
CA_TRUSTED_NODE_ACCOUNTS |
+String | + |
+If set, the list of service accounts that are allowed to use node authentication for CSRs. Node authentication allows an identity to create CSRs on behalf of other identities, but only if there is a pod running on the same node with that identity. This is intended for use with node proxies. | +
CERT_SIGNER_DOMAIN |
+String | + |
+The cert signer domain info | +
CLOUD_PLATFORM |
+String | + |
+Cloud Platform on which proxy is running, if not specified, Istio will try to discover the platform. Valid platform values are aws, azure, gcp, none | +
CLUSTER_ID |
+String | +Kubernetes |
+Defines the cluster and service registry that this Istiod instance belongs to | +
ENABLE_AUTO_SNI |
+Boolean | +false |
+If enabled, automatically set SNI when `DestinationRules` do not specify the same | +
ENABLE_CA_SERVER |
+Boolean | +true |
+If this is set to false, will not create CA server in istiod. | +
ENABLE_DEBUG_ON_HTTP |
+Boolean | +true |
+If this is set to false, the debug interface will not be enabled, recommended for production | +
ENABLE_ENHANCED_RESOURCE_SCOPING |
+Boolean | +false |
+If enabled, meshConfig.discoverySelectors will limit the CustomResource configurations(like Gateway,VirtualService,DestinationRule,Ingress, etc)that can be processed by pilot. This will also restrict the root-ca certificate distribution. | +
ENABLE_HCM_INTERNAL_NETWORKS |
+Boolean | +false |
+If enable, endpoints defined in mesh networks will be configured as internal addresses in Http Connection Manager | +
ENABLE_LEADER_ELECTION |
+Boolean | +true |
+If enabled (default), starts a leader election client and gains leadership before executing controllers. If false, it assumes that only one instance of istiod is running and skips leader election. | +
ENABLE_MCS_AUTO_EXPORT |
+Boolean | +false |
+If enabled, istiod will automatically generate Kubernetes Multi-Cluster Services (MCS) ServiceExport resources for every service in the mesh. Services defined to be cluster-local in MeshConfig are excluded. | +
ENABLE_MCS_CLUSTER_LOCAL |
+Boolean | +false |
+If enabled, istiod will treat the host `<svc>.<namespace>.svc.cluster.local` as defined by the Kubernetes Multi-Cluster Services (MCS) spec. In this mode, requests to `cluster.local` will be routed to only those endpoints residing within the same cluster as the client. Requires that both ENABLE_MCS_SERVICE_DISCOVERY and ENABLE_MCS_HOST also be enabled. | +
ENABLE_MCS_HOST |
+Boolean | +false |
+If enabled, istiod will configure a Kubernetes Multi-Cluster Services (MCS) host (<svc>.<namespace>.svc.clusterset.local) for each service exported (via ServiceExport) in at least one cluster. Clients must, however, be able to successfully lookup these DNS hosts. That means that either Istio DNS interception must be enabled or an MCS controller must be used. Requires that ENABLE_MCS_SERVICE_DISCOVERY also be enabled. | +
ENABLE_MCS_SERVICE_DISCOVERY |
+Boolean | +false |
+If enabled, istiod will enable Kubernetes Multi-Cluster Services (MCS) service discovery mode. In this mode, service endpoints in a cluster will only be discoverable within the same cluster unless explicitly exported via ServiceExport. | +
ENABLE_MULTICLUSTER_HEADLESS |
+Boolean | +true |
+If true, the DNS name table for a headless service will resolve to same-network endpoints in any cluster. | +
ENABLE_NATIVE_SIDECARS |
+Boolean | +false |
+If set, used Kubernetes native Sidecar container support. Requires SidecarContainer feature flag. | +
ENABLE_OPTIMIZED_CONFIG_REBUILD |
+Boolean | +true |
+If enabled, pilot will only rebuild config for resources that have changed | +
ENABLE_OTEL_BUILTIN_RESOURCE_LABELS |
+Boolean | +false |
+If enabled, envoy will send builtin lables(e.g. node_name) via OTel sink. | +
ENABLE_PROBE_KEEPALIVE_CONNECTIONS |
+Boolean | +false |
+If enabled, readiness probes will keep the connection from pilot-agent to the application alive. This mirrors older Istio versions' behaviors, but not kubelet's. | +
ENABLE_TLS_ON_SIDECAR_INGRESS |
+Boolean | +false |
+If enabled, the TLS configuration on Sidecar.ingress will take effect | +
EXTERNAL_ISTIOD |
+Boolean | +false |
+If this is set to true, one Istiod will control remote clusters including CA. | +
GCP_METADATA |
+String | + |
+Pipe separated GCP metadata, schemed as PROJECT_ID|PROJECT_NUMBER|CLUSTER_NAME|CLUSTER_ZONE | +
GCP_QUOTA_PROJECT |
+String | + |
+Allows specification of a quota project to be used in requests to GCP APIs. | +
GRPC_KEEPALIVE_INTERVAL |
+Time Duration | +30s |
+gRPC Keepalive Interval | +
GRPC_KEEPALIVE_TIMEOUT |
+Time Duration | +10s |
+gRPC Keepalive Timeout | +
HTTP_STRIP_FRAGMENT_FROM_PATH_UNSAFE_IF_DISABLED |
+Boolean | +true |
++ |
INBOUND_INTERCEPTION_MODE |
+String | + |
+The mode used to redirect inbound connections to Envoy, either "REDIRECT" or "TPROXY" | +
INBOUND_TPROXY_MARK |
+String | + |
++ |
INJECTION_WEBHOOK_CONFIG_NAME |
+String | +istio-sidecar-injector |
+Name of the mutatingwebhookconfiguration to patch, if istioctl is not used. | +
ISTIOCONFIG |
+String | +$HOME/.istioctl/config.yaml |
+Default values for istioctl flags | +
ISTIOCTL_AUTHORITY |
+String | + |
+The istioctl --authority override | +
ISTIOCTL_CERT_DIR |
+String | + |
+The istioctl --cert-dir override | +
ISTIOCTL_INSECURE |
+Boolean | +false |
+The istioctl --insecure override | +
ISTIOCTL_ISTIONAMESPACE |
+String | +istio-system |
+The istioctl --istioNamespace override | +
ISTIOCTL_PLAINTEXT |
+Boolean | +false |
+The istioctl --plaintext override | +
ISTIOCTL_PREFER_EXPERIMENTAL |
+Boolean | +false |
+The istioctl should use experimental subcommand variants | +
ISTIOCTL_XDS_ADDRESS |
+String | + |
+The istioctl --xds-address override | +
ISTIOCTL_XDS_PORT |
+Integer | +15012 |
+The istioctl --xds-port override | +
ISTIOD_CUSTOM_HOST |
+String | + |
+Custom host name of istiod that istiod signs the server cert. Multiple custom host names are supported, and multiple values are separated by commas. | +
ISTIO_AGENT_ENABLE_WASM_REMOTE_LOAD_CONVERSION |
+Boolean | +true |
+If enabled, Istio agent will intercept ECDS resource update, downloads Wasm module, and replaces Wasm module remote load with downloaded local module file. | +
ISTIO_BOOTSTRAP |
+String | + |
++ |
ISTIO_DELTA_XDS |
+Boolean | +false |
+If enabled, pilot will only send the delta configs as opposed to the state of the world on a Resource Request. This feature uses the delta xds api, but does not currently send the actual deltas. | +
ISTIO_DUAL_STACK |
+Boolean | +false |
+If true, Istio will enable the Dual Stack feature. | +
ISTIO_ENABLE_CONTROLLER_QUEUE_METRICS |
+Boolean | +false |
+If enabled, publishes metrics for queue depth, latency and processing times. | +
ISTIO_ENABLE_HTTP2_PROBING |
+Boolean | +true |
+If enabled, HTTP2 probes will be enabled for HTTPS probes, following Kubernetes | +
ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSH |
+Boolean | +true |
+If enabled, Istiod will not push changes on arbitrary annotation change. | +
ISTIO_GPRC_MAXRECVMSGSIZE |
+Integer | +4194304 |
+Sets the max receive buffer size of gRPC stream in bytes. | +
ISTIO_GPRC_MAXSTREAMS |
+Integer | +100000 |
+Sets the maximum number of concurrent grpc streams. | +
ISTIO_KUBE_CLIENT_CONTENT_TYPE |
+String | +protobuf |
+The content type to use for Kubernetes clients. Defaults to protobuf. Valid options: [protobuf, json] | +
ISTIO_MULTIROOT_MESH |
+Boolean | +false |
+If enabled, mesh will support certificates signed by more than one trustAnchor for ISTIO_MUTUAL mTLS | +
ISTIO_OUTBOUND_OWNER_GROUPS |
+String | +* |
+Comma separated list of groups whose outgoing traffic is to be redirected to Envoy. +A group can be specified either by name or by a numeric GID. +The wildcard character "*" can be used to configure redirection of traffic from all groups. | +
ISTIO_OUTBOUND_OWNER_GROUPS_EXCLUDE |
+String | + |
+Comma separated list of groups whose outgoing traffic is to be excluded from redirection to Envoy. +A group can be specified either by name or by a numeric GID. +Only applies when traffic from all groups (i.e. "*") is being redirected to Envoy. | +
ISTIO_PROMETHEUS_ANNOTATIONS |
+String | + |
++ |
ISTIO_WATCH_NAMESPACE |
+String | + |
+If set, limit Kubernetes watches to a single namespace. Warning: only a single namespace can be set. | +
ISTIO_WORKLOAD_ENTRY_VALIDATE_IDENTITY |
+Boolean | +true |
+If enabled, will validate the identity of a workload matches the identity of the WorkloadEntry it is associating with for health checks and auto registration. This flag is added for backwards compatibility only and will be removed in future releases | +
JWKS_RESOLVER_INSECURE_SKIP_VERIFY |
+Boolean | +false |
+If enabled, istiod will skip verifying the certificate of the JWKS server. | +
JWT_POLICY |
+String | +third-party-jwt |
+The JWT validation policy. | +
K8S_INGRESS_NS |
+String | +istio-system |
++ |
K_REVISION |
+String | + |
+KNative revision, set if running in knative | +
LABEL_CANONICAL_SERVICES_FOR_MESH_EXTERNAL_SERVICE_ENTRIES |
+Boolean | +false |
+If enabled, metadata representing canonical services for ServiceEntry resources with a location of mesh_external will be populatedin the cluster metadata for those endpoints. | +
LOCAL_CLUSTER_SECRET_WATCHER |
+Boolean | +false |
+If enabled, the cluster secret watcher will watch the namespace of the external cluster instead of config cluster | +
MCS_API_GROUP |
+String | +multicluster.x-k8s.io |
+The group to be used for the Kubernetes Multi-Cluster Services (MCS) API. | +
MCS_API_VERSION |
+String | +v1alpha1 |
+The version to be used for the Kubernets Multi-Cluster Services (MCS) API. | +
METRIC_GRACEFUL_DELETION_INTERVAL |
+Time Duration | +5m0s |
+Metric expiry graceful deletion interval. No-op if METRIC_ROTATION_INTERVAL is disabled. | +
METRIC_ROTATION_INTERVAL |
+Time Duration | +0s |
+Metric scope rotation interval, set to 0 to disable the metric scope rotation | +
MUTEX_PROFILE_FRACTION |
+Integer | +1000 |
+If set to a non-zero value, enables mutex profiling a rate of 1/MUTEX_PROFILE_FRACTION events. For example, '1000' will record 0.1% of events. Set to 0 to disable entirely. | +
NATIVE_METADATA_EXCHANGE |
+Boolean | +true |
+If set, uses a native implementation of the HTTP metadata exchange filter | +
PILOT_ALLOW_SIDECAR_SERVICE_INBOUND_LISTENER_MERGE |
+Boolean | +false |
+If set, it allows creating inbound listeners for service ports and sidecar ingress listeners | +
PILOT_ANALYSIS_INTERVAL |
+Time Duration | +10s |
+If analysis is enabled, pilot will run istio analyzers using this value as interval in seconds Istio Resources | +
PILOT_CERT_PROVIDER |
+String | +istiod |
+The provider of Pilot DNS certificate. | +
PILOT_DEBOUNCE_AFTER |
+Time Duration | +100ms |
+The delay added to config/registry events for debouncing. This will delay the push by at least this interval. If no change is detected within this period, the push will happen, otherwise we'll keep delaying until things settle, up to a max of PILOT_DEBOUNCE_MAX. | +
PILOT_DEBOUNCE_MAX |
+Time Duration | +10s |
+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. | +
PILOT_DISTRIBUTION_HISTORY_RETENTION |
+Time Duration | +1m0s |
+If enabled, Pilot will keep track of old versions of distributed config for this duration. | +
PILOT_DRAINING_LABEL |
+String | +istio.io/draining |
+If not empty, endpoints with the label value present will be sent with status DRAINING. | +
PILOT_ENABLE_ALPHA_GATEWAY_API |
+Boolean | +false |
+If this is set to true, support for alpha APIs in the Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed. | +
PILOT_ENABLE_ALPN_FILTER |
+Boolean | +true |
+If true, pilot will add Istio ALPN filters, required for proper protocol sniffing. | +
PILOT_ENABLE_AMBIENT_CONTROLLERS |
+Boolean | +false |
+If enabled, controllers required for ambient will run. This is required to run ambient mesh. | +
PILOT_ENABLE_ANALYSIS |
+Boolean | +false |
+If enabled, pilot will run istio analyzers and write analysis errors to the Status field of any Istio Resources | +
PILOT_ENABLE_CDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache CDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE. | +
PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING |
+Boolean | +false |
+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. | +
PILOT_ENABLE_CROSS_CLUSTER_WORKLOAD_ENTRY |
+Boolean | +true |
+If enabled, pilot will read WorkloadEntry from other clusters, selectable by Services in that cluster. | +
PILOT_ENABLE_EDS_DEBOUNCE |
+Boolean | +true |
+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 | +
PILOT_ENABLE_EDS_FOR_HEADLESS_SERVICES |
+Boolean | +false |
+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. | +
PILOT_ENABLE_GATEWAY_API |
+Boolean | +true |
+If this is set to true, support for Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed. | +
PILOT_ENABLE_GATEWAY_API_DEPLOYMENT_CONTROLLER |
+Boolean | +true |
+If this is set to true, gateway-api resources will automatically provision in cluster deployment, services, etc | +
PILOT_ENABLE_GATEWAY_API_GATEWAYCLASS_CONTROLLER |
+Boolean | +true |
+If this is set to true, istiod will create and manage its default GatewayClasses | +
PILOT_ENABLE_GATEWAY_API_STATUS |
+Boolean | +true |
+If this is set to true, gateway-api resources will have status written to them | +
PILOT_ENABLE_HBONE |
+Boolean | +false |
+If enabled, HBONE support can be configured for proxies. Note: proxies must opt in on a per-proxy basis with ENABLE_HBONE to actually get HBONE config, in addition to this flag. | +
PILOT_ENABLE_HEADLESS_SERVICE_POD_LISTENERS |
+Boolean | +true |
+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. | +
PILOT_ENABLE_INBOUND_PASSTHROUGH |
+Boolean | +true |
+If enabled, inbound clusters will be configured as ORIGINAL_DST clusters. When disabled, requests are always sent to localhost. The primary implication of this is that when enabled, binding to POD_IP will work while localhost will not; when disable, bind to POD_IP will not work, while localhost will. The enabled behavior matches the behavior without Istio enabled at all; this flag exists only for backwards compatibility. Regardless of this setting, the configuration can be overridden with the Sidecar.Ingress.DefaultEndpoint configuration. | +
PILOT_ENABLE_K8S_SELECT_WORKLOAD_ENTRIES |
+Boolean | +true |
+If enabled, Kubernetes services with selectors will select workload entries with matching labels. It is safe to disable it if you are quite sure you don't need this feature | +
PILOT_ENABLE_METADATA_EXCHANGE |
+Boolean | +true |
+If true, pilot will add metadata exchange filters, which will be consumed by telemetry filter. | +
PILOT_ENABLE_MONGO_FILTER |
+Boolean | +true |
+EnableMongoFilter enables injection of `envoy.filters.network.mongo_proxy` in the filter chain. | +
PILOT_ENABLE_MYSQL_FILTER |
+Boolean | +false |
+EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain. | +
PILOT_ENABLE_PERSISTENT_SESSION_FILTER |
+Boolean | +false |
+If enabled, Istiod sets up persistent session filter for listeners, if services have 'PILOT_PERSISTENT_SESSION_LABEL' set. | +
PILOT_ENABLE_QUIC_LISTENERS |
+Boolean | +false |
+If true, QUIC listeners will be generated wherever there are listeners terminating TLS on gateways if the gateway service exposes a UDP port with the same number (for example 443/TCP and 443/UDP) | +
PILOT_ENABLE_RDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache RDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE. | +
PILOT_ENABLE_REDIS_FILTER |
+Boolean | +false |
+EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain. | +
PILOT_ENABLE_ROUTE_COLLAPSE_OPTIMIZATION |
+Boolean | +true |
+If true, Pilot will merge virtual hosts with the same routes into a single virtual host, as an optimization. | +
PILOT_ENABLE_SERVICEENTRY_SELECT_PODS |
+Boolean | +true |
+If enabled, service entries with selectors will select pods from the cluster. It is safe to disable it if you are quite sure you don't need this feature | +
PILOT_ENABLE_STATUS |
+Boolean | +false |
+If enabled, pilot will update the CRD Status field of all istio resources with reconciliation status. | +
PILOT_ENABLE_TELEMETRY_LABEL |
+Boolean | +true |
+If true, pilot will add telemetry related metadata to cluster and endpoint resources, which will be consumed by telemetry filter. | +
PILOT_ENABLE_WORKLOAD_ENTRY_AUTOREGISTRATION |
+Boolean | +true |
+Enables auto-registering WorkloadEntries based on associated WorkloadGroups upon XDS connection by the workload. | +
PILOT_ENABLE_WORKLOAD_ENTRY_HEALTHCHECKS |
+Boolean | +true |
+Enables automatic health checks of WorkloadEntries based on the config provided in the associated WorkloadGroup | +
PILOT_ENABLE_XDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache XDS responses. | +
PILOT_ENABLE_XDS_IDENTITY_CHECK |
+Boolean | +true |
+If enabled, pilot will authorize XDS clients, to ensure they are acting only as namespaces they have permissions for. | +
PILOT_ENDPOINT_TELEMETRY_LABEL |
+Boolean | +true |
+If true, pilot will add telemetry related metadata to Endpoint resource, which will be consumed by telemetry filter. | +
PILOT_ENVOY_FILTER_STATS |
+Boolean | +false |
+If true, Pilot will collect metrics for envoy filter operations. | +
PILOT_FILTER_GATEWAY_CLUSTER_CONFIG |
+Boolean | +false |
+If enabled, Pilot will send only clusters that referenced in gateway virtual services attached to gateway | +
PILOT_HTTP10 |
+Boolean | +false |
+Enables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications. | +
PILOT_INSECURE_MULTICLUSTER_KUBECONFIG_OPTIONS |
+String | + |
+Comma separated list of potentially insecure kubeconfig authentication options that are allowed for multicluster authentication.Support values: all authProviders (`gcp`, `azure`, `exec`, `openstack`), `clientKey`, `clientCertificate`, `tokenFile`, and `exec`. | +
PILOT_JWT_ENABLE_REMOTE_JWKS |
+String | +false |
+Mode of fetching JWKs from JwksUri in RequestAuthentication. Supported value: istiod, false, hybrid, true, envoy. The client fetching JWKs is as following: istiod/false - Istiod; hybrid/true - Envoy and fallback to Istiod if JWKs server is external; envoy - Envoy. | +
PILOT_JWT_PUB_KEY_REFRESH_INTERVAL |
+Time Duration | +20m0s |
+The interval for istiod to fetch the jwks_uri for the jwks public key. | +
PILOT_MAX_REQUESTS_PER_SECOND |
+Floating-Point | +25 |
+Limits the number of incoming XDS requests per second. On larger machines this can be increased to handle more proxies concurrently. | +
PILOT_MULTI_NETWORK_DISCOVER_GATEWAY_API |
+Boolean | +false |
+If true, Pilot will discover labeled Kubernetes gateway objects as multi-network gateways. | +
PILOT_PERSISTENT_SESSION_HEADER_LABEL |
+String | +istio.io/persistent-session-header |
+If not empty, services with this label will use header based persistent sessions | +
PILOT_PERSISTENT_SESSION_LABEL |
+String | +istio.io/persistent-session |
+If not empty, services with this label will use cookie based persistent sessions | +
PILOT_PUSH_THROTTLE |
+Integer | +100 |
+Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes | +
PILOT_REMOTE_CLUSTER_TIMEOUT |
+Time Duration | +30s |
+After this timeout expires, pilot can become ready without syncing data from clusters added via remote-secrets. Setting the timeout to 0 disables this behavior. | +
PILOT_SCOPE_GATEWAY_TO_NAMESPACE |
+Boolean | +false |
+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. | +
PILOT_SEND_UNHEALTHY_ENDPOINTS |
+Boolean | +false |
+If enabled, Pilot will include unhealthy endpoints in EDS pushes and even if they are sent Envoy does not use them for load balancing. To avoid, sending traffic to non ready endpoints, enabling this flag, disables panic threshold in Envoy i.e. Envoy does not load balance requests to unhealthy/non-ready hosts even if the percentage of healthy hosts fall below minimum health percentage(panic threshold). | +
PILOT_SIDECAR_USE_REMOTE_ADDRESS |
+Boolean | +false |
+UseRemoteAddress sets useRemoteAddress to true for sidecar outbound listeners. | +
PILOT_SKIP_VALIDATE_TRUST_DOMAIN |
+Boolean | +false |
+Skip validating the peer is from the same trust domain when mTLS is enabled in authentication policy | +
PILOT_STATUS_BURST |
+Integer | +500 |
+If status is enabled, controls the Burst rate with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config Burst | +
PILOT_STATUS_MAX_WORKERS |
+Integer | +100 |
+The maximum number of workers Pilot will use to keep configuration status up to date. Smaller numbers will result in higher status latency, but larger numbers may impact CPU in high scale environments. | +
PILOT_STATUS_QPS |
+Integer | +100 |
+If status is enabled, controls the QPS with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config QPS | +
PILOT_STATUS_UPDATE_INTERVAL |
+Time Duration | +500ms |
+Interval to update the XDS distribution status. | +
PILOT_TRACE_SAMPLING |
+Floating-Point | +1 |
+Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 1.0. | +
PILOT_WORKLOAD_ENTRY_GRACE_PERIOD |
+Time Duration | +10s |
+The amount of time an auto-registered workload can remain disconnected from all Pilot instances before the associated WorkloadEntry is cleaned up. | +
PILOT_XDS_CACHE_INDEX_CLEAR_INTERVAL |
+Time Duration | +5s |
+The interval for xds cache index clearing. | +
PILOT_XDS_CACHE_SIZE |
+Integer | +60000 |
+The maximum number of cache entries for the XDS cache. | +
PILOT_XDS_CACHE_STATS |
+Boolean | +false |
+If true, Pilot will collect metrics for XDS cache efficiency. | +
PILOT_XDS_SEND_TIMEOUT |
+Time Duration | +0s |
+The timeout to send the XDS configuration to proxies. After this timeout is reached, Pilot will discard that push. | +
PLATFORM |
+String | + |
+Platform where Istio is deployed. Possible values are "openshift" and "gcp" | +
REQUIRE_3P_TOKEN |
+Boolean | +false |
+Reject k8s default tokens, without audience. If false, default K8S token will be accepted | +
RESOLVE_HOSTNAME_GATEWAYS |
+Boolean | +true |
+If true, hostnames in the LoadBalancer addresses of a Service will be resolved at the control plane for use in cross-network gateways. | +
REWRITE_PROBE_LEGACY_LOCALHOST_DESTINATION |
+Boolean | +false |
+If enabled, readiness probes will be sent to 'localhost'. Otherwise, they will be sent to the Pod's IP, matching Kubernetes' behavior. | +
SHARED_MESH_CONFIG |
+String | + |
+Additional config map to load for shared MeshConfig settings. The standard mesh config will take precedence. | +
TERM |
+String | + |
+Specifies terminal type. Use 'dumb' to suppress color output | +
TOKEN_AUDIENCES |
+String | +istio-ca |
+A list of comma separated audiences to check in the JWT token before issuing a certificate. The token is accepted if it matches with one of the audiences | +
TRUSTED_GATEWAY_CIDR |
+String | + |
+If set, any connections from gateway to Istiod with this CIDR range are treated as trusted for using authentication mechanisms like XFCC. This can only be used when the network where Istiod and the authenticating gateways are running in a trusted/secure network | +
UNSAFE_ENABLE_ADMIN_ENDPOINTS |
+Boolean | +false |
+If this is set to true, dangerous admin endpoints will be exposed on the debug interface. Not recommended for production. | +
UNSAFE_PILOT_ENABLE_DELTA_TEST |
+Boolean | +false |
+If enabled, addition runtime tests for Delta XDS efficiency are added. These checks are extremely expensive, so this should be used only for testing, not production. | +
UNSAFE_PILOT_ENABLE_RUNTIME_ASSERTIONS |
+Boolean | +false |
+If enabled, addition runtime asserts will be performed. These checks are both expensive and panic on failure. As a result, this should be used only for testing. | +
VALIDATION_WEBHOOK_CONFIG_NAME |
+String | +istio-istio-system |
+If not empty, the controller will automatically patch validatingwebhookconfiguration when the CA certificate changes. Only works in kubernetes environment. | +
VERIFY_CERTIFICATE_AT_CLIENT |
+Boolean | +false |
+If enabled, certificates received by the proxy will be verified against the OS CA certificate bundle. | +
VERIFY_SDS_CERTIFICATE |
+Boolean | +true |
+If enabled, certificates fetched from SDS server will be verified before sending back to proxy. | +
XDS_AUTH |
+Boolean | +true |
+If true, will authenticate XDS clients. | +
XDS_AUTH_PLAINTEXT |
+Boolean | +false |
+authenticate plain text requests - used if Istiod is running on a secure/trusted network | +
| Metric Name | Type | Description |
|---|---|---|
auto_registration_deletes_total | Sum | Total number of auto registration cleaned up by periodic timer. |
auto_registration_errors_total | Sum | Total number of auto registration errors. |
auto_registration_success_total | Sum | Total number of successful auto registrations. |
auto_registration_unregister_total | Sum | Total number of unregistrations. |
auto_registration_updates_total | Sum | Total number of auto registration updates. |
cache_flush_total | Sum | number of times operator cache was flushed |
controller_sync_errors_total | Sum | Total number of errorMetric syncing controllers. |
cr_deletion_total | Sum | Number of IstioOperator CR deleted |
cr_merge_failure_total | Sum | Number of IstioOperator CR merge failures |
cr_validation_error_total | Sum | Number of IstioOperator CR validation failures |
endpoint_no_pod | LastValue | Endpoints without an associated pod. |
get_cr_error_total | Sum | Number of times fetching CR from apiserver failed |
istio_build | LastValue | Istio component build info |
istiod_managed_clusters | LastValue | Number of clusters managed by istiod |
legacy_path_translation_total | Sum | Number of times a legacy API path is translated |
manifest_patch_error_total | Sum | Number of times K8S patch overlays failed |
manifest_render_error_total | Sum | Number of times error occurred during rendering output manifest |
num_outgoing_retries | Sum | Number of outgoing retry requests (e.g. to a token exchange server, CA, etc.) |
owned_resource_total | LastValue | Number of resources currently owned by the operator |
pilot_conflict_inbound_listener | LastValue | Number of conflicting inbound listeners. |
pilot_conflict_outbound_listener_tcp_over_current_tcp | LastValue | Number of conflicting tcp listeners with current tcp listener. |
pilot_debounce_time | Distribution | Delay in seconds between the first config enters debouncing and the merged push request is pushed into the push queue. |
pilot_destrule_subsets | LastValue | Duplicate subsets across destination rules for same host |
pilot_dns_cluster_without_endpoints | LastValue | DNS clusters without endpoints caused by the endpoint field in STRICT_DNS type cluster is not set or the corresponding subset cannot select any endpoint |
pilot_duplicate_envoy_clusters | LastValue | Duplicate envoy clusters caused by service entries with same hostname |
pilot_eds_no_instances | LastValue | Number of clusters without instances. |
pilot_endpoint_not_ready | LastValue | Endpoint found in unready state. |
pilot_envoy_filter_status | LastValue | Status of Envoy filters whether it was applied or errored. |
pilot_inbound_updates | Sum | Total number of updates received by pilot. |
pilot_jwks_resolver_network_fetch_fail_total | Sum | Total number of failed network fetch by pilot jwks resolver |
pilot_jwks_resolver_network_fetch_success_total | Sum | Total number of successfully network fetch by pilot jwks resolver |
pilot_k8s_cfg_events | Sum | Events from k8s config. |
pilot_k8s_endpoints_pending_pod | LastValue | Number of endpoints that do not currently have any corresponding pods. |
pilot_k8s_endpoints_with_no_pods | Sum | Endpoints that does not have any corresponding pods. |
pilot_k8s_reg_events | Sum | Events from k8s registry. |
pilot_no_ip | LastValue | Pods not found in the endpoint table, possibly invalid. |
pilot_proxy_convergence_time | Distribution | Delay in seconds between config change and a proxy receiving all required configuration. |
pilot_proxy_queue_time | Distribution | Time in seconds, a proxy is in the push queue before being dequeued. |
pilot_push_triggers | Sum | Total number of times a push was triggered, labeled by reason for the push. |
pilot_pushcontext_init_seconds | Distribution | Total time in seconds Pilot takes to init pushContext. |
pilot_sds_certificate_errors_total | Sum | Total number of failures to fetch SDS key and certificate. |
pilot_services | LastValue | Total services known to pilot. |
pilot_total_rejected_configs | Sum | Total number of configs that Pilot had to reject or ignore. |
pilot_total_xds_internal_errors | Sum | Total number of internal XDS errors in pilot. |
pilot_total_xds_rejects | Sum | Total number of XDS responses from pilot rejected by proxy. |
pilot_virt_services | LastValue | Total virtual services known to pilot. |
pilot_vservice_dup_domain | LastValue | Virtual services with dup domains. |
pilot_worker_queue_depth | LastValue | Depth of the controller queues |
pilot_worker_queue_duration | Distribution | Time taken to process an item |
pilot_worker_queue_latency | Distribution | Latency before the item is processed |
pilot_xds | LastValue | Number of endpoints connected to this pilot using XDS. |
pilot_xds_cds_reject | LastValue | Pilot rejected CDS configs. |
pilot_xds_config_size_bytes | Distribution | Distribution of configuration sizes pushed to clients |
pilot_xds_eds_reject | LastValue | Pilot rejected EDS. |
pilot_xds_expired_nonce | Sum | Total number of XDS requests with an expired nonce. |
pilot_xds_lds_reject | LastValue | Pilot rejected LDS. |
pilot_xds_push_context_errors | Sum | Number of errors (timeouts) initiating push context. |
pilot_xds_push_time | Distribution | Total time in seconds Pilot takes to push lds, rds, cds and eds. |
pilot_xds_pushes | Sum | Pilot build and send errors for lds, rds, cds and eds. |
pilot_xds_rds_reject | LastValue | Pilot rejected RDS. |
pilot_xds_send_time | Distribution | Total time in seconds Pilot takes to send generated configuration. |
pilot_xds_write_timeout | Sum | Pilot XDS response write timeouts. |
provider_lookup_cluster_failures | Sum | Number of times a cluster lookup failed |
reconcile_request_total | Sum | Number of times requesting Reconcile |
remote_cluster_sync_timeouts_total | Sum | Number of times remote clusters took too long to sync, causing slow startup that excludes remote clusters. |
render_manifest_total | Sum | Number of component manifests rendered |
resource_creation_total | Sum | Number of resources created by the operator |
resource_deletion_total | Sum | Number of resources deleted by the operator |
resource_prune_total | Sum | Number of resources pruned by the operator |
resource_update_total | Sum | Number of resources updated by the operator |
scrape_failures_total | Sum | The total number of failed scrapes. |
scrapes_total | Sum | The total number of scrapes. |
sidecar_injection_failure_total | Sum | Total number of failed sidecar injection requests. |
sidecar_injection_requests_total | Sum | Total number of sidecar injection requests. |
sidecar_injection_skip_total | Sum | Total number of skipped sidecar injection requests. |
sidecar_injection_success_total | Sum | Total number of successful sidecar injection requests. |
sidecar_injection_time_seconds | Distribution | Total time taken for injection in seconds. |
startup_duration_seconds | LastValue | The time from the process starting to being marked ready. |
version | LastValue | Version of operator binary |
wasm_cache_entries | LastValue | number of Wasm remote fetch cache entries. |
wasm_cache_lookup_count | Sum | number of Wasm remote fetch cache lookups. |
wasm_config_conversion_count | Sum | number of Wasm config conversion count and results, including success, no remote load, marshal failure, remote fetch failure, miss remote fetch hint. |
wasm_config_conversion_duration | Distribution | Total time in milliseconds istio-agent spends on converting remote load in Wasm config. |
wasm_remote_fetch_count | Sum | number of Wasm remote fetches and results, including success, download failure, and checksum mismatch. |
webhook_patch_attempts_total | Sum | Webhook patching attempts |
webhook_patch_failures_total | Sum | Webhook patching total failures |
webhook_patch_retries_total | Sum | Webhook patching retries |
xds_cache_dependent_config_size | LastValue | Current size of dependent configs |
xds_cache_evictions | Sum | Total number of xds cache evictions. |
xds_cache_reads | Sum | Total number of xds cache xdsCacheReads. |
xds_cache_size | LastValue | Current size of xds cache |
The Istio operator.
+| Flags | +Description | +
|---|---|
--kubeconfig <string> |
+Paths to a kubeconfig. Only required if out-of-cluster. (default ``) | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for operator for the specified shell. +See each sub-command's help for details on how to use the generated script. +
+| Flags | +Description | +
|---|---|
--kubeconfig <string> |
+Paths to a kubeconfig. Only required if out-of-cluster. (default ``) | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the bash shell.
+This script depends on the 'bash-completion' package. +If it is not installed already, you can install it via your OS's package manager.
+To load completions in your current shell session:
+source <(operator completion bash)
+To load completions for every new session, execute once:
+#### Linux:
+operator completion bash > /etc/bash_completion.d/operator
+#### macOS:
+operator completion bash > $(brew --prefix)/etc/bash_completion.d/operator
+You will need to start a new shell for this setup to take effect. +
+operator completion bash
+| Flags | +Description | +
|---|---|
--kubeconfig <string> |
+Paths to a kubeconfig. Only required if out-of-cluster. (default ``) | +
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the fish shell.
+To load completions in your current shell session:
+operator completion fish | source
+To load completions for every new session, execute once:
+operator completion fish > ~/.config/fish/completions/operator.fish
+You will need to start a new shell for this setup to take effect. +
+operator completion fish [flags]
+| Flags | +Description | +
|---|---|
--kubeconfig <string> |
+Paths to a kubeconfig. Only required if out-of-cluster. (default ``) | +
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for powershell.
+To load completions in your current shell session:
+operator completion powershell | Out-String | Invoke-Expression
+To load completions for every new session, add the output of the above command +to your powershell profile. +
+operator completion powershell [flags]
+| Flags | +Description | +
|---|---|
--kubeconfig <string> |
+Paths to a kubeconfig. Only required if out-of-cluster. (default ``) | +
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the zsh shell.
+If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once:
+echo "autoload -U compinit; compinit" >> ~/.zshrc
+To load completions in your current shell session:
+source <(operator completion zsh)
+To load completions for every new session, execute once:
+#### Linux:
+operator completion zsh > "${fpath[1]}/_operator"
+#### macOS:
+operator completion zsh > $(brew --prefix)/share/zsh/site-functions/_operator
+You will need to start a new shell for this setup to take effect. +
+operator completion zsh [flags]
+| Flags | +Description | +
|---|---|
--kubeconfig <string> |
+Paths to a kubeconfig. Only required if out-of-cluster. (default ``) | +
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Starts the Istio operator server
+operator server [flags]
+| Flags | +Description | +
|---|---|
--ctrlz_address <string> |
+The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `localhost`) | +
--ctrlz_port <uint16> |
+The IP port to use for the ControlZ introspection facility (default `9876`) | +
--force |
+Proceed even with validation errors. | +
--kubeconfig <string> |
+Paths to a kubeconfig. Only required if out-of-cluster. (default ``) | +
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, file, gateway, grpcgen, ingress status, installer, klog, kube, model, monitoring, patch, processing, retry, security, serviceentry, spiffe, status, tpath, translator, trustBundle, util, validation, wasm, wle] (default ``) | +
--log_output_level <string> |
+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, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, file, gateway, grpcgen, ingress status, installer, klog, kube, model, monitoring, patch, processing, retry, security, serviceentry, spiffe, status, tpath, translator, trustBundle, util, validation, wasm, wle] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, file, gateway, grpcgen, ingress status, installer, klog, kube, model, monitoring, patch, processing, retry, security, serviceentry, spiffe, status, tpath, translator, trustBundle, util, validation, wasm, wle] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--max-concurrent-reconciles <int> |
+Defines the concurrency limit for operator to reconcile IstioOperatorSpec in parallel. Default value is 1. (default `1`) | +
--monitoring-host <string> |
+HTTP host to use for operator's self-monitoring information (default `0.0.0.0`) | +
--monitoring-port <uint32> |
+HTTP port to use for operator's self-monitoring information (default `8383`) | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Prints out build version information
+operator version [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--kubeconfig <string> |
++ | Paths to a kubeconfig. Only required if out-of-cluster. (default ``) | +
--output <string> |
+-o |
+One of 'yaml' or 'json'. (default ``) | +
--short |
+-s |
+Use --short=false to generate full version information | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
operator command. Please use with caution as these environment variables are experimental and can change anytime.
+| Variable Name | +Type | +Default Value | +Description | +
|---|---|---|---|
CA_TRUSTED_NODE_ACCOUNTS |
+String | + |
+If set, the list of service accounts that are allowed to use node authentication for CSRs. Node authentication allows an identity to create CSRs on behalf of other identities, but only if there is a pod running on the same node with that identity. This is intended for use with node proxies. | +
CERT_SIGNER_DOMAIN |
+String | + |
+The cert signer domain info | +
CLOUD_PLATFORM |
+String | + |
+Cloud Platform on which proxy is running, if not specified, Istio will try to discover the platform. Valid platform values are aws, azure, gcp, none | +
CLUSTER_ID |
+String | +Kubernetes |
+Defines the cluster and service registry that this Istiod instance belongs to | +
ENABLE_AUTO_SNI |
+Boolean | +false |
+If enabled, automatically set SNI when `DestinationRules` do not specify the same | +
ENABLE_CA_SERVER |
+Boolean | +true |
+If this is set to false, will not create CA server in istiod. | +
ENABLE_DEBUG_ON_HTTP |
+Boolean | +true |
+If this is set to false, the debug interface will not be enabled, recommended for production | +
ENABLE_ENHANCED_RESOURCE_SCOPING |
+Boolean | +false |
+If enabled, meshConfig.discoverySelectors will limit the CustomResource configurations(like Gateway,VirtualService,DestinationRule,Ingress, etc)that can be processed by pilot. This will also restrict the root-ca certificate distribution. | +
ENABLE_HCM_INTERNAL_NETWORKS |
+Boolean | +false |
+If enable, endpoints defined in mesh networks will be configured as internal addresses in Http Connection Manager | +
ENABLE_LEADER_ELECTION |
+Boolean | +true |
+If enabled (default), starts a leader election client and gains leadership before executing controllers. If false, it assumes that only one instance of istiod is running and skips leader election. | +
ENABLE_MCS_AUTO_EXPORT |
+Boolean | +false |
+If enabled, istiod will automatically generate Kubernetes Multi-Cluster Services (MCS) ServiceExport resources for every service in the mesh. Services defined to be cluster-local in MeshConfig are excluded. | +
ENABLE_MCS_CLUSTER_LOCAL |
+Boolean | +false |
+If enabled, istiod will treat the host `<svc>.<namespace>.svc.cluster.local` as defined by the Kubernetes Multi-Cluster Services (MCS) spec. In this mode, requests to `cluster.local` will be routed to only those endpoints residing within the same cluster as the client. Requires that both ENABLE_MCS_SERVICE_DISCOVERY and ENABLE_MCS_HOST also be enabled. | +
ENABLE_MCS_HOST |
+Boolean | +false |
+If enabled, istiod will configure a Kubernetes Multi-Cluster Services (MCS) host (<svc>.<namespace>.svc.clusterset.local) for each service exported (via ServiceExport) in at least one cluster. Clients must, however, be able to successfully lookup these DNS hosts. That means that either Istio DNS interception must be enabled or an MCS controller must be used. Requires that ENABLE_MCS_SERVICE_DISCOVERY also be enabled. | +
ENABLE_MCS_SERVICE_DISCOVERY |
+Boolean | +false |
+If enabled, istiod will enable Kubernetes Multi-Cluster Services (MCS) service discovery mode. In this mode, service endpoints in a cluster will only be discoverable within the same cluster unless explicitly exported via ServiceExport. | +
ENABLE_MULTICLUSTER_HEADLESS |
+Boolean | +true |
+If true, the DNS name table for a headless service will resolve to same-network endpoints in any cluster. | +
ENABLE_NATIVE_SIDECARS |
+Boolean | +false |
+If set, used Kubernetes native Sidecar container support. Requires SidecarContainer feature flag. | +
ENABLE_OPTIMIZED_CONFIG_REBUILD |
+Boolean | +true |
+If enabled, pilot will only rebuild config for resources that have changed | +
ENABLE_OTEL_BUILTIN_RESOURCE_LABELS |
+Boolean | +false |
+If enabled, envoy will send builtin lables(e.g. node_name) via OTel sink. | +
ENABLE_PROBE_KEEPALIVE_CONNECTIONS |
+Boolean | +false |
+If enabled, readiness probes will keep the connection from pilot-agent to the application alive. This mirrors older Istio versions' behaviors, but not kubelet's. | +
ENABLE_TLS_ON_SIDECAR_INGRESS |
+Boolean | +false |
+If enabled, the TLS configuration on Sidecar.ingress will take effect | +
EXTERNAL_ISTIOD |
+Boolean | +false |
+If this is set to true, one Istiod will control remote clusters including CA. | +
GCP_METADATA |
+String | + |
+Pipe separated GCP metadata, schemed as PROJECT_ID|PROJECT_NUMBER|CLUSTER_NAME|CLUSTER_ZONE | +
GCP_QUOTA_PROJECT |
+String | + |
+Allows specification of a quota project to be used in requests to GCP APIs. | +
GRPC_KEEPALIVE_INTERVAL |
+Time Duration | +30s |
+gRPC Keepalive Interval | +
GRPC_KEEPALIVE_TIMEOUT |
+Time Duration | +10s |
+gRPC Keepalive Timeout | +
HTTP_STRIP_FRAGMENT_FROM_PATH_UNSAFE_IF_DISABLED |
+Boolean | +true |
++ |
INBOUND_INTERCEPTION_MODE |
+String | + |
+The mode used to redirect inbound connections to Envoy, either "REDIRECT" or "TPROXY" | +
INBOUND_TPROXY_MARK |
+String | + |
++ |
INJECTION_WEBHOOK_CONFIG_NAME |
+String | +istio-sidecar-injector |
+Name of the mutatingwebhookconfiguration to patch, if istioctl is not used. | +
ISTIOD_CUSTOM_HOST |
+String | + |
+Custom host name of istiod that istiod signs the server cert. Multiple custom host names are supported, and multiple values are separated by commas. | +
ISTIO_AGENT_ENABLE_WASM_REMOTE_LOAD_CONVERSION |
+Boolean | +true |
+If enabled, Istio agent will intercept ECDS resource update, downloads Wasm module, and replaces Wasm module remote load with downloaded local module file. | +
ISTIO_BOOTSTRAP |
+String | + |
++ |
ISTIO_DELTA_XDS |
+Boolean | +false |
+If enabled, pilot will only send the delta configs as opposed to the state of the world on a Resource Request. This feature uses the delta xds api, but does not currently send the actual deltas. | +
ISTIO_DUAL_STACK |
+Boolean | +false |
+If true, Istio will enable the Dual Stack feature. | +
ISTIO_ENABLE_CONTROLLER_QUEUE_METRICS |
+Boolean | +false |
+If enabled, publishes metrics for queue depth, latency and processing times. | +
ISTIO_ENABLE_HTTP2_PROBING |
+Boolean | +true |
+If enabled, HTTP2 probes will be enabled for HTTPS probes, following Kubernetes | +
ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSH |
+Boolean | +true |
+If enabled, Istiod will not push changes on arbitrary annotation change. | +
ISTIO_GPRC_MAXRECVMSGSIZE |
+Integer | +4194304 |
+Sets the max receive buffer size of gRPC stream in bytes. | +
ISTIO_GPRC_MAXSTREAMS |
+Integer | +100000 |
+Sets the maximum number of concurrent grpc streams. | +
ISTIO_KUBE_CLIENT_CONTENT_TYPE |
+String | +protobuf |
+The content type to use for Kubernetes clients. Defaults to protobuf. Valid options: [protobuf, json] | +
ISTIO_MULTIROOT_MESH |
+Boolean | +false |
+If enabled, mesh will support certificates signed by more than one trustAnchor for ISTIO_MUTUAL mTLS | +
ISTIO_OUTBOUND_OWNER_GROUPS |
+String | +* |
+Comma separated list of groups whose outgoing traffic is to be redirected to Envoy. +A group can be specified either by name or by a numeric GID. +The wildcard character "*" can be used to configure redirection of traffic from all groups. | +
ISTIO_OUTBOUND_OWNER_GROUPS_EXCLUDE |
+String | + |
+Comma separated list of groups whose outgoing traffic is to be excluded from redirection to Envoy. +A group can be specified either by name or by a numeric GID. +Only applies when traffic from all groups (i.e. "*") is being redirected to Envoy. | +
ISTIO_PROMETHEUS_ANNOTATIONS |
+String | + |
++ |
ISTIO_WATCH_NAMESPACE |
+String | + |
+If set, limit Kubernetes watches to a single namespace. Warning: only a single namespace can be set. | +
ISTIO_WORKLOAD_ENTRY_VALIDATE_IDENTITY |
+Boolean | +true |
+If enabled, will validate the identity of a workload matches the identity of the WorkloadEntry it is associating with for health checks and auto registration. This flag is added for backwards compatibility only and will be removed in future releases | +
JWKS_RESOLVER_INSECURE_SKIP_VERIFY |
+Boolean | +false |
+If enabled, istiod will skip verifying the certificate of the JWKS server. | +
JWT_POLICY |
+String | +third-party-jwt |
+The JWT validation policy. | +
K8S_INGRESS_NS |
+String | +istio-system |
++ |
K_REVISION |
+String | + |
+KNative revision, set if running in knative | +
LABEL_CANONICAL_SERVICES_FOR_MESH_EXTERNAL_SERVICE_ENTRIES |
+Boolean | +false |
+If enabled, metadata representing canonical services for ServiceEntry resources with a location of mesh_external will be populatedin the cluster metadata for those endpoints. | +
LOCAL_CLUSTER_SECRET_WATCHER |
+Boolean | +false |
+If enabled, the cluster secret watcher will watch the namespace of the external cluster instead of config cluster | +
MCS_API_GROUP |
+String | +multicluster.x-k8s.io |
+The group to be used for the Kubernetes Multi-Cluster Services (MCS) API. | +
MCS_API_VERSION |
+String | +v1alpha1 |
+The version to be used for the Kubernets Multi-Cluster Services (MCS) API. | +
METRIC_GRACEFUL_DELETION_INTERVAL |
+Time Duration | +5m0s |
+Metric expiry graceful deletion interval. No-op if METRIC_ROTATION_INTERVAL is disabled. | +
METRIC_ROTATION_INTERVAL |
+Time Duration | +0s |
+Metric scope rotation interval, set to 0 to disable the metric scope rotation | +
MUTEX_PROFILE_FRACTION |
+Integer | +1000 |
+If set to a non-zero value, enables mutex profiling a rate of 1/MUTEX_PROFILE_FRACTION events. For example, '1000' will record 0.1% of events. Set to 0 to disable entirely. | +
NATIVE_METADATA_EXCHANGE |
+Boolean | +true |
+If set, uses a native implementation of the HTTP metadata exchange filter | +
PILOT_ALLOW_SIDECAR_SERVICE_INBOUND_LISTENER_MERGE |
+Boolean | +false |
+If set, it allows creating inbound listeners for service ports and sidecar ingress listeners | +
PILOT_ANALYSIS_INTERVAL |
+Time Duration | +10s |
+If analysis is enabled, pilot will run istio analyzers using this value as interval in seconds Istio Resources | +
PILOT_CERT_PROVIDER |
+String | +istiod |
+The provider of Pilot DNS certificate. | +
PILOT_DEBOUNCE_AFTER |
+Time Duration | +100ms |
+The delay added to config/registry events for debouncing. This will delay the push by at least this interval. If no change is detected within this period, the push will happen, otherwise we'll keep delaying until things settle, up to a max of PILOT_DEBOUNCE_MAX. | +
PILOT_DEBOUNCE_MAX |
+Time Duration | +10s |
+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. | +
PILOT_DISTRIBUTION_HISTORY_RETENTION |
+Time Duration | +1m0s |
+If enabled, Pilot will keep track of old versions of distributed config for this duration. | +
PILOT_DRAINING_LABEL |
+String | +istio.io/draining |
+If not empty, endpoints with the label value present will be sent with status DRAINING. | +
PILOT_ENABLE_ALPHA_GATEWAY_API |
+Boolean | +false |
+If this is set to true, support for alpha APIs in the Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed. | +
PILOT_ENABLE_ALPN_FILTER |
+Boolean | +true |
+If true, pilot will add Istio ALPN filters, required for proper protocol sniffing. | +
PILOT_ENABLE_AMBIENT_CONTROLLERS |
+Boolean | +false |
+If enabled, controllers required for ambient will run. This is required to run ambient mesh. | +
PILOT_ENABLE_ANALYSIS |
+Boolean | +false |
+If enabled, pilot will run istio analyzers and write analysis errors to the Status field of any Istio Resources | +
PILOT_ENABLE_CDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache CDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE. | +
PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING |
+Boolean | +false |
+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. | +
PILOT_ENABLE_CROSS_CLUSTER_WORKLOAD_ENTRY |
+Boolean | +true |
+If enabled, pilot will read WorkloadEntry from other clusters, selectable by Services in that cluster. | +
PILOT_ENABLE_EDS_DEBOUNCE |
+Boolean | +true |
+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 | +
PILOT_ENABLE_EDS_FOR_HEADLESS_SERVICES |
+Boolean | +false |
+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. | +
PILOT_ENABLE_GATEWAY_API |
+Boolean | +true |
+If this is set to true, support for Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed. | +
PILOT_ENABLE_GATEWAY_API_DEPLOYMENT_CONTROLLER |
+Boolean | +true |
+If this is set to true, gateway-api resources will automatically provision in cluster deployment, services, etc | +
PILOT_ENABLE_GATEWAY_API_GATEWAYCLASS_CONTROLLER |
+Boolean | +true |
+If this is set to true, istiod will create and manage its default GatewayClasses | +
PILOT_ENABLE_GATEWAY_API_STATUS |
+Boolean | +true |
+If this is set to true, gateway-api resources will have status written to them | +
PILOT_ENABLE_HBONE |
+Boolean | +false |
+If enabled, HBONE support can be configured for proxies. Note: proxies must opt in on a per-proxy basis with ENABLE_HBONE to actually get HBONE config, in addition to this flag. | +
PILOT_ENABLE_HEADLESS_SERVICE_POD_LISTENERS |
+Boolean | +true |
+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. | +
PILOT_ENABLE_INBOUND_PASSTHROUGH |
+Boolean | +true |
+If enabled, inbound clusters will be configured as ORIGINAL_DST clusters. When disabled, requests are always sent to localhost. The primary implication of this is that when enabled, binding to POD_IP will work while localhost will not; when disable, bind to POD_IP will not work, while localhost will. The enabled behavior matches the behavior without Istio enabled at all; this flag exists only for backwards compatibility. Regardless of this setting, the configuration can be overridden with the Sidecar.Ingress.DefaultEndpoint configuration. | +
PILOT_ENABLE_K8S_SELECT_WORKLOAD_ENTRIES |
+Boolean | +true |
+If enabled, Kubernetes services with selectors will select workload entries with matching labels. It is safe to disable it if you are quite sure you don't need this feature | +
PILOT_ENABLE_METADATA_EXCHANGE |
+Boolean | +true |
+If true, pilot will add metadata exchange filters, which will be consumed by telemetry filter. | +
PILOT_ENABLE_MONGO_FILTER |
+Boolean | +true |
+EnableMongoFilter enables injection of `envoy.filters.network.mongo_proxy` in the filter chain. | +
PILOT_ENABLE_MYSQL_FILTER |
+Boolean | +false |
+EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain. | +
PILOT_ENABLE_PERSISTENT_SESSION_FILTER |
+Boolean | +false |
+If enabled, Istiod sets up persistent session filter for listeners, if services have 'PILOT_PERSISTENT_SESSION_LABEL' set. | +
PILOT_ENABLE_QUIC_LISTENERS |
+Boolean | +false |
+If true, QUIC listeners will be generated wherever there are listeners terminating TLS on gateways if the gateway service exposes a UDP port with the same number (for example 443/TCP and 443/UDP) | +
PILOT_ENABLE_RDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache RDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE. | +
PILOT_ENABLE_REDIS_FILTER |
+Boolean | +false |
+EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain. | +
PILOT_ENABLE_ROUTE_COLLAPSE_OPTIMIZATION |
+Boolean | +true |
+If true, Pilot will merge virtual hosts with the same routes into a single virtual host, as an optimization. | +
PILOT_ENABLE_SERVICEENTRY_SELECT_PODS |
+Boolean | +true |
+If enabled, service entries with selectors will select pods from the cluster. It is safe to disable it if you are quite sure you don't need this feature | +
PILOT_ENABLE_STATUS |
+Boolean | +false |
+If enabled, pilot will update the CRD Status field of all istio resources with reconciliation status. | +
PILOT_ENABLE_TELEMETRY_LABEL |
+Boolean | +true |
+If true, pilot will add telemetry related metadata to cluster and endpoint resources, which will be consumed by telemetry filter. | +
PILOT_ENABLE_WORKLOAD_ENTRY_AUTOREGISTRATION |
+Boolean | +true |
+Enables auto-registering WorkloadEntries based on associated WorkloadGroups upon XDS connection by the workload. | +
PILOT_ENABLE_WORKLOAD_ENTRY_HEALTHCHECKS |
+Boolean | +true |
+Enables automatic health checks of WorkloadEntries based on the config provided in the associated WorkloadGroup | +
PILOT_ENABLE_XDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache XDS responses. | +
PILOT_ENABLE_XDS_IDENTITY_CHECK |
+Boolean | +true |
+If enabled, pilot will authorize XDS clients, to ensure they are acting only as namespaces they have permissions for. | +
PILOT_ENDPOINT_TELEMETRY_LABEL |
+Boolean | +true |
+If true, pilot will add telemetry related metadata to Endpoint resource, which will be consumed by telemetry filter. | +
PILOT_ENVOY_FILTER_STATS |
+Boolean | +false |
+If true, Pilot will collect metrics for envoy filter operations. | +
PILOT_FILTER_GATEWAY_CLUSTER_CONFIG |
+Boolean | +false |
+If enabled, Pilot will send only clusters that referenced in gateway virtual services attached to gateway | +
PILOT_HTTP10 |
+Boolean | +false |
+Enables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications. | +
PILOT_INSECURE_MULTICLUSTER_KUBECONFIG_OPTIONS |
+String | + |
+Comma separated list of potentially insecure kubeconfig authentication options that are allowed for multicluster authentication.Support values: all authProviders (`gcp`, `azure`, `exec`, `openstack`), `clientKey`, `clientCertificate`, `tokenFile`, and `exec`. | +
PILOT_JWT_ENABLE_REMOTE_JWKS |
+String | +false |
+Mode of fetching JWKs from JwksUri in RequestAuthentication. Supported value: istiod, false, hybrid, true, envoy. The client fetching JWKs is as following: istiod/false - Istiod; hybrid/true - Envoy and fallback to Istiod if JWKs server is external; envoy - Envoy. | +
PILOT_JWT_PUB_KEY_REFRESH_INTERVAL |
+Time Duration | +20m0s |
+The interval for istiod to fetch the jwks_uri for the jwks public key. | +
PILOT_MAX_REQUESTS_PER_SECOND |
+Floating-Point | +25 |
+Limits the number of incoming XDS requests per second. On larger machines this can be increased to handle more proxies concurrently. | +
PILOT_MULTI_NETWORK_DISCOVER_GATEWAY_API |
+Boolean | +false |
+If true, Pilot will discover labeled Kubernetes gateway objects as multi-network gateways. | +
PILOT_PERSISTENT_SESSION_HEADER_LABEL |
+String | +istio.io/persistent-session-header |
+If not empty, services with this label will use header based persistent sessions | +
PILOT_PERSISTENT_SESSION_LABEL |
+String | +istio.io/persistent-session |
+If not empty, services with this label will use cookie based persistent sessions | +
PILOT_PUSH_THROTTLE |
+Integer | +100 |
+Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes | +
PILOT_REMOTE_CLUSTER_TIMEOUT |
+Time Duration | +30s |
+After this timeout expires, pilot can become ready without syncing data from clusters added via remote-secrets. Setting the timeout to 0 disables this behavior. | +
PILOT_SCOPE_GATEWAY_TO_NAMESPACE |
+Boolean | +false |
+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. | +
PILOT_SEND_UNHEALTHY_ENDPOINTS |
+Boolean | +false |
+If enabled, Pilot will include unhealthy endpoints in EDS pushes and even if they are sent Envoy does not use them for load balancing. To avoid, sending traffic to non ready endpoints, enabling this flag, disables panic threshold in Envoy i.e. Envoy does not load balance requests to unhealthy/non-ready hosts even if the percentage of healthy hosts fall below minimum health percentage(panic threshold). | +
PILOT_SIDECAR_USE_REMOTE_ADDRESS |
+Boolean | +false |
+UseRemoteAddress sets useRemoteAddress to true for sidecar outbound listeners. | +
PILOT_SKIP_VALIDATE_TRUST_DOMAIN |
+Boolean | +false |
+Skip validating the peer is from the same trust domain when mTLS is enabled in authentication policy | +
PILOT_STATUS_BURST |
+Integer | +500 |
+If status is enabled, controls the Burst rate with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config Burst | +
PILOT_STATUS_MAX_WORKERS |
+Integer | +100 |
+The maximum number of workers Pilot will use to keep configuration status up to date. Smaller numbers will result in higher status latency, but larger numbers may impact CPU in high scale environments. | +
PILOT_STATUS_QPS |
+Integer | +100 |
+If status is enabled, controls the QPS with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config QPS | +
PILOT_STATUS_UPDATE_INTERVAL |
+Time Duration | +500ms |
+Interval to update the XDS distribution status. | +
PILOT_TRACE_SAMPLING |
+Floating-Point | +1 |
+Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 1.0. | +
PILOT_WORKLOAD_ENTRY_GRACE_PERIOD |
+Time Duration | +10s |
+The amount of time an auto-registered workload can remain disconnected from all Pilot instances before the associated WorkloadEntry is cleaned up. | +
PILOT_XDS_CACHE_INDEX_CLEAR_INTERVAL |
+Time Duration | +5s |
+The interval for xds cache index clearing. | +
PILOT_XDS_CACHE_SIZE |
+Integer | +60000 |
+The maximum number of cache entries for the XDS cache. | +
PILOT_XDS_CACHE_STATS |
+Boolean | +false |
+If true, Pilot will collect metrics for XDS cache efficiency. | +
PILOT_XDS_SEND_TIMEOUT |
+Time Duration | +0s |
+The timeout to send the XDS configuration to proxies. After this timeout is reached, Pilot will discard that push. | +
PLATFORM |
+String | + |
+Platform where Istio is deployed. Possible values are "openshift" and "gcp" | +
REQUIRE_3P_TOKEN |
+Boolean | +false |
+Reject k8s default tokens, without audience. If false, default K8S token will be accepted | +
RESOLVE_HOSTNAME_GATEWAYS |
+Boolean | +true |
+If true, hostnames in the LoadBalancer addresses of a Service will be resolved at the control plane for use in cross-network gateways. | +
REWRITE_PROBE_LEGACY_LOCALHOST_DESTINATION |
+Boolean | +false |
+If enabled, readiness probes will be sent to 'localhost'. Otherwise, they will be sent to the Pod's IP, matching Kubernetes' behavior. | +
SHARED_MESH_CONFIG |
+String | + |
+Additional config map to load for shared MeshConfig settings. The standard mesh config will take precedence. | +
TERM |
+String | + |
+Specifies terminal type. Use 'dumb' to suppress color output | +
TOKEN_AUDIENCES |
+String | +istio-ca |
+A list of comma separated audiences to check in the JWT token before issuing a certificate. The token is accepted if it matches with one of the audiences | +
TRUSTED_GATEWAY_CIDR |
+String | + |
+If set, any connections from gateway to Istiod with this CIDR range are treated as trusted for using authentication mechanisms like XFCC. This can only be used when the network where Istiod and the authenticating gateways are running in a trusted/secure network | +
UNSAFE_ENABLE_ADMIN_ENDPOINTS |
+Boolean | +false |
+If this is set to true, dangerous admin endpoints will be exposed on the debug interface. Not recommended for production. | +
UNSAFE_PILOT_ENABLE_DELTA_TEST |
+Boolean | +false |
+If enabled, addition runtime tests for Delta XDS efficiency are added. These checks are extremely expensive, so this should be used only for testing, not production. | +
UNSAFE_PILOT_ENABLE_RUNTIME_ASSERTIONS |
+Boolean | +false |
+If enabled, addition runtime asserts will be performed. These checks are both expensive and panic on failure. As a result, this should be used only for testing. | +
VALIDATION_WEBHOOK_CONFIG_NAME |
+String | +istio-istio-system |
+If not empty, the controller will automatically patch validatingwebhookconfiguration when the CA certificate changes. Only works in kubernetes environment. | +
VERIFY_CERTIFICATE_AT_CLIENT |
+Boolean | +false |
+If enabled, certificates received by the proxy will be verified against the OS CA certificate bundle. | +
VERIFY_SDS_CERTIFICATE |
+Boolean | +true |
+If enabled, certificates fetched from SDS server will be verified before sending back to proxy. | +
XDS_AUTH |
+Boolean | +true |
+If true, will authenticate XDS clients. | +
XDS_AUTH_PLAINTEXT |
+Boolean | +false |
+authenticate plain text requests - used if Istiod is running on a secure/trusted network | +
| Metric Name | Type | Description |
|---|---|---|
auto_registration_deletes_total | Sum | Total number of auto registration cleaned up by periodic timer. |
auto_registration_errors_total | Sum | Total number of auto registration errors. |
auto_registration_success_total | Sum | Total number of successful auto registrations. |
auto_registration_unregister_total | Sum | Total number of unregistrations. |
auto_registration_updates_total | Sum | Total number of auto registration updates. |
cache_flush_total | Sum | number of times operator cache was flushed |
controller_sync_errors_total | Sum | Total number of errorMetric syncing controllers. |
cr_deletion_total | Sum | Number of IstioOperator CR deleted |
cr_merge_failure_total | Sum | Number of IstioOperator CR merge failures |
cr_validation_error_total | Sum | Number of IstioOperator CR validation failures |
endpoint_no_pod | LastValue | Endpoints without an associated pod. |
get_cr_error_total | Sum | Number of times fetching CR from apiserver failed |
istio_build | LastValue | Istio component build info |
istiod_managed_clusters | LastValue | Number of clusters managed by istiod |
legacy_path_translation_total | Sum | Number of times a legacy API path is translated |
manifest_patch_error_total | Sum | Number of times K8S patch overlays failed |
manifest_render_error_total | Sum | Number of times error occurred during rendering output manifest |
num_outgoing_retries | Sum | Number of outgoing retry requests (e.g. to a token exchange server, CA, etc.) |
owned_resource_total | LastValue | Number of resources currently owned by the operator |
pilot_conflict_inbound_listener | LastValue | Number of conflicting inbound listeners. |
pilot_conflict_outbound_listener_tcp_over_current_tcp | LastValue | Number of conflicting tcp listeners with current tcp listener. |
pilot_debounce_time | Distribution | Delay in seconds between the first config enters debouncing and the merged push request is pushed into the push queue. |
pilot_destrule_subsets | LastValue | Duplicate subsets across destination rules for same host |
pilot_dns_cluster_without_endpoints | LastValue | DNS clusters without endpoints caused by the endpoint field in STRICT_DNS type cluster is not set or the corresponding subset cannot select any endpoint |
pilot_duplicate_envoy_clusters | LastValue | Duplicate envoy clusters caused by service entries with same hostname |
pilot_eds_no_instances | LastValue | Number of clusters without instances. |
pilot_endpoint_not_ready | LastValue | Endpoint found in unready state. |
pilot_envoy_filter_status | LastValue | Status of Envoy filters whether it was applied or errored. |
pilot_inbound_updates | Sum | Total number of updates received by pilot. |
pilot_jwks_resolver_network_fetch_fail_total | Sum | Total number of failed network fetch by pilot jwks resolver |
pilot_jwks_resolver_network_fetch_success_total | Sum | Total number of successfully network fetch by pilot jwks resolver |
pilot_k8s_cfg_events | Sum | Events from k8s config. |
pilot_k8s_endpoints_pending_pod | LastValue | Number of endpoints that do not currently have any corresponding pods. |
pilot_k8s_endpoints_with_no_pods | Sum | Endpoints that does not have any corresponding pods. |
pilot_k8s_reg_events | Sum | Events from k8s registry. |
pilot_no_ip | LastValue | Pods not found in the endpoint table, possibly invalid. |
pilot_proxy_convergence_time | Distribution | Delay in seconds between config change and a proxy receiving all required configuration. |
pilot_proxy_queue_time | Distribution | Time in seconds, a proxy is in the push queue before being dequeued. |
pilot_push_triggers | Sum | Total number of times a push was triggered, labeled by reason for the push. |
pilot_pushcontext_init_seconds | Distribution | Total time in seconds Pilot takes to init pushContext. |
pilot_sds_certificate_errors_total | Sum | Total number of failures to fetch SDS key and certificate. |
pilot_services | LastValue | Total services known to pilot. |
pilot_total_rejected_configs | Sum | Total number of configs that Pilot had to reject or ignore. |
pilot_total_xds_internal_errors | Sum | Total number of internal XDS errors in pilot. |
pilot_total_xds_rejects | Sum | Total number of XDS responses from pilot rejected by proxy. |
pilot_virt_services | LastValue | Total virtual services known to pilot. |
pilot_vservice_dup_domain | LastValue | Virtual services with dup domains. |
pilot_worker_queue_depth | LastValue | Depth of the controller queues |
pilot_worker_queue_duration | Distribution | Time taken to process an item |
pilot_worker_queue_latency | Distribution | Latency before the item is processed |
pilot_xds | LastValue | Number of endpoints connected to this pilot using XDS. |
pilot_xds_cds_reject | LastValue | Pilot rejected CDS configs. |
pilot_xds_config_size_bytes | Distribution | Distribution of configuration sizes pushed to clients |
pilot_xds_eds_reject | LastValue | Pilot rejected EDS. |
pilot_xds_expired_nonce | Sum | Total number of XDS requests with an expired nonce. |
pilot_xds_lds_reject | LastValue | Pilot rejected LDS. |
pilot_xds_push_context_errors | Sum | Number of errors (timeouts) initiating push context. |
pilot_xds_push_time | Distribution | Total time in seconds Pilot takes to push lds, rds, cds and eds. |
pilot_xds_pushes | Sum | Pilot build and send errors for lds, rds, cds and eds. |
pilot_xds_rds_reject | LastValue | Pilot rejected RDS. |
pilot_xds_send_time | Distribution | Total time in seconds Pilot takes to send generated configuration. |
pilot_xds_write_timeout | Sum | Pilot XDS response write timeouts. |
provider_lookup_cluster_failures | Sum | Number of times a cluster lookup failed |
reconcile_request_total | Sum | Number of times requesting Reconcile |
remote_cluster_sync_timeouts_total | Sum | Number of times remote clusters took too long to sync, causing slow startup that excludes remote clusters. |
render_manifest_total | Sum | Number of component manifests rendered |
resource_creation_total | Sum | Number of resources created by the operator |
resource_deletion_total | Sum | Number of resources deleted by the operator |
resource_prune_total | Sum | Number of resources pruned by the operator |
resource_update_total | Sum | Number of resources updated by the operator |
scrape_failures_total | Sum | The total number of failed scrapes. |
scrapes_total | Sum | The total number of scrapes. |
sidecar_injection_failure_total | Sum | Total number of failed sidecar injection requests. |
sidecar_injection_requests_total | Sum | Total number of sidecar injection requests. |
sidecar_injection_skip_total | Sum | Total number of skipped sidecar injection requests. |
sidecar_injection_success_total | Sum | Total number of successful sidecar injection requests. |
sidecar_injection_time_seconds | Distribution | Total time taken for injection in seconds. |
startup_duration_seconds | LastValue | The time from the process starting to being marked ready. |
version | LastValue | Version of operator binary |
wasm_cache_entries | LastValue | number of Wasm remote fetch cache entries. |
wasm_cache_lookup_count | Sum | number of Wasm remote fetch cache lookups. |
wasm_config_conversion_count | Sum | number of Wasm config conversion count and results, including success, no remote load, marshal failure, remote fetch failure, miss remote fetch hint. |
wasm_config_conversion_duration | Distribution | Total time in milliseconds istio-agent spends on converting remote load in Wasm config. |
wasm_remote_fetch_count | Sum | number of Wasm remote fetches and results, including success, download failure, and checksum mismatch. |
webhook_patch_attempts_total | Sum | Webhook patching attempts |
webhook_patch_failures_total | Sum | Webhook patching total failures |
webhook_patch_retries_total | Sum | Webhook patching retries |
xds_cache_dependent_config_size | LastValue | Current size of dependent configs |
xds_cache_evictions | Sum | Total number of xds cache evictions. |
xds_cache_reads | Sum | Total number of xds cache xdsCacheReads. |
xds_cache_size | LastValue | Current size of xds cache |
Istio Pilot agent runs in the sidecar or gateway container and bootstraps Envoy.
+| Flags | +Description | +
|---|---|
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
+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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for pilot-agent for the specified shell. +See each sub-command's help for details on how to use the generated script. +
+| Flags | +Description | +
|---|---|
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
+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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the bash shell.
+This script depends on the 'bash-completion' package. +If it is not installed already, you can install it via your OS's package manager.
+To load completions in your current shell session:
+source <(pilot-agent completion bash)
+To load completions for every new session, execute once:
+#### Linux:
+pilot-agent completion bash > /etc/bash_completion.d/pilot-agent
+#### macOS:
+pilot-agent completion bash > $(brew --prefix)/etc/bash_completion.d/pilot-agent
+You will need to start a new shell for this setup to take effect. +
+pilot-agent completion bash
+| Flags | +Description | +
|---|---|
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
+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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the fish shell.
+To load completions in your current shell session:
+pilot-agent completion fish | source
+To load completions for every new session, execute once:
+pilot-agent completion fish > ~/.config/fish/completions/pilot-agent.fish
+You will need to start a new shell for this setup to take effect. +
+pilot-agent completion fish [flags]
+| Flags | +Description | +
|---|---|
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
+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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for powershell.
+To load completions in your current shell session:
+pilot-agent completion powershell | Out-String | Invoke-Expression
+To load completions for every new session, add the output of the above command +to your powershell profile. +
+pilot-agent completion powershell [flags]
+| Flags | +Description | +
|---|---|
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
+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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the zsh shell.
+If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once:
+echo "autoload -U compinit; compinit" >> ~/.zshrc
+To load completions in your current shell session:
+source <(pilot-agent completion zsh)
+To load completions for every new session, execute once:
+#### Linux:
+pilot-agent completion zsh > "${fpath[1]}/_pilot-agent"
+#### macOS:
+pilot-agent completion zsh > $(brew --prefix)/share/zsh/site-functions/_pilot-agent
+You will need to start a new shell for this setup to take effect. +
+pilot-agent completion zsh [flags]
+| Flags | +Description | +
|---|---|
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
+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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Script responsible for cleaning up iptables rules
+pilot-agent istio-clean-iptables [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--dry-run |
+-n |
+Do not call any external dependencies like iptables | +
--istio-inbound-interception-mode <string> |
+-m |
+The mode used to redirect inbound connections to Envoy, either "REDIRECT" or "TPROXY" (default ``) | +
--istio-inbound-tproxy-mark <string> |
+-t |
+(default ``) | +
--log_as_json |
++ | Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
++ | Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
++ | 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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
++ | The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
++ | The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
++ | The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
++ | The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
++ | Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
++ | The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--proxy-gid <string> |
+-g |
+Specify the GID of the user for which the redirection is not applied. (same default value as -u param) (default ``) | +
--proxy-uid <string> |
+-u |
+Specify the UID of the user for which the redirection is not applied. Typically, this is the UID of the proxy container (default ``) | +
--redirect-dns |
++ | Enable capture of dns traffic by istio-agent | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istio-iptables is responsible for setting up port forwarding for Istio Sidecar.
+pilot-agent istio-iptables [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--capture-all-dns |
++ | Instead of only capturing DNS traffic to DNS server IP, capture all DNS traffic at port 53. This setting is only effective when redirect dns is enabled. | +
--cni-mode |
++ | Whether to run as CNI plugin. | +
--drop-invalid |
++ | Enable invalid drop in the iptables rules. | +
--dry-run |
+-n |
+Do not call any external dependencies like iptables. | +
--envoy-port <string> |
+-p |
+Specify the envoy port to which redirect all TCP traffic (default $ENVOY_PORT = 15001). (default ``) | +
--host-nsenter-exec |
++ | Instead of using the internal go netns, use the nsenter command for switching network namespaces. | +
--inbound-capture-port <string> |
+-z |
+Port to which all inbound TCP traffic to the pod/VM should be redirected to (default $INBOUND_CAPTURE_PORT = 15006). (default ``) | +
--inbound-tunnel-port <string> |
+-e |
+Specify the istio tunnel port for inbound tcp traffic (default $INBOUND_TUNNEL_PORT = 15008). (default ``) | +
--iptables-probe-port <string> |
++ | Set listen port for failure detection. (default `15002`) | +
--iptables-trace-logging |
++ | Insert tracing logs for each iptables rules, using the LOG chain. | +
--istio-exclude-interfaces <string> |
+-c |
+Comma separated list of NIC (optional). Neither inbound nor outbound traffic will be captured. (default ``) | +
--istio-inbound-interception-mode <string> |
+-m |
+The mode used to redirect inbound connections to Envoy, either "REDIRECT" or "TPROXY". (default ``) | +
--istio-inbound-ports <string> |
+-b |
+Comma separated list of inbound ports for which traffic is to be redirected to Envoy (optional). The wildcard character "*" can be used to configure redirection for all ports. An empty list will disable. (default ``) | +
--istio-inbound-tproxy-mark <string> |
+-t |
+(default ``) | +
--istio-inbound-tproxy-route-table <string> |
+-r |
+(default ``) | +
--istio-local-exclude-ports <string> |
+-d |
+Comma separated list of inbound ports to be excluded from redirection to Envoy (optional). Only applies when all inbound traffic (i.e. "*") is being redirected (default to $ISTIO_LOCAL_EXCLUDE_PORTS). (default ``) | +
--istio-local-outbound-ports-exclude <string> |
+-o |
+Comma separated list of outbound ports to be excluded from redirection to Envoy. (default ``) | +
--istio-outbound-ports <string> |
+-q |
+Comma separated list of outbound ports to be explicitly included for redirection to Envoy. (default ``) | +
--istio-service-cidr <string> |
+-i |
+Comma separated list of IP ranges in CIDR form to redirect to envoy (optional). The wildcard character "*" can be used to redirect all outbound traffic. An empty list will disable all outbound. (default ``) | +
--istio-service-exclude-cidr <string> |
+-x |
+Comma separated list of IP ranges in CIDR form to be excluded from redirection. Only applies when all outbound traffic (i.e. "*") is being redirected (default to $ISTIO_SERVICE_EXCLUDE_CIDR). (default ``) | +
--kube-virt-interfaces <string> |
+-k |
+Comma separated list of virtual interfaces whose inbound traffic (from VM) will be treated as outbound. (default ``) | +
--log_as_json |
++ | Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
++ | Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
++ | 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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
++ | The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
++ | The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
++ | The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
++ | The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
++ | Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
++ | The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--network-namespace <string> |
++ | The network namespace that iptables rules should be applied to. (default ``) | +
--probe-timeout <duration> |
++ | Failure detection timeout. (default `5s`) | +
--proxy-gid <string> |
+-g |
+Specify the GID of the user for which the redirection is not applied (same default value as -u param). (default ``) | +
--proxy-uid <string> |
+-u |
+Specify the UID of the user for which the redirection is not applied. Typically, this is the UID of the proxy container. (default ``) | +
--redirect-dns |
++ | Enable capture of dns traffic by istio-agent. | +
--restore-format |
+-f |
+Print iptables rules in iptables-restore interpretable format. | +
--run-validation |
++ | Validate iptables. | +
--skip-rule-apply |
++ | Skip iptables apply. | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
XDS proxy agent
+pilot-agent proxy [flags]
+| Flags | +Description | +
|---|---|
--concurrency <int> |
+number of worker threads to run (default `0`) | +
--domain <string> |
+DNS domain suffix. If not provided uses ${POD_NAMESPACE}.svc.cluster.local (default ``) | +
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
+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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--meshConfig <string> |
+File name for Istio mesh configuration. If not specified, a default mesh will be used. This may be overridden by PROXY_CONFIG environment variable or proxy.istio.io/config annotation. (default `./etc/istio/config/mesh`) | +
--outlierLogPath <string> |
+The log path for outlier detection (default ``) | +
--profiling |
+Enable profiling via web interface host:port/debug/pprof/. | +
--proxyComponentLogLevel <string> |
+The component log level used to start the Envoy proxy. Deprecated, use proxyLogLevel instead (default ``) | +
--proxyLogLevel <string> |
+The log level used to start the Envoy proxy (choose from {trace, debug, info, warning, error, critical, off}).Level may also include one or more scopes, such as 'info,misc:error,upstream:debug' (default `warning,misc:error`) | +
--serviceCluster <string> |
+Service cluster (default `istio-proxy`) | +
--stsPort <int> |
+HTTP Port on which to serve Security Token Service (STS). If zero, STS service will not be provided. (default `0`) | +
--templateFile <string> |
+Go template bootstrap config (default ``) | +
--tokenManagerPlugin <string> |
+Token provider specific plugin name. (default `GoogleTokenExchange`) | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Makes an HTTP request to the Envoy admin API
+pilot-agent request <method> <path> [<body>] [flags]
+| Flags | +Description | +
|---|---|
--debug-port <int32> |
+Set the port to make a local request to. The default points to the Envoy admin API. (default `15000`) | +
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
+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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Prints out build version information
+pilot-agent version [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--log_as_json |
++ | Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
++ | Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
++ | 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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
++ | The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
++ | The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
++ | The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
++ | The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
++ | Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
++ | The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--output <string> |
+-o |
+One of 'yaml' or 'json'. (default ``) | +
--short |
+-s |
+Use --short=false to generate full version information | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Waits until the Envoy proxy is ready
+pilot-agent wait [flags]
+| Flags | +Description | +
|---|---|
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
+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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--periodMillis <int> |
+number of milliseconds to wait between attempts (default `500`) | +
--requestTimeoutMillis <int> |
+number of milliseconds to wait for response (default `500`) | +
--timeoutSeconds <int> |
+maximum number of seconds to wait for Envoy to be ready (default `60`) | +
--url <string> |
+URL to use in requests (default `http://localhost:15021/healthz/ready`) | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
pilot-agent command. Please use with caution as these environment variables are experimental and can change anytime.
+| Variable Name | +Type | +Default Value | +Description | +
|---|---|---|---|
BOOTSTRAP_XDS_AGENT |
+Boolean | +false |
+If set to true, agent retrieves the bootstrap configuration prior to starting Envoy | +
CA_ADDR |
+String | + |
+Address of the spiffe certificate provider. Defaults to discoveryAddress | +
CA_PROVIDER |
+String | +Citadel |
+name of authentication provider | +
CA_ROOT_CA |
+String | + |
+Explicitly set the root CA to expect for the CA connection. | +
CA_TRUSTED_NODE_ACCOUNTS |
+String | + |
+If set, the list of service accounts that are allowed to use node authentication for CSRs. Node authentication allows an identity to create CSRs on behalf of other identities, but only if there is a pod running on the same node with that identity. This is intended for use with node proxies. | +
CERT_SIGNER_DOMAIN |
+String | + |
+The cert signer domain info | +
CLOUD_PLATFORM |
+String | + |
+Cloud Platform on which proxy is running, if not specified, Istio will try to discover the platform. Valid platform values are aws, azure, gcp, none | +
CLUSTER_ID |
+String | +Kubernetes |
+Defines the cluster and service registry that this Istiod instance belongs to | +
CREDENTIAL_FETCHER_TYPE |
+String | +JWT |
+The type of the credential fetcher. Currently supported types include GoogleComputeEngine | +
CREDENTIAL_IDENTITY_PROVIDER |
+String | +GoogleComputeEngine |
+The identity provider for credential. Currently default supported identity provider is GoogleComputeEngine | +
DISABLE_ENVOY |
+Boolean | +false |
+Disables all Envoy agent features. | +
DNS_FORWARD_PARALLEL |
+Boolean | +false |
+If set to true, agent will send parallel DNS queries to all upstream nameservers | +
DNS_PROXY_ADDR |
+String | +localhost:15053 |
+Custom address for the DNS proxy. If it ends with :53 and running as root allows running without iptable DNS capture | +
DRY_RUN_FILE_PATH |
+String | + |
+If provided, StdoutStubDependencies will write the input from stdin to the given file. | +
ECC_CURVE |
+String | +P256 |
+The elliptic curve to use when ECC_SIGNATURE_ALGORITHM is set to ECDSA | +
ECC_SIGNATURE_ALGORITHM |
+String | + |
+The type of ECC signature algorithm to use when generating private keys | +
ENABLE_AUTO_SNI |
+Boolean | +false |
+If enabled, automatically set SNI when `DestinationRules` do not specify the same | +
ENABLE_CA_SERVER |
+Boolean | +true |
+If this is set to false, will not create CA server in istiod. | +
ENABLE_DEBUG_ON_HTTP |
+Boolean | +true |
+If this is set to false, the debug interface will not be enabled, recommended for production | +
ENABLE_ENHANCED_RESOURCE_SCOPING |
+Boolean | +false |
+If enabled, meshConfig.discoverySelectors will limit the CustomResource configurations(like Gateway,VirtualService,DestinationRule,Ingress, etc)that can be processed by pilot. This will also restrict the root-ca certificate distribution. | +
ENABLE_HCM_INTERNAL_NETWORKS |
+Boolean | +false |
+If enable, endpoints defined in mesh networks will be configured as internal addresses in Http Connection Manager | +
ENABLE_LEADER_ELECTION |
+Boolean | +true |
+If enabled (default), starts a leader election client and gains leadership before executing controllers. If false, it assumes that only one instance of istiod is running and skips leader election. | +
ENABLE_MCS_AUTO_EXPORT |
+Boolean | +false |
+If enabled, istiod will automatically generate Kubernetes Multi-Cluster Services (MCS) ServiceExport resources for every service in the mesh. Services defined to be cluster-local in MeshConfig are excluded. | +
ENABLE_MCS_CLUSTER_LOCAL |
+Boolean | +false |
+If enabled, istiod will treat the host `<svc>.<namespace>.svc.cluster.local` as defined by the Kubernetes Multi-Cluster Services (MCS) spec. In this mode, requests to `cluster.local` will be routed to only those endpoints residing within the same cluster as the client. Requires that both ENABLE_MCS_SERVICE_DISCOVERY and ENABLE_MCS_HOST also be enabled. | +
ENABLE_MCS_HOST |
+Boolean | +false |
+If enabled, istiod will configure a Kubernetes Multi-Cluster Services (MCS) host (<svc>.<namespace>.svc.clusterset.local) for each service exported (via ServiceExport) in at least one cluster. Clients must, however, be able to successfully lookup these DNS hosts. That means that either Istio DNS interception must be enabled or an MCS controller must be used. Requires that ENABLE_MCS_SERVICE_DISCOVERY also be enabled. | +
ENABLE_MCS_SERVICE_DISCOVERY |
+Boolean | +false |
+If enabled, istiod will enable Kubernetes Multi-Cluster Services (MCS) service discovery mode. In this mode, service endpoints in a cluster will only be discoverable within the same cluster unless explicitly exported via ServiceExport. | +
ENABLE_MULTICLUSTER_HEADLESS |
+Boolean | +true |
+If true, the DNS name table for a headless service will resolve to same-network endpoints in any cluster. | +
ENABLE_NATIVE_SIDECARS |
+Boolean | +false |
+If set, used Kubernetes native Sidecar container support. Requires SidecarContainer feature flag. | +
ENABLE_OPTIMIZED_CONFIG_REBUILD |
+Boolean | +true |
+If enabled, pilot will only rebuild config for resources that have changed | +
ENABLE_OTEL_BUILTIN_RESOURCE_LABELS |
+Boolean | +false |
+If enabled, envoy will send builtin lables(e.g. node_name) via OTel sink. | +
ENABLE_PROBE_KEEPALIVE_CONNECTIONS |
+Boolean | +false |
+If enabled, readiness probes will keep the connection from pilot-agent to the application alive. This mirrors older Istio versions' behaviors, but not kubelet's. | +
ENABLE_TLS_ON_SIDECAR_INGRESS |
+Boolean | +false |
+If enabled, the TLS configuration on Sidecar.ingress will take effect | +
ENVOY_PROMETHEUS_PORT |
+Integer | +15090 |
+Envoy prometheus redirection port value | +
ENVOY_STATUS_PORT |
+Integer | +15021 |
+Envoy health status port value | +
ENVOY_USER |
+String | +istio-proxy |
+Envoy proxy username | +
EXIT_ON_ZERO_ACTIVE_CONNECTIONS |
+Boolean | +false |
+When set to true, terminates proxy when number of active connections become zero during draining | +
EXTERNAL_ISTIOD |
+Boolean | +false |
+If this is set to true, one Istiod will control remote clusters including CA. | +
FILE_DEBOUNCE_DURATION |
+Time Duration | +100ms |
+The duration for which the file read operation is delayed once file update is detected | +
FILE_MOUNTED_CERTS |
+Boolean | +false |
++ |
GCP_METADATA |
+String | + |
+Pipe separated GCP metadata, schemed as PROJECT_ID|PROJECT_NUMBER|CLUSTER_NAME|CLUSTER_ZONE | +
GCP_QUOTA_PROJECT |
+String | + |
+Allows specification of a quota project to be used in requests to GCP APIs. | +
GKE_CLUSTER_URL |
+String | + |
+The url of GKE cluster | +
GRPC_KEEPALIVE_INTERVAL |
+Time Duration | +30s |
+gRPC Keepalive Interval | +
GRPC_KEEPALIVE_TIMEOUT |
+Time Duration | +10s |
+gRPC Keepalive Timeout | +
GRPC_XDS_BOOTSTRAP |
+String | +etc/istio/proxy/grpc-bootstrap.json |
+Path where gRPC expects to read a bootstrap file. Agent will generate one if set. | +
HTTP_STRIP_FRAGMENT_FROM_PATH_UNSAFE_IF_DISABLED |
+Boolean | +true |
++ |
INBOUND_INTERCEPTION_MODE |
+String | + |
+The mode used to redirect inbound connections to Envoy, either "REDIRECT" or "TPROXY" | +
INBOUND_TPROXY_MARK |
+String | + |
++ |
INJECTION_WEBHOOK_CONFIG_NAME |
+String | +istio-sidecar-injector |
+Name of the mutatingwebhookconfiguration to patch, if istioctl is not used. | +
INSTANCE_IP |
+String | + |
++ |
INVALID_DROP |
+Boolean | +false |
+If set to true, enable the invalid drop iptables rule, default false will cause iptables reset out of window packets | +
IPTABLES_TRACE_LOGGING |
+Boolean | +false |
+When enable, all iptables actions will be logged. This requires NET_ADMIN privilege and has noisy logs; as a result, this is intended for debugging only | +
ISTIOD_CUSTOM_HOST |
+String | + |
+Custom host name of istiod that istiod signs the server cert. Multiple custom host names are supported, and multiple values are separated by commas. | +
ISTIOD_SAN |
+String | + |
+Override the ServerName used to validate Istiod certificate. Can be used as an alternative to setting /etc/hosts for VMs - discovery address will be an IP:port | +
ISTIO_AGENT_ENABLE_WASM_REMOTE_LOAD_CONVERSION |
+Boolean | +true |
+If enabled, Istio agent will intercept ECDS resource update, downloads Wasm module, and replaces Wasm module remote load with downloaded local module file. | +
ISTIO_BOOTSTRAP |
+String | + |
++ |
ISTIO_BOOTSTRAP_OVERRIDE |
+String | + |
++ |
ISTIO_CPU_LIMIT |
+Integer | +0 |
+CPU limit for the current process. Expressed as an integer value, rounded up. | +
ISTIO_DELTA_XDS |
+Boolean | +false |
+If enabled, pilot will only send the delta configs as opposed to the state of the world on a Resource Request. This feature uses the delta xds api, but does not currently send the actual deltas. | +
ISTIO_DUAL_STACK |
+Boolean | +false |
+If true, Istio will enable the Dual Stack feature. | +
ISTIO_ENABLE_CONTROLLER_QUEUE_METRICS |
+Boolean | +false |
+If enabled, publishes metrics for queue depth, latency and processing times. | +
ISTIO_ENABLE_HTTP2_PROBING |
+Boolean | +true |
+If enabled, HTTP2 probes will be enabled for HTTPS probes, following Kubernetes | +
ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSH |
+Boolean | +true |
+If enabled, Istiod will not push changes on arbitrary annotation change. | +
ISTIO_ENVOY_ENABLE_CORE_DUMP |
+Boolean | +false |
++ |
ISTIO_GPRC_MAXRECVMSGSIZE |
+Integer | +4194304 |
+Sets the max receive buffer size of gRPC stream in bytes. | +
ISTIO_GPRC_MAXSTREAMS |
+Integer | +100000 |
+Sets the maximum number of concurrent grpc streams. | +
ISTIO_KUBE_APP_PROBERS |
+String | + |
++ |
ISTIO_KUBE_CLIENT_CONTENT_TYPE |
+String | +protobuf |
+The content type to use for Kubernetes clients. Defaults to protobuf. Valid options: [protobuf, json] | +
ISTIO_META_CERT_SIGNER |
+String | + |
+The cert signer info for workload cert | +
ISTIO_META_CLUSTER_ID |
+String | + |
++ |
ISTIO_META_DNS_CAPTURE |
+Boolean | +false |
+If set to true, enable the capture of outgoing DNS packets on port 53, redirecting to istio-agent on :15053 | +
ISTIO_MULTIROOT_MESH |
+Boolean | +false |
+If enabled, mesh will support certificates signed by more than one trustAnchor for ISTIO_MUTUAL mTLS | +
ISTIO_OUTBOUND_OWNER_GROUPS |
+String | +* |
+Comma separated list of groups whose outgoing traffic is to be redirected to Envoy. +A group can be specified either by name or by a numeric GID. +The wildcard character "*" can be used to configure redirection of traffic from all groups. | +
ISTIO_OUTBOUND_OWNER_GROUPS_EXCLUDE |
+String | + |
+Comma separated list of groups whose outgoing traffic is to be excluded from redirection to Envoy. +A group can be specified either by name or by a numeric GID. +Only applies when traffic from all groups (i.e. "*") is being redirected to Envoy. | +
ISTIO_PROMETHEUS_ANNOTATIONS |
+String | + |
++ |
ISTIO_WATCH_NAMESPACE |
+String | + |
+If set, limit Kubernetes watches to a single namespace. Warning: only a single namespace can be set. | +
ISTIO_WORKLOAD_ENTRY_VALIDATE_IDENTITY |
+Boolean | +true |
+If enabled, will validate the identity of a workload matches the identity of the WorkloadEntry it is associating with for health checks and auto registration. This flag is added for backwards compatibility only and will be removed in future releases | +
JWKS_RESOLVER_INSECURE_SKIP_VERIFY |
+Boolean | +false |
+If enabled, istiod will skip verifying the certificate of the JWKS server. | +
JWT_POLICY |
+String | +third-party-jwt |
+The JWT validation policy. | +
K8S_INGRESS_NS |
+String | +istio-system |
++ |
KUBERNETES_SERVICE_HOST |
+String | + |
+Kubernetes service host, set automatically when running in-cluster | +
K_REVISION |
+String | + |
+KNative revision, set if running in knative | +
LABEL_CANONICAL_SERVICES_FOR_MESH_EXTERNAL_SERVICE_ENTRIES |
+Boolean | +false |
+If enabled, metadata representing canonical services for ServiceEntry resources with a location of mesh_external will be populatedin the cluster metadata for those endpoints. | +
LOCAL_CLUSTER_SECRET_WATCHER |
+Boolean | +false |
+If enabled, the cluster secret watcher will watch the namespace of the external cluster instead of config cluster | +
MCS_API_GROUP |
+String | +multicluster.x-k8s.io |
+The group to be used for the Kubernetes Multi-Cluster Services (MCS) API. | +
MCS_API_VERSION |
+String | +v1alpha1 |
+The version to be used for the Kubernets Multi-Cluster Services (MCS) API. | +
METRIC_GRACEFUL_DELETION_INTERVAL |
+Time Duration | +5m0s |
+Metric expiry graceful deletion interval. No-op if METRIC_ROTATION_INTERVAL is disabled. | +
METRIC_ROTATION_INTERVAL |
+Time Duration | +0s |
+Metric scope rotation interval, set to 0 to disable the metric scope rotation | +
MINIMUM_DRAIN_DURATION |
+Time Duration | +5s |
+The minimum duration for which agent waits before it checks for active connections and terminates proxywhen number of active connections become zero | +
MUTEX_PROFILE_FRACTION |
+Integer | +1000 |
+If set to a non-zero value, enables mutex profiling a rate of 1/MUTEX_PROFILE_FRACTION events. For example, '1000' will record 0.1% of events. Set to 0 to disable entirely. | +
NATIVE_METADATA_EXCHANGE |
+Boolean | +true |
+If set, uses a native implementation of the HTTP metadata exchange filter | +
OUTPUT_CERTS |
+String | + |
+The output directory for the key and certificate. If empty, key and certificate will not be saved. Must be set for VMs using provisioning certificates. | +
PILOT_ALLOW_SIDECAR_SERVICE_INBOUND_LISTENER_MERGE |
+Boolean | +false |
+If set, it allows creating inbound listeners for service ports and sidecar ingress listeners | +
PILOT_ANALYSIS_INTERVAL |
+Time Duration | +10s |
+If analysis is enabled, pilot will run istio analyzers using this value as interval in seconds Istio Resources | +
PILOT_CERT_PROVIDER |
+String | +istiod |
+The provider of Pilot DNS certificate. | +
PILOT_DEBOUNCE_AFTER |
+Time Duration | +100ms |
+The delay added to config/registry events for debouncing. This will delay the push by at least this interval. If no change is detected within this period, the push will happen, otherwise we'll keep delaying until things settle, up to a max of PILOT_DEBOUNCE_MAX. | +
PILOT_DEBOUNCE_MAX |
+Time Duration | +10s |
+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. | +
PILOT_DISTRIBUTION_HISTORY_RETENTION |
+Time Duration | +1m0s |
+If enabled, Pilot will keep track of old versions of distributed config for this duration. | +
PILOT_DRAINING_LABEL |
+String | +istio.io/draining |
+If not empty, endpoints with the label value present will be sent with status DRAINING. | +
PILOT_ENABLE_ALPHA_GATEWAY_API |
+Boolean | +false |
+If this is set to true, support for alpha APIs in the Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed. | +
PILOT_ENABLE_ALPN_FILTER |
+Boolean | +true |
+If true, pilot will add Istio ALPN filters, required for proper protocol sniffing. | +
PILOT_ENABLE_AMBIENT_CONTROLLERS |
+Boolean | +false |
+If enabled, controllers required for ambient will run. This is required to run ambient mesh. | +
PILOT_ENABLE_ANALYSIS |
+Boolean | +false |
+If enabled, pilot will run istio analyzers and write analysis errors to the Status field of any Istio Resources | +
PILOT_ENABLE_CDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache CDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE. | +
PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING |
+Boolean | +false |
+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. | +
PILOT_ENABLE_CROSS_CLUSTER_WORKLOAD_ENTRY |
+Boolean | +true |
+If enabled, pilot will read WorkloadEntry from other clusters, selectable by Services in that cluster. | +
PILOT_ENABLE_EDS_DEBOUNCE |
+Boolean | +true |
+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 | +
PILOT_ENABLE_EDS_FOR_HEADLESS_SERVICES |
+Boolean | +false |
+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. | +
PILOT_ENABLE_GATEWAY_API |
+Boolean | +true |
+If this is set to true, support for Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed. | +
PILOT_ENABLE_GATEWAY_API_DEPLOYMENT_CONTROLLER |
+Boolean | +true |
+If this is set to true, gateway-api resources will automatically provision in cluster deployment, services, etc | +
PILOT_ENABLE_GATEWAY_API_GATEWAYCLASS_CONTROLLER |
+Boolean | +true |
+If this is set to true, istiod will create and manage its default GatewayClasses | +
PILOT_ENABLE_GATEWAY_API_STATUS |
+Boolean | +true |
+If this is set to true, gateway-api resources will have status written to them | +
PILOT_ENABLE_HBONE |
+Boolean | +false |
+If enabled, HBONE support can be configured for proxies. Note: proxies must opt in on a per-proxy basis with ENABLE_HBONE to actually get HBONE config, in addition to this flag. | +
PILOT_ENABLE_HEADLESS_SERVICE_POD_LISTENERS |
+Boolean | +true |
+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. | +
PILOT_ENABLE_INBOUND_PASSTHROUGH |
+Boolean | +true |
+If enabled, inbound clusters will be configured as ORIGINAL_DST clusters. When disabled, requests are always sent to localhost. The primary implication of this is that when enabled, binding to POD_IP will work while localhost will not; when disable, bind to POD_IP will not work, while localhost will. The enabled behavior matches the behavior without Istio enabled at all; this flag exists only for backwards compatibility. Regardless of this setting, the configuration can be overridden with the Sidecar.Ingress.DefaultEndpoint configuration. | +
PILOT_ENABLE_K8S_SELECT_WORKLOAD_ENTRIES |
+Boolean | +true |
+If enabled, Kubernetes services with selectors will select workload entries with matching labels. It is safe to disable it if you are quite sure you don't need this feature | +
PILOT_ENABLE_METADATA_EXCHANGE |
+Boolean | +true |
+If true, pilot will add metadata exchange filters, which will be consumed by telemetry filter. | +
PILOT_ENABLE_MONGO_FILTER |
+Boolean | +true |
+EnableMongoFilter enables injection of `envoy.filters.network.mongo_proxy` in the filter chain. | +
PILOT_ENABLE_MYSQL_FILTER |
+Boolean | +false |
+EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain. | +
PILOT_ENABLE_PERSISTENT_SESSION_FILTER |
+Boolean | +false |
+If enabled, Istiod sets up persistent session filter for listeners, if services have 'PILOT_PERSISTENT_SESSION_LABEL' set. | +
PILOT_ENABLE_QUIC_LISTENERS |
+Boolean | +false |
+If true, QUIC listeners will be generated wherever there are listeners terminating TLS on gateways if the gateway service exposes a UDP port with the same number (for example 443/TCP and 443/UDP) | +
PILOT_ENABLE_RDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache RDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE. | +
PILOT_ENABLE_REDIS_FILTER |
+Boolean | +false |
+EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain. | +
PILOT_ENABLE_ROUTE_COLLAPSE_OPTIMIZATION |
+Boolean | +true |
+If true, Pilot will merge virtual hosts with the same routes into a single virtual host, as an optimization. | +
PILOT_ENABLE_SERVICEENTRY_SELECT_PODS |
+Boolean | +true |
+If enabled, service entries with selectors will select pods from the cluster. It is safe to disable it if you are quite sure you don't need this feature | +
PILOT_ENABLE_STATUS |
+Boolean | +false |
+If enabled, pilot will update the CRD Status field of all istio resources with reconciliation status. | +
PILOT_ENABLE_TELEMETRY_LABEL |
+Boolean | +true |
+If true, pilot will add telemetry related metadata to cluster and endpoint resources, which will be consumed by telemetry filter. | +
PILOT_ENABLE_WORKLOAD_ENTRY_AUTOREGISTRATION |
+Boolean | +true |
+Enables auto-registering WorkloadEntries based on associated WorkloadGroups upon XDS connection by the workload. | +
PILOT_ENABLE_WORKLOAD_ENTRY_HEALTHCHECKS |
+Boolean | +true |
+Enables automatic health checks of WorkloadEntries based on the config provided in the associated WorkloadGroup | +
PILOT_ENABLE_XDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache XDS responses. | +
PILOT_ENABLE_XDS_IDENTITY_CHECK |
+Boolean | +true |
+If enabled, pilot will authorize XDS clients, to ensure they are acting only as namespaces they have permissions for. | +
PILOT_ENDPOINT_TELEMETRY_LABEL |
+Boolean | +true |
+If true, pilot will add telemetry related metadata to Endpoint resource, which will be consumed by telemetry filter. | +
PILOT_ENVOY_FILTER_STATS |
+Boolean | +false |
+If true, Pilot will collect metrics for envoy filter operations. | +
PILOT_FILTER_GATEWAY_CLUSTER_CONFIG |
+Boolean | +false |
+If enabled, Pilot will send only clusters that referenced in gateway virtual services attached to gateway | +
PILOT_HTTP10 |
+Boolean | +false |
+Enables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications. | +
PILOT_INSECURE_MULTICLUSTER_KUBECONFIG_OPTIONS |
+String | + |
+Comma separated list of potentially insecure kubeconfig authentication options that are allowed for multicluster authentication.Support values: all authProviders (`gcp`, `azure`, `exec`, `openstack`), `clientKey`, `clientCertificate`, `tokenFile`, and `exec`. | +
PILOT_JWT_ENABLE_REMOTE_JWKS |
+String | +false |
+Mode of fetching JWKs from JwksUri in RequestAuthentication. Supported value: istiod, false, hybrid, true, envoy. The client fetching JWKs is as following: istiod/false - Istiod; hybrid/true - Envoy and fallback to Istiod if JWKs server is external; envoy - Envoy. | +
PILOT_JWT_PUB_KEY_REFRESH_INTERVAL |
+Time Duration | +20m0s |
+The interval for istiod to fetch the jwks_uri for the jwks public key. | +
PILOT_MAX_REQUESTS_PER_SECOND |
+Floating-Point | +25 |
+Limits the number of incoming XDS requests per second. On larger machines this can be increased to handle more proxies concurrently. | +
PILOT_MULTI_NETWORK_DISCOVER_GATEWAY_API |
+Boolean | +false |
+If true, Pilot will discover labeled Kubernetes gateway objects as multi-network gateways. | +
PILOT_PERSISTENT_SESSION_HEADER_LABEL |
+String | +istio.io/persistent-session-header |
+If not empty, services with this label will use header based persistent sessions | +
PILOT_PERSISTENT_SESSION_LABEL |
+String | +istio.io/persistent-session |
+If not empty, services with this label will use cookie based persistent sessions | +
PILOT_PUSH_THROTTLE |
+Integer | +100 |
+Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes | +
PILOT_REMOTE_CLUSTER_TIMEOUT |
+Time Duration | +30s |
+After this timeout expires, pilot can become ready without syncing data from clusters added via remote-secrets. Setting the timeout to 0 disables this behavior. | +
PILOT_SCOPE_GATEWAY_TO_NAMESPACE |
+Boolean | +false |
+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. | +
PILOT_SEND_UNHEALTHY_ENDPOINTS |
+Boolean | +false |
+If enabled, Pilot will include unhealthy endpoints in EDS pushes and even if they are sent Envoy does not use them for load balancing. To avoid, sending traffic to non ready endpoints, enabling this flag, disables panic threshold in Envoy i.e. Envoy does not load balance requests to unhealthy/non-ready hosts even if the percentage of healthy hosts fall below minimum health percentage(panic threshold). | +
PILOT_SIDECAR_USE_REMOTE_ADDRESS |
+Boolean | +false |
+UseRemoteAddress sets useRemoteAddress to true for sidecar outbound listeners. | +
PILOT_SKIP_VALIDATE_TRUST_DOMAIN |
+Boolean | +false |
+Skip validating the peer is from the same trust domain when mTLS is enabled in authentication policy | +
PILOT_STATUS_BURST |
+Integer | +500 |
+If status is enabled, controls the Burst rate with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config Burst | +
PILOT_STATUS_MAX_WORKERS |
+Integer | +100 |
+The maximum number of workers Pilot will use to keep configuration status up to date. Smaller numbers will result in higher status latency, but larger numbers may impact CPU in high scale environments. | +
PILOT_STATUS_QPS |
+Integer | +100 |
+If status is enabled, controls the QPS with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config QPS | +
PILOT_STATUS_UPDATE_INTERVAL |
+Time Duration | +500ms |
+Interval to update the XDS distribution status. | +
PILOT_TRACE_SAMPLING |
+Floating-Point | +1 |
+Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 1.0. | +
PILOT_WORKLOAD_ENTRY_GRACE_PERIOD |
+Time Duration | +10s |
+The amount of time an auto-registered workload can remain disconnected from all Pilot instances before the associated WorkloadEntry is cleaned up. | +
PILOT_XDS_CACHE_INDEX_CLEAR_INTERVAL |
+Time Duration | +5s |
+The interval for xds cache index clearing. | +
PILOT_XDS_CACHE_SIZE |
+Integer | +60000 |
+The maximum number of cache entries for the XDS cache. | +
PILOT_XDS_CACHE_STATS |
+Boolean | +false |
+If true, Pilot will collect metrics for XDS cache efficiency. | +
PILOT_XDS_SEND_TIMEOUT |
+Time Duration | +0s |
+The timeout to send the XDS configuration to proxies. After this timeout is reached, Pilot will discard that push. | +
PKCS8_KEY |
+Boolean | +false |
+Whether to generate PKCS#8 private keys | +
PLATFORM |
+String | + |
+Platform where Istio is deployed. Possible values are "openshift" and "gcp" | +
POD_NAME |
+String | + |
++ |
POD_NAMESPACE |
+String | + |
++ |
PROV_CERT |
+String | + |
+Set to a directory containing provisioned certs, for VMs | +
PROXY_CONFIG |
+String | + |
+The proxy configuration. This will be set by the injection - gateways will use file mounts. | +
PROXY_CONFIG_XDS_AGENT |
+Boolean | +false |
+If set to true, agent retrieves dynamic proxy-config updates via xds channel | +
PROXY_XDS_DEBUG_VIA_AGENT |
+Boolean | +true |
+If set to true, the agent will listen on tap port and offer pilot's XDS istio.io/debug debug API there. | +
PROXY_XDS_DEBUG_VIA_AGENT_PORT |
+Integer | +15004 |
+Agent debugging port. | +
REQUIRE_3P_TOKEN |
+Boolean | +false |
+Reject k8s default tokens, without audience. If false, default K8S token will be accepted | +
RESOLVE_HOSTNAME_GATEWAYS |
+Boolean | +true |
+If true, hostnames in the LoadBalancer addresses of a Service will be resolved at the control plane for use in cross-network gateways. | +
REWRITE_PROBE_LEGACY_LOCALHOST_DESTINATION |
+Boolean | +false |
+If enabled, readiness probes will be sent to 'localhost'. Otherwise, they will be sent to the Pod's IP, matching Kubernetes' behavior. | +
SECRET_GRACE_PERIOD_RATIO |
+Floating-Point | +0.5 |
+The grace period ratio for the cert rotation, by default 0.5. | +
SECRET_TTL |
+Time Duration | +24h0m0s |
+The cert lifetime requested by istio agent | +
SERVICE_ACCOUNT |
+String | + |
+Name of service account | +
SHARED_MESH_CONFIG |
+String | + |
+Additional config map to load for shared MeshConfig settings. The standard mesh config will take precedence. | +
TOKEN_AUDIENCES |
+String | +istio-ca |
+A list of comma separated audiences to check in the JWT token before issuing a certificate. The token is accepted if it matches with one of the audiences | +
TRUSTED_GATEWAY_CIDR |
+String | + |
+If set, any connections from gateway to Istiod with this CIDR range are treated as trusted for using authentication mechanisms like XFCC. This can only be used when the network where Istiod and the authenticating gateways are running in a trusted/secure network | +
TRUST_DOMAIN |
+String | +cluster.local |
+The trust domain for spiffe certificates | +
UNSAFE_ENABLE_ADMIN_ENDPOINTS |
+Boolean | +false |
+If this is set to true, dangerous admin endpoints will be exposed on the debug interface. Not recommended for production. | +
UNSAFE_PILOT_ENABLE_DELTA_TEST |
+Boolean | +false |
+If enabled, addition runtime tests for Delta XDS efficiency are added. These checks are extremely expensive, so this should be used only for testing, not production. | +
UNSAFE_PILOT_ENABLE_RUNTIME_ASSERTIONS |
+Boolean | +false |
+If enabled, addition runtime asserts will be performed. These checks are both expensive and panic on failure. As a result, this should be used only for testing. | +
USE_EXTERNAL_WORKLOAD_SDS |
+Boolean | +false |
+When set to true, the istio-agent will require an external SDS and will throw an error if the workload SDS socket is not found | +
VALIDATION_WEBHOOK_CONFIG_NAME |
+String | +istio-istio-system |
+If not empty, the controller will automatically patch validatingwebhookconfiguration when the CA certificate changes. Only works in kubernetes environment. | +
VERIFY_CERTIFICATE_AT_CLIENT |
+Boolean | +false |
+If enabled, certificates received by the proxy will be verified against the OS CA certificate bundle. | +
VERIFY_SDS_CERTIFICATE |
+Boolean | +true |
+If enabled, certificates fetched from SDS server will be verified before sending back to proxy. | +
WASM_HTTP_REQUEST_MAX_RETRIES |
+Integer | +5 |
+maximum number of HTTP/HTTPS request retries for pulling a Wasm module via http/https | +
WASM_HTTP_REQUEST_TIMEOUT |
+Time Duration | +15s |
+timeout per a HTTP request for pulling a Wasm module via http/https | +
WASM_INSECURE_REGISTRIES |
+String | + |
+allow agent pull wasm plugin from insecure registries or https server, for example: 'localhost:5000,docker-registry:5000' | +
WASM_MODULE_EXPIRY |
+Time Duration | +24h0m0s |
+cache expiration duration for a wasm module. | +
WASM_PURGE_INTERVAL |
+Time Duration | +1h0m0s |
+interval between checking the expiration of wasm modules | +
WORKLOAD_RSA_KEY_SIZE |
+Integer | +2048 |
+Specify the RSA key size to use for workload certificates. | +
XDS_AUTH |
+Boolean | +true |
+If true, will authenticate XDS clients. | +
XDS_AUTH_PLAINTEXT |
+Boolean | +false |
+authenticate plain text requests - used if Istiod is running on a secure/trusted network | +
XDS_AUTH_PROVIDER |
+String | + |
+Provider for XDS auth | +
XDS_ROOT_CA |
+String | + |
+Explicitly set the root CA to expect for the XDS connection. | +
| Metric Name | Type | Description |
|---|---|---|
auto_registration_deletes_total | Sum | Total number of auto registration cleaned up by periodic timer. |
auto_registration_errors_total | Sum | Total number of auto registration errors. |
auto_registration_success_total | Sum | Total number of successful auto registrations. |
auto_registration_unregister_total | Sum | Total number of unregistrations. |
auto_registration_updates_total | Sum | Total number of auto registration updates. |
cert_expiry_seconds | LastValue | The time remaining, in seconds, before the certificate chain will expire. A negative value indicates the cert is expired. |
controller_sync_errors_total | Sum | Total number of errorMetric syncing controllers. |
dns_requests_total | Sum | Total number of DNS requests. |
dns_upstream_failures_total | Sum | Total number of DNS requests forwarded to upstream. |
dns_upstream_request_duration_seconds | Distribution | Total time in seconds Istio takes to get DNS response from upstream. |
dns_upstream_requests_total | Sum | Total number of DNS requests forwarded to upstream. |
endpoint_no_pod | LastValue | Endpoints without an associated pod. |
envoy_connection_terminations | Sum | The total number of connection errors from envoy |
istio_build | LastValue | Istio component build info |
istiod_connection_failures | Sum | The total number of connection failures to Istiod |
istiod_connection_terminations | Sum | The total number of connection errors to Istiod |
istiod_managed_clusters | LastValue | Number of clusters managed by istiod |
num_failed_outgoing_requests | Sum | Number of failed outgoing requests (e.g. to a token exchange server, CA, etc.) |
num_file_secret_failures_total | Sum | Number of times secret generation failed for files |
num_file_watcher_failures_total | Sum | Number of times file watcher failed to add watchers |
num_outgoing_requests | Sum | Number of total outgoing requests (e.g. to a token exchange server, CA, etc.) |
num_outgoing_retries | Sum | Number of outgoing retry requests (e.g. to a token exchange server, CA, etc.) |
outgoing_latency | Sum | The latency of outgoing requests (e.g. to a token exchange server, CA, etc.) in milliseconds. |
pilot_conflict_inbound_listener | LastValue | Number of conflicting inbound listeners. |
pilot_conflict_outbound_listener_tcp_over_current_tcp | LastValue | Number of conflicting tcp listeners with current tcp listener. |
pilot_debounce_time | Distribution | Delay in seconds between the first config enters debouncing and the merged push request is pushed into the push queue. |
pilot_destrule_subsets | LastValue | Duplicate subsets across destination rules for same host |
pilot_dns_cluster_without_endpoints | LastValue | DNS clusters without endpoints caused by the endpoint field in STRICT_DNS type cluster is not set or the corresponding subset cannot select any endpoint |
pilot_duplicate_envoy_clusters | LastValue | Duplicate envoy clusters caused by service entries with same hostname |
pilot_eds_no_instances | LastValue | Number of clusters without instances. |
pilot_endpoint_not_ready | LastValue | Endpoint found in unready state. |
pilot_envoy_filter_status | LastValue | Status of Envoy filters whether it was applied or errored. |
pilot_inbound_updates | Sum | Total number of updates received by pilot. |
pilot_jwks_resolver_network_fetch_fail_total | Sum | Total number of failed network fetch by pilot jwks resolver |
pilot_jwks_resolver_network_fetch_success_total | Sum | Total number of successfully network fetch by pilot jwks resolver |
pilot_k8s_cfg_events | Sum | Events from k8s config. |
pilot_k8s_endpoints_pending_pod | LastValue | Number of endpoints that do not currently have any corresponding pods. |
pilot_k8s_endpoints_with_no_pods | Sum | Endpoints that does not have any corresponding pods. |
pilot_k8s_reg_events | Sum | Events from k8s registry. |
pilot_no_ip | LastValue | Pods not found in the endpoint table, possibly invalid. |
pilot_proxy_convergence_time | Distribution | Delay in seconds between config change and a proxy receiving all required configuration. |
pilot_proxy_queue_time | Distribution | Time in seconds, a proxy is in the push queue before being dequeued. |
pilot_push_triggers | Sum | Total number of times a push was triggered, labeled by reason for the push. |
pilot_pushcontext_init_seconds | Distribution | Total time in seconds Pilot takes to init pushContext. |
pilot_sds_certificate_errors_total | Sum | Total number of failures to fetch SDS key and certificate. |
pilot_services | LastValue | Total services known to pilot. |
pilot_total_rejected_configs | Sum | Total number of configs that Pilot had to reject or ignore. |
pilot_total_xds_internal_errors | Sum | Total number of internal XDS errors in pilot. |
pilot_total_xds_rejects | Sum | Total number of XDS responses from pilot rejected by proxy. |
pilot_virt_services | LastValue | Total virtual services known to pilot. |
pilot_vservice_dup_domain | LastValue | Virtual services with dup domains. |
pilot_worker_queue_depth | LastValue | Depth of the controller queues |
pilot_worker_queue_duration | Distribution | Time taken to process an item |
pilot_worker_queue_latency | Distribution | Latency before the item is processed |
pilot_xds | LastValue | Number of endpoints connected to this pilot using XDS. |
pilot_xds_cds_reject | LastValue | Pilot rejected CDS configs. |
pilot_xds_config_size_bytes | Distribution | Distribution of configuration sizes pushed to clients |
pilot_xds_eds_reject | LastValue | Pilot rejected EDS. |
pilot_xds_expired_nonce | Sum | Total number of XDS requests with an expired nonce. |
pilot_xds_lds_reject | LastValue | Pilot rejected LDS. |
pilot_xds_push_context_errors | Sum | Number of errors (timeouts) initiating push context. |
pilot_xds_push_time | Distribution | Total time in seconds Pilot takes to push lds, rds, cds and eds. |
pilot_xds_pushes | Sum | Pilot build and send errors for lds, rds, cds and eds. |
pilot_xds_rds_reject | LastValue | Pilot rejected RDS. |
pilot_xds_send_time | Distribution | Total time in seconds Pilot takes to send generated configuration. |
pilot_xds_write_timeout | Sum | Pilot XDS response write timeouts. |
provider_lookup_cluster_failures | Sum | Number of times a cluster lookup failed |
remote_cluster_sync_timeouts_total | Sum | Number of times remote clusters took too long to sync, causing slow startup that excludes remote clusters. |
scrape_failures_total | Sum | The total number of failed scrapes. |
scrapes_total | Sum | The total number of scrapes. |
sidecar_injection_failure_total | Sum | Total number of failed sidecar injection requests. |
sidecar_injection_requests_total | Sum | Total number of sidecar injection requests. |
sidecar_injection_skip_total | Sum | Total number of skipped sidecar injection requests. |
sidecar_injection_success_total | Sum | Total number of successful sidecar injection requests. |
sidecar_injection_time_seconds | Distribution | Total time taken for injection in seconds. |
startup_duration_seconds | LastValue | The time from the process starting to being marked ready. |
wasm_cache_entries | LastValue | number of Wasm remote fetch cache entries. |
wasm_cache_lookup_count | Sum | number of Wasm remote fetch cache lookups. |
wasm_config_conversion_count | Sum | number of Wasm config conversion count and results, including success, no remote load, marshal failure, remote fetch failure, miss remote fetch hint. |
wasm_config_conversion_duration | Distribution | Total time in milliseconds istio-agent spends on converting remote load in Wasm config. |
wasm_remote_fetch_count | Sum | number of Wasm remote fetches and results, including success, download failure, and checksum mismatch. |
webhook_patch_attempts_total | Sum | Webhook patching attempts |
webhook_patch_failures_total | Sum | Webhook patching total failures |
webhook_patch_retries_total | Sum | Webhook patching retries |
xds_cache_dependent_config_size | LastValue | Current size of dependent configs |
xds_cache_evictions | Sum | Total number of xds cache evictions. |
xds_cache_reads | Sum | Total number of xds cache xdsCacheReads. |
xds_cache_size | LastValue | Current size of xds cache |
xds_proxy_requests | Sum | The total number of Xds Proxy Requests |
xds_proxy_responses | Sum | The total number of Xds Proxy Responses |
Istio Pilot provides mesh-wide traffic management, security and policy capabilities in the Istio Service Mesh.
+| Flags | +Description | +
|---|---|
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for pilot-discovery for the specified shell. +See each sub-command's help for details on how to use the generated script. +
+| Flags | +Description | +
|---|---|
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the bash shell.
+This script depends on the 'bash-completion' package. +If it is not installed already, you can install it via your OS's package manager.
+To load completions in your current shell session:
+source <(pilot-discovery completion bash)
+To load completions for every new session, execute once:
+#### Linux:
+pilot-discovery completion bash > /etc/bash_completion.d/pilot-discovery
+#### macOS:
+pilot-discovery completion bash > $(brew --prefix)/etc/bash_completion.d/pilot-discovery
+You will need to start a new shell for this setup to take effect. +
+pilot-discovery completion bash
+| Flags | +Description | +
|---|---|
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the fish shell.
+To load completions in your current shell session:
+pilot-discovery completion fish | source
+To load completions for every new session, execute once:
+pilot-discovery completion fish > ~/.config/fish/completions/pilot-discovery.fish
+You will need to start a new shell for this setup to take effect. +
+pilot-discovery completion fish [flags]
+| Flags | +Description | +
|---|---|
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for powershell.
+To load completions in your current shell session:
+pilot-discovery completion powershell | Out-String | Invoke-Expression
+To load completions for every new session, add the output of the above command +to your powershell profile. +
+pilot-discovery completion powershell [flags]
+| Flags | +Description | +
|---|---|
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the zsh shell.
+If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once:
+echo "autoload -U compinit; compinit" >> ~/.zshrc
+To load completions in your current shell session:
+source <(pilot-discovery completion zsh)
+To load completions for every new session, execute once:
+#### Linux:
+pilot-discovery completion zsh > "${fpath[1]}/_pilot-discovery"
+#### macOS:
+pilot-discovery completion zsh > $(brew --prefix)/share/zsh/site-functions/_pilot-discovery
+You will need to start a new shell for this setup to take effect. +
+pilot-discovery completion zsh [flags]
+| Flags | +Description | +
|---|---|
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Start Istio proxy discovery service.
+pilot-discovery discovery [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--caCertFile <string> |
++ | File containing the x509 Server CA Certificate (default ``) | +
--clusterAliases <stringToString> |
++ | Alias names for clusters (default `[]`) | +
--clusterID <string> |
++ | The ID of the cluster that this Istiod instance resides (default `Kubernetes`) | +
--clusterRegistriesNamespace <string> |
++ | Namespace for ConfigMap which stores clusters configs (default `istio-system`) | +
--configDir <string> |
++ | Directory to watch for updates to config yaml files. If specified, the files will be used as the source of config, rather than a CRD client. (default ``) | +
--ctrlz_address <string> |
++ | The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `localhost`) | +
--ctrlz_port <uint16> |
++ | The IP port to use for the ControlZ introspection facility (default `9876`) | +
--domain <string> |
++ | DNS domain suffix (default `cluster.local`) | +
--grpcAddr <string> |
++ | Discovery service gRPC address (default `:15010`) | +
--httpAddr <string> |
++ | Discovery service HTTP address (default `:8080`) | +
--httpsAddr <string> |
++ | Injection and validation service HTTPS address (default `:15017`) | +
--keepaliveInterval <duration> |
++ | The time interval if no activity on the connection it pings the peer to see if the transport is alive (default `30s`) | +
--keepaliveMaxServerConnectionAge <duration> |
++ | Maximum duration a connection will be kept open on the server before a graceful close. (default `2562047h47m16.854775807s`) | +
--keepaliveTimeout <duration> |
++ | After having pinged for keepalive check, the client/server waits for a duration of keepaliveTimeout and if no activity is seen even after that the connection is closed. (default `10s`) | +
--kubeconfig <string> |
++ | Use a Kubernetes configuration file instead of in-cluster configuration (default ``) | +
--kubernetesApiBurst <int> |
++ | Maximum burst for throttle when communicating with the kubernetes API (default `160`) | +
--kubernetesApiQPS <float32> |
++ | Maximum QPS when communicating with the kubernetes API (default `80`) | +
--log_as_json |
++ | Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
++ | Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, file, gateway, grpcgen, ingress status, klog, kube, model, monitor, monitoring, pkica, pkira, processing, retry, rootcertrotator, secretcontroller, security, serverca, serviceentry, spiffe, status, trustBundle, validation, validationController, validationServer, wasm, wle] (default ``) | +
--log_output_level <string> |
++ | 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, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, file, gateway, grpcgen, ingress status, klog, kube, model, monitor, monitoring, pkica, pkira, processing, retry, rootcertrotator, secretcontroller, security, serverca, serviceentry, spiffe, status, trustBundle, validation, validationController, validationServer, wasm, wle] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
++ | The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
++ | The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
++ | The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
++ | The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
++ | Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, file, gateway, grpcgen, ingress status, klog, kube, model, monitor, monitoring, pkica, pkira, processing, retry, rootcertrotator, secretcontroller, security, serverca, serviceentry, spiffe, status, trustBundle, validation, validationController, validationServer, wasm, wle] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
++ | The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--meshConfig <string> |
++ | File name for Istio mesh configuration. If not specified, a default mesh will be used. (default `./etc/istio/config/mesh`) | +
--monitoringAddr <string> |
++ | HTTP address to use for pilot's self-monitoring information (default `:15014`) | +
--namespace <string> |
+-n |
+Select a namespace where the controller resides. If not set, uses ${POD_NAMESPACE} environment variable (default `istio-system`) | +
--networksConfig <string> |
++ | File name for Istio mesh networks configuration. If not specified, a default mesh networks will be used. (default `./etc/istio/config/meshNetworks`) | +
--profile |
++ | Enable profiling via web interface host:port/debug/pprof | +
--registries <stringSlice> |
++ | Comma separated list of platform service registries to read from (choose one or more from {Kubernetes, Mock}) (default `[Kubernetes]`) | +
--secureGRPCAddr <string> |
++ | Discovery service secured gRPC address (default `:15012`) | +
--shutdownDuration <duration> |
++ | Duration the discovery server needs to terminate gracefully (default `10s`) | +
--tls-cipher-suites <stringSlice> |
++ | Comma-separated list of cipher suites for istiod TLS server. If omitted, the default Go cipher suites will be used. +Preferred values: TLS_AES_128_GCM_SHA256, TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_GCM_SHA384. +Insecure values: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_RC4_128_SHA, TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_RC4_128_SHA, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_RC4_128_SHA. (default `[]`) | +
--tlsCertFile <string> |
++ | File containing the x509 Server Certificate (default ``) | +
--tlsKeyFile <string> |
++ | File containing the x509 private key matching --tlsCertFile (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Makes an HTTP request to Pilot metrics/debug endpoint
+pilot-discovery request <method> <path> [<body>] [flags]
+| Flags | +Description | +
|---|---|
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Prints out build version information
+pilot-discovery version [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--output <string> |
+-o |
+One of 'yaml' or 'json'. (default ``) | +
--short |
+-s |
+Use --short=false to generate full version information | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
pilot-discovery command. Please use with caution as these environment variables are experimental and can change anytime.
+| Variable Name | +Type | +Default Value | +Description | +
|---|---|---|---|
AUDIENCE |
+String | + |
+Expected audience in the tokens. | +
CA_TRUSTED_NODE_ACCOUNTS |
+String | + |
+If set, the list of service accounts that are allowed to use node authentication for CSRs. Node authentication allows an identity to create CSRs on behalf of other identities, but only if there is a pod running on the same node with that identity. This is intended for use with node proxies. | +
CERT_SIGNER_DOMAIN |
+String | + |
+The cert signer domain info | +
CITADEL_ENABLE_JITTER_FOR_ROOT_CERT_ROTATOR |
+Boolean | +true |
+If true, set up a jitter to start root cert rotator. Jitter selects a backoff time in seconds to start root cert rotator, and the back off time is below root cert check interval. | +
CITADEL_SELF_SIGNED_CA_CERT_TTL |
+Time Duration | +87600h0m0s |
+The TTL of self-signed CA root certificate. | +
CITADEL_SELF_SIGNED_CA_RSA_KEY_SIZE |
+Integer | +2048 |
+Specify the RSA key size to use for self-signed Istio CA certificates. | +
CITADEL_SELF_SIGNED_ROOT_CERT_CHECK_INTERVAL |
+Time Duration | +1h0m0s |
+The interval that self-signed CA checks its root certificate expiration time and rotates root certificate. Setting this interval to zero or a negative value disables automated root cert check and rotation. This interval is suggested to be larger than 10 minutes. | +
CITADEL_SELF_SIGNED_ROOT_CERT_GRACE_PERIOD_PERCENTILE |
+Integer | +20 |
+Grace period percentile for self-signed root cert. | +
CLOUD_PLATFORM |
+String | + |
+Cloud Platform on which proxy is running, if not specified, Istio will try to discover the platform. Valid platform values are aws, azure, gcp, none | +
CLUSTER_ID |
+String | +Kubernetes |
+Defines the cluster and service registry that this Istiod instance belongs to | +
DEFAULT_WORKLOAD_CERT_TTL |
+Time Duration | +24h0m0s |
+The default TTL of issued workload certificates. Applied when the client sets a non-positive TTL in the CSR. | +
ENABLE_AUTO_SNI |
+Boolean | +false |
+If enabled, automatically set SNI when `DestinationRules` do not specify the same | +
ENABLE_CA_SERVER |
+Boolean | +true |
+If this is set to false, will not create CA server in istiod. | +
ENABLE_DEBUG_ON_HTTP |
+Boolean | +true |
+If this is set to false, the debug interface will not be enabled, recommended for production | +
ENABLE_ENHANCED_RESOURCE_SCOPING |
+Boolean | +false |
+If enabled, meshConfig.discoverySelectors will limit the CustomResource configurations(like Gateway,VirtualService,DestinationRule,Ingress, etc)that can be processed by pilot. This will also restrict the root-ca certificate distribution. | +
ENABLE_HCM_INTERNAL_NETWORKS |
+Boolean | +false |
+If enable, endpoints defined in mesh networks will be configured as internal addresses in Http Connection Manager | +
ENABLE_LEADER_ELECTION |
+Boolean | +true |
+If enabled (default), starts a leader election client and gains leadership before executing controllers. If false, it assumes that only one instance of istiod is running and skips leader election. | +
ENABLE_MCS_AUTO_EXPORT |
+Boolean | +false |
+If enabled, istiod will automatically generate Kubernetes Multi-Cluster Services (MCS) ServiceExport resources for every service in the mesh. Services defined to be cluster-local in MeshConfig are excluded. | +
ENABLE_MCS_CLUSTER_LOCAL |
+Boolean | +false |
+If enabled, istiod will treat the host `<svc>.<namespace>.svc.cluster.local` as defined by the Kubernetes Multi-Cluster Services (MCS) spec. In this mode, requests to `cluster.local` will be routed to only those endpoints residing within the same cluster as the client. Requires that both ENABLE_MCS_SERVICE_DISCOVERY and ENABLE_MCS_HOST also be enabled. | +
ENABLE_MCS_HOST |
+Boolean | +false |
+If enabled, istiod will configure a Kubernetes Multi-Cluster Services (MCS) host (<svc>.<namespace>.svc.clusterset.local) for each service exported (via ServiceExport) in at least one cluster. Clients must, however, be able to successfully lookup these DNS hosts. That means that either Istio DNS interception must be enabled or an MCS controller must be used. Requires that ENABLE_MCS_SERVICE_DISCOVERY also be enabled. | +
ENABLE_MCS_SERVICE_DISCOVERY |
+Boolean | +false |
+If enabled, istiod will enable Kubernetes Multi-Cluster Services (MCS) service discovery mode. In this mode, service endpoints in a cluster will only be discoverable within the same cluster unless explicitly exported via ServiceExport. | +
ENABLE_MULTICLUSTER_HEADLESS |
+Boolean | +true |
+If true, the DNS name table for a headless service will resolve to same-network endpoints in any cluster. | +
ENABLE_NATIVE_SIDECARS |
+Boolean | +false |
+If set, used Kubernetes native Sidecar container support. Requires SidecarContainer feature flag. | +
ENABLE_OPTIMIZED_CONFIG_REBUILD |
+Boolean | +true |
+If enabled, pilot will only rebuild config for resources that have changed | +
ENABLE_OTEL_BUILTIN_RESOURCE_LABELS |
+Boolean | +false |
+If enabled, envoy will send builtin lables(e.g. node_name) via OTel sink. | +
ENABLE_PROBE_KEEPALIVE_CONNECTIONS |
+Boolean | +false |
+If enabled, readiness probes will keep the connection from pilot-agent to the application alive. This mirrors older Istio versions' behaviors, but not kubelet's. | +
ENABLE_TLS_ON_SIDECAR_INGRESS |
+Boolean | +false |
+If enabled, the TLS configuration on Sidecar.ingress will take effect | +
EXTERNAL_CA |
+String | + |
+External CA Integration Type. Permitted Values are ISTIOD_RA_KUBERNETES_API or ISTIOD_RA_ISTIO_API | +
EXTERNAL_ISTIOD |
+Boolean | +false |
+If this is set to true, one Istiod will control remote clusters including CA. | +
GCP_METADATA |
+String | + |
+Pipe separated GCP metadata, schemed as PROJECT_ID|PROJECT_NUMBER|CLUSTER_NAME|CLUSTER_ZONE | +
GCP_QUOTA_PROJECT |
+String | + |
+Allows specification of a quota project to be used in requests to GCP APIs. | +
GRPC_KEEPALIVE_INTERVAL |
+Time Duration | +30s |
+gRPC Keepalive Interval | +
GRPC_KEEPALIVE_TIMEOUT |
+Time Duration | +10s |
+gRPC Keepalive Timeout | +
HTTP_STRIP_FRAGMENT_FROM_PATH_UNSAFE_IF_DISABLED |
+Boolean | +true |
++ |
INBOUND_INTERCEPTION_MODE |
+String | + |
+The mode used to redirect inbound connections to Envoy, either "REDIRECT" or "TPROXY" | +
INBOUND_TPROXY_MARK |
+String | + |
++ |
INJECTION_WEBHOOK_CONFIG_NAME |
+String | +istio-sidecar-injector |
+Name of the mutatingwebhookconfiguration to patch, if istioctl is not used. | +
INJECT_ENABLED |
+Boolean | +true |
+Enable mutating webhook handler. | +
ISTIOD_CUSTOM_HOST |
+String | + |
+Custom host name of istiod that istiod signs the server cert. Multiple custom host names are supported, and multiple values are separated by commas. | +
ISTIO_AGENT_ENABLE_WASM_REMOTE_LOAD_CONVERSION |
+Boolean | +true |
+If enabled, Istio agent will intercept ECDS resource update, downloads Wasm module, and replaces Wasm module remote load with downloaded local module file. | +
ISTIO_BOOTSTRAP |
+String | + |
++ |
ISTIO_DELTA_XDS |
+Boolean | +false |
+If enabled, pilot will only send the delta configs as opposed to the state of the world on a Resource Request. This feature uses the delta xds api, but does not currently send the actual deltas. | +
ISTIO_DUAL_STACK |
+Boolean | +false |
+If true, Istio will enable the Dual Stack feature. | +
ISTIO_ENABLE_CONTROLLER_QUEUE_METRICS |
+Boolean | +false |
+If enabled, publishes metrics for queue depth, latency and processing times. | +
ISTIO_ENABLE_HTTP2_PROBING |
+Boolean | +true |
+If enabled, HTTP2 probes will be enabled for HTTPS probes, following Kubernetes | +
ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSH |
+Boolean | +true |
+If enabled, Istiod will not push changes on arbitrary annotation change. | +
ISTIO_GPRC_MAXRECVMSGSIZE |
+Integer | +4194304 |
+Sets the max receive buffer size of gRPC stream in bytes. | +
ISTIO_GPRC_MAXSTREAMS |
+Integer | +100000 |
+Sets the maximum number of concurrent grpc streams. | +
ISTIO_KUBE_CLIENT_CONTENT_TYPE |
+String | +protobuf |
+The content type to use for Kubernetes clients. Defaults to protobuf. Valid options: [protobuf, json] | +
ISTIO_MULTIROOT_MESH |
+Boolean | +false |
+If enabled, mesh will support certificates signed by more than one trustAnchor for ISTIO_MUTUAL mTLS | +
ISTIO_OUTBOUND_OWNER_GROUPS |
+String | +* |
+Comma separated list of groups whose outgoing traffic is to be redirected to Envoy. +A group can be specified either by name or by a numeric GID. +The wildcard character "*" can be used to configure redirection of traffic from all groups. | +
ISTIO_OUTBOUND_OWNER_GROUPS_EXCLUDE |
+String | + |
+Comma separated list of groups whose outgoing traffic is to be excluded from redirection to Envoy. +A group can be specified either by name or by a numeric GID. +Only applies when traffic from all groups (i.e. "*") is being redirected to Envoy. | +
ISTIO_PROMETHEUS_ANNOTATIONS |
+String | + |
++ |
ISTIO_WATCH_NAMESPACE |
+String | + |
+If set, limit Kubernetes watches to a single namespace. Warning: only a single namespace can be set. | +
ISTIO_WORKLOAD_ENTRY_VALIDATE_IDENTITY |
+Boolean | +true |
+If enabled, will validate the identity of a workload matches the identity of the WorkloadEntry it is associating with for health checks and auto registration. This flag is added for backwards compatibility only and will be removed in future releases | +
JWKS_RESOLVER_INSECURE_SKIP_VERIFY |
+Boolean | +false |
+If enabled, istiod will skip verifying the certificate of the JWKS server. | +
JWT_POLICY |
+String | +third-party-jwt |
+The JWT validation policy. | +
JWT_RULE |
+String | + |
+The JWT rule used by istiod authentication | +
K8S_INGRESS_NS |
+String | +istio-system |
++ |
K8S_SIGNER |
+String | + |
+Kubernetes CA Signer type. Valid from Kubernetes 1.18 | +
KUBERNETES_SERVICE_HOST |
+String | + |
+Kubernetes service host, set automatically when running in-cluster | +
K_REVISION |
+String | + |
+KNative revision, set if running in knative | +
LABEL_CANONICAL_SERVICES_FOR_MESH_EXTERNAL_SERVICE_ENTRIES |
+Boolean | +false |
+If enabled, metadata representing canonical services for ServiceEntry resources with a location of mesh_external will be populatedin the cluster metadata for those endpoints. | +
LOCAL_CLUSTER_SECRET_WATCHER |
+Boolean | +false |
+If enabled, the cluster secret watcher will watch the namespace of the external cluster instead of config cluster | +
MAX_WORKLOAD_CERT_TTL |
+Time Duration | +2160h0m0s |
+The max TTL of issued workload certificates. | +
MCS_API_GROUP |
+String | +multicluster.x-k8s.io |
+The group to be used for the Kubernetes Multi-Cluster Services (MCS) API. | +
MCS_API_VERSION |
+String | +v1alpha1 |
+The version to be used for the Kubernets Multi-Cluster Services (MCS) API. | +
METRIC_GRACEFUL_DELETION_INTERVAL |
+Time Duration | +5m0s |
+Metric expiry graceful deletion interval. No-op if METRIC_ROTATION_INTERVAL is disabled. | +
METRIC_ROTATION_INTERVAL |
+Time Duration | +0s |
+Metric scope rotation interval, set to 0 to disable the metric scope rotation | +
MUTEX_PROFILE_FRACTION |
+Integer | +1000 |
+If set to a non-zero value, enables mutex profiling a rate of 1/MUTEX_PROFILE_FRACTION events. For example, '1000' will record 0.1% of events. Set to 0 to disable entirely. | +
NATIVE_METADATA_EXCHANGE |
+Boolean | +true |
+If set, uses a native implementation of the HTTP metadata exchange filter | +
PILOT_ALLOW_SIDECAR_SERVICE_INBOUND_LISTENER_MERGE |
+Boolean | +false |
+If set, it allows creating inbound listeners for service ports and sidecar ingress listeners | +
PILOT_ANALYSIS_INTERVAL |
+Time Duration | +10s |
+If analysis is enabled, pilot will run istio analyzers using this value as interval in seconds Istio Resources | +
PILOT_CERT_PROVIDER |
+String | +istiod |
+The provider of Pilot DNS certificate. | +
PILOT_DEBOUNCE_AFTER |
+Time Duration | +100ms |
+The delay added to config/registry events for debouncing. This will delay the push by at least this interval. If no change is detected within this period, the push will happen, otherwise we'll keep delaying until things settle, up to a max of PILOT_DEBOUNCE_MAX. | +
PILOT_DEBOUNCE_MAX |
+Time Duration | +10s |
+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. | +
PILOT_DISTRIBUTION_HISTORY_RETENTION |
+Time Duration | +1m0s |
+If enabled, Pilot will keep track of old versions of distributed config for this duration. | +
PILOT_DRAINING_LABEL |
+String | +istio.io/draining |
+If not empty, endpoints with the label value present will be sent with status DRAINING. | +
PILOT_ENABLE_ALPHA_GATEWAY_API |
+Boolean | +false |
+If this is set to true, support for alpha APIs in the Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed. | +
PILOT_ENABLE_ALPN_FILTER |
+Boolean | +true |
+If true, pilot will add Istio ALPN filters, required for proper protocol sniffing. | +
PILOT_ENABLE_AMBIENT_CONTROLLERS |
+Boolean | +false |
+If enabled, controllers required for ambient will run. This is required to run ambient mesh. | +
PILOT_ENABLE_ANALYSIS |
+Boolean | +false |
+If enabled, pilot will run istio analyzers and write analysis errors to the Status field of any Istio Resources | +
PILOT_ENABLE_CDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache CDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE. | +
PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING |
+Boolean | +false |
+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. | +
PILOT_ENABLE_CROSS_CLUSTER_WORKLOAD_ENTRY |
+Boolean | +true |
+If enabled, pilot will read WorkloadEntry from other clusters, selectable by Services in that cluster. | +
PILOT_ENABLE_EDS_DEBOUNCE |
+Boolean | +true |
+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 | +
PILOT_ENABLE_EDS_FOR_HEADLESS_SERVICES |
+Boolean | +false |
+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. | +
PILOT_ENABLE_GATEWAY_API |
+Boolean | +true |
+If this is set to true, support for Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed. | +
PILOT_ENABLE_GATEWAY_API_DEPLOYMENT_CONTROLLER |
+Boolean | +true |
+If this is set to true, gateway-api resources will automatically provision in cluster deployment, services, etc | +
PILOT_ENABLE_GATEWAY_API_GATEWAYCLASS_CONTROLLER |
+Boolean | +true |
+If this is set to true, istiod will create and manage its default GatewayClasses | +
PILOT_ENABLE_GATEWAY_API_STATUS |
+Boolean | +true |
+If this is set to true, gateway-api resources will have status written to them | +
PILOT_ENABLE_HBONE |
+Boolean | +false |
+If enabled, HBONE support can be configured for proxies. Note: proxies must opt in on a per-proxy basis with ENABLE_HBONE to actually get HBONE config, in addition to this flag. | +
PILOT_ENABLE_HEADLESS_SERVICE_POD_LISTENERS |
+Boolean | +true |
+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. | +
PILOT_ENABLE_INBOUND_PASSTHROUGH |
+Boolean | +true |
+If enabled, inbound clusters will be configured as ORIGINAL_DST clusters. When disabled, requests are always sent to localhost. The primary implication of this is that when enabled, binding to POD_IP will work while localhost will not; when disable, bind to POD_IP will not work, while localhost will. The enabled behavior matches the behavior without Istio enabled at all; this flag exists only for backwards compatibility. Regardless of this setting, the configuration can be overridden with the Sidecar.Ingress.DefaultEndpoint configuration. | +
PILOT_ENABLE_K8S_SELECT_WORKLOAD_ENTRIES |
+Boolean | +true |
+If enabled, Kubernetes services with selectors will select workload entries with matching labels. It is safe to disable it if you are quite sure you don't need this feature | +
PILOT_ENABLE_METADATA_EXCHANGE |
+Boolean | +true |
+If true, pilot will add metadata exchange filters, which will be consumed by telemetry filter. | +
PILOT_ENABLE_MONGO_FILTER |
+Boolean | +true |
+EnableMongoFilter enables injection of `envoy.filters.network.mongo_proxy` in the filter chain. | +
PILOT_ENABLE_MYSQL_FILTER |
+Boolean | +false |
+EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain. | +
PILOT_ENABLE_PERSISTENT_SESSION_FILTER |
+Boolean | +false |
+If enabled, Istiod sets up persistent session filter for listeners, if services have 'PILOT_PERSISTENT_SESSION_LABEL' set. | +
PILOT_ENABLE_QUIC_LISTENERS |
+Boolean | +false |
+If true, QUIC listeners will be generated wherever there are listeners terminating TLS on gateways if the gateway service exposes a UDP port with the same number (for example 443/TCP and 443/UDP) | +
PILOT_ENABLE_RDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache RDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE. | +
PILOT_ENABLE_REDIS_FILTER |
+Boolean | +false |
+EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain. | +
PILOT_ENABLE_ROUTE_COLLAPSE_OPTIMIZATION |
+Boolean | +true |
+If true, Pilot will merge virtual hosts with the same routes into a single virtual host, as an optimization. | +
PILOT_ENABLE_SERVICEENTRY_SELECT_PODS |
+Boolean | +true |
+If enabled, service entries with selectors will select pods from the cluster. It is safe to disable it if you are quite sure you don't need this feature | +
PILOT_ENABLE_STATUS |
+Boolean | +false |
+If enabled, pilot will update the CRD Status field of all istio resources with reconciliation status. | +
PILOT_ENABLE_TELEMETRY_LABEL |
+Boolean | +true |
+If true, pilot will add telemetry related metadata to cluster and endpoint resources, which will be consumed by telemetry filter. | +
PILOT_ENABLE_WORKLOAD_ENTRY_AUTOREGISTRATION |
+Boolean | +true |
+Enables auto-registering WorkloadEntries based on associated WorkloadGroups upon XDS connection by the workload. | +
PILOT_ENABLE_WORKLOAD_ENTRY_HEALTHCHECKS |
+Boolean | +true |
+Enables automatic health checks of WorkloadEntries based on the config provided in the associated WorkloadGroup | +
PILOT_ENABLE_XDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache XDS responses. | +
PILOT_ENABLE_XDS_IDENTITY_CHECK |
+Boolean | +true |
+If enabled, pilot will authorize XDS clients, to ensure they are acting only as namespaces they have permissions for. | +
PILOT_ENDPOINT_TELEMETRY_LABEL |
+Boolean | +true |
+If true, pilot will add telemetry related metadata to Endpoint resource, which will be consumed by telemetry filter. | +
PILOT_ENVOY_FILTER_STATS |
+Boolean | +false |
+If true, Pilot will collect metrics for envoy filter operations. | +
PILOT_FILTER_GATEWAY_CLUSTER_CONFIG |
+Boolean | +false |
+If enabled, Pilot will send only clusters that referenced in gateway virtual services attached to gateway | +
PILOT_HTTP10 |
+Boolean | +false |
+Enables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications. | +
PILOT_INSECURE_MULTICLUSTER_KUBECONFIG_OPTIONS |
+String | + |
+Comma separated list of potentially insecure kubeconfig authentication options that are allowed for multicluster authentication.Support values: all authProviders (`gcp`, `azure`, `exec`, `openstack`), `clientKey`, `clientCertificate`, `tokenFile`, and `exec`. | +
PILOT_JWT_ENABLE_REMOTE_JWKS |
+String | +false |
+Mode of fetching JWKs from JwksUri in RequestAuthentication. Supported value: istiod, false, hybrid, true, envoy. The client fetching JWKs is as following: istiod/false - Istiod; hybrid/true - Envoy and fallback to Istiod if JWKs server is external; envoy - Envoy. | +
PILOT_JWT_PUB_KEY_REFRESH_INTERVAL |
+Time Duration | +20m0s |
+The interval for istiod to fetch the jwks_uri for the jwks public key. | +
PILOT_MAX_REQUESTS_PER_SECOND |
+Floating-Point | +25 |
+Limits the number of incoming XDS requests per second. On larger machines this can be increased to handle more proxies concurrently. | +
PILOT_MULTI_NETWORK_DISCOVER_GATEWAY_API |
+Boolean | +false |
+If true, Pilot will discover labeled Kubernetes gateway objects as multi-network gateways. | +
PILOT_PERSISTENT_SESSION_HEADER_LABEL |
+String | +istio.io/persistent-session-header |
+If not empty, services with this label will use header based persistent sessions | +
PILOT_PERSISTENT_SESSION_LABEL |
+String | +istio.io/persistent-session |
+If not empty, services with this label will use cookie based persistent sessions | +
PILOT_PUSH_THROTTLE |
+Integer | +100 |
+Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes | +
PILOT_REMOTE_CLUSTER_TIMEOUT |
+Time Duration | +30s |
+After this timeout expires, pilot can become ready without syncing data from clusters added via remote-secrets. Setting the timeout to 0 disables this behavior. | +
PILOT_SCOPE_GATEWAY_TO_NAMESPACE |
+Boolean | +false |
+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. | +
PILOT_SEND_UNHEALTHY_ENDPOINTS |
+Boolean | +false |
+If enabled, Pilot will include unhealthy endpoints in EDS pushes and even if they are sent Envoy does not use them for load balancing. To avoid, sending traffic to non ready endpoints, enabling this flag, disables panic threshold in Envoy i.e. Envoy does not load balance requests to unhealthy/non-ready hosts even if the percentage of healthy hosts fall below minimum health percentage(panic threshold). | +
PILOT_SIDECAR_USE_REMOTE_ADDRESS |
+Boolean | +false |
+UseRemoteAddress sets useRemoteAddress to true for sidecar outbound listeners. | +
PILOT_SKIP_VALIDATE_TRUST_DOMAIN |
+Boolean | +false |
+Skip validating the peer is from the same trust domain when mTLS is enabled in authentication policy | +
PILOT_STATUS_BURST |
+Integer | +500 |
+If status is enabled, controls the Burst rate with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config Burst | +
PILOT_STATUS_MAX_WORKERS |
+Integer | +100 |
+The maximum number of workers Pilot will use to keep configuration status up to date. Smaller numbers will result in higher status latency, but larger numbers may impact CPU in high scale environments. | +
PILOT_STATUS_QPS |
+Integer | +100 |
+If status is enabled, controls the QPS with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config QPS | +
PILOT_STATUS_UPDATE_INTERVAL |
+Time Duration | +500ms |
+Interval to update the XDS distribution status. | +
PILOT_TRACE_SAMPLING |
+Floating-Point | +1 |
+Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 1.0. | +
PILOT_WORKLOAD_ENTRY_GRACE_PERIOD |
+Time Duration | +10s |
+The amount of time an auto-registered workload can remain disconnected from all Pilot instances before the associated WorkloadEntry is cleaned up. | +
PILOT_XDS_CACHE_INDEX_CLEAR_INTERVAL |
+Time Duration | +5s |
+The interval for xds cache index clearing. | +
PILOT_XDS_CACHE_SIZE |
+Integer | +60000 |
+The maximum number of cache entries for the XDS cache. | +
PILOT_XDS_CACHE_STATS |
+Boolean | +false |
+If true, Pilot will collect metrics for XDS cache efficiency. | +
PILOT_XDS_SEND_TIMEOUT |
+Time Duration | +0s |
+The timeout to send the XDS configuration to proxies. After this timeout is reached, Pilot will discard that push. | +
PLATFORM |
+String | + |
+Platform where Istio is deployed. Possible values are "openshift" and "gcp" | +
POD_NAME |
+String | + |
++ |
POD_NAMESPACE |
+String | +istio-system |
++ |
REQUIRE_3P_TOKEN |
+Boolean | +false |
+Reject k8s default tokens, without audience. If false, default K8S token will be accepted | +
RESOLVE_HOSTNAME_GATEWAYS |
+Boolean | +true |
+If true, hostnames in the LoadBalancer addresses of a Service will be resolved at the control plane for use in cross-network gateways. | +
REVISION |
+String | + |
++ |
REWRITE_PROBE_LEGACY_LOCALHOST_DESTINATION |
+Boolean | +false |
+If enabled, readiness probes will be sent to 'localhost'. Otherwise, they will be sent to the Pod's IP, matching Kubernetes' behavior. | +
ROOT_CA_DIR |
+String | +./etc/cacerts |
+Location of a local or mounted CA root | +
SHARED_MESH_CONFIG |
+String | + |
+Additional config map to load for shared MeshConfig settings. The standard mesh config will take precedence. | +
TOKEN_AUDIENCES |
+String | +istio-ca |
+A list of comma separated audiences to check in the JWT token before issuing a certificate. The token is accepted if it matches with one of the audiences | +
TOKEN_ISSUER |
+String | + |
+OIDC token issuer. If set, will be used to check the tokens. | +
TRUSTED_GATEWAY_CIDR |
+String | + |
+If set, any connections from gateway to Istiod with this CIDR range are treated as trusted for using authentication mechanisms like XFCC. This can only be used when the network where Istiod and the authenticating gateways are running in a trusted/secure network | +
UNSAFE_ENABLE_ADMIN_ENDPOINTS |
+Boolean | +false |
+If this is set to true, dangerous admin endpoints will be exposed on the debug interface. Not recommended for production. | +
UNSAFE_PILOT_ENABLE_DELTA_TEST |
+Boolean | +false |
+If enabled, addition runtime tests for Delta XDS efficiency are added. These checks are extremely expensive, so this should be used only for testing, not production. | +
UNSAFE_PILOT_ENABLE_RUNTIME_ASSERTIONS |
+Boolean | +false |
+If enabled, addition runtime asserts will be performed. These checks are both expensive and panic on failure. As a result, this should be used only for testing. | +
USE_REMOTE_CERTS |
+Boolean | +false |
+Whether to try to load CA certs from config Kubernetes cluster. Used for external Istiod. | +
VALIDATION_WEBHOOK_CONFIG_NAME |
+String | +istio-istio-system |
+If not empty, the controller will automatically patch validatingwebhookconfiguration when the CA certificate changes. Only works in kubernetes environment. | +
VERIFY_CERTIFICATE_AT_CLIENT |
+Boolean | +false |
+If enabled, certificates received by the proxy will be verified against the OS CA certificate bundle. | +
VERIFY_SDS_CERTIFICATE |
+Boolean | +true |
+If enabled, certificates fetched from SDS server will be verified before sending back to proxy. | +
XDS_AUTH |
+Boolean | +true |
+If true, will authenticate XDS clients. | +
XDS_AUTH_PLAINTEXT |
+Boolean | +false |
+authenticate plain text requests - used if Istiod is running on a secure/trusted network | +
| Metric Name | Type | Description |
|---|---|---|
auto_registration_deletes_total | Sum | Total number of auto registration cleaned up by periodic timer. |
auto_registration_errors_total | Sum | Total number of auto registration errors. |
auto_registration_success_total | Sum | Total number of successful auto registrations. |
auto_registration_unregister_total | Sum | Total number of unregistrations. |
auto_registration_updates_total | Sum | Total number of auto registration updates. |
citadel_server_authentication_failure_count | Sum | The number of authentication failures. |
citadel_server_cert_chain_expiry_timestamp | LastValue | The unix timestamp, in seconds, when Citadel cert chain will expire. A negative time indicates the cert is expired. |
citadel_server_csr_count | Sum | The number of CSRs received by Citadel server. |
citadel_server_csr_parsing_err_count | Sum | The number of errors occurred when parsing the CSR. |
citadel_server_csr_sign_err_count | Sum | The number of errors occurred when signing the CSR. |
citadel_server_id_extraction_err_count | Sum | The number of errors occurred when extracting the ID from CSR. |
citadel_server_root_cert_expiry_timestamp | LastValue | The unix timestamp, in seconds, when Citadel root cert will expire. A negative time indicates the cert is expired. |
citadel_server_success_cert_issuance_count | Sum | The number of certificates issuances that have succeeded. |
controller_sync_errors_total | Sum | Total number of errorMetric syncing controllers. |
endpoint_no_pod | LastValue | Endpoints without an associated pod. |
galley_validation_config_load_error | Sum | k8s webhook configuration (re)load error |
galley_validation_config_update_error | Sum | k8s webhook configuration update error |
galley_validation_config_updates | Sum | k8s webhook configuration updates |
galley_validation_failed | Sum | Resource validation failed |
galley_validation_http_error | Sum | Resource validation http serve errors |
galley_validation_passed | Sum | Resource is valid |
istio_build | LastValue | Istio component build info |
istiod_managed_clusters | LastValue | Number of clusters managed by istiod |
istiod_uptime_seconds | LastValue | Current istiod server uptime in seconds |
num_outgoing_retries | Sum | Number of outgoing retry requests (e.g. to a token exchange server, CA, etc.) |
pilot_conflict_inbound_listener | LastValue | Number of conflicting inbound listeners. |
pilot_conflict_outbound_listener_tcp_over_current_tcp | LastValue | Number of conflicting tcp listeners with current tcp listener. |
pilot_debounce_time | Distribution | Delay in seconds between the first config enters debouncing and the merged push request is pushed into the push queue. |
pilot_destrule_subsets | LastValue | Duplicate subsets across destination rules for same host |
pilot_dns_cluster_without_endpoints | LastValue | DNS clusters without endpoints caused by the endpoint field in STRICT_DNS type cluster is not set or the corresponding subset cannot select any endpoint |
pilot_duplicate_envoy_clusters | LastValue | Duplicate envoy clusters caused by service entries with same hostname |
pilot_eds_no_instances | LastValue | Number of clusters without instances. |
pilot_endpoint_not_ready | LastValue | Endpoint found in unready state. |
pilot_envoy_filter_status | LastValue | Status of Envoy filters whether it was applied or errored. |
pilot_inbound_updates | Sum | Total number of updates received by pilot. |
pilot_info | LastValue | Pilot version and build information. |
pilot_jwks_resolver_network_fetch_fail_total | Sum | Total number of failed network fetch by pilot jwks resolver |
pilot_jwks_resolver_network_fetch_success_total | Sum | Total number of successfully network fetch by pilot jwks resolver |
pilot_k8s_cfg_events | Sum | Events from k8s config. |
pilot_k8s_endpoints_pending_pod | LastValue | Number of endpoints that do not currently have any corresponding pods. |
pilot_k8s_endpoints_with_no_pods | Sum | Endpoints that does not have any corresponding pods. |
pilot_k8s_reg_events | Sum | Events from k8s registry. |
pilot_no_ip | LastValue | Pods not found in the endpoint table, possibly invalid. |
pilot_proxy_convergence_time | Distribution | Delay in seconds between config change and a proxy receiving all required configuration. |
pilot_proxy_queue_time | Distribution | Time in seconds, a proxy is in the push queue before being dequeued. |
pilot_push_triggers | Sum | Total number of times a push was triggered, labeled by reason for the push. |
pilot_pushcontext_init_seconds | Distribution | Total time in seconds Pilot takes to init pushContext. |
pilot_sds_certificate_errors_total | Sum | Total number of failures to fetch SDS key and certificate. |
pilot_services | LastValue | Total services known to pilot. |
pilot_total_rejected_configs | Sum | Total number of configs that Pilot had to reject or ignore. |
pilot_total_xds_internal_errors | Sum | Total number of internal XDS errors in pilot. |
pilot_total_xds_rejects | Sum | Total number of XDS responses from pilot rejected by proxy. |
pilot_virt_services | LastValue | Total virtual services known to pilot. |
pilot_vservice_dup_domain | LastValue | Virtual services with dup domains. |
pilot_worker_queue_depth | LastValue | Depth of the controller queues |
pilot_worker_queue_duration | Distribution | Time taken to process an item |
pilot_worker_queue_latency | Distribution | Latency before the item is processed |
pilot_xds | LastValue | Number of endpoints connected to this pilot using XDS. |
pilot_xds_cds_reject | LastValue | Pilot rejected CDS configs. |
pilot_xds_config_size_bytes | Distribution | Distribution of configuration sizes pushed to clients |
pilot_xds_eds_reject | LastValue | Pilot rejected EDS. |
pilot_xds_expired_nonce | Sum | Total number of XDS requests with an expired nonce. |
pilot_xds_lds_reject | LastValue | Pilot rejected LDS. |
pilot_xds_push_context_errors | Sum | Number of errors (timeouts) initiating push context. |
pilot_xds_push_time | Distribution | Total time in seconds Pilot takes to push lds, rds, cds and eds. |
pilot_xds_pushes | Sum | Pilot build and send errors for lds, rds, cds and eds. |
pilot_xds_rds_reject | LastValue | Pilot rejected RDS. |
pilot_xds_send_time | Distribution | Total time in seconds Pilot takes to send generated configuration. |
pilot_xds_write_timeout | Sum | Pilot XDS response write timeouts. |
provider_lookup_cluster_failures | Sum | Number of times a cluster lookup failed |
remote_cluster_sync_timeouts_total | Sum | Number of times remote clusters took too long to sync, causing slow startup that excludes remote clusters. |
scrape_failures_total | Sum | The total number of failed scrapes. |
scrapes_total | Sum | The total number of scrapes. |
sidecar_injection_failure_total | Sum | Total number of failed sidecar injection requests. |
sidecar_injection_requests_total | Sum | Total number of sidecar injection requests. |
sidecar_injection_skip_total | Sum | Total number of skipped sidecar injection requests. |
sidecar_injection_success_total | Sum | Total number of successful sidecar injection requests. |
sidecar_injection_time_seconds | Distribution | Total time taken for injection in seconds. |
startup_duration_seconds | LastValue | The time from the process starting to being marked ready. |
wasm_cache_entries | LastValue | number of Wasm remote fetch cache entries. |
wasm_cache_lookup_count | Sum | number of Wasm remote fetch cache lookups. |
wasm_config_conversion_count | Sum | number of Wasm config conversion count and results, including success, no remote load, marshal failure, remote fetch failure, miss remote fetch hint. |
wasm_config_conversion_duration | Distribution | Total time in milliseconds istio-agent spends on converting remote load in Wasm config. |
wasm_remote_fetch_count | Sum | number of Wasm remote fetches and results, including success, download failure, and checksum mismatch. |
webhook_patch_attempts_total | Sum | Webhook patching attempts |
webhook_patch_failures_total | Sum | Webhook patching total failures |
webhook_patch_retries_total | Sum | Webhook patching retries |
xds_cache_dependent_config_size | LastValue | Current size of dependent configs |
xds_cache_evictions | Sum | Total number of xds cache evictions. |
xds_cache_reads | Sum | Total number of xds cache xdsCacheReads. |
xds_cache_size | LastValue | Current size of xds cache |
Configuration affecting the service mesh as a whole.
@@ -67,26 +67,6 @@Connection timeout used by Envoy. (MUST BE >=1ms) Default timeout is 10s.
- -protocolDetectionTimeoutDurationAutomatic protocol detection uses a set of heuristics to -determine whether the connection is using TLS or not (on the -server side), as well as the application protocol being used -(e.g., http vs tcp). These heuristics rely on the client sending -the first bits of data. For server first protocols like MySQL, -MongoDB, etc. Envoy will timeout on the protocol detection after -the specified period, defaulting to non mTLS plain TCP -traffic. Set this field to tweak the period that Envoy will wait -for the client to send the first bits of data. (MUST BE >=1ms or -0s to disable). Default detection timeout is 0s (no timeout).
-metadataExchangeHeadersMetadataExchangeHeadersControls Istio metadata exchange headers X-Envoy-Peer-Metadata and X-Envoy-Peer-Metadata-Id.
+By default, the behavior is unspecified.
+If IN_MESH, these headers will not be appended to outbound requests from sidecars to services not in-mesh.
Network provides information about the endpoints in a routable L3 @@ -4227,6 +4246,34 @@
| Name | +Description | +||||
|---|---|---|---|---|---|
UNDEFINED |
+
+ Existing Istio behavior for the metadata exchange headers is unchanged. + + |
+||||
IN_MESH |
+
+ Only append the istio metadata exchange headers for services considered in-mesh.
+Traffic is considered in-mesh if it is secured with Istio mutual TLS. This means that |
REDIRECT |
The |
diff --git a/content/en/docs/reference/config/networking/virtual-service/index.html b/content/en/docs/reference/config/networking/virtual-service/index.html
index 2f2088618b40..21757ed265ce 100644
--- a/content/en/docs/reference/config/networking/virtual-service/index.html
+++ b/content/en/docs/reference/config/networking/virtual-service/index.html
@@ -8,7 +8,7 @@
generator: protoc-gen-docs
schema: istio.networking.v1alpha3.VirtualService
aliases: [/docs/reference/config/networking/v1alpha3/virtual-service]
-number_of_entries: 28
+number_of_entries: 29
---
+No + | + +|
mirrors |
+HTTPMirrorPolicy[] |
+
+ Specifies the destinations to mirror HTTP traffic in addition +to the original destination. Mirrored traffic is on a +best effort basis where the sidecar/gateway will not wait for the +mirrored destinations to respond before returning the response from the +original destination. Statistics will be generated for the mirrored +destination. + |
No
@@ -2495,7 +2511,8 @@ HTTPRetrybetween retries will be determined automatically (25ms+). When requesttimeout of the HTTP route
or per_try_timeout is configured, the actual number of retries attempted also depends on
-the specified request timeout and per_try_timeout values.
+the specified request timeout and per_try_timeout values. MUST BE >= 0. If 0, retries will be disabled.
+The maximum possible number of requests made will be 1 + attempts.
|
@@ -2734,6 +2751,52 @@ HTTPFaultInjectionAbort Http request attempts and return error codes back to downstream service, giving the impression that the upstream service is faulty. + |
++No + | +
HTTPMirrorPolicy can be used to specify the destinations to mirror HTTP traffic in addition +to the original destination. Mirrored traffic is on a +best effort basis where the sidecar/gateway will not wait for the +mirrored destinations to respond before returning the response from the +original destination. Statistics will be generated for the mirrored +destination.
+ + +PluginType indicates the type of Wasm Extension to be used.
+There are two types of Extensions: HTTP and NETWORK.
+HTTP Extension work at “Layer 7”(for example as an HTTP filters in Envoy).
+The detailed HTTP interface for can be found at [C++] (https://github.com/proxy-wasm/proxy-wasm-cpp-host/blob/b7e690703c7f26707438a2f1ebd7c197bc8f0296/include/proxy-wasm/context_interface.h#L199)
+and [Rust] (https://github.com/proxy-wasm/proxy-wasm-rust-sdk/blob/6b47aec926bc29971c727471d6f4c972ec407c7f/src/traits.rs#L309).
+NETWORK Extension work at “Layer 4”(for example, as a network filter in Envoy).
+The detailed NETWORK interface for can be found at [C++] (https://github.com/proxy-wasm/proxy-wasm-cpp-host/blob/b7e690703c7f26707438a2f1ebd7c197bc8f0296/include/proxy-wasm/context_interface.h#L257)
+and [Rust] (https://github.com/proxy-wasm/proxy-wasm-rust-sdk/blob/6b47aec926bc29971c727471d6f4c972ec407c7f/src/traits.rs#L257).
+The NETWORK Extension can be applied to HTTP traffic as well.
| Name | +Description | +|||
|---|---|---|---|---|
UNSPECIFIED_PLUGIN_TYPE |
+
+ Defaults to HTTP. + + |
+|||
HTTP |
+
+ Use HTTP Wasm Extension. + + |
+|||
NETWORK |
+
+ Use Network Wasm Extension. + |
| Flags | +Description | +
|---|---|
--ambient-enabled |
+Whether ambient controller is enabled | +
--chained-cni-plugin |
+Whether to install CNI plugin as a chained or standalone | +
--cni-conf-name <string> |
+Name of the CNI configuration file (default ``) | +
--cni-net-dir <string> |
+Directory on the host where CNI network plugins are installed (default `/etc/cni/net.d`) | +
--cni-network-config <string> |
+CNI configuration template as a string (default ``) | +
--cni-network-config-file <string> |
+CNI config template as a file (default ``) | +
--ctrlz_address <string> |
+The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `localhost`) | +
--ctrlz_port <uint16> |
+The IP port to use for the ControlZ introspection facility (default `9876`) | +
--ebpf-enabled |
+Whether ebpf redirection is enabled | +
--kube-ca-file <string> |
+CA file for kubeconfig. Defaults to the same as install-cni pod (default ``) | +
--kubecfg-file-name <string> |
+Name of the kubeconfig file which CNI plugin will use when interacting with API server (default `ZZZ-istio-cni-kubeconfig`) | +
--kubeconfig-mode <int> |
+File mode of the kubeconfig file (default `384`) | +
--log-level <string> |
+Fallback value for log level in CNI config file, if not specified in helm template (default `warn`) | +
--log-uds-address <string> |
+The UDS server address which CNI plugin will copy log output to (default `/var/run/istio-cni/log.sock`) | +
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] (default ``) | +
--log_output_level <string> |
+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 [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--monitoring-port <int> |
+HTTP port to serve prometheus metrics (default `15014`) | +
--mounted-cni-net-dir <string> |
+Directory on the container where CNI networks are installed (default `/host/etc/cni/net.d`) | +
--repair-broken-pod-label-key <string> |
+The key portion of the label which will be set by the ace repair if label pods is true (default `cni.istio.io/uninitialized`) | +
--repair-broken-pod-label-value <string> |
+The value portion of the label which will be set by the race repair if label pods is true (default `true`) | +
--repair-delete-pods |
+Controller will delete pods when detecting pod broken by race condition | +
--repair-enabled |
+Whether to enable race condition repair or not | +
--repair-field-selectors <string> |
+A set of field selectors in label=value format that will be added to the pod list filters (default ``) | +
--repair-init-container-exit-code <int> |
+Expected exit code for the init container when crash-looping because of CNI misconfiguration (default `126`) | +
--repair-init-container-name <string> |
+The name of the istio init container (will crash-loop if CNI is not configured for the pod) (default `istio-validation`) | +
--repair-init-container-termination-message <string> |
+The expected termination message for the init container when crash-looping because of CNI misconfiguration (default ``) | +
--repair-label-pods |
+Controller will label pods when detecting pod broken by race condition | +
--repair-label-selectors <string> |
+A set of label selectors in label=value format that will be added to the pod list filters (default ``) | +
--repair-node-name <string> |
+The name of the managed node (will manage all nodes if unset) (default ``) | +
--repair-sidecar-annotation <string> |
+An annotation key that indicates this pod contains an istio sidecar. All pods without this annotation will be ignored.The value of the annotation is ignored. (default `sidecar.istio.io/status`) | +
--skip-tls-verify |
+Whether to use insecure TLS in kubeconfig file | +
Generate the autocompletion script for install-cni for the specified shell. +See each sub-command's help for details on how to use the generated script. +
+| Flags | +Description | +
|---|---|
--ctrlz_address <string> |
+The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `localhost`) | +
--ctrlz_port <uint16> |
+The IP port to use for the ControlZ introspection facility (default `9876`) | +
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] (default ``) | +
--log_output_level <string> |
+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 [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
Generate the autocompletion script for the bash shell.
+This script depends on the 'bash-completion' package. +If it is not installed already, you can install it via your OS's package manager.
+To load completions in your current shell session:
+source <(install-cni completion bash)
+To load completions for every new session, execute once:
+#### Linux:
+install-cni completion bash > /etc/bash_completion.d/install-cni
+#### macOS:
+install-cni completion bash > $(brew --prefix)/etc/bash_completion.d/install-cni
+You will need to start a new shell for this setup to take effect. +
+install-cni completion bash
+| Flags | +Description | +
|---|---|
--ctrlz_address <string> |
+The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `localhost`) | +
--ctrlz_port <uint16> |
+The IP port to use for the ControlZ introspection facility (default `9876`) | +
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] (default ``) | +
--log_output_level <string> |
+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 [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--no-descriptions |
+disable completion descriptions | +
Generate the autocompletion script for the fish shell.
+To load completions in your current shell session:
+install-cni completion fish | source
+To load completions for every new session, execute once:
+install-cni completion fish > ~/.config/fish/completions/install-cni.fish
+You will need to start a new shell for this setup to take effect. +
+install-cni completion fish [flags]
+| Flags | +Description | +
|---|---|
--ctrlz_address <string> |
+The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `localhost`) | +
--ctrlz_port <uint16> |
+The IP port to use for the ControlZ introspection facility (default `9876`) | +
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] (default ``) | +
--log_output_level <string> |
+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 [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--no-descriptions |
+disable completion descriptions | +
Generate the autocompletion script for powershell.
+To load completions in your current shell session:
+install-cni completion powershell | Out-String | Invoke-Expression
+To load completions for every new session, add the output of the above command +to your powershell profile. +
+install-cni completion powershell [flags]
+| Flags | +Description | +
|---|---|
--ctrlz_address <string> |
+The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `localhost`) | +
--ctrlz_port <uint16> |
+The IP port to use for the ControlZ introspection facility (default `9876`) | +
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] (default ``) | +
--log_output_level <string> |
+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 [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--no-descriptions |
+disable completion descriptions | +
Generate the autocompletion script for the zsh shell.
+If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once:
+echo "autoload -U compinit; compinit" >> ~/.zshrc
+To load completions in your current shell session:
+source <(install-cni completion zsh)
+To load completions for every new session, execute once:
+#### Linux:
+install-cni completion zsh > "${fpath[1]}/_install-cni"
+#### macOS:
+install-cni completion zsh > $(brew --prefix)/share/zsh/site-functions/_install-cni
+You will need to start a new shell for this setup to take effect. +
+install-cni completion zsh [flags]
+| Flags | +Description | +
|---|---|
--ctrlz_address <string> |
+The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `localhost`) | +
--ctrlz_port <uint16> |
+The IP port to use for the ControlZ introspection facility (default `9876`) | +
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] (default ``) | +
--log_output_level <string> |
+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 [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--no-descriptions |
+disable completion descriptions | +
Prints out build version information
+install-cni version [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--ctrlz_address <string> |
++ | The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `localhost`) | +
--ctrlz_port <uint16> |
++ | The IP port to use for the ControlZ introspection facility (default `9876`) | +
--log_as_json |
++ | Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
++ | Comma-separated list of scopes for which to include caller information, scopes can be any of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] (default ``) | +
--log_output_level <string> |
++ | 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 [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
++ | The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
++ | The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
++ | The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
++ | The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
++ | Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, ambient, cni, controllers, default, ebpf, install, klog, model, monitoring, repair, spiffe, trustBundle, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
++ | The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--output <string> |
+-o |
+One of 'yaml' or 'json'. (default ``) | +
--short |
+-s |
+Use --short=false to generate full version information | +
install-cni command. Please use with caution as these environment variables are experimental and can change anytime.
+| Variable Name | +Type | +Default Value | +Description | +
|---|---|---|---|
AMBIENT_ENABLED |
+Boolean | +false |
+Whether ambient controller is enabled | +
CA_TRUSTED_NODE_ACCOUNTS |
+String | + |
+If set, the list of service accounts that are allowed to use node authentication for CSRs. Node authentication allows an identity to create CSRs on behalf of other identities, but only if there is a pod running on the same node with that identity. This is intended for use with node proxies. | +
CERT_SIGNER_DOMAIN |
+String | + |
+The cert signer domain info | +
CHAINED_CNI_PLUGIN |
+Boolean | +true |
+Whether to install CNI plugin as a chained or standalone | +
CLUSTER_ID |
+String | +Kubernetes |
+Defines the cluster and service registry that this Istiod instance belongs to | +
CNI_CONF_NAME |
+String | + |
+Name of the CNI configuration file | +
CNI_NETWORK_CONFIG |
+String | + |
+CNI configuration template as a string | +
CNI_NETWORK_CONFIG_FILE |
+String | + |
+CNI config template as a file | +
CNI_NET_DIR |
+String | +/etc/cni/net.d |
+Directory on the host where CNI network plugins are installed | +
EBPF_ENABLED |
+Boolean | +false |
+Whether ebpf redirection is enabled | +
ENABLE_AUTO_SNI |
+Boolean | +false |
+If enabled, automatically set SNI when `DestinationRules` do not specify the same | +
ENABLE_CA_SERVER |
+Boolean | +true |
+If this is set to false, will not create CA server in istiod. | +
ENABLE_DEBUG_ON_HTTP |
+Boolean | +true |
+If this is set to false, the debug interface will not be enabled, recommended for production | +
ENABLE_ENHANCED_RESOURCE_SCOPING |
+Boolean | +false |
+If enabled, meshConfig.discoverySelectors will limit the CustomResource configurations(like Gateway,VirtualService,DestinationRule,Ingress, etc)that can be processed by pilot. This will also restrict the root-ca certificate distribution. | +
ENABLE_HCM_INTERNAL_NETWORKS |
+Boolean | +false |
+If enable, endpoints defined in mesh networks will be configured as internal addresses in Http Connection Manager | +
ENABLE_LEADER_ELECTION |
+Boolean | +true |
+If enabled (default), starts a leader election client and gains leadership before executing controllers. If false, it assumes that only one instance of istiod is running and skips leader election. | +
ENABLE_MCS_AUTO_EXPORT |
+Boolean | +false |
+If enabled, istiod will automatically generate Kubernetes Multi-Cluster Services (MCS) ServiceExport resources for every service in the mesh. Services defined to be cluster-local in MeshConfig are excluded. | +
ENABLE_MCS_CLUSTER_LOCAL |
+Boolean | +false |
+If enabled, istiod will treat the host `<svc>.<namespace>.svc.cluster.local` as defined by the Kubernetes Multi-Cluster Services (MCS) spec. In this mode, requests to `cluster.local` will be routed to only those endpoints residing within the same cluster as the client. Requires that both ENABLE_MCS_SERVICE_DISCOVERY and ENABLE_MCS_HOST also be enabled. | +
ENABLE_MCS_HOST |
+Boolean | +false |
+If enabled, istiod will configure a Kubernetes Multi-Cluster Services (MCS) host (<svc>.<namespace>.svc.clusterset.local) for each service exported (via ServiceExport) in at least one cluster. Clients must, however, be able to successfully lookup these DNS hosts. That means that either Istio DNS interception must be enabled or an MCS controller must be used. Requires that ENABLE_MCS_SERVICE_DISCOVERY also be enabled. | +
ENABLE_MCS_SERVICE_DISCOVERY |
+Boolean | +false |
+If enabled, istiod will enable Kubernetes Multi-Cluster Services (MCS) service discovery mode. In this mode, service endpoints in a cluster will only be discoverable within the same cluster unless explicitly exported via ServiceExport. | +
ENABLE_MULTICLUSTER_HEADLESS |
+Boolean | +true |
+If true, the DNS name table for a headless service will resolve to same-network endpoints in any cluster. | +
ENABLE_NATIVE_SIDECARS |
+Boolean | +false |
+If set, used Kubernetes native Sidecar container support. Requires SidecarContainer feature flag. | +
ENABLE_OPTIMIZED_CONFIG_REBUILD |
+Boolean | +true |
+If enabled, pilot will only rebuild config for resources that have changed | +
ENABLE_OTEL_BUILTIN_RESOURCE_LABELS |
+Boolean | +false |
+If enabled, envoy will send builtin lables(e.g. node_name) via OTel sink. | +
ENABLE_TLS_ON_SIDECAR_INGRESS |
+Boolean | +false |
+If enabled, the TLS configuration on Sidecar.ingress will take effect | +
EXTERNAL_ISTIOD |
+Boolean | +false |
+If this is set to true, one Istiod will control remote clusters including CA. | +
HOST_IP |
+String | + |
++ |
INBOUND_INTERCEPTION_MODE |
+String | + |
+The mode used to redirect inbound connections to Envoy, either "REDIRECT" or "TPROXY" | +
INBOUND_TPROXY_MARK |
+String | + |
++ |
INJECTION_WEBHOOK_CONFIG_NAME |
+String | +istio-sidecar-injector |
+Name of the mutatingwebhookconfiguration to patch, if istioctl is not used. | +
ISTIOD_CUSTOM_HOST |
+String | + |
+Custom host name of istiod that istiod signs the server cert. Multiple custom host names are supported, and multiple values are separated by commas. | +
ISTIO_AGENT_ENABLE_WASM_REMOTE_LOAD_CONVERSION |
+Boolean | +true |
+If enabled, Istio agent will intercept ECDS resource update, downloads Wasm module, and replaces Wasm module remote load with downloaded local module file. | +
ISTIO_DELTA_XDS |
+Boolean | +false |
+If enabled, pilot will only send the delta configs as opposed to the state of the world on a Resource Request. This feature uses the delta xds api, but does not currently send the actual deltas. | +
ISTIO_DUAL_STACK |
+Boolean | +false |
+If true, Istio will enable the Dual Stack feature. | +
ISTIO_ENABLE_CONTROLLER_QUEUE_METRICS |
+Boolean | +false |
+If enabled, publishes metrics for queue depth, latency and processing times. | +
ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSH |
+Boolean | +true |
+If enabled, Istiod will not push changes on arbitrary annotation change. | +
ISTIO_GPRC_MAXRECVMSGSIZE |
+Integer | +4194304 |
+Sets the max receive buffer size of gRPC stream in bytes. | +
ISTIO_GPRC_MAXSTREAMS |
+Integer | +100000 |
+Sets the maximum number of concurrent grpc streams. | +
ISTIO_KUBE_CLIENT_CONTENT_TYPE |
+String | +protobuf |
+The content type to use for Kubernetes clients. Defaults to protobuf. Valid options: [protobuf, json] | +
ISTIO_MULTIROOT_MESH |
+Boolean | +false |
+If enabled, mesh will support certificates signed by more than one trustAnchor for ISTIO_MUTUAL mTLS | +
ISTIO_OUTBOUND_OWNER_GROUPS |
+String | +* |
+Comma separated list of groups whose outgoing traffic is to be redirected to Envoy. +A group can be specified either by name or by a numeric GID. +The wildcard character "*" can be used to configure redirection of traffic from all groups. | +
ISTIO_OUTBOUND_OWNER_GROUPS_EXCLUDE |
+String | + |
+Comma separated list of groups whose outgoing traffic is to be excluded from redirection to Envoy. +A group can be specified either by name or by a numeric GID. +Only applies when traffic from all groups (i.e. "*") is being redirected to Envoy. | +
ISTIO_WATCH_NAMESPACE |
+String | + |
+If set, limit Kubernetes watches to a single namespace. Warning: only a single namespace can be set. | +
ISTIO_WORKLOAD_ENTRY_VALIDATE_IDENTITY |
+Boolean | +true |
+If enabled, will validate the identity of a workload matches the identity of the WorkloadEntry it is associating with for health checks and auto registration. This flag is added for backwards compatibility only and will be removed in future releases | +
JWKS_RESOLVER_INSECURE_SKIP_VERIFY |
+Boolean | +false |
+If enabled, istiod will skip verifying the certificate of the JWKS server. | +
JWT_POLICY |
+String | +third-party-jwt |
+The JWT validation policy. | +
KUBECFG_FILE_NAME |
+String | +ZZZ-istio-cni-kubeconfig |
+Name of the kubeconfig file which CNI plugin will use when interacting with API server | +
KUBECONFIG_MODE |
+Integer | +384 |
+File mode of the kubeconfig file | +
KUBE_CA_FILE |
+String | + |
+CA file for kubeconfig. Defaults to the same as install-cni pod | +
LABEL_CANONICAL_SERVICES_FOR_MESH_EXTERNAL_SERVICE_ENTRIES |
+Boolean | +false |
+If enabled, metadata representing canonical services for ServiceEntry resources with a location of mesh_external will be populatedin the cluster metadata for those endpoints. | +
LOCAL_CLUSTER_SECRET_WATCHER |
+Boolean | +false |
+If enabled, the cluster secret watcher will watch the namespace of the external cluster instead of config cluster | +
LOG_LEVEL |
+String | +warn |
+Fallback value for log level in CNI config file, if not specified in helm template | +
LOG_UDS_ADDRESS |
+String | +/var/run/istio-cni/log.sock |
+The UDS server address which CNI plugin will copy log output to | +
MCS_API_GROUP |
+String | +multicluster.x-k8s.io |
+The group to be used for the Kubernetes Multi-Cluster Services (MCS) API. | +
MCS_API_VERSION |
+String | +v1alpha1 |
+The version to be used for the Kubernets Multi-Cluster Services (MCS) API. | +
METRIC_GRACEFUL_DELETION_INTERVAL |
+Time Duration | +5m0s |
+Metric expiry graceful deletion interval. No-op if METRIC_ROTATION_INTERVAL is disabled. | +
METRIC_ROTATION_INTERVAL |
+Time Duration | +0s |
+Metric scope rotation interval, set to 0 to disable the metric scope rotation | +
MONITORING_PORT |
+Integer | +15014 |
+HTTP port to serve prometheus metrics | +
MOUNTED_CNI_NET_DIR |
+String | +/host/etc/cni/net.d |
+Directory on the container where CNI networks are installed | +
MUTEX_PROFILE_FRACTION |
+Integer | +1000 |
+If set to a non-zero value, enables mutex profiling a rate of 1/MUTEX_PROFILE_FRACTION events. For example, '1000' will record 0.1% of events. Set to 0 to disable entirely. | +
NATIVE_METADATA_EXCHANGE |
+Boolean | +true |
+If set, uses a native implementation of the HTTP metadata exchange filter | +
NODE_NAME |
+String | + |
++ |
PILOT_ALLOW_SIDECAR_SERVICE_INBOUND_LISTENER_MERGE |
+Boolean | +false |
+If set, it allows creating inbound listeners for service ports and sidecar ingress listeners | +
PILOT_ANALYSIS_INTERVAL |
+Time Duration | +10s |
+If analysis is enabled, pilot will run istio analyzers using this value as interval in seconds Istio Resources | +
PILOT_CERT_PROVIDER |
+String | +istiod |
+The provider of Pilot DNS certificate. | +
PILOT_DEBOUNCE_AFTER |
+Time Duration | +100ms |
+The delay added to config/registry events for debouncing. This will delay the push by at least this interval. If no change is detected within this period, the push will happen, otherwise we'll keep delaying until things settle, up to a max of PILOT_DEBOUNCE_MAX. | +
PILOT_DEBOUNCE_MAX |
+Time Duration | +10s |
+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. | +
PILOT_DISTRIBUTION_HISTORY_RETENTION |
+Time Duration | +1m0s |
+If enabled, Pilot will keep track of old versions of distributed config for this duration. | +
PILOT_DRAINING_LABEL |
+String | +istio.io/draining |
+If not empty, endpoints with the label value present will be sent with status DRAINING. | +
PILOT_ENABLE_ALPHA_GATEWAY_API |
+Boolean | +false |
+If this is set to true, support for alpha APIs in the Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed. | +
PILOT_ENABLE_ALPN_FILTER |
+Boolean | +true |
+If true, pilot will add Istio ALPN filters, required for proper protocol sniffing. | +
PILOT_ENABLE_AMBIENT_CONTROLLERS |
+Boolean | +false |
+If enabled, controllers required for ambient will run. This is required to run ambient mesh. | +
PILOT_ENABLE_ANALYSIS |
+Boolean | +false |
+If enabled, pilot will run istio analyzers and write analysis errors to the Status field of any Istio Resources | +
PILOT_ENABLE_CDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache CDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE. | +
PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING |
+Boolean | +false |
+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. | +
PILOT_ENABLE_CROSS_CLUSTER_WORKLOAD_ENTRY |
+Boolean | +true |
+If enabled, pilot will read WorkloadEntry from other clusters, selectable by Services in that cluster. | +
PILOT_ENABLE_EDS_DEBOUNCE |
+Boolean | +true |
+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 | +
PILOT_ENABLE_EDS_FOR_HEADLESS_SERVICES |
+Boolean | +false |
+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. | +
PILOT_ENABLE_GATEWAY_API |
+Boolean | +true |
+If this is set to true, support for Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed. | +
PILOT_ENABLE_GATEWAY_API_DEPLOYMENT_CONTROLLER |
+Boolean | +true |
+If this is set to true, gateway-api resources will automatically provision in cluster deployment, services, etc | +
PILOT_ENABLE_GATEWAY_API_GATEWAYCLASS_CONTROLLER |
+Boolean | +true |
+If this is set to true, istiod will create and manage its default GatewayClasses | +
PILOT_ENABLE_GATEWAY_API_STATUS |
+Boolean | +true |
+If this is set to true, gateway-api resources will have status written to them | +
PILOT_ENABLE_HBONE |
+Boolean | +false |
+If enabled, HBONE support can be configured for proxies. Note: proxies must opt in on a per-proxy basis with ENABLE_HBONE to actually get HBONE config, in addition to this flag. | +
PILOT_ENABLE_HEADLESS_SERVICE_POD_LISTENERS |
+Boolean | +true |
+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. | +
PILOT_ENABLE_INBOUND_PASSTHROUGH |
+Boolean | +true |
+If enabled, inbound clusters will be configured as ORIGINAL_DST clusters. When disabled, requests are always sent to localhost. The primary implication of this is that when enabled, binding to POD_IP will work while localhost will not; when disable, bind to POD_IP will not work, while localhost will. The enabled behavior matches the behavior without Istio enabled at all; this flag exists only for backwards compatibility. Regardless of this setting, the configuration can be overridden with the Sidecar.Ingress.DefaultEndpoint configuration. | +
PILOT_ENABLE_K8S_SELECT_WORKLOAD_ENTRIES |
+Boolean | +true |
+If enabled, Kubernetes services with selectors will select workload entries with matching labels. It is safe to disable it if you are quite sure you don't need this feature | +
PILOT_ENABLE_METADATA_EXCHANGE |
+Boolean | +true |
+If true, pilot will add metadata exchange filters, which will be consumed by telemetry filter. | +
PILOT_ENABLE_MONGO_FILTER |
+Boolean | +true |
+EnableMongoFilter enables injection of `envoy.filters.network.mongo_proxy` in the filter chain. | +
PILOT_ENABLE_MYSQL_FILTER |
+Boolean | +false |
+EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain. | +
PILOT_ENABLE_PERSISTENT_SESSION_FILTER |
+Boolean | +false |
+If enabled, Istiod sets up persistent session filter for listeners, if services have 'PILOT_PERSISTENT_SESSION_LABEL' set. | +
PILOT_ENABLE_QUIC_LISTENERS |
+Boolean | +false |
+If true, QUIC listeners will be generated wherever there are listeners terminating TLS on gateways if the gateway service exposes a UDP port with the same number (for example 443/TCP and 443/UDP) | +
PILOT_ENABLE_RDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache RDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE. | +
PILOT_ENABLE_REDIS_FILTER |
+Boolean | +false |
+EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain. | +
PILOT_ENABLE_ROUTE_COLLAPSE_OPTIMIZATION |
+Boolean | +true |
+If true, Pilot will merge virtual hosts with the same routes into a single virtual host, as an optimization. | +
PILOT_ENABLE_SERVICEENTRY_SELECT_PODS |
+Boolean | +true |
+If enabled, service entries with selectors will select pods from the cluster. It is safe to disable it if you are quite sure you don't need this feature | +
PILOT_ENABLE_STATUS |
+Boolean | +false |
+If enabled, pilot will update the CRD Status field of all istio resources with reconciliation status. | +
PILOT_ENABLE_TELEMETRY_LABEL |
+Boolean | +true |
+If true, pilot will add telemetry related metadata to cluster and endpoint resources, which will be consumed by telemetry filter. | +
PILOT_ENABLE_WORKLOAD_ENTRY_AUTOREGISTRATION |
+Boolean | +true |
+Enables auto-registering WorkloadEntries based on associated WorkloadGroups upon XDS connection by the workload. | +
PILOT_ENABLE_WORKLOAD_ENTRY_HEALTHCHECKS |
+Boolean | +true |
+Enables automatic health checks of WorkloadEntries based on the config provided in the associated WorkloadGroup | +
PILOT_ENABLE_XDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache XDS responses. | +
PILOT_ENABLE_XDS_IDENTITY_CHECK |
+Boolean | +true |
+If enabled, pilot will authorize XDS clients, to ensure they are acting only as namespaces they have permissions for. | +
PILOT_ENDPOINT_TELEMETRY_LABEL |
+Boolean | +true |
+If true, pilot will add telemetry related metadata to Endpoint resource, which will be consumed by telemetry filter. | +
PILOT_ENVOY_FILTER_STATS |
+Boolean | +false |
+If true, Pilot will collect metrics for envoy filter operations. | +
PILOT_FILTER_GATEWAY_CLUSTER_CONFIG |
+Boolean | +false |
+If enabled, Pilot will send only clusters that referenced in gateway virtual services attached to gateway | +
PILOT_HTTP10 |
+Boolean | +false |
+Enables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications. | +
PILOT_INSECURE_MULTICLUSTER_KUBECONFIG_OPTIONS |
+String | + |
+Comma separated list of potentially insecure kubeconfig authentication options that are allowed for multicluster authentication.Support values: all authProviders (`gcp`, `azure`, `exec`, `openstack`), `clientKey`, `clientCertificate`, `tokenFile`, and `exec`. | +
PILOT_JWT_ENABLE_REMOTE_JWKS |
+String | +false |
+Mode of fetching JWKs from JwksUri in RequestAuthentication. Supported value: istiod, false, hybrid, true, envoy. The client fetching JWKs is as following: istiod/false - Istiod; hybrid/true - Envoy and fallback to Istiod if JWKs server is external; envoy - Envoy. | +
PILOT_JWT_PUB_KEY_REFRESH_INTERVAL |
+Time Duration | +20m0s |
+The interval for istiod to fetch the jwks_uri for the jwks public key. | +
PILOT_MAX_REQUESTS_PER_SECOND |
+Floating-Point | +25 |
+Limits the number of incoming XDS requests per second. On larger machines this can be increased to handle more proxies concurrently. | +
PILOT_MULTI_NETWORK_DISCOVER_GATEWAY_API |
+Boolean | +false |
+If true, Pilot will discover labeled Kubernetes gateway objects as multi-network gateways. | +
PILOT_PERSISTENT_SESSION_HEADER_LABEL |
+String | +istio.io/persistent-session-header |
+If not empty, services with this label will use header based persistent sessions | +
PILOT_PERSISTENT_SESSION_LABEL |
+String | +istio.io/persistent-session |
+If not empty, services with this label will use cookie based persistent sessions | +
PILOT_PUSH_THROTTLE |
+Integer | +100 |
+Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes | +
PILOT_REMOTE_CLUSTER_TIMEOUT |
+Time Duration | +30s |
+After this timeout expires, pilot can become ready without syncing data from clusters added via remote-secrets. Setting the timeout to 0 disables this behavior. | +
PILOT_SCOPE_GATEWAY_TO_NAMESPACE |
+Boolean | +false |
+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. | +
PILOT_SEND_UNHEALTHY_ENDPOINTS |
+Boolean | +false |
+If enabled, Pilot will include unhealthy endpoints in EDS pushes and even if they are sent Envoy does not use them for load balancing. To avoid, sending traffic to non ready endpoints, enabling this flag, disables panic threshold in Envoy i.e. Envoy does not load balance requests to unhealthy/non-ready hosts even if the percentage of healthy hosts fall below minimum health percentage(panic threshold). | +
PILOT_SIDECAR_USE_REMOTE_ADDRESS |
+Boolean | +false |
+UseRemoteAddress sets useRemoteAddress to true for sidecar outbound listeners. | +
PILOT_SKIP_VALIDATE_TRUST_DOMAIN |
+Boolean | +false |
+Skip validating the peer is from the same trust domain when mTLS is enabled in authentication policy | +
PILOT_STATUS_BURST |
+Integer | +500 |
+If status is enabled, controls the Burst rate with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config Burst | +
PILOT_STATUS_MAX_WORKERS |
+Integer | +100 |
+The maximum number of workers Pilot will use to keep configuration status up to date. Smaller numbers will result in higher status latency, but larger numbers may impact CPU in high scale environments. | +
PILOT_STATUS_QPS |
+Integer | +100 |
+If status is enabled, controls the QPS with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config QPS | +
PILOT_STATUS_UPDATE_INTERVAL |
+Time Duration | +500ms |
+Interval to update the XDS distribution status. | +
PILOT_TRACE_SAMPLING |
+Floating-Point | +1 |
+Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 1.0. | +
PILOT_WORKLOAD_ENTRY_GRACE_PERIOD |
+Time Duration | +10s |
+The amount of time an auto-registered workload can remain disconnected from all Pilot instances before the associated WorkloadEntry is cleaned up. | +
PILOT_XDS_CACHE_INDEX_CLEAR_INTERVAL |
+Time Duration | +5s |
+The interval for xds cache index clearing. | +
PILOT_XDS_CACHE_SIZE |
+Integer | +60000 |
+The maximum number of cache entries for the XDS cache. | +
PILOT_XDS_CACHE_STATS |
+Boolean | +false |
+If true, Pilot will collect metrics for XDS cache efficiency. | +
PILOT_XDS_SEND_TIMEOUT |
+Time Duration | +0s |
+The timeout to send the XDS configuration to proxies. After this timeout is reached, Pilot will discard that push. | +
POD_NAME |
+String | + |
++ |
REPAIR_BROKEN_POD_LABEL_KEY |
+String | +cni.istio.io/uninitialized |
+The key portion of the label which will be set by the ace repair if label pods is true | +
REPAIR_BROKEN_POD_LABEL_VALUE |
+String | +true |
+The value portion of the label which will be set by the race repair if label pods is true | +
REPAIR_DELETE_PODS |
+Boolean | +false |
+Controller will delete pods when detecting pod broken by race condition | +
REPAIR_ENABLED |
+Boolean | +true |
+Whether to enable race condition repair or not | +
REPAIR_FIELD_SELECTORS |
+String | + |
+A set of field selectors in label=value format that will be added to the pod list filters | +
REPAIR_INIT_CONTAINER_EXIT_CODE |
+Integer | +126 |
+Expected exit code for the init container when crash-looping because of CNI misconfiguration | +
REPAIR_INIT_CONTAINER_NAME |
+String | +istio-validation |
+The name of the istio init container (will crash-loop if CNI is not configured for the pod) | +
REPAIR_INIT_CONTAINER_TERMINATION_MESSAGE |
+String | + |
+The expected termination message for the init container when crash-looping because of CNI misconfiguration | +
REPAIR_LABEL_PODS |
+Boolean | +false |
+Controller will label pods when detecting pod broken by race condition | +
REPAIR_LABEL_SELECTORS |
+String | + |
+A set of label selectors in label=value format that will be added to the pod list filters | +
REPAIR_NODE_NAME |
+String | + |
+The name of the managed node (will manage all nodes if unset) | +
REPAIR_SIDECAR_ANNOTATION |
+String | +sidecar.istio.io/status |
+An annotation key that indicates this pod contains an istio sidecar. All pods without this annotation will be ignored.The value of the annotation is ignored. | +
RESOLVE_HOSTNAME_GATEWAYS |
+Boolean | +true |
+If true, hostnames in the LoadBalancer addresses of a Service will be resolved at the control plane for use in cross-network gateways. | +
REVISION |
+String | + |
++ |
SHARED_MESH_CONFIG |
+String | + |
+Additional config map to load for shared MeshConfig settings. The standard mesh config will take precedence. | +
SKIP_TLS_VERIFY |
+Boolean | +false |
+Whether to use insecure TLS in kubeconfig file | +
SYSTEM_NAMESPACE |
+String | +istio-system |
+pod's namespace | +
TRUSTED_GATEWAY_CIDR |
+String | + |
+If set, any connections from gateway to Istiod with this CIDR range are treated as trusted for using authentication mechanisms like XFCC. This can only be used when the network where Istiod and the authenticating gateways are running in a trusted/secure network | +
UNSAFE_ENABLE_ADMIN_ENDPOINTS |
+Boolean | +false |
+If this is set to true, dangerous admin endpoints will be exposed on the debug interface. Not recommended for production. | +
UNSAFE_PILOT_ENABLE_DELTA_TEST |
+Boolean | +false |
+If enabled, addition runtime tests for Delta XDS efficiency are added. These checks are extremely expensive, so this should be used only for testing, not production. | +
UNSAFE_PILOT_ENABLE_RUNTIME_ASSERTIONS |
+Boolean | +false |
+If enabled, addition runtime asserts will be performed. These checks are both expensive and panic on failure. As a result, this should be used only for testing. | +
VALIDATION_WEBHOOK_CONFIG_NAME |
+String | +istio-istio-system |
+If not empty, the controller will automatically patch validatingwebhookconfiguration when the CA certificate changes. Only works in kubernetes environment. | +
VERIFY_CERTIFICATE_AT_CLIENT |
+Boolean | +false |
+If enabled, certificates received by the proxy will be verified against the OS CA certificate bundle. | +
VERIFY_SDS_CERTIFICATE |
+Boolean | +true |
+If enabled, certificates fetched from SDS server will be verified before sending back to proxy. | +
XDS_AUTH |
+Boolean | +true |
+If true, will authenticate XDS clients. | +
| Metric Name | Type | Description |
|---|---|---|
controller_sync_errors_total | Sum | Total number of errorMetric syncing controllers. |
endpoint_no_pod | LastValue | Endpoints without an associated pod. |
istio_build | LastValue | Istio component build info |
istio_cni_install_ready | LastValue | Whether the CNI plugin installation is ready or not |
istio_cni_installs_total | Sum | Total number of CNI plugins installed by the Istio CNI installer |
istio_cni_repair_pods_repaired_total | Sum | Total number of pods repaired by repair controller |
pilot_conflict_inbound_listener | LastValue | Number of conflicting inbound listeners. |
pilot_conflict_outbound_listener_tcp_over_current_tcp | LastValue | Number of conflicting tcp listeners with current tcp listener. |
pilot_destrule_subsets | LastValue | Duplicate subsets across destination rules for same host |
pilot_dns_cluster_without_endpoints | LastValue | DNS clusters without endpoints caused by the endpoint field in STRICT_DNS type cluster is not set or the corresponding subset cannot select any endpoint |
pilot_duplicate_envoy_clusters | LastValue | Duplicate envoy clusters caused by service entries with same hostname |
pilot_eds_no_instances | LastValue | Number of clusters without instances. |
pilot_endpoint_not_ready | LastValue | Endpoint found in unready state. |
pilot_jwks_resolver_network_fetch_fail_total | Sum | Total number of failed network fetch by pilot jwks resolver |
pilot_jwks_resolver_network_fetch_success_total | Sum | Total number of successfully network fetch by pilot jwks resolver |
pilot_no_ip | LastValue | Pods not found in the endpoint table, possibly invalid. |
pilot_total_rejected_configs | Sum | Total number of configs that Pilot had to reject or ignore. |
pilot_virt_services | LastValue | Total virtual services known to pilot. |
pilot_vservice_dup_domain | LastValue | Virtual services with dup domains. |
provider_lookup_cluster_failures | Sum | Number of times a cluster lookup failed |
xds_cache_dependent_config_size | LastValue | Current size of dependent configs |
xds_cache_evictions | Sum | Total number of xds cache evictions. |
xds_cache_reads | Sum | Total number of xds cache xdsCacheReads. |
xds_cache_size | LastValue | Current size of xds cache |
Istio configuration command line utility for service operators to +debug and diagnose their Istio mesh. +
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
A group of commands used to manage istiod configuration
+istioctl admin [flags]
+istioctl istiod [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--selector <string> |
+-l |
+label selector (default `app=istiod`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Retrieve information about istiod configuration.
+ istioctl admin log
+Retrieve or update logging levels of istiod components.
+istioctl admin log [<pod-name>]|[-r|--revision] [--level <scope>:<level>][--stack-trace-level <scope>:<level>]|[--reset]|[--output|-o short|json|yaml] [flags]
+istioctl admin l [<pod-name>]|[-r|--revision] [--level <scope>:<level>][--stack-trace-level <scope>:<level>]|[--reset]|[--output|-o short|json|yaml] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--ctrlz_port <int> |
++ | ControlZ port (default `9876`) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--level <string> |
++ | Comma-separated list of output logging level for scopes in format <scope>:<level>[,<scope>:<level>,...]Possible values for <level>: none, error, warn, info, debug (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--reset |
++ | Reset levels to default value. (info) | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--selector <string> |
+-l |
+label selector (default `app=istiod`) | +
--stack-trace-level <string> |
++ | Comma-separated list of stack trace level for scopes in format <scope>:<stack-trace-level>[,<scope>:<stack-trace-level>,...] Possible values for <stack-trace-level>: none, error, warn, info, debug (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Retrieve information about istiod logging levels.
+ istioctl admin log
+
+ # Retrieve information about istiod logging levels on a specific control plane pod.
+ istioctl admin l istiod-5c868d8bdd-pmvgg
+
+ # Update levels of the specified loggers.
+ istioctl admin log --level ads:debug,authorization:debug
+
+ # Retrieve information about istiod logging levels for a specified revision.
+ istioctl admin log --revision v1
+
+ # Reset levels of all the loggers to default value (info).
+ istioctl admin log --reset
+
+Analyze Istio configuration and print validation messages
+istioctl analyze <file>... [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--all-namespaces |
+-A |
+Analyze all namespaces | +
--color |
++ | Default true. Disable with '=false' or set $TERM to dumb | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--failure-threshold <Level> |
++ | The severity level of analysis at which to set a non-zero exit code. Valid values: [Info Warning Error] (default `Error`) | +
--ignore-unknown |
++ | Don't complain about un-parseable input documents, for cases where analyze should run only on k8s compliant inputs. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--list-analyzers |
+-L |
+List the analyzers available to run. Suppresses normal execution. | +
--meshConfigFile <string> |
++ | Overrides the mesh config values to use for analysis. (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of [log json yaml] (default `log`) | +
--output-threshold <Level> |
++ | The severity level of analysis at which to display messages. Valid values: [Info Warning Error] (default `Info`) | +
--recursive |
+-R |
+Process directory arguments recursively. Useful when you want to analyze related manifests organized within the same directory. | +
--revision <string> |
++ | analyze a specific revision deployed. (default `default`) | +
--suppress <stringArray> |
+-S |
+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 `[]`) | +
--timeout <duration> |
++ | The duration to wait before failing (default `30s`) | +
--use-kube |
+-k |
+Use live Kubernetes cluster for analysis. Set --use-kube=false to analyze files only. | +
--verbose |
+-v |
+Enable verbose output | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Analyze the current live cluster
+ istioctl analyze
+
+ # Analyze the current live cluster for a specific revision
+ istioctl analyze --revision 1-16
+
+ # Analyze the current live cluster, simulating the effect of applying additional yaml files
+ istioctl analyze a.yaml b.yaml my-app-config/
+
+ # Analyze the current live cluster, simulating the effect of applying a directory of config recursively
+ istioctl analyze --recursive my-istio-config/
+
+ # Analyze yaml files without connecting to a live cluster
+ istioctl analyze --use-kube=false a.yaml b.yaml my-app-config/
+
+ # Analyze the current live cluster and suppress PodMissingProxy for pod mypod in namespace 'testing'.
+ istioctl analyze -S "IST0103=Pod mypod.testing"
+
+ # Analyze the current live cluster and suppress PodMissingProxy for all pods in namespace 'testing',
+ # and suppress MisplacedAnnotation on deployment foobar in namespace default.
+ istioctl analyze -S "IST0103=Pod *.testing" -S "IST0107=Deployment foobar.default"
+
+ # List available analyzers
+ istioctl analyze -L
+(authz is experimental. Use `istioctl experimental authz`)
+istioctl authz [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
bug-report selectively captures cluster information and logs into an archive to help diagnose problems. +Proxy logs can be filtered using: + --include|--exclude ns1,ns2.../dep1,dep2.../pod1,pod2.../lbl1=val1,lbl2=val2.../ann1=val1,ann2=val2.../cntr1,cntr... +where ns=namespace, dep=deployment, lbl=label, ann=annotation, cntr=container
+The filter spec is interpreted as 'must be in (ns1 OR ns2) AND (dep1 OR dep2) AND (cntr1 OR cntr2)...' +The log will be included only if the container matches at least one include filter and does not match any exclude filters. +All parts of the filter are optional and can be omitted e.g. ns1//pod1 filters only for namespace ns1 and pod1. +All names except label and annotation keys support '*' glob matching pattern.
+e.g. +--include ns1,ns2 (only namespaces ns1 and ns2) +--include n*//p*/l=v* (pods with name beginning with 'p' in namespaces beginning with 'n' and having label 'l' with value beginning with 'v'.)
+istioctl bug-report [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Name of the kubeconfig Context to use. (default ``) | +
--critical-errs <stringSlice> |
++ | List of comma separated glob patterns to match against log error strings. If any pattern matches an error in the log, the logs is given the highest priority for archive inclusion. (default `[]`) | +
--dir <string> |
++ | Set a specific directory for temporary artifact storage. (default ``) | +
--dry-run |
++ | Only log commands that would be run, don't fetch or write. | +
--duration <duration> |
++ | How far to go back in time from end-time for log entries to include in the archive. Default is infinity. If set, --start-time must be unset. (default `0s`) | +
--end-time <string> |
++ | End time for the range of log entries to include in the archive. Default is now. (default ``) | +
--exclude <stringSlice> |
++ | Spec for which pod's proxy logs to exclude from the archive, after the include spec is processed. See above for format and examples. (default `["kube-node-lease,kube-public,kube-system,local-path-storage"]`) | +
--filename <string> |
+-f |
+Path to a file containing configuration in YAML format. The file contents are applied over the default values and flag settings, with lists being replaced per JSON merge semantics. (default ``) | +
--full-secrets |
++ | If set, secret contents are included in output. | +
--ignore-errs <stringSlice> |
++ | List of comma separated glob patterns to match against log error strings. Any error matching these patterns is ignored when calculating the log importance heuristic. (default `[]`) | +
--include <stringSlice> |
++ | Spec for which pod's proxy logs to include in the archive. See above for format and examples. (default `[]`) | +
--istio-namespace <string> |
++ | Namespace where Istio control plane is installed. (default `istio-system`) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Path to kube config. (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output-dir <string> |
++ | Set a specific directory for output archive file. (default ``) | +
--rps-limit <int> |
++ | Requests per second limit to the Kubernetes API server, defaults to 10.A higher limit can make bug report collection much faster. (default `0`) | +
--start-time <string> |
++ | Start time for the range of log entries to include in the archive. Default is the infinite past. If set, --duration must be unset. (default ``) | +
--timeout <duration> |
++ | Maximum amount of time to spend fetching logs. When timeout is reached only the logs captured so far are saved to the archive. (default `30m0s`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Prints out build version information
+istioctl bug-report version [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Name of the kubeconfig Context to use. (default ``) | +
--critical-errs <stringSlice> |
++ | List of comma separated glob patterns to match against log error strings. If any pattern matches an error in the log, the logs is given the highest priority for archive inclusion. (default `[]`) | +
--dir <string> |
++ | Set a specific directory for temporary artifact storage. (default ``) | +
--dry-run |
++ | Only log commands that would be run, don't fetch or write. | +
--duration <duration> |
++ | How far to go back in time from end-time for log entries to include in the archive. Default is infinity. If set, --start-time must be unset. (default `0s`) | +
--end-time <string> |
++ | End time for the range of log entries to include in the archive. Default is now. (default ``) | +
--exclude <stringSlice> |
++ | Spec for which pod's proxy logs to exclude from the archive, after the include spec is processed. See above for format and examples. (default `["kube-node-lease,kube-public,kube-system,local-path-storage"]`) | +
--filename <string> |
+-f |
+Path to a file containing configuration in YAML format. The file contents are applied over the default values and flag settings, with lists being replaced per JSON merge semantics. (default ``) | +
--full-secrets |
++ | If set, secret contents are included in output. | +
--ignore-errs <stringSlice> |
++ | List of comma separated glob patterns to match against log error strings. Any error matching these patterns is ignored when calculating the log importance heuristic. (default `[]`) | +
--include <stringSlice> |
++ | Spec for which pod's proxy logs to include in the archive. See above for format and examples. (default `[]`) | +
--istio-namespace <string> |
++ | Namespace where Istio control plane is installed. (default `istio-system`) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Path to kube config. (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+One of 'yaml' or 'json'. (default ``) | +
--output-dir <string> |
++ | Set a specific directory for output archive file. (default ``) | +
--rps-limit <int> |
++ | Requests per second limit to the Kubernetes API server, defaults to 10.A higher limit can make bug report collection much faster. (default `0`) | +
--short |
+-s |
+Use --short=false to generate full version information | +
--start-time <string> |
++ | Start time for the range of log entries to include in the archive. Default is the infinite past. If set, --duration must be unset. (default ``) | +
--timeout <duration> |
++ | Maximum amount of time to spend fetching logs. When timeout is reached only the logs captured so far are saved to the archive. (default `30m0s`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for istioctl for the specified shell. +See each sub-command's help for details on how to use the generated script. +
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the bash shell.
+This script depends on the 'bash-completion' package. +If it is not installed already, you can install it via your OS's package manager.
+To load completions in your current shell session:
+source <(istioctl completion bash)
+To load completions for every new session, execute once:
+#### Linux:
+istioctl completion bash > /etc/bash_completion.d/istioctl
+#### macOS:
+istioctl completion bash > $(brew --prefix)/etc/bash_completion.d/istioctl
+You will need to start a new shell for this setup to take effect. +
+istioctl completion bash
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--no-descriptions |
++ | disable completion descriptions | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the fish shell.
+To load completions in your current shell session:
+istioctl completion fish | source
+To load completions for every new session, execute once:
+istioctl completion fish > ~/.config/fish/completions/istioctl.fish
+You will need to start a new shell for this setup to take effect. +
+istioctl completion fish [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--no-descriptions |
++ | disable completion descriptions | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for powershell.
+To load completions in your current shell session:
+istioctl completion powershell | Out-String | Invoke-Expression
+To load completions for every new session, add the output of the above command +to your powershell profile. +
+istioctl completion powershell [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--no-descriptions |
++ | disable completion descriptions | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the zsh shell.
+If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once:
+echo "autoload -U compinit; compinit" >> ~/.zshrc
+To load completions in your current shell session:
+source <(istioctl completion zsh)
+To load completions for every new session, execute once:
+#### Linux:
+istioctl completion zsh > "${fpath[1]}/_istioctl"
+#### macOS:
+istioctl completion zsh > $(brew --prefix)/share/zsh/site-functions/_istioctl
+You will need to start a new shell for this setup to take effect. +
+istioctl completion zsh [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--no-descriptions |
++ | disable completion descriptions | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Create a secret with credentials to allow Istio to access remote Kubernetes apiservers
+istioctl create-remote-secret [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--auth-plugin-config <stringToString> |
++ | Authenticator plug-in configuration. --auth-type=plugin must be set with this option (default `[]`) | +
--auth-plugin-name <string> |
++ | Authenticator plug-in name. --auth-type=plugin must be set with this option (default ``) | +
--auth-type <RemoteSecretAuthType> |
++ | Type of authentication to use. supported values = [bearer-token plugin] (default `bearer-token`) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--create-service-account |
++ | If true, the service account needed for creating the remote secret will be created if it doesn't exist. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). (default ``) | +
--name <string> |
++ | Name of the local cluster whose credentials are stored in the secret. If a name is not specified the kube-system namespace's UUID of the local cluster will be used. (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--secret-name <string> |
++ | The name of the specific secret to use from the service-account. Needed when there are multiple secrets in the service account. (default ``) | +
--server <string> |
++ | The address and port of the Kubernetes API server. (default ``) | +
--service-account <string> |
++ | Create a secret with this service account's credentials. Default value is "istio-reader-service-account" if --type is "remote", "istiod" if --type is "config". (default ``) | +
--type <SecretType> |
++ | Type of the generated secret. supported values = [remote config] (default `remote`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Create a secret to access cluster c0's apiserver and install it in cluster c1.
+ istioctl --kubeconfig=c0.yaml create-remote-secret --name c0 \
+ | kubectl --kubeconfig=c1.yaml apply -f -
+
+ # Delete a secret that was previously installed in c1
+ istioctl --kubeconfig=c0.yaml create-remote-secret --name c0 \
+ | kubectl --kubeconfig=c1.yaml delete -f -
+
+ # Create a secret access a remote cluster with an auth plugin
+ istioctl --kubeconfig=c0.yaml create-remote-secret --name c0 --auth-type=plugin --auth-plugin-name=gcp \
+ | kubectl --kubeconfig=c1.yaml apply -f -
+Access to Istio web UIs
+istioctl dashboard [flags]
+istioctl dash [flags]
+istioctl d [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`) | +
--browser |
++ | When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`) | +
--port <int> |
+-p |
+Local port to listen to (default `0`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Open the ControlZ web UI for a pod in the Istio control plane
+istioctl dashboard controlz [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`) | +
--browser |
++ | When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--ctrlz_port <int> |
++ | ControlZ port (default `9876`) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`) | +
--port <int> |
+-p |
+Local port to listen to (default `0`) | +
--selector <string> |
+-l |
+Label selector (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Open ControlZ web UI for the istiod-123-456.istio-system pod
+ istioctl dashboard controlz istiod-123-456.istio-system
+
+ # Open ControlZ web UI for the istiod-56dd66799-jfdvs pod in a custom namespace
+ istioctl dashboard controlz istiod-123-456 -n custom-ns
+
+ # Open ControlZ web UI for any Istiod pod
+ istioctl dashboard controlz deployment/istiod.istio-system
+
+ # with short syntax
+ istioctl dash controlz pilot-123-456.istio-system
+ istioctl d controlz pilot-123-456.istio-system
+
+Open the Envoy admin dashboard for a sidecar
+istioctl dashboard envoy [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`) | +
--browser |
++ | When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Namespace where the addon is running, if not specified, istio-system would be used (default ``) | +
--port <int> |
+-p |
+Local port to listen to (default `0`) | +
--selector <string> |
+-l |
+Label selector (default ``) | +
--ui-port <int> |
++ | The component dashboard UI port. (default `15000`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Open Envoy dashboard for the productpage-123-456.default pod
+ istioctl dashboard envoy productpage-123-456.default
+
+ # Open Envoy dashboard for one pod under a deployment
+ istioctl dashboard envoy deployment/productpage-v1
+
+ # with short syntax
+ istioctl dash envoy productpage-123-456.default
+ istioctl d envoy productpage-123-456.default
+
+Open Istio's Grafana dashboard
+istioctl dashboard grafana [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`) | +
--browser |
++ | When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`) | +
--port <int> |
+-p |
+Local port to listen to (default `0`) | +
--ui-port <int> |
++ | The component dashboard UI port. (default `3000`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl dashboard grafana
+
+ # with short syntax
+ istioctl dash grafana
+ istioctl d grafana
+Open Istio's Jaeger dashboard
+istioctl dashboard jaeger [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`) | +
--browser |
++ | When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`) | +
--port <int> |
+-p |
+Local port to listen to (default `0`) | +
--ui-port <int> |
++ | The component dashboard UI port. (default `16686`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl dashboard jaeger
+
+ # with short syntax
+ istioctl dash jaeger
+ istioctl d jaeger
+Open Istio's Kiali dashboard
+istioctl dashboard kiali [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`) | +
--browser |
++ | When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`) | +
--port <int> |
+-p |
+Local port to listen to (default `0`) | +
--ui-port <int> |
++ | The component dashboard UI port. (default `20001`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl dashboard kiali
+
+ # with short syntax
+ istioctl dash kiali
+ istioctl d kiali
+Open Istio's Prometheus dashboard
+istioctl dashboard prometheus [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`) | +
--browser |
++ | When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`) | +
--port <int> |
+-p |
+Local port to listen to (default `0`) | +
--ui-port <int> |
++ | The component dashboard UI port. (default `9090`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl dashboard prometheus
+
+ # with short syntax
+ istioctl dash prometheus
+ istioctl d prometheus
+Open the Istio dashboard in the SkyWalking UI
+istioctl dashboard skywalking [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`) | +
--browser |
++ | When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`) | +
--port <int> |
+-p |
+Local port to listen to (default `0`) | +
--ui-port <int> |
++ | The component dashboard UI port. (default `8080`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl dashboard skywalking
+
+ # with short syntax
+ istioctl dash skywalking
+ istioctl d skywalking
+Open Istio's Zipkin dashboard
+istioctl dashboard zipkin [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`) | +
--browser |
++ | When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`) | +
--port <int> |
+-p |
+Local port to listen to (default `0`) | +
--ui-port <int> |
++ | The component dashboard UI port. (default `9411`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl dashboard zipkin
+
+ # with short syntax
+ istioctl dash zipkin
+ istioctl d zipkin
+Experimental commands that may be modified or deprecated
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Check prints the AuthorizationPolicy applied to a pod by directly checking +the Envoy configuration of the pod. The command is especially useful for inspecting +the policy propagation from Istiod to Envoy and the final AuthorizationPolicy list merged +from multiple sources (mesh-level, namespace-level and workload-level).
+The command also supports reading from a standalone config dump file with flag -f.
+istioctl experimental authz check [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--file <string> |
+-f |
+The json file with Envoy config dump to be checked (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Check AuthorizationPolicy applied to pod httpbin-88ddbcfdd-nt5jb:
+ istioctl x authz check httpbin-88ddbcfdd-nt5jb
+
+ # Check AuthorizationPolicy applied to one pod under a deployment
+ istioctl x authz check deployment/productpage-v1
+
+ # Check AuthorizationPolicy from Envoy config dump file:
+ istioctl x authz check -f httpbin_config_dump.json
++Checks associated resources of the given resource, and running webhooks to examine whether the pod can be or will be injected or not.
+istioctl experimental check-inject [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--labels <string> |
+-l |
+Check namespace and label pairs injection status, split multiple labels by commas (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Check the injection status of a pod
+ istioctl experimental check-inject details-v1-fcff6c49c-kqnfk.test
+
+ # Check the injection status of a pod under a deployment
+ istioctl x check-inject deployment/details-v1
+
+ # Check the injection status of a pod under a deployment in namespace test
+ istioctl x check-inject deployment/details-v1 -n test
+
+ # Check the injection status of label pairs in a specific namespace before actual injection
+ istioctl x check-inject -n test -l app=helloworld,version=v1
+
+Configure istioctl defaults
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# list configuration parameters
+ istioctl experimental config list
+List istio configurable defaults
+istioctl experimental config list [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Describe resource and related Istio configuration
+istioctl experimental describe [flags]
+istioctl experimental des [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Analyzes pod, its Services, DestinationRules, and VirtualServices and reports +the configuration objects that affect that pod.
+THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
+istioctl experimental describe pod <pod> [flags]
+istioctl experimental describe po <pod> [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--ignoreUnmeshed |
++ | Suppress warnings for unmeshed pods | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl experimental describe pod productpage-v1-c7765c886-7zzd4
+Analyzes service, pods, DestinationRules, and VirtualServices and reports +the configuration objects that affect that service.
+THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
+istioctl experimental describe service <svc> [flags]
+istioctl experimental describe svc <svc> [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--ignoreUnmeshed |
++ | Suppress warnings for unmeshed pods | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl experimental describe service productpage
+Retrieve Envoy emitted metrics for the specified pod.
+istioctl experimental envoy-stats [<type>/]<name>[.<namespace>] [flags]
+istioctl experimental es [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|prom|prom-merged (default `short`) | +
--type <string> |
+-t |
+Where to grab the stats: one of server|clusters (default `server`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Retrieve Envoy emitted metrics for the specified pod.
+ istioctl experimental envoy-stats <pod-name[.namespace]>
+
+ # Retrieve Envoy server metrics in prometheus format
+ istioctl experimental envoy-stats <pod-name[.namespace]> --output prom
+
+ # Retrieve Envoy server metrics in prometheus format with merged application metrics
+ istioctl experimental envoy-stats <pod-name[.namespace]> --output prom-merged
+
+ # Retrieve Envoy cluster metrics
+ istioctl experimental envoy-stats <pod-name[.namespace]> --type clusters
+
+List sidecar injector and sidecar versions
+istioctl experimental injector [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl experimental injector list
+List sidecar injector and sidecar versions
+istioctl experimental injector list [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl experimental injector list
++Retrieves the debug information from Istiod or Pods in the mesh using the service account from the pod if --cert-dir is empty. +By default it will use the default serviceAccount from (istio-system) namespace if the pod is not specified.
++THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
+istioctl experimental internal-debug [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--all |
++ | Send the same request to all instances of Istiod. Only applicable for in-cluster deployment. | +
--authority <string> |
++ | XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``) | +
--cert-dir <string> |
++ | XDS Endpoint certificate directory (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--insecure |
++ | Skip server certificate and domain verification. (NOT SECURE!) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--plaintext |
++ | Use plain-text HTTP/2 when connecting to server (no TLS). | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--timeout <duration> |
++ | The duration to wait before failing (default `30s`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
--xds-address <string> |
++ | XDS Endpoint (default ``) | +
--xds-label <string> |
++ | Istiod pod label selector (default ``) | +
--xds-port <int> |
++ | Istiod pod port (default `15012`) | +
# Retrieve sync status for all Envoys in a mesh
+ istioctl x internal-debug syncz
+
+ # Retrieve sync diff for a single Envoy and Istiod
+ istioctl x internal-debug syncz istio-egressgateway-59585c5b9c-ndc59.istio-system
+
+ # SECURITY OPTIONS
+
+ # Retrieve syncz debug information directly from the control plane, using token security
+ # (This is the usual way to get the debug information with an out-of-cluster control plane.)
+ istioctl x internal-debug syncz --xds-address istio.cloudprovider.example.com:15012
+
+ # Retrieve syncz debug information via Kubernetes config, using token security
+ # (This is the usual way to get the debug information with an in-cluster control plane.)
+ istioctl x internal-debug syncz
+
+ # Retrieve syncz debug information directly from the control plane, using RSA certificate security
+ # (Certificates must be obtained before this step. The --cert-dir flag lets istioctl bypass the Kubernetes API server.)
+ istioctl x internal-debug syncz --xds-address istio.example.com:15012 --cert-dir ~/.istio-certs
+
+ # Retrieve syncz information via XDS from specific control plane in multi-control plane in-cluster configuration
+ # (Select a specific control plane in an in-cluster canary Istio configuration.)
+ istioctl x internal-debug syncz --xds-label istio.io/rev=default
+
++Prints the metrics for the specified service(s) when running in Kubernetes.
+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.
+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. +
+istioctl experimental metrics <workload name>...
+istioctl experimental m <workload name>...
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--duration <duration> |
+-d |
+Duration of query metrics, default value is 1m. (default `1m0s`) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Retrieve workload metrics for productpage-v1 workload
+ istioctl experimental metrics productpage-v1
+
+ # Retrieve workload metrics for various services with custom duration
+ istioctl experimental metrics productpage-v1 -d 2m
+
+ # Retrieve workload metrics for various services in the different namespaces
+ istioctl experimental metrics productpage-v1.foo reviews-v1.bar ratings-v1.baz
+precheck inspects a Kubernetes cluster for Istio install and upgrade requirements.
+istioctl experimental precheck [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of [log json yaml] (default `log`) | +
--output-threshold <Level> |
++ | The severity level of precheck at which to display messages. Valid values: [Info Warning Error] (default `Warning`) | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--skip-controlplane |
++ | skip checking the control plane | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Verify that Istio can be installed or upgraded
+ istioctl x precheck
+
+ # Check only a single namespace
+ istioctl x precheck --namespace default
++Retrieves last sent and last acknowledged xDS sync from Istiod to each Envoy in the mesh +
+istioctl experimental proxy-status [<type>/]<name>[.<namespace>] [flags]
+istioctl experimental ps [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--authority <string> |
++ | XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``) | +
--cert-dir <string> |
++ | XDS Endpoint certificate directory (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--file <string> |
+-f |
+Envoy config dump JSON file (default ``) | +
--insecure |
++ | Skip server certificate and domain verification. (NOT SECURE!) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--plaintext |
++ | Use plain-text HTTP/2 when connecting to server (no TLS). | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--timeout <duration> |
++ | The duration to wait before failing (default `30s`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
--xds-address <string> |
++ | XDS Endpoint (default ``) | +
--xds-label <string> |
++ | Istiod pod label selector (default ``) | +
--xds-port <int> |
++ | Istiod pod port (default `15012`) | +
--xds-via-agents |
++ | Access Istiod via the tap service of each agent | +
--xds-via-agents-limit <xds-via-agent> |
++ | Maximum number of pods being visited by istioctl when xds-via-agent flag is true.To iterate all the agent pods without limit, set to 0 (default `100`) | +
# Retrieve sync status for all Envoys in a mesh
+ istioctl x proxy-status
+
+ # Retrieve sync diff for a single Envoy and Istiod
+ istioctl x proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system
+
+ # SECURITY OPTIONS
+
+ # Retrieve proxy status information directly from the control plane, using token security
+ # (This is the usual way to get the proxy-status with an out-of-cluster control plane.)
+ istioctl x ps --xds-address istio.cloudprovider.example.com:15012
+
+ # Retrieve proxy status information via Kubernetes config, using token security
+ # (This is the usual way to get the proxy-status with an in-cluster control plane.)
+ istioctl x proxy-status
+
+ # Retrieve proxy status information directly from the control plane, using RSA certificate security
+ # (Certificates must be obtained before this step. The --cert-dir flag lets istioctl bypass the Kubernetes API server.)
+ istioctl x ps --xds-address istio.example.com:15012 --cert-dir ~/.istio-certs
+
+ # Retrieve proxy status information via XDS from specific control plane in multi-control plane in-cluster configuration
+ # (Select a specific control plane in an in-cluster canary Istio configuration.)
+ istioctl x ps --xds-label istio.io/rev=default
+
+The revision command provides a revision centric view of istio deployments. It provides insight into IstioOperator CRs defining the revision, istiod and gateway pods which are part of deployment of a particular revision.
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format for revision description (available formats: table,json) (default `table`) | +
--verbose |
+-v |
+Enable verbose output | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Show information about a revision, including customizations, istiod version and which pods/gateways are using it.
+istioctl experimental revision describe [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format for revision description (available formats: table,json) (default `table`) | +
--verbose |
+-v |
+Enable verbose output | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# View the details of a revision named 'canary'
+ istioctl x revision describe canary
+
+ # View the details of a revision named 'canary' and also the pods
+ # under that particular revision
+ istioctl x revision describe canary -v
+
+ # Get details about a revision in json format (default format is human-friendly table format)
+ istioctl x revision describe canary -v -o json
+
+Show list of control plane and gateway revisions that are currently installed in cluster
+istioctl experimental revision list [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format for revision description (available formats: table,json) (default `table`) | +
--verbose |
+-v |
+Enable verbose output | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# View summary of revisions installed in the current cluster
+ # which can be overridden with --context parameter.
+ istioctl x revision list
+
+ # View list of revisions including customizations, istiod and gateway pods
+ istioctl x revision list -v
+
+Prints out build version information
+istioctl experimental version [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--authority <string> |
++ | XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``) | +
--cert-dir <string> |
++ | XDS Endpoint certificate directory (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--insecure |
++ | Skip server certificate and domain verification. (NOT SECURE!) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+One of 'yaml' or 'json'. (default ``) | +
--plaintext |
++ | Use plain-text HTTP/2 when connecting to server (no TLS). | +
--remote |
++ | Use --remote=false to suppress control plane check | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--short |
+-s |
+Use --short=false to generate full version information | +
--timeout <duration> |
++ | The duration to wait before failing (default `30s`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
--xds-address <string> |
++ | XDS Endpoint (default ``) | +
--xds-label <string> |
++ | Istiod pod label selector (default ``) | +
--xds-port <int> |
++ | Istiod pod port (default `15012`) | +
# Retrieve version information directly from the control plane, using token security
+ # (This is the usual way to get the control plane version with an out-of-cluster control plane.)
+ istioctl x version --xds-address istio.cloudprovider.example.com:15012
+
+ # Retrieve version information via Kubernetes config, using token security
+ # (This is the usual way to get the control plane version with an in-cluster control plane.)
+ istioctl x version
+
+ # Retrieve version information directly from the control plane, using RSA certificate security
+ # (Certificates must be obtained before this step. The --cert-dir flag lets istioctl bypass the Kubernetes API server.)
+ istioctl x version --xds-address istio.example.com:15012 --cert-dir ~/.istio-certs
+
+ # Retrieve version information via XDS from specific control plane in multi-control plane in-cluster configuration
+ # (Select a specific control plane in an in-cluster canary Istio configuration.)
+ istioctl x version --xds-label istio.io/rev=default
+
+Waits for the specified condition to be true of an Istio resource.
+istioctl experimental wait [flags] <type> <name>[.<namespace>]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--for <string> |
++ | Wait condition, must be 'distribution' or 'delete' (default `distribution`) | +
--generation <string> |
++ | Wait for a specific generation of config to become current, rather than using whatever is latest in Kubernetes (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--threshold <float32> |
++ | The ratio of distribution required for success (default `1`) | +
--timeout <duration> |
++ | The duration to wait before failing (default `30s`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# 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=300s virtualservice bookinfo.default
+
+A group of commands used to manage waypoint configuration
+istioctl experimental waypoint [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--service-account <string> |
+-s |
+service account to create a waypoint for (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Apply a waypoint to the current namespace
+ istioctl x waypoint apply
+
+ # Generate a waypoint as yaml
+ istioctl x waypoint generate --service-account something --namespace default
+
+ # Delete a waypoint from a specific namespace for a specific service account
+ istioctl x waypoint delete --service-account something --namespace default
+
+ # List all waypoints in a specific namespace
+ istioctl x waypoint list --namespace default
+Apply a waypoint configuration to the cluster
+istioctl experimental waypoint apply [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--revision <string> |
+-r |
+The revision to label the waypoint with (default ``) | +
--service-account <string> |
+-s |
+service account to create a waypoint for (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Apply a waypoint to the current namespace
+ istioctl x waypoint apply
+
+ # Apply a waypoint to a specific namespace for a specific service account
+ istioctl x waypoint apply --service-account something --namespace default
+Delete a waypoint configuration from the cluster
+istioctl experimental waypoint delete [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--service-account <string> |
+-s |
+service account to create a waypoint for (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Delete a waypoint from the default namespace
+ istioctl x waypoint delete
+
+ # Delete a waypoint from a specific namespace for a specific service account
+ istioctl x waypoint delete --service-account something --namespace default
+
+ # Delete a waypoint by name, which can obtain from istioctl x waypoint list
+ istioctl x waypoint delete waypoint-name --namespace default
+Generate a waypoint configuration as YAML
+istioctl experimental waypoint generate [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--revision <string> |
+-r |
+The revision to label the waypoint with (default ``) | +
--service-account <string> |
+-s |
+service account to create a waypoint for (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Generate a waypoint as yaml
+ istioctl x waypoint generate --service-account something --namespace default
+List managed waypoint configurations in the cluster
+istioctl experimental waypoint list [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--all-namespaces |
+-A |
+List all waypoints in all namespaces | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--service-account <string> |
+-s |
+service account to create a waypoint for (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# List all waypoints in a specific namespace
+ istioctl x waypoint list --namespace default
+
+ # List all waypoints in the cluster
+ istioctl x waypoint list -A
+Commands to assist in configuring and deploying workloads running on VMs and other non-Kubernetes environments
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# workload group yaml generation
+ istioctl x workload group create
+
+ # workload entry configuration generation
+ istioctl x workload entry configure
+Commands dealing with WorkloadEntry resources
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl x workload entry configure -f workloadgroup.yaml -o outputDir
+Generates all the required configuration files for workload instance on a VM or non-Kubernetes environment from a WorkloadGroup artifact. +This includes a MeshConfig resource, the cluster.env file, and necessary certificates and security tokens. +Configure requires either the WorkloadGroup artifact path or its location on the API server.
+istioctl experimental workload entry configure [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--autoregister |
++ | Creates a WorkloadEntry upon connection to istiod (if enabled in pilot). | +
--capture-dns |
++ | Enables the capture of outgoing DNS packets on port 53, redirecting to istio-agent | +
--clusterID <string> |
++ | The ID used to identify the cluster (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--externalIP <string> |
++ | External IP address of the workload (default ``) | +
--file <string> |
+-f |
+filename of the WorkloadGroup artifact. Leave this field empty if using the API server (default ``) | +
--ingressIP <string> |
++ | IP address of the ingress gateway (default ``) | +
--ingressService <string> |
++ | Name of the Service to be used as the ingress gateway, in the format <service>.<namespace>. If no namespace is provided, the default istio-system namespace will be used. (default `istio-eastwestgateway`) | +
--internalIP <string> |
++ | Internal IP address of the workload (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--name <string> |
++ | The name of the workload group (default ``) | +
--namespace <string> |
+-n |
+The namespace that the workload instances belong to (default ``) | +
--output <string> |
+-o |
+Output directory for generated files (default ``) | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--tokenDuration <int> |
++ | The token duration in seconds (default: 1 hour) (default `3600`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# configure example using a local WorkloadGroup artifact
+ istioctl x workload entry configure -f workloadgroup.yaml -o config
+
+ # configure example using the API server
+ istioctl x workload entry configure --name foo --namespace bar -o config
+Commands dealing with WorkloadGroup resources
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl x workload group create --name foo --namespace bar --labels app=foobar
+Creates a WorkloadGroup resource that provides a template for associated WorkloadEntries. +The default output is serialized YAML, which can be piped into 'kubectl apply -f -' to send the artifact to the API Server.
+istioctl experimental workload group create [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--annotations <stringSlice> |
+-a |
+The annotations to apply to the workload instances (default `[]`) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--labels <stringSlice> |
+-l |
+The labels to apply to the workload instances; e.g. -l env=prod,vers=2 (default `[]`) | +
--name <string> |
++ | The name of the workload group (default ``) | +
--namespace <string> |
+-n |
+The namespace that the workload instances will belong to (default ``) | +
--ports <stringSlice> |
+-p |
+The incoming ports exposed by the workload instance (default `[]`) | +
--serviceAccount <string> |
+-s |
+The service identity to associate with the workload instances (default `default`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl x workload group create --name foo --namespace bar --labels app=foo,bar=baz --ports grpc=3550,http=8080 --annotations annotation=foobar --serviceAccount sa
+The install command generates an Istio install manifest and applies it to a cluster.
+istioctl install [flags]
+istioctl apply [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--charts <string> |
++ | Deprecated, use --manifests instead. (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--filename <stringSlice> |
+-f |
+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 `[]`) | +
--force |
++ | Proceed even with validation errors. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--readiness-timeout <duration> |
++ | Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`) | +
--revision <string> |
+-r |
+Target control plane revision for the command. (default ``) | +
--set <stringArray> |
+-s |
+Override an IstioOperator value, e.g. to choose a profile +(--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio +settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.20/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`) | +
--skip-confirmation |
+-y |
+The skipConfirmation determines whether the user is prompted for confirmation. +If set to true, the user is not prompted and a Yes response is assumed in all cases. | +
--verify |
++ | Verify the Istio control plane after installation/in-place upgrade | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Apply a default Istio installation
+ istioctl install
+
+ # Enable Tracing
+ istioctl install --set meshConfig.enableTracing=true
+
+ # Generate the demo profile and don't wait for confirmation
+ istioctl install --set profile=demo --skip-confirmation
+
+ # To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes.
+ istioctl install --set "values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default"
+
++kube-inject manually injects the Istio sidecar into Kubernetes +workloads. Unsupported resources are left unmodified so it is safe to +run kube-inject over a single file that contains multiple Service, +ConfigMap, Deployment, etc. definitions for a complex application. When in +doubt re-run istioctl kube-inject on deployments to get the most up-to-date changes.
+It's best to do kube-inject when the resource is initially created. +
+istioctl kube-inject [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--authority <string> |
++ | XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``) | +
--cert-dir <string> |
++ | XDS Endpoint certificate directory (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--filename <string> |
+-f |
+Input Kubernetes resource filename (default ``) | +
--injectConfigFile <string> |
++ | Injection configuration filename. Cannot be used with --injectConfigMapName (default ``) | +
--insecure |
++ | Skip server certificate and domain verification. (NOT SECURE!) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--meshConfigFile <string> |
++ | Mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``) | +
--meshConfigMapName <string> |
++ | ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--operatorFileName <string> |
++ | Path to file containing IstioOperator custom resources. If configs from files like meshConfigFile, valuesFile are provided, they will be overridden by iop config values. (default ``) | +
--output <string> |
+-o |
+Modified output Kubernetes resource filename (default ``) | +
--plaintext |
++ | Use plain-text HTTP/2 when connecting to server (no TLS). | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--timeout <duration> |
++ | The duration to wait before failing (default `30s`) | +
--valuesFile <string> |
++ | Injection values configuration filename. (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
--webhookConfig <string> |
++ | MutatingWebhookConfiguration name for Istio (default `istio-sidecar-injector`) | +
--xds-address <string> |
++ | XDS Endpoint (default ``) | +
--xds-label <string> |
++ | Istiod pod label selector (default ``) | +
--xds-port <int> |
++ | Istiod pod port (default `15012`) | +
# Update resources on the fly before applying.
+ kubectl apply -f <(istioctl kube-inject -f <resource.yaml>)
+
+ # Create a persistent version of the deployment with Istio sidecar injected.
+ istioctl kube-inject -f deployment.yaml -o deployment-injected.yaml
+
+ # Update an existing deployment.
+ kubectl get deployment -o yaml | istioctl kube-inject -f - | kubectl apply -f -
+
+ # Capture cluster configuration for later use with kube-inject
+ kubectl -n istio-system get cm istio-sidecar-injector -o jsonpath="{.data.config}" > /tmp/inj-template.tmpl
+ kubectl -n istio-system get cm istio -o jsonpath="{.data.mesh}" > /tmp/mesh.yaml
+ kubectl -n istio-system get cm istio-sidecar-injector -o jsonpath="{.data.values}" > /tmp/values.json
+
+ # Use kube-inject based on captured configuration
+ istioctl kube-inject -f samples/bookinfo/platform/kube/bookinfo.yaml \
+ --injectConfigFile /tmp/inj-template.tmpl \
+ --meshConfigFile /tmp/mesh.yaml \
+ --valuesFile /tmp/values.json
+
+The manifest command generates and diffs Istio manifests.
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
The diff subcommand compares manifests from two files or directories. The output is a list of +changed paths with the value changes shown as OLD-VALUE -> NEW-VALUE. +List order changes are shown as [OLD-INDEX->NEW-INDEX], with ? used where a list item is added or +removed.
+istioctl manifest diff <file|dir> <file|dir> [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--directory |
+-r |
+Compare directory. | +
--dry-run |
++ | Console/log output only, make no changes. | +
--ignore <string> |
++ | Ignore all listed items during comparison, using the same list format as selectResources. (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--rename <string> |
++ | Rename resources before comparison. +The format of each renaming pair is A->B, all renaming pairs are comma separated. +e.g. Service:*:istiod->Service:*:istio-control - rename istiod service into istio-control (default ``) | +
--select <string> |
++ | Constrain the list of resources to compare to only the ones in this list, ignoring all others. +The format of each list item is "::" and the items are comma separated. The "*" character represents wildcard selection. +e.g. + Deployment:istio-system:* - compare all deployments in istio-system namespace + Service:*:istiod - compare Services called "istiod" in all namespaces (default `::`) | +
--verbose |
+-v |
+Verbose output. | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
The generate subcommand generates an Istio install manifest and outputs to the console by default.
+istioctl manifest generate [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--charts <string> |
++ | Deprecated, use --manifests instead. (default ``) | +
--cluster-specific |
++ | If enabled, the current cluster will be checked for cluster-specific setting detection. | +
--component <stringSlice> |
++ | Specify which component to generate manifests for. (default `[]`) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--filename <stringSlice> |
+-f |
+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 `[]`) | +
--force |
++ | Proceed even with validation errors. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Manifest output directory path. (default ``) | +
--revision <string> |
+-r |
+Target control plane revision for the command. (default ``) | +
--set <stringArray> |
+-s |
+Override an IstioOperator value, e.g. to choose a profile +(--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio +settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.20/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Generate a default Istio installation
+ istioctl manifest generate
+
+ # Enable Tracing
+ istioctl manifest generate --set meshConfig.enableTracing=true
+
+ # Generate the demo profile
+ istioctl manifest generate --set profile=demo
+
+ # To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes.
+ istioctl manifest generate --set "values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default"
+
+The install command generates an Istio install manifest and applies it to a cluster.
+istioctl manifest install [flags]
+istioctl manifest apply [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--charts <string> |
++ | Deprecated, use --manifests instead. (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--filename <stringSlice> |
+-f |
+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 `[]`) | +
--force |
++ | Proceed even with validation errors. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--readiness-timeout <duration> |
++ | Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`) | +
--revision <string> |
+-r |
+Target control plane revision for the command. (default ``) | +
--set <stringArray> |
+-s |
+Override an IstioOperator value, e.g. to choose a profile +(--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio +settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.20/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`) | +
--skip-confirmation |
+-y |
+The skipConfirmation determines whether the user is prompted for confirmation. +If set to true, the user is not prompted and a Yes response is assumed in all cases. | +
--verify |
++ | Verify the Istio control plane after installation/in-place upgrade | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Apply a default Istio installation
+ istioctl install
+
+ # Enable Tracing
+ istioctl install --set meshConfig.enableTracing=true
+
+ # Generate the demo profile and don't wait for confirmation
+ istioctl install --set profile=demo --skip-confirmation
+
+ # To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes.
+ istioctl install --set "values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default"
+
+The operator command installs, dumps, removes and shows the status of the operator controller.
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
The dump subcommand dumps the Istio operator controller manifest.
+istioctl operator dump [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--charts <string> |
++ | Deprecated, use --manifests instead. (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--hub <string> |
++ | The hub for the operator controller image. (default `unknown`) | +
--imagePullSecrets <stringSlice> |
++ | The imagePullSecrets are used to pull the operator image from the private registry, +could be secret list separated by comma, eg. '--imagePullSecrets imagePullSecret1,imagePullSecret2' (default `[]`) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--operatorNamespace <string> |
++ | The namespace the operator controller is installed into. (default `istio-operator`) | +
--output <string> |
+-o |
+Output format: one of json|yaml (default `yaml`) | +
--revision <string> |
+-r |
+Target revision for the operator. (default ``) | +
--tag <string> |
++ | The tag for the operator controller image. (default `unknown`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
--watchedNamespaces <string> |
++ | The namespaces the operator controller watches, could be namespace list separated by comma, eg. 'ns1,ns2' (default `istio-system`) | +
The init subcommand installs the Istio operator controller in the cluster.
+istioctl operator init [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--charts <string> |
++ | Deprecated, use --manifests instead. (default ``) | +
--context <string> |
++ | The name of the kubeconfig context to use. (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--filename <string> |
+-f |
+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 ``) | +
--hub <string> |
++ | The hub for the operator controller image. (default `unknown`) | +
--imagePullSecrets <stringSlice> |
++ | The imagePullSecrets are used to pull the operator image from the private registry, +could be secret list separated by comma, eg. '--imagePullSecrets imagePullSecret1,imagePullSecret2' (default `[]`) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Path to kube config. (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--operatorNamespace <string> |
++ | The namespace the operator controller is installed into. (default `istio-operator`) | +
--revision <string> |
+-r |
+Target revision for the operator. (default ``) | +
--tag <string> |
++ | The tag for the operator controller image. (default `unknown`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
--watchedNamespaces <string> |
++ | The namespaces the operator controller watches, could be namespace list separated by comma, eg. 'ns1,ns2' (default `istio-system`) | +
The remove subcommand removes the Istio operator controller from the cluster.
+istioctl operator remove [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | The name of the kubeconfig context to use. (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--force |
++ | Proceed even with validation errors. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Path to kube config. (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--operatorNamespace <string> |
++ | The namespace the operator controller is installed into. (default `istio-operator`) | +
--purge |
++ | Remove all versions of Istio operator. | +
--revision <string> |
+-r |
+Target revision for the operator. (default ``) | +
--skip-confirmation |
+-y |
+The skipConfirmation determines whether the user is prompted for confirmation. +If set to true, the user is not prompted and a Yes response is assumed in all cases. | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Displays istioctl global options
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
The profile command lists, dumps or diffs Istio configuration profiles.
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl profile list
+istioctl install --set profile=demo # Use a profile from the list
+The diff subcommand displays the differences between two Istio configuration profiles.
+istioctl profile diff <profile|file1.yaml> <profile|file2.yaml> [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--charts <string> |
++ | Deprecated, use --manifests instead. (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Profile diff by providing yaml files
+ istioctl profile diff manifests/profiles/default.yaml manifests/profiles/demo.yaml
+
+ # Profile diff by providing a profile name
+ istioctl profile diff default demo
+The dump subcommand dumps the values in an Istio configuration profile.
+istioctl profile dump [<profile>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--charts <string> |
++ | Deprecated, use --manifests instead. (default ``) | +
--config-path <string> |
+-p |
+The path the root of the configuration subtree to dump e.g. components.pilot. By default, dump whole tree (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--filename <stringSlice> |
+-f |
+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 `[]`) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|flags (default `yaml`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
The list subcommand lists the available Istio configuration profiles.
+istioctl profile list [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--charts <string> |
++ | Deprecated, use --manifests instead. (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
A group of commands used to retrieve information about proxy configuration from the Envoy config dump
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Retrieve information about proxy configuration from an Envoy instance.
+ istioctl proxy-config <clusters|listeners|routes|endpoints|bootstrap|log|secret> <pod-name[.namespace]>
+Retrieve information about all configuration for the Envoy instance in the specified pod.
+istioctl proxy-config all [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config a [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Filter listeners by address field (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--direction <string> |
++ | Filter clusters by Direction field (default ``) | +
--file <string> |
+-f |
+Envoy config dump file (default ``) | +
--fqdn <string> |
++ | Filter clusters by substring of Service FQDN field (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--name <string> |
++ | Filter listeners by route name field (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--port <int> |
++ | Filter clusters and listeners by Port field (default `0`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--subset <string> |
++ | Filter clusters by substring of Subset field (default ``) | +
--type <string> |
++ | Filter listeners by type field (default ``) | +
--verbose |
++ | Output more information | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Retrieve summary about all configuration for a given pod from Envoy.
+ istioctl proxy-config all <pod-name[.namespace]>
+
+ # Retrieve full cluster dump as JSON
+ istioctl proxy-config all <pod-name[.namespace]> -o json
+
+ # Retrieve full cluster dump with short syntax
+ istioctl pc a <pod-name[.namespace]>
+
+ # Retrieve cluster summary without using Kubernetes API
+ ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
+ istioctl proxy-config all --file envoy-config.json
+
+Retrieve information about bootstrap configuration for the Envoy instance in the specified pod.
+istioctl proxy-config bootstrap [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config b [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--file <string> |
+-f |
+Envoy config dump JSON file (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `json`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Retrieve full bootstrap configuration for a given pod from Envoy.
+ istioctl proxy-config bootstrap <pod-name[.namespace]>
+
+ # Retrieve full bootstrap without using Kubernetes API
+ ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
+ istioctl proxy-config bootstrap --file envoy-config.json
+
+ # Show a human-readable Istio and Envoy version summary
+ istioctl proxy-config bootstrap -o short
+
+Retrieve information about cluster configuration for the Envoy instance in the specified pod.
+istioctl proxy-config cluster [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config clusters [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config c [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--direction <string> |
++ | Filter clusters by Direction field (default ``) | +
--file <string> |
+-f |
+Envoy config dump JSON file (default ``) | +
--fqdn <string> |
++ | Filter clusters by substring of Service FQDN field (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--port <int> |
++ | Filter clusters by Port field (default `0`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--subset <string> |
++ | Filter clusters by substring of Subset field (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# 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
+
+Retrieve information about typed extension configuration for the Envoy instance in the specified pod.
+istioctl proxy-config ecds [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config ec [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--file <string> |
+-f |
+Envoy config dump JSON file (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Retrieve full typed extension configuration for a given pod from Envoy.
+ istioctl proxy-config ecds <pod-name[.namespace]>
+
+ # Retrieve endpoint summary without using Kubernetes API
+ ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
+ istioctl proxy-config ecds --file envoy-config.json
+
+Retrieve information about endpoint configuration for the Envoy instance in the specified pod.
+istioctl proxy-config endpoint [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config endpoints [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config ep [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Filter endpoints by address field (default ``) | +
--cluster <string> |
++ | Filter endpoints by cluster name field (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--file <string> |
+-f |
+Envoy config dump JSON file (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--port <int> |
++ | Filter endpoints by Port field (default `0`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--status <string> |
++ | Filter endpoints by status field (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# 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
+
+Retrieve information about listener configuration for the Envoy instance in the specified pod.
+istioctl proxy-config listener [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config listeners [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config l [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--address <string> |
++ | Filter listeners by address field (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--file <string> |
+-f |
+Envoy config dump JSON file (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--port <int> |
++ | Filter listeners by Port field (default `0`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--type <string> |
++ | Filter listeners by type field (default ``) | +
--verbose |
++ | Output more information | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# 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
+
+Retrieve information about logging levels of the Envoy instance in the specified pod, and update optionally
+istioctl proxy-config log [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config o [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--level <string> |
++ | Comma-separated minimum per-logger level of messages to output, in the form of [<logger>:]<level>,[<logger>:]<level>,... where logger components can be listed by running "istioctl proxy-config log <pod-name[.namespace]>"or referred from https://github.com/envoyproxy/envoy/blob/main/source/common/common/logger.h, and level can be one of [trace, debug, info, warning, error, critical, off] (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--reset |
+-r |
+Reset levels to default value (warning). | +
--selector <string> |
+-l |
+Label selector (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# 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
+
+Compare ROOTCA values for given 2 pods to check the connectivity between them.
+THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
+istioctl proxy-config rootca-compare [pod/]<name-1>[.<namespace-1>] [pod/]<name-2>[.<namespace-2>] [flags]
+istioctl proxy-config rc [pod/]<name-1>[.<namespace-1>] [pod/]<name-2>[.<namespace-2>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Compare ROOTCA values for given 2 pods to check the connectivity between them.
+ istioctl proxy-config rootca-compare <pod-name-1[.namespace]> <pod-name-2[.namespace]>
+Retrieve information about route configuration for the Envoy instance in the specified pod.
+istioctl proxy-config route [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config routes [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config r [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--file <string> |
+-f |
+Envoy config dump JSON file (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--name <string> |
++ | Filter listeners by route name field (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--verbose |
++ | Output more information | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# 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
+
+Retrieve information about secret configuration for the Envoy instance in the specified pod.
+istioctl proxy-config secret [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config secrets [<type>/]<name>[.<namespace>] [flags]
+istioctl proxy-config s [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--file <string> |
+-f |
+Envoy config dump JSON file (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+Output format: one of json|yaml|short (default `short`) | +
--proxy-admin-port <int> |
++ | Envoy proxy admin port (default `15000`) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# 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
++Retrieves last sent and last acknowledged xDS sync from Istiod to each Envoy in the mesh
+ +istioctl proxy-status [<type>/]<name>[.<namespace>] [flags]
+istioctl ps [<type>/]<name>[.<namespace>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--file <string> |
+-f |
+Envoy config dump JSON file (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Retrieve sync status for all Envoys in a mesh
+ istioctl proxy-status
+
+ # Retrieve sync diff for a single Envoy and Istiod
+ istioctl proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system
+
+ # Retrieve sync diff between Istiod and one pod under a deployment
+ istioctl proxy-status deployment/productpage-v1
+
+ # Write proxy config-dump to file, and compare to Istio control plane
+ kubectl port-forward -n istio-system istio-egressgateway-59585c5b9c-ndc59 15000 &
+ curl localhost:15000/config_dump > cd.json
+ istioctl proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system --file cd.json
+
+Lists the remote clusters each istiod instance is connected to.
+istioctl remote-clusters [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Command group used to interact with revision tags. Revision tags allow for the creation of mutable aliases +referring to control plane revisions for sidecar injection.
+With revision tags, rather than relabeling a namespace from "istio.io/rev=revision-a" to "istio.io/rev=revision-b" to +change which control plane revision handles injection, it's possible to create a revision tag "prod" and label our +namespace "istio.io/rev=prod". The "prod" revision tag could point to "1-7-6" initially and then be changed to point to "1-8-1" +at some later point.
+This allows operators to change which Istio control plane revision should handle injection for a namespace or set of namespaces +without manual relabeling of the "istio.io/rev" tag. +
+istioctl tag [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Create a revision tag and output to the command's stdout. Tag an Istio control plane revision for use with namespace istio.io/rev +injection labels.
+istioctl tag generate <revision-tag> [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--auto-inject-namespaces |
++ | If set to true, the sidecars should be automatically injected into all namespaces by default | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--overwrite |
++ | If true, allow revision tags to be overwritten, otherwise reject revision tag updates that +overwrite existing revision tags. | +
--revision <string> |
+-r |
+Control plane revision to reference from a given revision tag (default ``) | +
--skip-confirmation |
+-y |
+The skipConfirmation determines whether the user is prompted for confirmation. +If set to true, the user is not prompted and a Yes response is assumed in all cases. | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
--webhook-name <string> |
++ | Name to use for a revision tag's mutating webhook configuration. (default ``) | +
# Create a revision tag from the "1-8-0" revision
+ istioctl tag generate prod --revision 1-8-0 > tag.yaml
+
+ # Apply the tag to cluster
+ kubectl apply -f tag.yaml
+
+ # Point namespace "test-ns" at the revision pointed to by the "prod" revision tag
+ kubectl label ns test-ns istio.io/rev=prod
+
+ # Rollout namespace "test-ns" to update workloads to the "1-8-0" revision
+ kubectl rollout restart deployments -n test-ns
+
+List existing revision tags
+istioctl tag list [flags]
+istioctl tag show [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl tag list
+Remove Istio control plane revision tag.
+Removing a revision tag should be done with care. Removing a revision tag will disrupt sidecar injection in namespaces +that reference the tag in an "istio.io/rev" label. Verify that there are no remaining namespaces referencing a +revision tag before removing using the "istioctl tag list" command. +
+istioctl tag remove <revision-tag> [flags]
+istioctl tag delete <revision-tag> [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--skip-confirmation |
+-y |
+The skipConfirmation determines whether the user is prompted for confirmation. +If set to true, the user is not prompted and a Yes response is assumed in all cases. | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Remove the revision tag "prod"
+ istioctl tag remove prod
+
+Create or modify revision tags. Tag an Istio control plane revision for use with namespace istio.io/rev +injection labels.
+istioctl tag set <revision-tag> [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--auto-inject-namespaces |
++ | If set to true, the sidecars should be automatically injected into all namespaces by default | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--overwrite |
++ | If true, allow revision tags to be overwritten, otherwise reject revision tag updates that +overwrite existing revision tags. | +
--revision <string> |
+-r |
+Control plane revision to reference from a given revision tag (default ``) | +
--skip-confirmation |
+-y |
+The skipConfirmation determines whether the user is prompted for confirmation. +If set to true, the user is not prompted and a Yes response is assumed in all cases. | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
--webhook-name <string> |
++ | Name to use for a revision tag's mutating webhook configuration. (default ``) | +
# Create a revision tag from the "1-8-0" revision
+ istioctl tag set prod --revision 1-8-0
+
+ # Point namespace "test-ns" at the revision pointed to by the "prod" revision tag
+ kubectl label ns test-ns istio.io/rev=prod
+
+ # Change the revision tag to reference the "1-8-1" revision
+ istioctl tag set prod --revision 1-8-1 --overwrite
+
+ # Make revision "1-8-1" the default revision, both resulting in that revision handling injection for "istio-injection=enabled"
+ # and validating resources cluster-wide
+ istioctl tag set default --revision 1-8-1
+
+ # Rollout namespace "test-ns" to update workloads to the "1-8-1" revision
+ kubectl rollout restart deployments -n test-ns
+
+The uninstall command uninstalls Istio from a cluster
+istioctl uninstall [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | The name of the kubeconfig context to use. (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--filename <string> |
+-f |
+The filename of the IstioOperator CR. (default ``) | +
--force |
++ | Proceed even with validation errors. | +
--istioNamespace <string> |
++ | The namespace of Istio Control Plane. (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Path to kube config. (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--purge |
++ | Delete all Istio related sources for all versions | +
--revision <string> |
+-r |
+Target control plane revision for the command. (default ``) | +
--set <stringArray> |
+-s |
+Override an IstioOperator value, e.g. to choose a profile +(--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio +settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.20/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`) | +
--skip-confirmation |
+-y |
+The skipConfirmation determines whether the user is prompted for confirmation. +If set to true, the user is not prompted and a Yes response is assumed in all cases. | +
--verbose |
+-v |
+Verbose output. | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Uninstall a single control plane by revision
+ istioctl uninstall --revision foo
+
+ # Uninstall a single control plane by iop file
+ istioctl uninstall -f iop.yaml
+
+ # Uninstall all control planes and shared resources
+ istioctl uninstall --purge
+The upgrade command is an alias for the install command that performs additional upgrade-related checks.
+istioctl upgrade [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--charts <string> |
++ | Deprecated, use --manifests instead. (default ``) | +
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--dry-run |
++ | Console/log output only, make no changes. | +
--filename <stringSlice> |
+-f |
+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 `[]`) | +
--force |
++ | Proceed even with validation errors. | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). + (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--readiness-timeout <duration> |
++ | Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`) | +
--revision <string> |
+-r |
+Target control plane revision for the command. (default ``) | +
--set <stringArray> |
+-s |
+Override an IstioOperator value, e.g. to choose a profile +(--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio +settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.20/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`) | +
--skip-confirmation |
+-y |
+The skipConfirmation determines whether the user is prompted for confirmation. +If set to true, the user is not prompted and a Yes response is assumed in all cases. | +
--verify |
++ | Verify the Istio control plane after installation/in-place upgrade | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Validate Istio policy and rules files
+istioctl validate -f FILENAME [options] [flags]
+istioctl v -f FILENAME [options] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--filename <stringSlice> |
+-f |
+Inputs of files to validate (default `[]`) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Validate bookinfo-gateway.yaml
+ istioctl validate -f samples/bookinfo/networking/bookinfo-gateway.yaml
+
+ # Validate bookinfo-gateway.yaml with shorthand syntax
+ istioctl v -f samples/bookinfo/networking/bookinfo-gateway.yaml
+
+ # Validate all yaml files under samples/bookinfo/networking directory
+ istioctl validate -f samples/bookinfo/networking
+
+ # Validate current deployments under 'default' namespace within the cluster
+ kubectl get deployments -o yaml | istioctl validate -f -
+
+ # Validate current services under 'default' namespace within the cluster
+ kubectl get services -o yaml | istioctl validate -f -
+
+ # Also see the related command 'istioctl analyze'
+ istioctl analyze samples/bookinfo/networking/bookinfo-gateway.yaml
+
++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.
+If you do not specify an installation it will check for an IstioOperator resource +and will verify if pods and services defined in it are present.
+Note: For verifying whether your cluster is ready for Istio installation, see +istioctl experimental precheck. +
+istioctl verify-install [-f <deployment or istio operator file>] [--revision <revision>] [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--filename <stringSlice> |
+-f |
+Istio YAML installation file. (default `[]`) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--manifests <string> |
+-d |
+Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.20.0/manifests). (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
# Verify that Istio is installed correctly via Istio Operator
+ istioctl verify-install
+
+ # Verify the deployment matches a custom Istio deployment configuration
+ istioctl verify-install -f $HOME/istio.yaml
+
+ # Verify the deployment matches the Istio Operator deployment definition
+ istioctl verify-install --revision <canary>
+
+ # Verify the installation of specific revision
+ istioctl verify-install -r 1-9-0
+Prints out build version information
+istioctl version [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--context <string> |
++ | Kubernetes configuration context (default ``) | +
--istioNamespace <string> |
+-i |
+Istio system namespace (default `istio-system`) | +
--kubeconfig <string> |
+-c |
+Kubernetes configuration file (default ``) | +
--namespace <string> |
+-n |
+Kubernetes namespace (default ``) | +
--output <string> |
+-o |
+One of 'yaml' or 'json'. (default ``) | +
--remote |
++ | Use --remote=false to suppress control plane check | +
--revision <string> |
+-r |
+Control plane revision (default ``) | +
--short |
+-s |
+Use --short=false to generate full version information | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istioctl command. Please use with caution as these environment variables are experimental and can change anytime.
+| Variable Name | +Type | +Default Value | +Description | +
|---|---|---|---|
CA_TRUSTED_NODE_ACCOUNTS |
+String | + |
+If set, the list of service accounts that are allowed to use node authentication for CSRs. Node authentication allows an identity to create CSRs on behalf of other identities, but only if there is a pod running on the same node with that identity. This is intended for use with node proxies. | +
CERT_SIGNER_DOMAIN |
+String | + |
+The cert signer domain info | +
CLOUD_PLATFORM |
+String | + |
+Cloud Platform on which proxy is running, if not specified, Istio will try to discover the platform. Valid platform values are aws, azure, gcp, none | +
CLUSTER_ID |
+String | +Kubernetes |
+Defines the cluster and service registry that this Istiod instance belongs to | +
ENABLE_AUTO_SNI |
+Boolean | +false |
+If enabled, automatically set SNI when `DestinationRules` do not specify the same | +
ENABLE_CA_SERVER |
+Boolean | +true |
+If this is set to false, will not create CA server in istiod. | +
ENABLE_DEBUG_ON_HTTP |
+Boolean | +true |
+If this is set to false, the debug interface will not be enabled, recommended for production | +
ENABLE_ENHANCED_RESOURCE_SCOPING |
+Boolean | +false |
+If enabled, meshConfig.discoverySelectors will limit the CustomResource configurations(like Gateway,VirtualService,DestinationRule,Ingress, etc)that can be processed by pilot. This will also restrict the root-ca certificate distribution. | +
ENABLE_HCM_INTERNAL_NETWORKS |
+Boolean | +false |
+If enable, endpoints defined in mesh networks will be configured as internal addresses in Http Connection Manager | +
ENABLE_LEADER_ELECTION |
+Boolean | +true |
+If enabled (default), starts a leader election client and gains leadership before executing controllers. If false, it assumes that only one instance of istiod is running and skips leader election. | +
ENABLE_MCS_AUTO_EXPORT |
+Boolean | +false |
+If enabled, istiod will automatically generate Kubernetes Multi-Cluster Services (MCS) ServiceExport resources for every service in the mesh. Services defined to be cluster-local in MeshConfig are excluded. | +
ENABLE_MCS_CLUSTER_LOCAL |
+Boolean | +false |
+If enabled, istiod will treat the host `<svc>.<namespace>.svc.cluster.local` as defined by the Kubernetes Multi-Cluster Services (MCS) spec. In this mode, requests to `cluster.local` will be routed to only those endpoints residing within the same cluster as the client. Requires that both ENABLE_MCS_SERVICE_DISCOVERY and ENABLE_MCS_HOST also be enabled. | +
ENABLE_MCS_HOST |
+Boolean | +false |
+If enabled, istiod will configure a Kubernetes Multi-Cluster Services (MCS) host (<svc>.<namespace>.svc.clusterset.local) for each service exported (via ServiceExport) in at least one cluster. Clients must, however, be able to successfully lookup these DNS hosts. That means that either Istio DNS interception must be enabled or an MCS controller must be used. Requires that ENABLE_MCS_SERVICE_DISCOVERY also be enabled. | +
ENABLE_MCS_SERVICE_DISCOVERY |
+Boolean | +false |
+If enabled, istiod will enable Kubernetes Multi-Cluster Services (MCS) service discovery mode. In this mode, service endpoints in a cluster will only be discoverable within the same cluster unless explicitly exported via ServiceExport. | +
ENABLE_MULTICLUSTER_HEADLESS |
+Boolean | +true |
+If true, the DNS name table for a headless service will resolve to same-network endpoints in any cluster. | +
ENABLE_NATIVE_SIDECARS |
+Boolean | +false |
+If set, used Kubernetes native Sidecar container support. Requires SidecarContainer feature flag. | +
ENABLE_OPTIMIZED_CONFIG_REBUILD |
+Boolean | +true |
+If enabled, pilot will only rebuild config for resources that have changed | +
ENABLE_OTEL_BUILTIN_RESOURCE_LABELS |
+Boolean | +false |
+If enabled, envoy will send builtin lables(e.g. node_name) via OTel sink. | +
ENABLE_PROBE_KEEPALIVE_CONNECTIONS |
+Boolean | +false |
+If enabled, readiness probes will keep the connection from pilot-agent to the application alive. This mirrors older Istio versions' behaviors, but not kubelet's. | +
ENABLE_TLS_ON_SIDECAR_INGRESS |
+Boolean | +false |
+If enabled, the TLS configuration on Sidecar.ingress will take effect | +
EXTERNAL_ISTIOD |
+Boolean | +false |
+If this is set to true, one Istiod will control remote clusters including CA. | +
GCP_METADATA |
+String | + |
+Pipe separated GCP metadata, schemed as PROJECT_ID|PROJECT_NUMBER|CLUSTER_NAME|CLUSTER_ZONE | +
GCP_QUOTA_PROJECT |
+String | + |
+Allows specification of a quota project to be used in requests to GCP APIs. | +
GRPC_KEEPALIVE_INTERVAL |
+Time Duration | +30s |
+gRPC Keepalive Interval | +
GRPC_KEEPALIVE_TIMEOUT |
+Time Duration | +10s |
+gRPC Keepalive Timeout | +
HTTP_STRIP_FRAGMENT_FROM_PATH_UNSAFE_IF_DISABLED |
+Boolean | +true |
++ |
INBOUND_INTERCEPTION_MODE |
+String | + |
+The mode used to redirect inbound connections to Envoy, either "REDIRECT" or "TPROXY" | +
INBOUND_TPROXY_MARK |
+String | + |
++ |
INJECTION_WEBHOOK_CONFIG_NAME |
+String | +istio-sidecar-injector |
+Name of the mutatingwebhookconfiguration to patch, if istioctl is not used. | +
ISTIOCONFIG |
+String | +$HOME/.istioctl/config.yaml |
+Default values for istioctl flags | +
ISTIOCTL_AUTHORITY |
+String | + |
+The istioctl --authority override | +
ISTIOCTL_CERT_DIR |
+String | + |
+The istioctl --cert-dir override | +
ISTIOCTL_INSECURE |
+Boolean | +false |
+The istioctl --insecure override | +
ISTIOCTL_ISTIONAMESPACE |
+String | +istio-system |
+The istioctl --istioNamespace override | +
ISTIOCTL_PLAINTEXT |
+Boolean | +false |
+The istioctl --plaintext override | +
ISTIOCTL_PREFER_EXPERIMENTAL |
+Boolean | +false |
+The istioctl should use experimental subcommand variants | +
ISTIOCTL_XDS_ADDRESS |
+String | + |
+The istioctl --xds-address override | +
ISTIOCTL_XDS_PORT |
+Integer | +15012 |
+The istioctl --xds-port override | +
ISTIOD_CUSTOM_HOST |
+String | + |
+Custom host name of istiod that istiod signs the server cert. Multiple custom host names are supported, and multiple values are separated by commas. | +
ISTIO_AGENT_ENABLE_WASM_REMOTE_LOAD_CONVERSION |
+Boolean | +true |
+If enabled, Istio agent will intercept ECDS resource update, downloads Wasm module, and replaces Wasm module remote load with downloaded local module file. | +
ISTIO_BOOTSTRAP |
+String | + |
++ |
ISTIO_DELTA_XDS |
+Boolean | +false |
+If enabled, pilot will only send the delta configs as opposed to the state of the world on a Resource Request. This feature uses the delta xds api, but does not currently send the actual deltas. | +
ISTIO_DUAL_STACK |
+Boolean | +false |
+If true, Istio will enable the Dual Stack feature. | +
ISTIO_ENABLE_CONTROLLER_QUEUE_METRICS |
+Boolean | +false |
+If enabled, publishes metrics for queue depth, latency and processing times. | +
ISTIO_ENABLE_HTTP2_PROBING |
+Boolean | +true |
+If enabled, HTTP2 probes will be enabled for HTTPS probes, following Kubernetes | +
ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSH |
+Boolean | +true |
+If enabled, Istiod will not push changes on arbitrary annotation change. | +
ISTIO_GPRC_MAXRECVMSGSIZE |
+Integer | +4194304 |
+Sets the max receive buffer size of gRPC stream in bytes. | +
ISTIO_GPRC_MAXSTREAMS |
+Integer | +100000 |
+Sets the maximum number of concurrent grpc streams. | +
ISTIO_KUBE_CLIENT_CONTENT_TYPE |
+String | +protobuf |
+The content type to use for Kubernetes clients. Defaults to protobuf. Valid options: [protobuf, json] | +
ISTIO_MULTIROOT_MESH |
+Boolean | +false |
+If enabled, mesh will support certificates signed by more than one trustAnchor for ISTIO_MUTUAL mTLS | +
ISTIO_OUTBOUND_OWNER_GROUPS |
+String | +* |
+Comma separated list of groups whose outgoing traffic is to be redirected to Envoy. +A group can be specified either by name or by a numeric GID. +The wildcard character "*" can be used to configure redirection of traffic from all groups. | +
ISTIO_OUTBOUND_OWNER_GROUPS_EXCLUDE |
+String | + |
+Comma separated list of groups whose outgoing traffic is to be excluded from redirection to Envoy. +A group can be specified either by name or by a numeric GID. +Only applies when traffic from all groups (i.e. "*") is being redirected to Envoy. | +
ISTIO_PROMETHEUS_ANNOTATIONS |
+String | + |
++ |
ISTIO_WATCH_NAMESPACE |
+String | + |
+If set, limit Kubernetes watches to a single namespace. Warning: only a single namespace can be set. | +
ISTIO_WORKLOAD_ENTRY_VALIDATE_IDENTITY |
+Boolean | +true |
+If enabled, will validate the identity of a workload matches the identity of the WorkloadEntry it is associating with for health checks and auto registration. This flag is added for backwards compatibility only and will be removed in future releases | +
JWKS_RESOLVER_INSECURE_SKIP_VERIFY |
+Boolean | +false |
+If enabled, istiod will skip verifying the certificate of the JWKS server. | +
JWT_POLICY |
+String | +third-party-jwt |
+The JWT validation policy. | +
K8S_INGRESS_NS |
+String | +istio-system |
++ |
K_REVISION |
+String | + |
+KNative revision, set if running in knative | +
LABEL_CANONICAL_SERVICES_FOR_MESH_EXTERNAL_SERVICE_ENTRIES |
+Boolean | +false |
+If enabled, metadata representing canonical services for ServiceEntry resources with a location of mesh_external will be populatedin the cluster metadata for those endpoints. | +
LOCAL_CLUSTER_SECRET_WATCHER |
+Boolean | +false |
+If enabled, the cluster secret watcher will watch the namespace of the external cluster instead of config cluster | +
MCS_API_GROUP |
+String | +multicluster.x-k8s.io |
+The group to be used for the Kubernetes Multi-Cluster Services (MCS) API. | +
MCS_API_VERSION |
+String | +v1alpha1 |
+The version to be used for the Kubernets Multi-Cluster Services (MCS) API. | +
METRIC_GRACEFUL_DELETION_INTERVAL |
+Time Duration | +5m0s |
+Metric expiry graceful deletion interval. No-op if METRIC_ROTATION_INTERVAL is disabled. | +
METRIC_ROTATION_INTERVAL |
+Time Duration | +0s |
+Metric scope rotation interval, set to 0 to disable the metric scope rotation | +
MUTEX_PROFILE_FRACTION |
+Integer | +1000 |
+If set to a non-zero value, enables mutex profiling a rate of 1/MUTEX_PROFILE_FRACTION events. For example, '1000' will record 0.1% of events. Set to 0 to disable entirely. | +
NATIVE_METADATA_EXCHANGE |
+Boolean | +true |
+If set, uses a native implementation of the HTTP metadata exchange filter | +
PILOT_ALLOW_SIDECAR_SERVICE_INBOUND_LISTENER_MERGE |
+Boolean | +false |
+If set, it allows creating inbound listeners for service ports and sidecar ingress listeners | +
PILOT_ANALYSIS_INTERVAL |
+Time Duration | +10s |
+If analysis is enabled, pilot will run istio analyzers using this value as interval in seconds Istio Resources | +
PILOT_CERT_PROVIDER |
+String | +istiod |
+The provider of Pilot DNS certificate. | +
PILOT_DEBOUNCE_AFTER |
+Time Duration | +100ms |
+The delay added to config/registry events for debouncing. This will delay the push by at least this interval. If no change is detected within this period, the push will happen, otherwise we'll keep delaying until things settle, up to a max of PILOT_DEBOUNCE_MAX. | +
PILOT_DEBOUNCE_MAX |
+Time Duration | +10s |
+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. | +
PILOT_DISTRIBUTION_HISTORY_RETENTION |
+Time Duration | +1m0s |
+If enabled, Pilot will keep track of old versions of distributed config for this duration. | +
PILOT_DRAINING_LABEL |
+String | +istio.io/draining |
+If not empty, endpoints with the label value present will be sent with status DRAINING. | +
PILOT_ENABLE_ALPHA_GATEWAY_API |
+Boolean | +false |
+If this is set to true, support for alpha APIs in the Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed. | +
PILOT_ENABLE_ALPN_FILTER |
+Boolean | +true |
+If true, pilot will add Istio ALPN filters, required for proper protocol sniffing. | +
PILOT_ENABLE_AMBIENT_CONTROLLERS |
+Boolean | +false |
+If enabled, controllers required for ambient will run. This is required to run ambient mesh. | +
PILOT_ENABLE_ANALYSIS |
+Boolean | +false |
+If enabled, pilot will run istio analyzers and write analysis errors to the Status field of any Istio Resources | +
PILOT_ENABLE_CDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache CDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE. | +
PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING |
+Boolean | +false |
+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. | +
PILOT_ENABLE_CROSS_CLUSTER_WORKLOAD_ENTRY |
+Boolean | +true |
+If enabled, pilot will read WorkloadEntry from other clusters, selectable by Services in that cluster. | +
PILOT_ENABLE_EDS_DEBOUNCE |
+Boolean | +true |
+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 | +
PILOT_ENABLE_EDS_FOR_HEADLESS_SERVICES |
+Boolean | +false |
+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. | +
PILOT_ENABLE_GATEWAY_API |
+Boolean | +true |
+If this is set to true, support for Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed. | +
PILOT_ENABLE_GATEWAY_API_DEPLOYMENT_CONTROLLER |
+Boolean | +true |
+If this is set to true, gateway-api resources will automatically provision in cluster deployment, services, etc | +
PILOT_ENABLE_GATEWAY_API_GATEWAYCLASS_CONTROLLER |
+Boolean | +true |
+If this is set to true, istiod will create and manage its default GatewayClasses | +
PILOT_ENABLE_GATEWAY_API_STATUS |
+Boolean | +true |
+If this is set to true, gateway-api resources will have status written to them | +
PILOT_ENABLE_HBONE |
+Boolean | +false |
+If enabled, HBONE support can be configured for proxies. Note: proxies must opt in on a per-proxy basis with ENABLE_HBONE to actually get HBONE config, in addition to this flag. | +
PILOT_ENABLE_HEADLESS_SERVICE_POD_LISTENERS |
+Boolean | +true |
+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. | +
PILOT_ENABLE_INBOUND_PASSTHROUGH |
+Boolean | +true |
+If enabled, inbound clusters will be configured as ORIGINAL_DST clusters. When disabled, requests are always sent to localhost. The primary implication of this is that when enabled, binding to POD_IP will work while localhost will not; when disable, bind to POD_IP will not work, while localhost will. The enabled behavior matches the behavior without Istio enabled at all; this flag exists only for backwards compatibility. Regardless of this setting, the configuration can be overridden with the Sidecar.Ingress.DefaultEndpoint configuration. | +
PILOT_ENABLE_K8S_SELECT_WORKLOAD_ENTRIES |
+Boolean | +true |
+If enabled, Kubernetes services with selectors will select workload entries with matching labels. It is safe to disable it if you are quite sure you don't need this feature | +
PILOT_ENABLE_METADATA_EXCHANGE |
+Boolean | +true |
+If true, pilot will add metadata exchange filters, which will be consumed by telemetry filter. | +
PILOT_ENABLE_MONGO_FILTER |
+Boolean | +true |
+EnableMongoFilter enables injection of `envoy.filters.network.mongo_proxy` in the filter chain. | +
PILOT_ENABLE_MYSQL_FILTER |
+Boolean | +false |
+EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain. | +
PILOT_ENABLE_PERSISTENT_SESSION_FILTER |
+Boolean | +false |
+If enabled, Istiod sets up persistent session filter for listeners, if services have 'PILOT_PERSISTENT_SESSION_LABEL' set. | +
PILOT_ENABLE_QUIC_LISTENERS |
+Boolean | +false |
+If true, QUIC listeners will be generated wherever there are listeners terminating TLS on gateways if the gateway service exposes a UDP port with the same number (for example 443/TCP and 443/UDP) | +
PILOT_ENABLE_RDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache RDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE. | +
PILOT_ENABLE_REDIS_FILTER |
+Boolean | +false |
+EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain. | +
PILOT_ENABLE_ROUTE_COLLAPSE_OPTIMIZATION |
+Boolean | +true |
+If true, Pilot will merge virtual hosts with the same routes into a single virtual host, as an optimization. | +
PILOT_ENABLE_SERVICEENTRY_SELECT_PODS |
+Boolean | +true |
+If enabled, service entries with selectors will select pods from the cluster. It is safe to disable it if you are quite sure you don't need this feature | +
PILOT_ENABLE_STATUS |
+Boolean | +false |
+If enabled, pilot will update the CRD Status field of all istio resources with reconciliation status. | +
PILOT_ENABLE_TELEMETRY_LABEL |
+Boolean | +true |
+If true, pilot will add telemetry related metadata to cluster and endpoint resources, which will be consumed by telemetry filter. | +
PILOT_ENABLE_WORKLOAD_ENTRY_AUTOREGISTRATION |
+Boolean | +true |
+Enables auto-registering WorkloadEntries based on associated WorkloadGroups upon XDS connection by the workload. | +
PILOT_ENABLE_WORKLOAD_ENTRY_HEALTHCHECKS |
+Boolean | +true |
+Enables automatic health checks of WorkloadEntries based on the config provided in the associated WorkloadGroup | +
PILOT_ENABLE_XDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache XDS responses. | +
PILOT_ENABLE_XDS_IDENTITY_CHECK |
+Boolean | +true |
+If enabled, pilot will authorize XDS clients, to ensure they are acting only as namespaces they have permissions for. | +
PILOT_ENDPOINT_TELEMETRY_LABEL |
+Boolean | +true |
+If true, pilot will add telemetry related metadata to Endpoint resource, which will be consumed by telemetry filter. | +
PILOT_ENVOY_FILTER_STATS |
+Boolean | +false |
+If true, Pilot will collect metrics for envoy filter operations. | +
PILOT_FILTER_GATEWAY_CLUSTER_CONFIG |
+Boolean | +false |
+If enabled, Pilot will send only clusters that referenced in gateway virtual services attached to gateway | +
PILOT_HTTP10 |
+Boolean | +false |
+Enables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications. | +
PILOT_INSECURE_MULTICLUSTER_KUBECONFIG_OPTIONS |
+String | + |
+Comma separated list of potentially insecure kubeconfig authentication options that are allowed for multicluster authentication.Support values: all authProviders (`gcp`, `azure`, `exec`, `openstack`), `clientKey`, `clientCertificate`, `tokenFile`, and `exec`. | +
PILOT_JWT_ENABLE_REMOTE_JWKS |
+String | +false |
+Mode of fetching JWKs from JwksUri in RequestAuthentication. Supported value: istiod, false, hybrid, true, envoy. The client fetching JWKs is as following: istiod/false - Istiod; hybrid/true - Envoy and fallback to Istiod if JWKs server is external; envoy - Envoy. | +
PILOT_JWT_PUB_KEY_REFRESH_INTERVAL |
+Time Duration | +20m0s |
+The interval for istiod to fetch the jwks_uri for the jwks public key. | +
PILOT_MAX_REQUESTS_PER_SECOND |
+Floating-Point | +25 |
+Limits the number of incoming XDS requests per second. On larger machines this can be increased to handle more proxies concurrently. | +
PILOT_MULTI_NETWORK_DISCOVER_GATEWAY_API |
+Boolean | +false |
+If true, Pilot will discover labeled Kubernetes gateway objects as multi-network gateways. | +
PILOT_PERSISTENT_SESSION_HEADER_LABEL |
+String | +istio.io/persistent-session-header |
+If not empty, services with this label will use header based persistent sessions | +
PILOT_PERSISTENT_SESSION_LABEL |
+String | +istio.io/persistent-session |
+If not empty, services with this label will use cookie based persistent sessions | +
PILOT_PUSH_THROTTLE |
+Integer | +100 |
+Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes | +
PILOT_REMOTE_CLUSTER_TIMEOUT |
+Time Duration | +30s |
+After this timeout expires, pilot can become ready without syncing data from clusters added via remote-secrets. Setting the timeout to 0 disables this behavior. | +
PILOT_SCOPE_GATEWAY_TO_NAMESPACE |
+Boolean | +false |
+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. | +
PILOT_SEND_UNHEALTHY_ENDPOINTS |
+Boolean | +false |
+If enabled, Pilot will include unhealthy endpoints in EDS pushes and even if they are sent Envoy does not use them for load balancing. To avoid, sending traffic to non ready endpoints, enabling this flag, disables panic threshold in Envoy i.e. Envoy does not load balance requests to unhealthy/non-ready hosts even if the percentage of healthy hosts fall below minimum health percentage(panic threshold). | +
PILOT_SIDECAR_USE_REMOTE_ADDRESS |
+Boolean | +false |
+UseRemoteAddress sets useRemoteAddress to true for sidecar outbound listeners. | +
PILOT_SKIP_VALIDATE_TRUST_DOMAIN |
+Boolean | +false |
+Skip validating the peer is from the same trust domain when mTLS is enabled in authentication policy | +
PILOT_STATUS_BURST |
+Integer | +500 |
+If status is enabled, controls the Burst rate with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config Burst | +
PILOT_STATUS_MAX_WORKERS |
+Integer | +100 |
+The maximum number of workers Pilot will use to keep configuration status up to date. Smaller numbers will result in higher status latency, but larger numbers may impact CPU in high scale environments. | +
PILOT_STATUS_QPS |
+Integer | +100 |
+If status is enabled, controls the QPS with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config QPS | +
PILOT_STATUS_UPDATE_INTERVAL |
+Time Duration | +500ms |
+Interval to update the XDS distribution status. | +
PILOT_TRACE_SAMPLING |
+Floating-Point | +1 |
+Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 1.0. | +
PILOT_WORKLOAD_ENTRY_GRACE_PERIOD |
+Time Duration | +10s |
+The amount of time an auto-registered workload can remain disconnected from all Pilot instances before the associated WorkloadEntry is cleaned up. | +
PILOT_XDS_CACHE_INDEX_CLEAR_INTERVAL |
+Time Duration | +5s |
+The interval for xds cache index clearing. | +
PILOT_XDS_CACHE_SIZE |
+Integer | +60000 |
+The maximum number of cache entries for the XDS cache. | +
PILOT_XDS_CACHE_STATS |
+Boolean | +false |
+If true, Pilot will collect metrics for XDS cache efficiency. | +
PILOT_XDS_SEND_TIMEOUT |
+Time Duration | +0s |
+The timeout to send the XDS configuration to proxies. After this timeout is reached, Pilot will discard that push. | +
PLATFORM |
+String | + |
+Platform where Istio is deployed. Possible values are "openshift" and "gcp" | +
REQUIRE_3P_TOKEN |
+Boolean | +false |
+Reject k8s default tokens, without audience. If false, default K8S token will be accepted | +
RESOLVE_HOSTNAME_GATEWAYS |
+Boolean | +true |
+If true, hostnames in the LoadBalancer addresses of a Service will be resolved at the control plane for use in cross-network gateways. | +
REWRITE_PROBE_LEGACY_LOCALHOST_DESTINATION |
+Boolean | +false |
+If enabled, readiness probes will be sent to 'localhost'. Otherwise, they will be sent to the Pod's IP, matching Kubernetes' behavior. | +
SHARED_MESH_CONFIG |
+String | + |
+Additional config map to load for shared MeshConfig settings. The standard mesh config will take precedence. | +
TERM |
+String | + |
+Specifies terminal type. Use 'dumb' to suppress color output | +
TOKEN_AUDIENCES |
+String | +istio-ca |
+A list of comma separated audiences to check in the JWT token before issuing a certificate. The token is accepted if it matches with one of the audiences | +
TRUSTED_GATEWAY_CIDR |
+String | + |
+If set, any connections from gateway to Istiod with this CIDR range are treated as trusted for using authentication mechanisms like XFCC. This can only be used when the network where Istiod and the authenticating gateways are running in a trusted/secure network | +
UNSAFE_ENABLE_ADMIN_ENDPOINTS |
+Boolean | +false |
+If this is set to true, dangerous admin endpoints will be exposed on the debug interface. Not recommended for production. | +
UNSAFE_PILOT_ENABLE_DELTA_TEST |
+Boolean | +false |
+If enabled, addition runtime tests for Delta XDS efficiency are added. These checks are extremely expensive, so this should be used only for testing, not production. | +
UNSAFE_PILOT_ENABLE_RUNTIME_ASSERTIONS |
+Boolean | +false |
+If enabled, addition runtime asserts will be performed. These checks are both expensive and panic on failure. As a result, this should be used only for testing. | +
VALIDATION_WEBHOOK_CONFIG_NAME |
+String | +istio-istio-system |
+If not empty, the controller will automatically patch validatingwebhookconfiguration when the CA certificate changes. Only works in kubernetes environment. | +
VERIFY_CERTIFICATE_AT_CLIENT |
+Boolean | +false |
+If enabled, certificates received by the proxy will be verified against the OS CA certificate bundle. | +
VERIFY_SDS_CERTIFICATE |
+Boolean | +true |
+If enabled, certificates fetched from SDS server will be verified before sending back to proxy. | +
XDS_AUTH |
+Boolean | +true |
+If true, will authenticate XDS clients. | +
XDS_AUTH_PLAINTEXT |
+Boolean | +false |
+authenticate plain text requests - used if Istiod is running on a secure/trusted network | +
| Metric Name | Type | Description |
|---|---|---|
auto_registration_deletes_total | Sum | Total number of auto registration cleaned up by periodic timer. |
auto_registration_errors_total | Sum | Total number of auto registration errors. |
auto_registration_success_total | Sum | Total number of successful auto registrations. |
auto_registration_unregister_total | Sum | Total number of unregistrations. |
auto_registration_updates_total | Sum | Total number of auto registration updates. |
cache_flush_total | Sum | number of times operator cache was flushed |
controller_sync_errors_total | Sum | Total number of errorMetric syncing controllers. |
cr_deletion_total | Sum | Number of IstioOperator CR deleted |
cr_merge_failure_total | Sum | Number of IstioOperator CR merge failures |
cr_validation_error_total | Sum | Number of IstioOperator CR validation failures |
endpoint_no_pod | LastValue | Endpoints without an associated pod. |
get_cr_error_total | Sum | Number of times fetching CR from apiserver failed |
istio_build | LastValue | Istio component build info |
istiod_managed_clusters | LastValue | Number of clusters managed by istiod |
legacy_path_translation_total | Sum | Number of times a legacy API path is translated |
manifest_patch_error_total | Sum | Number of times K8S patch overlays failed |
manifest_render_error_total | Sum | Number of times error occurred during rendering output manifest |
num_outgoing_retries | Sum | Number of outgoing retry requests (e.g. to a token exchange server, CA, etc.) |
owned_resource_total | LastValue | Number of resources currently owned by the operator |
pilot_conflict_inbound_listener | LastValue | Number of conflicting inbound listeners. |
pilot_conflict_outbound_listener_tcp_over_current_tcp | LastValue | Number of conflicting tcp listeners with current tcp listener. |
pilot_debounce_time | Distribution | Delay in seconds between the first config enters debouncing and the merged push request is pushed into the push queue. |
pilot_destrule_subsets | LastValue | Duplicate subsets across destination rules for same host |
pilot_dns_cluster_without_endpoints | LastValue | DNS clusters without endpoints caused by the endpoint field in STRICT_DNS type cluster is not set or the corresponding subset cannot select any endpoint |
pilot_duplicate_envoy_clusters | LastValue | Duplicate envoy clusters caused by service entries with same hostname |
pilot_eds_no_instances | LastValue | Number of clusters without instances. |
pilot_endpoint_not_ready | LastValue | Endpoint found in unready state. |
pilot_envoy_filter_status | LastValue | Status of Envoy filters whether it was applied or errored. |
pilot_inbound_updates | Sum | Total number of updates received by pilot. |
pilot_jwks_resolver_network_fetch_fail_total | Sum | Total number of failed network fetch by pilot jwks resolver |
pilot_jwks_resolver_network_fetch_success_total | Sum | Total number of successfully network fetch by pilot jwks resolver |
pilot_k8s_cfg_events | Sum | Events from k8s config. |
pilot_k8s_endpoints_pending_pod | LastValue | Number of endpoints that do not currently have any corresponding pods. |
pilot_k8s_endpoints_with_no_pods | Sum | Endpoints that does not have any corresponding pods. |
pilot_k8s_reg_events | Sum | Events from k8s registry. |
pilot_no_ip | LastValue | Pods not found in the endpoint table, possibly invalid. |
pilot_proxy_convergence_time | Distribution | Delay in seconds between config change and a proxy receiving all required configuration. |
pilot_proxy_queue_time | Distribution | Time in seconds, a proxy is in the push queue before being dequeued. |
pilot_push_triggers | Sum | Total number of times a push was triggered, labeled by reason for the push. |
pilot_pushcontext_init_seconds | Distribution | Total time in seconds Pilot takes to init pushContext. |
pilot_sds_certificate_errors_total | Sum | Total number of failures to fetch SDS key and certificate. |
pilot_services | LastValue | Total services known to pilot. |
pilot_total_rejected_configs | Sum | Total number of configs that Pilot had to reject or ignore. |
pilot_total_xds_internal_errors | Sum | Total number of internal XDS errors in pilot. |
pilot_total_xds_rejects | Sum | Total number of XDS responses from pilot rejected by proxy. |
pilot_virt_services | LastValue | Total virtual services known to pilot. |
pilot_vservice_dup_domain | LastValue | Virtual services with dup domains. |
pilot_worker_queue_depth | LastValue | Depth of the controller queues |
pilot_worker_queue_duration | Distribution | Time taken to process an item |
pilot_worker_queue_latency | Distribution | Latency before the item is processed |
pilot_xds | LastValue | Number of endpoints connected to this pilot using XDS. |
pilot_xds_cds_reject | LastValue | Pilot rejected CDS configs. |
pilot_xds_config_size_bytes | Distribution | Distribution of configuration sizes pushed to clients |
pilot_xds_eds_reject | LastValue | Pilot rejected EDS. |
pilot_xds_expired_nonce | Sum | Total number of XDS requests with an expired nonce. |
pilot_xds_lds_reject | LastValue | Pilot rejected LDS. |
pilot_xds_push_context_errors | Sum | Number of errors (timeouts) initiating push context. |
pilot_xds_push_time | Distribution | Total time in seconds Pilot takes to push lds, rds, cds and eds. |
pilot_xds_pushes | Sum | Pilot build and send errors for lds, rds, cds and eds. |
pilot_xds_rds_reject | LastValue | Pilot rejected RDS. |
pilot_xds_send_time | Distribution | Total time in seconds Pilot takes to send generated configuration. |
pilot_xds_write_timeout | Sum | Pilot XDS response write timeouts. |
provider_lookup_cluster_failures | Sum | Number of times a cluster lookup failed |
reconcile_request_total | Sum | Number of times requesting Reconcile |
remote_cluster_sync_timeouts_total | Sum | Number of times remote clusters took too long to sync, causing slow startup that excludes remote clusters. |
render_manifest_total | Sum | Number of component manifests rendered |
resource_creation_total | Sum | Number of resources created by the operator |
resource_deletion_total | Sum | Number of resources deleted by the operator |
resource_prune_total | Sum | Number of resources pruned by the operator |
resource_update_total | Sum | Number of resources updated by the operator |
scrape_failures_total | Sum | The total number of failed scrapes. |
scrapes_total | Sum | The total number of scrapes. |
sidecar_injection_failure_total | Sum | Total number of failed sidecar injection requests. |
sidecar_injection_requests_total | Sum | Total number of sidecar injection requests. |
sidecar_injection_skip_total | Sum | Total number of skipped sidecar injection requests. |
sidecar_injection_success_total | Sum | Total number of successful sidecar injection requests. |
sidecar_injection_time_seconds | Distribution | Total time taken for injection in seconds. |
startup_duration_seconds | LastValue | The time from the process starting to being marked ready. |
version | LastValue | Version of operator binary |
wasm_cache_entries | LastValue | number of Wasm remote fetch cache entries. |
wasm_cache_lookup_count | Sum | number of Wasm remote fetch cache lookups. |
wasm_config_conversion_count | Sum | number of Wasm config conversion count and results, including success, no remote load, marshal failure, remote fetch failure, miss remote fetch hint. |
wasm_config_conversion_duration | Distribution | Total time in milliseconds istio-agent spends on converting remote load in Wasm config. |
wasm_remote_fetch_count | Sum | number of Wasm remote fetches and results, including success, download failure, and checksum mismatch. |
webhook_patch_attempts_total | Sum | Webhook patching attempts |
webhook_patch_failures_total | Sum | Webhook patching total failures |
webhook_patch_retries_total | Sum | Webhook patching retries |
xds_cache_dependent_config_size | LastValue | Current size of dependent configs |
xds_cache_evictions | Sum | Total number of xds cache evictions. |
xds_cache_reads | Sum | Total number of xds cache xdsCacheReads. |
xds_cache_size | LastValue | Current size of xds cache |
The Istio operator.
+| Flags | +Description | +
|---|---|
--kubeconfig <string> |
+Paths to a kubeconfig. Only required if out-of-cluster. (default ``) | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for operator for the specified shell. +See each sub-command's help for details on how to use the generated script. +
+| Flags | +Description | +
|---|---|
--kubeconfig <string> |
+Paths to a kubeconfig. Only required if out-of-cluster. (default ``) | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the bash shell.
+This script depends on the 'bash-completion' package. +If it is not installed already, you can install it via your OS's package manager.
+To load completions in your current shell session:
+source <(operator completion bash)
+To load completions for every new session, execute once:
+#### Linux:
+operator completion bash > /etc/bash_completion.d/operator
+#### macOS:
+operator completion bash > $(brew --prefix)/etc/bash_completion.d/operator
+You will need to start a new shell for this setup to take effect. +
+operator completion bash
+| Flags | +Description | +
|---|---|
--kubeconfig <string> |
+Paths to a kubeconfig. Only required if out-of-cluster. (default ``) | +
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the fish shell.
+To load completions in your current shell session:
+operator completion fish | source
+To load completions for every new session, execute once:
+operator completion fish > ~/.config/fish/completions/operator.fish
+You will need to start a new shell for this setup to take effect. +
+operator completion fish [flags]
+| Flags | +Description | +
|---|---|
--kubeconfig <string> |
+Paths to a kubeconfig. Only required if out-of-cluster. (default ``) | +
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for powershell.
+To load completions in your current shell session:
+operator completion powershell | Out-String | Invoke-Expression
+To load completions for every new session, add the output of the above command +to your powershell profile. +
+operator completion powershell [flags]
+| Flags | +Description | +
|---|---|
--kubeconfig <string> |
+Paths to a kubeconfig. Only required if out-of-cluster. (default ``) | +
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the zsh shell.
+If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once:
+echo "autoload -U compinit; compinit" >> ~/.zshrc
+To load completions in your current shell session:
+source <(operator completion zsh)
+To load completions for every new session, execute once:
+#### Linux:
+operator completion zsh > "${fpath[1]}/_operator"
+#### macOS:
+operator completion zsh > $(brew --prefix)/share/zsh/site-functions/_operator
+You will need to start a new shell for this setup to take effect. +
+operator completion zsh [flags]
+| Flags | +Description | +
|---|---|
--kubeconfig <string> |
+Paths to a kubeconfig. Only required if out-of-cluster. (default ``) | +
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Starts the Istio operator server
+operator server [flags]
+| Flags | +Description | +
|---|---|
--ctrlz_address <string> |
+The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `localhost`) | +
--ctrlz_port <uint16> |
+The IP port to use for the ControlZ introspection facility (default `9876`) | +
--force |
+Proceed even with validation errors. | +
--kubeconfig <string> |
+Paths to a kubeconfig. Only required if out-of-cluster. (default ``) | +
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, file, gateway, grpcgen, ingress status, installer, klog, kube, model, monitoring, patch, processing, retry, security, serviceentry, spiffe, status, tpath, translator, trustBundle, util, validation, wasm, wle] (default ``) | +
--log_output_level <string> |
+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, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, file, gateway, grpcgen, ingress status, installer, klog, kube, model, monitoring, patch, processing, retry, security, serviceentry, spiffe, status, tpath, translator, trustBundle, util, validation, wasm, wle] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, file, gateway, grpcgen, ingress status, installer, klog, kube, model, monitoring, patch, processing, retry, security, serviceentry, spiffe, status, tpath, translator, trustBundle, util, validation, wasm, wle] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--max-concurrent-reconciles <int> |
+Defines the concurrency limit for operator to reconcile IstioOperatorSpec in parallel. Default value is 1. (default `1`) | +
--monitoring-host <string> |
+HTTP host to use for operator's self-monitoring information (default `0.0.0.0`) | +
--monitoring-port <uint32> |
+HTTP port to use for operator's self-monitoring information (default `8383`) | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Prints out build version information
+operator version [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--kubeconfig <string> |
++ | Paths to a kubeconfig. Only required if out-of-cluster. (default ``) | +
--output <string> |
+-o |
+One of 'yaml' or 'json'. (default ``) | +
--short |
+-s |
+Use --short=false to generate full version information | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
operator command. Please use with caution as these environment variables are experimental and can change anytime.
+| Variable Name | +Type | +Default Value | +Description | +
|---|---|---|---|
CA_TRUSTED_NODE_ACCOUNTS |
+String | + |
+If set, the list of service accounts that are allowed to use node authentication for CSRs. Node authentication allows an identity to create CSRs on behalf of other identities, but only if there is a pod running on the same node with that identity. This is intended for use with node proxies. | +
CERT_SIGNER_DOMAIN |
+String | + |
+The cert signer domain info | +
CLOUD_PLATFORM |
+String | + |
+Cloud Platform on which proxy is running, if not specified, Istio will try to discover the platform. Valid platform values are aws, azure, gcp, none | +
CLUSTER_ID |
+String | +Kubernetes |
+Defines the cluster and service registry that this Istiod instance belongs to | +
ENABLE_AUTO_SNI |
+Boolean | +false |
+If enabled, automatically set SNI when `DestinationRules` do not specify the same | +
ENABLE_CA_SERVER |
+Boolean | +true |
+If this is set to false, will not create CA server in istiod. | +
ENABLE_DEBUG_ON_HTTP |
+Boolean | +true |
+If this is set to false, the debug interface will not be enabled, recommended for production | +
ENABLE_ENHANCED_RESOURCE_SCOPING |
+Boolean | +false |
+If enabled, meshConfig.discoverySelectors will limit the CustomResource configurations(like Gateway,VirtualService,DestinationRule,Ingress, etc)that can be processed by pilot. This will also restrict the root-ca certificate distribution. | +
ENABLE_HCM_INTERNAL_NETWORKS |
+Boolean | +false |
+If enable, endpoints defined in mesh networks will be configured as internal addresses in Http Connection Manager | +
ENABLE_LEADER_ELECTION |
+Boolean | +true |
+If enabled (default), starts a leader election client and gains leadership before executing controllers. If false, it assumes that only one instance of istiod is running and skips leader election. | +
ENABLE_MCS_AUTO_EXPORT |
+Boolean | +false |
+If enabled, istiod will automatically generate Kubernetes Multi-Cluster Services (MCS) ServiceExport resources for every service in the mesh. Services defined to be cluster-local in MeshConfig are excluded. | +
ENABLE_MCS_CLUSTER_LOCAL |
+Boolean | +false |
+If enabled, istiod will treat the host `<svc>.<namespace>.svc.cluster.local` as defined by the Kubernetes Multi-Cluster Services (MCS) spec. In this mode, requests to `cluster.local` will be routed to only those endpoints residing within the same cluster as the client. Requires that both ENABLE_MCS_SERVICE_DISCOVERY and ENABLE_MCS_HOST also be enabled. | +
ENABLE_MCS_HOST |
+Boolean | +false |
+If enabled, istiod will configure a Kubernetes Multi-Cluster Services (MCS) host (<svc>.<namespace>.svc.clusterset.local) for each service exported (via ServiceExport) in at least one cluster. Clients must, however, be able to successfully lookup these DNS hosts. That means that either Istio DNS interception must be enabled or an MCS controller must be used. Requires that ENABLE_MCS_SERVICE_DISCOVERY also be enabled. | +
ENABLE_MCS_SERVICE_DISCOVERY |
+Boolean | +false |
+If enabled, istiod will enable Kubernetes Multi-Cluster Services (MCS) service discovery mode. In this mode, service endpoints in a cluster will only be discoverable within the same cluster unless explicitly exported via ServiceExport. | +
ENABLE_MULTICLUSTER_HEADLESS |
+Boolean | +true |
+If true, the DNS name table for a headless service will resolve to same-network endpoints in any cluster. | +
ENABLE_NATIVE_SIDECARS |
+Boolean | +false |
+If set, used Kubernetes native Sidecar container support. Requires SidecarContainer feature flag. | +
ENABLE_OPTIMIZED_CONFIG_REBUILD |
+Boolean | +true |
+If enabled, pilot will only rebuild config for resources that have changed | +
ENABLE_OTEL_BUILTIN_RESOURCE_LABELS |
+Boolean | +false |
+If enabled, envoy will send builtin lables(e.g. node_name) via OTel sink. | +
ENABLE_PROBE_KEEPALIVE_CONNECTIONS |
+Boolean | +false |
+If enabled, readiness probes will keep the connection from pilot-agent to the application alive. This mirrors older Istio versions' behaviors, but not kubelet's. | +
ENABLE_TLS_ON_SIDECAR_INGRESS |
+Boolean | +false |
+If enabled, the TLS configuration on Sidecar.ingress will take effect | +
EXTERNAL_ISTIOD |
+Boolean | +false |
+If this is set to true, one Istiod will control remote clusters including CA. | +
GCP_METADATA |
+String | + |
+Pipe separated GCP metadata, schemed as PROJECT_ID|PROJECT_NUMBER|CLUSTER_NAME|CLUSTER_ZONE | +
GCP_QUOTA_PROJECT |
+String | + |
+Allows specification of a quota project to be used in requests to GCP APIs. | +
GRPC_KEEPALIVE_INTERVAL |
+Time Duration | +30s |
+gRPC Keepalive Interval | +
GRPC_KEEPALIVE_TIMEOUT |
+Time Duration | +10s |
+gRPC Keepalive Timeout | +
HTTP_STRIP_FRAGMENT_FROM_PATH_UNSAFE_IF_DISABLED |
+Boolean | +true |
++ |
INBOUND_INTERCEPTION_MODE |
+String | + |
+The mode used to redirect inbound connections to Envoy, either "REDIRECT" or "TPROXY" | +
INBOUND_TPROXY_MARK |
+String | + |
++ |
INJECTION_WEBHOOK_CONFIG_NAME |
+String | +istio-sidecar-injector |
+Name of the mutatingwebhookconfiguration to patch, if istioctl is not used. | +
ISTIOD_CUSTOM_HOST |
+String | + |
+Custom host name of istiod that istiod signs the server cert. Multiple custom host names are supported, and multiple values are separated by commas. | +
ISTIO_AGENT_ENABLE_WASM_REMOTE_LOAD_CONVERSION |
+Boolean | +true |
+If enabled, Istio agent will intercept ECDS resource update, downloads Wasm module, and replaces Wasm module remote load with downloaded local module file. | +
ISTIO_BOOTSTRAP |
+String | + |
++ |
ISTIO_DELTA_XDS |
+Boolean | +false |
+If enabled, pilot will only send the delta configs as opposed to the state of the world on a Resource Request. This feature uses the delta xds api, but does not currently send the actual deltas. | +
ISTIO_DUAL_STACK |
+Boolean | +false |
+If true, Istio will enable the Dual Stack feature. | +
ISTIO_ENABLE_CONTROLLER_QUEUE_METRICS |
+Boolean | +false |
+If enabled, publishes metrics for queue depth, latency and processing times. | +
ISTIO_ENABLE_HTTP2_PROBING |
+Boolean | +true |
+If enabled, HTTP2 probes will be enabled for HTTPS probes, following Kubernetes | +
ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSH |
+Boolean | +true |
+If enabled, Istiod will not push changes on arbitrary annotation change. | +
ISTIO_GPRC_MAXRECVMSGSIZE |
+Integer | +4194304 |
+Sets the max receive buffer size of gRPC stream in bytes. | +
ISTIO_GPRC_MAXSTREAMS |
+Integer | +100000 |
+Sets the maximum number of concurrent grpc streams. | +
ISTIO_KUBE_CLIENT_CONTENT_TYPE |
+String | +protobuf |
+The content type to use for Kubernetes clients. Defaults to protobuf. Valid options: [protobuf, json] | +
ISTIO_MULTIROOT_MESH |
+Boolean | +false |
+If enabled, mesh will support certificates signed by more than one trustAnchor for ISTIO_MUTUAL mTLS | +
ISTIO_OUTBOUND_OWNER_GROUPS |
+String | +* |
+Comma separated list of groups whose outgoing traffic is to be redirected to Envoy. +A group can be specified either by name or by a numeric GID. +The wildcard character "*" can be used to configure redirection of traffic from all groups. | +
ISTIO_OUTBOUND_OWNER_GROUPS_EXCLUDE |
+String | + |
+Comma separated list of groups whose outgoing traffic is to be excluded from redirection to Envoy. +A group can be specified either by name or by a numeric GID. +Only applies when traffic from all groups (i.e. "*") is being redirected to Envoy. | +
ISTIO_PROMETHEUS_ANNOTATIONS |
+String | + |
++ |
ISTIO_WATCH_NAMESPACE |
+String | + |
+If set, limit Kubernetes watches to a single namespace. Warning: only a single namespace can be set. | +
ISTIO_WORKLOAD_ENTRY_VALIDATE_IDENTITY |
+Boolean | +true |
+If enabled, will validate the identity of a workload matches the identity of the WorkloadEntry it is associating with for health checks and auto registration. This flag is added for backwards compatibility only and will be removed in future releases | +
JWKS_RESOLVER_INSECURE_SKIP_VERIFY |
+Boolean | +false |
+If enabled, istiod will skip verifying the certificate of the JWKS server. | +
JWT_POLICY |
+String | +third-party-jwt |
+The JWT validation policy. | +
K8S_INGRESS_NS |
+String | +istio-system |
++ |
K_REVISION |
+String | + |
+KNative revision, set if running in knative | +
LABEL_CANONICAL_SERVICES_FOR_MESH_EXTERNAL_SERVICE_ENTRIES |
+Boolean | +false |
+If enabled, metadata representing canonical services for ServiceEntry resources with a location of mesh_external will be populatedin the cluster metadata for those endpoints. | +
LOCAL_CLUSTER_SECRET_WATCHER |
+Boolean | +false |
+If enabled, the cluster secret watcher will watch the namespace of the external cluster instead of config cluster | +
MCS_API_GROUP |
+String | +multicluster.x-k8s.io |
+The group to be used for the Kubernetes Multi-Cluster Services (MCS) API. | +
MCS_API_VERSION |
+String | +v1alpha1 |
+The version to be used for the Kubernets Multi-Cluster Services (MCS) API. | +
METRIC_GRACEFUL_DELETION_INTERVAL |
+Time Duration | +5m0s |
+Metric expiry graceful deletion interval. No-op if METRIC_ROTATION_INTERVAL is disabled. | +
METRIC_ROTATION_INTERVAL |
+Time Duration | +0s |
+Metric scope rotation interval, set to 0 to disable the metric scope rotation | +
MUTEX_PROFILE_FRACTION |
+Integer | +1000 |
+If set to a non-zero value, enables mutex profiling a rate of 1/MUTEX_PROFILE_FRACTION events. For example, '1000' will record 0.1% of events. Set to 0 to disable entirely. | +
NATIVE_METADATA_EXCHANGE |
+Boolean | +true |
+If set, uses a native implementation of the HTTP metadata exchange filter | +
PILOT_ALLOW_SIDECAR_SERVICE_INBOUND_LISTENER_MERGE |
+Boolean | +false |
+If set, it allows creating inbound listeners for service ports and sidecar ingress listeners | +
PILOT_ANALYSIS_INTERVAL |
+Time Duration | +10s |
+If analysis is enabled, pilot will run istio analyzers using this value as interval in seconds Istio Resources | +
PILOT_CERT_PROVIDER |
+String | +istiod |
+The provider of Pilot DNS certificate. | +
PILOT_DEBOUNCE_AFTER |
+Time Duration | +100ms |
+The delay added to config/registry events for debouncing. This will delay the push by at least this interval. If no change is detected within this period, the push will happen, otherwise we'll keep delaying until things settle, up to a max of PILOT_DEBOUNCE_MAX. | +
PILOT_DEBOUNCE_MAX |
+Time Duration | +10s |
+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. | +
PILOT_DISTRIBUTION_HISTORY_RETENTION |
+Time Duration | +1m0s |
+If enabled, Pilot will keep track of old versions of distributed config for this duration. | +
PILOT_DRAINING_LABEL |
+String | +istio.io/draining |
+If not empty, endpoints with the label value present will be sent with status DRAINING. | +
PILOT_ENABLE_ALPHA_GATEWAY_API |
+Boolean | +false |
+If this is set to true, support for alpha APIs in the Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed. | +
PILOT_ENABLE_ALPN_FILTER |
+Boolean | +true |
+If true, pilot will add Istio ALPN filters, required for proper protocol sniffing. | +
PILOT_ENABLE_AMBIENT_CONTROLLERS |
+Boolean | +false |
+If enabled, controllers required for ambient will run. This is required to run ambient mesh. | +
PILOT_ENABLE_ANALYSIS |
+Boolean | +false |
+If enabled, pilot will run istio analyzers and write analysis errors to the Status field of any Istio Resources | +
PILOT_ENABLE_CDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache CDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE. | +
PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING |
+Boolean | +false |
+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. | +
PILOT_ENABLE_CROSS_CLUSTER_WORKLOAD_ENTRY |
+Boolean | +true |
+If enabled, pilot will read WorkloadEntry from other clusters, selectable by Services in that cluster. | +
PILOT_ENABLE_EDS_DEBOUNCE |
+Boolean | +true |
+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 | +
PILOT_ENABLE_EDS_FOR_HEADLESS_SERVICES |
+Boolean | +false |
+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. | +
PILOT_ENABLE_GATEWAY_API |
+Boolean | +true |
+If this is set to true, support for Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed. | +
PILOT_ENABLE_GATEWAY_API_DEPLOYMENT_CONTROLLER |
+Boolean | +true |
+If this is set to true, gateway-api resources will automatically provision in cluster deployment, services, etc | +
PILOT_ENABLE_GATEWAY_API_GATEWAYCLASS_CONTROLLER |
+Boolean | +true |
+If this is set to true, istiod will create and manage its default GatewayClasses | +
PILOT_ENABLE_GATEWAY_API_STATUS |
+Boolean | +true |
+If this is set to true, gateway-api resources will have status written to them | +
PILOT_ENABLE_HBONE |
+Boolean | +false |
+If enabled, HBONE support can be configured for proxies. Note: proxies must opt in on a per-proxy basis with ENABLE_HBONE to actually get HBONE config, in addition to this flag. | +
PILOT_ENABLE_HEADLESS_SERVICE_POD_LISTENERS |
+Boolean | +true |
+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. | +
PILOT_ENABLE_INBOUND_PASSTHROUGH |
+Boolean | +true |
+If enabled, inbound clusters will be configured as ORIGINAL_DST clusters. When disabled, requests are always sent to localhost. The primary implication of this is that when enabled, binding to POD_IP will work while localhost will not; when disable, bind to POD_IP will not work, while localhost will. The enabled behavior matches the behavior without Istio enabled at all; this flag exists only for backwards compatibility. Regardless of this setting, the configuration can be overridden with the Sidecar.Ingress.DefaultEndpoint configuration. | +
PILOT_ENABLE_K8S_SELECT_WORKLOAD_ENTRIES |
+Boolean | +true |
+If enabled, Kubernetes services with selectors will select workload entries with matching labels. It is safe to disable it if you are quite sure you don't need this feature | +
PILOT_ENABLE_METADATA_EXCHANGE |
+Boolean | +true |
+If true, pilot will add metadata exchange filters, which will be consumed by telemetry filter. | +
PILOT_ENABLE_MONGO_FILTER |
+Boolean | +true |
+EnableMongoFilter enables injection of `envoy.filters.network.mongo_proxy` in the filter chain. | +
PILOT_ENABLE_MYSQL_FILTER |
+Boolean | +false |
+EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain. | +
PILOT_ENABLE_PERSISTENT_SESSION_FILTER |
+Boolean | +false |
+If enabled, Istiod sets up persistent session filter for listeners, if services have 'PILOT_PERSISTENT_SESSION_LABEL' set. | +
PILOT_ENABLE_QUIC_LISTENERS |
+Boolean | +false |
+If true, QUIC listeners will be generated wherever there are listeners terminating TLS on gateways if the gateway service exposes a UDP port with the same number (for example 443/TCP and 443/UDP) | +
PILOT_ENABLE_RDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache RDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE. | +
PILOT_ENABLE_REDIS_FILTER |
+Boolean | +false |
+EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain. | +
PILOT_ENABLE_ROUTE_COLLAPSE_OPTIMIZATION |
+Boolean | +true |
+If true, Pilot will merge virtual hosts with the same routes into a single virtual host, as an optimization. | +
PILOT_ENABLE_SERVICEENTRY_SELECT_PODS |
+Boolean | +true |
+If enabled, service entries with selectors will select pods from the cluster. It is safe to disable it if you are quite sure you don't need this feature | +
PILOT_ENABLE_STATUS |
+Boolean | +false |
+If enabled, pilot will update the CRD Status field of all istio resources with reconciliation status. | +
PILOT_ENABLE_TELEMETRY_LABEL |
+Boolean | +true |
+If true, pilot will add telemetry related metadata to cluster and endpoint resources, which will be consumed by telemetry filter. | +
PILOT_ENABLE_WORKLOAD_ENTRY_AUTOREGISTRATION |
+Boolean | +true |
+Enables auto-registering WorkloadEntries based on associated WorkloadGroups upon XDS connection by the workload. | +
PILOT_ENABLE_WORKLOAD_ENTRY_HEALTHCHECKS |
+Boolean | +true |
+Enables automatic health checks of WorkloadEntries based on the config provided in the associated WorkloadGroup | +
PILOT_ENABLE_XDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache XDS responses. | +
PILOT_ENABLE_XDS_IDENTITY_CHECK |
+Boolean | +true |
+If enabled, pilot will authorize XDS clients, to ensure they are acting only as namespaces they have permissions for. | +
PILOT_ENDPOINT_TELEMETRY_LABEL |
+Boolean | +true |
+If true, pilot will add telemetry related metadata to Endpoint resource, which will be consumed by telemetry filter. | +
PILOT_ENVOY_FILTER_STATS |
+Boolean | +false |
+If true, Pilot will collect metrics for envoy filter operations. | +
PILOT_FILTER_GATEWAY_CLUSTER_CONFIG |
+Boolean | +false |
+If enabled, Pilot will send only clusters that referenced in gateway virtual services attached to gateway | +
PILOT_HTTP10 |
+Boolean | +false |
+Enables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications. | +
PILOT_INSECURE_MULTICLUSTER_KUBECONFIG_OPTIONS |
+String | + |
+Comma separated list of potentially insecure kubeconfig authentication options that are allowed for multicluster authentication.Support values: all authProviders (`gcp`, `azure`, `exec`, `openstack`), `clientKey`, `clientCertificate`, `tokenFile`, and `exec`. | +
PILOT_JWT_ENABLE_REMOTE_JWKS |
+String | +false |
+Mode of fetching JWKs from JwksUri in RequestAuthentication. Supported value: istiod, false, hybrid, true, envoy. The client fetching JWKs is as following: istiod/false - Istiod; hybrid/true - Envoy and fallback to Istiod if JWKs server is external; envoy - Envoy. | +
PILOT_JWT_PUB_KEY_REFRESH_INTERVAL |
+Time Duration | +20m0s |
+The interval for istiod to fetch the jwks_uri for the jwks public key. | +
PILOT_MAX_REQUESTS_PER_SECOND |
+Floating-Point | +25 |
+Limits the number of incoming XDS requests per second. On larger machines this can be increased to handle more proxies concurrently. | +
PILOT_MULTI_NETWORK_DISCOVER_GATEWAY_API |
+Boolean | +false |
+If true, Pilot will discover labeled Kubernetes gateway objects as multi-network gateways. | +
PILOT_PERSISTENT_SESSION_HEADER_LABEL |
+String | +istio.io/persistent-session-header |
+If not empty, services with this label will use header based persistent sessions | +
PILOT_PERSISTENT_SESSION_LABEL |
+String | +istio.io/persistent-session |
+If not empty, services with this label will use cookie based persistent sessions | +
PILOT_PUSH_THROTTLE |
+Integer | +100 |
+Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes | +
PILOT_REMOTE_CLUSTER_TIMEOUT |
+Time Duration | +30s |
+After this timeout expires, pilot can become ready without syncing data from clusters added via remote-secrets. Setting the timeout to 0 disables this behavior. | +
PILOT_SCOPE_GATEWAY_TO_NAMESPACE |
+Boolean | +false |
+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. | +
PILOT_SEND_UNHEALTHY_ENDPOINTS |
+Boolean | +false |
+If enabled, Pilot will include unhealthy endpoints in EDS pushes and even if they are sent Envoy does not use them for load balancing. To avoid, sending traffic to non ready endpoints, enabling this flag, disables panic threshold in Envoy i.e. Envoy does not load balance requests to unhealthy/non-ready hosts even if the percentage of healthy hosts fall below minimum health percentage(panic threshold). | +
PILOT_SIDECAR_USE_REMOTE_ADDRESS |
+Boolean | +false |
+UseRemoteAddress sets useRemoteAddress to true for sidecar outbound listeners. | +
PILOT_SKIP_VALIDATE_TRUST_DOMAIN |
+Boolean | +false |
+Skip validating the peer is from the same trust domain when mTLS is enabled in authentication policy | +
PILOT_STATUS_BURST |
+Integer | +500 |
+If status is enabled, controls the Burst rate with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config Burst | +
PILOT_STATUS_MAX_WORKERS |
+Integer | +100 |
+The maximum number of workers Pilot will use to keep configuration status up to date. Smaller numbers will result in higher status latency, but larger numbers may impact CPU in high scale environments. | +
PILOT_STATUS_QPS |
+Integer | +100 |
+If status is enabled, controls the QPS with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config QPS | +
PILOT_STATUS_UPDATE_INTERVAL |
+Time Duration | +500ms |
+Interval to update the XDS distribution status. | +
PILOT_TRACE_SAMPLING |
+Floating-Point | +1 |
+Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 1.0. | +
PILOT_WORKLOAD_ENTRY_GRACE_PERIOD |
+Time Duration | +10s |
+The amount of time an auto-registered workload can remain disconnected from all Pilot instances before the associated WorkloadEntry is cleaned up. | +
PILOT_XDS_CACHE_INDEX_CLEAR_INTERVAL |
+Time Duration | +5s |
+The interval for xds cache index clearing. | +
PILOT_XDS_CACHE_SIZE |
+Integer | +60000 |
+The maximum number of cache entries for the XDS cache. | +
PILOT_XDS_CACHE_STATS |
+Boolean | +false |
+If true, Pilot will collect metrics for XDS cache efficiency. | +
PILOT_XDS_SEND_TIMEOUT |
+Time Duration | +0s |
+The timeout to send the XDS configuration to proxies. After this timeout is reached, Pilot will discard that push. | +
PLATFORM |
+String | + |
+Platform where Istio is deployed. Possible values are "openshift" and "gcp" | +
REQUIRE_3P_TOKEN |
+Boolean | +false |
+Reject k8s default tokens, without audience. If false, default K8S token will be accepted | +
RESOLVE_HOSTNAME_GATEWAYS |
+Boolean | +true |
+If true, hostnames in the LoadBalancer addresses of a Service will be resolved at the control plane for use in cross-network gateways. | +
REWRITE_PROBE_LEGACY_LOCALHOST_DESTINATION |
+Boolean | +false |
+If enabled, readiness probes will be sent to 'localhost'. Otherwise, they will be sent to the Pod's IP, matching Kubernetes' behavior. | +
SHARED_MESH_CONFIG |
+String | + |
+Additional config map to load for shared MeshConfig settings. The standard mesh config will take precedence. | +
TERM |
+String | + |
+Specifies terminal type. Use 'dumb' to suppress color output | +
TOKEN_AUDIENCES |
+String | +istio-ca |
+A list of comma separated audiences to check in the JWT token before issuing a certificate. The token is accepted if it matches with one of the audiences | +
TRUSTED_GATEWAY_CIDR |
+String | + |
+If set, any connections from gateway to Istiod with this CIDR range are treated as trusted for using authentication mechanisms like XFCC. This can only be used when the network where Istiod and the authenticating gateways are running in a trusted/secure network | +
UNSAFE_ENABLE_ADMIN_ENDPOINTS |
+Boolean | +false |
+If this is set to true, dangerous admin endpoints will be exposed on the debug interface. Not recommended for production. | +
UNSAFE_PILOT_ENABLE_DELTA_TEST |
+Boolean | +false |
+If enabled, addition runtime tests for Delta XDS efficiency are added. These checks are extremely expensive, so this should be used only for testing, not production. | +
UNSAFE_PILOT_ENABLE_RUNTIME_ASSERTIONS |
+Boolean | +false |
+If enabled, addition runtime asserts will be performed. These checks are both expensive and panic on failure. As a result, this should be used only for testing. | +
VALIDATION_WEBHOOK_CONFIG_NAME |
+String | +istio-istio-system |
+If not empty, the controller will automatically patch validatingwebhookconfiguration when the CA certificate changes. Only works in kubernetes environment. | +
VERIFY_CERTIFICATE_AT_CLIENT |
+Boolean | +false |
+If enabled, certificates received by the proxy will be verified against the OS CA certificate bundle. | +
VERIFY_SDS_CERTIFICATE |
+Boolean | +true |
+If enabled, certificates fetched from SDS server will be verified before sending back to proxy. | +
XDS_AUTH |
+Boolean | +true |
+If true, will authenticate XDS clients. | +
XDS_AUTH_PLAINTEXT |
+Boolean | +false |
+authenticate plain text requests - used if Istiod is running on a secure/trusted network | +
| Metric Name | Type | Description |
|---|---|---|
auto_registration_deletes_total | Sum | Total number of auto registration cleaned up by periodic timer. |
auto_registration_errors_total | Sum | Total number of auto registration errors. |
auto_registration_success_total | Sum | Total number of successful auto registrations. |
auto_registration_unregister_total | Sum | Total number of unregistrations. |
auto_registration_updates_total | Sum | Total number of auto registration updates. |
cache_flush_total | Sum | number of times operator cache was flushed |
controller_sync_errors_total | Sum | Total number of errorMetric syncing controllers. |
cr_deletion_total | Sum | Number of IstioOperator CR deleted |
cr_merge_failure_total | Sum | Number of IstioOperator CR merge failures |
cr_validation_error_total | Sum | Number of IstioOperator CR validation failures |
endpoint_no_pod | LastValue | Endpoints without an associated pod. |
get_cr_error_total | Sum | Number of times fetching CR from apiserver failed |
istio_build | LastValue | Istio component build info |
istiod_managed_clusters | LastValue | Number of clusters managed by istiod |
legacy_path_translation_total | Sum | Number of times a legacy API path is translated |
manifest_patch_error_total | Sum | Number of times K8S patch overlays failed |
manifest_render_error_total | Sum | Number of times error occurred during rendering output manifest |
num_outgoing_retries | Sum | Number of outgoing retry requests (e.g. to a token exchange server, CA, etc.) |
owned_resource_total | LastValue | Number of resources currently owned by the operator |
pilot_conflict_inbound_listener | LastValue | Number of conflicting inbound listeners. |
pilot_conflict_outbound_listener_tcp_over_current_tcp | LastValue | Number of conflicting tcp listeners with current tcp listener. |
pilot_debounce_time | Distribution | Delay in seconds between the first config enters debouncing and the merged push request is pushed into the push queue. |
pilot_destrule_subsets | LastValue | Duplicate subsets across destination rules for same host |
pilot_dns_cluster_without_endpoints | LastValue | DNS clusters without endpoints caused by the endpoint field in STRICT_DNS type cluster is not set or the corresponding subset cannot select any endpoint |
pilot_duplicate_envoy_clusters | LastValue | Duplicate envoy clusters caused by service entries with same hostname |
pilot_eds_no_instances | LastValue | Number of clusters without instances. |
pilot_endpoint_not_ready | LastValue | Endpoint found in unready state. |
pilot_envoy_filter_status | LastValue | Status of Envoy filters whether it was applied or errored. |
pilot_inbound_updates | Sum | Total number of updates received by pilot. |
pilot_jwks_resolver_network_fetch_fail_total | Sum | Total number of failed network fetch by pilot jwks resolver |
pilot_jwks_resolver_network_fetch_success_total | Sum | Total number of successfully network fetch by pilot jwks resolver |
pilot_k8s_cfg_events | Sum | Events from k8s config. |
pilot_k8s_endpoints_pending_pod | LastValue | Number of endpoints that do not currently have any corresponding pods. |
pilot_k8s_endpoints_with_no_pods | Sum | Endpoints that does not have any corresponding pods. |
pilot_k8s_reg_events | Sum | Events from k8s registry. |
pilot_no_ip | LastValue | Pods not found in the endpoint table, possibly invalid. |
pilot_proxy_convergence_time | Distribution | Delay in seconds between config change and a proxy receiving all required configuration. |
pilot_proxy_queue_time | Distribution | Time in seconds, a proxy is in the push queue before being dequeued. |
pilot_push_triggers | Sum | Total number of times a push was triggered, labeled by reason for the push. |
pilot_pushcontext_init_seconds | Distribution | Total time in seconds Pilot takes to init pushContext. |
pilot_sds_certificate_errors_total | Sum | Total number of failures to fetch SDS key and certificate. |
pilot_services | LastValue | Total services known to pilot. |
pilot_total_rejected_configs | Sum | Total number of configs that Pilot had to reject or ignore. |
pilot_total_xds_internal_errors | Sum | Total number of internal XDS errors in pilot. |
pilot_total_xds_rejects | Sum | Total number of XDS responses from pilot rejected by proxy. |
pilot_virt_services | LastValue | Total virtual services known to pilot. |
pilot_vservice_dup_domain | LastValue | Virtual services with dup domains. |
pilot_worker_queue_depth | LastValue | Depth of the controller queues |
pilot_worker_queue_duration | Distribution | Time taken to process an item |
pilot_worker_queue_latency | Distribution | Latency before the item is processed |
pilot_xds | LastValue | Number of endpoints connected to this pilot using XDS. |
pilot_xds_cds_reject | LastValue | Pilot rejected CDS configs. |
pilot_xds_config_size_bytes | Distribution | Distribution of configuration sizes pushed to clients |
pilot_xds_eds_reject | LastValue | Pilot rejected EDS. |
pilot_xds_expired_nonce | Sum | Total number of XDS requests with an expired nonce. |
pilot_xds_lds_reject | LastValue | Pilot rejected LDS. |
pilot_xds_push_context_errors | Sum | Number of errors (timeouts) initiating push context. |
pilot_xds_push_time | Distribution | Total time in seconds Pilot takes to push lds, rds, cds and eds. |
pilot_xds_pushes | Sum | Pilot build and send errors for lds, rds, cds and eds. |
pilot_xds_rds_reject | LastValue | Pilot rejected RDS. |
pilot_xds_send_time | Distribution | Total time in seconds Pilot takes to send generated configuration. |
pilot_xds_write_timeout | Sum | Pilot XDS response write timeouts. |
provider_lookup_cluster_failures | Sum | Number of times a cluster lookup failed |
reconcile_request_total | Sum | Number of times requesting Reconcile |
remote_cluster_sync_timeouts_total | Sum | Number of times remote clusters took too long to sync, causing slow startup that excludes remote clusters. |
render_manifest_total | Sum | Number of component manifests rendered |
resource_creation_total | Sum | Number of resources created by the operator |
resource_deletion_total | Sum | Number of resources deleted by the operator |
resource_prune_total | Sum | Number of resources pruned by the operator |
resource_update_total | Sum | Number of resources updated by the operator |
scrape_failures_total | Sum | The total number of failed scrapes. |
scrapes_total | Sum | The total number of scrapes. |
sidecar_injection_failure_total | Sum | Total number of failed sidecar injection requests. |
sidecar_injection_requests_total | Sum | Total number of sidecar injection requests. |
sidecar_injection_skip_total | Sum | Total number of skipped sidecar injection requests. |
sidecar_injection_success_total | Sum | Total number of successful sidecar injection requests. |
sidecar_injection_time_seconds | Distribution | Total time taken for injection in seconds. |
startup_duration_seconds | LastValue | The time from the process starting to being marked ready. |
version | LastValue | Version of operator binary |
wasm_cache_entries | LastValue | number of Wasm remote fetch cache entries. |
wasm_cache_lookup_count | Sum | number of Wasm remote fetch cache lookups. |
wasm_config_conversion_count | Sum | number of Wasm config conversion count and results, including success, no remote load, marshal failure, remote fetch failure, miss remote fetch hint. |
wasm_config_conversion_duration | Distribution | Total time in milliseconds istio-agent spends on converting remote load in Wasm config. |
wasm_remote_fetch_count | Sum | number of Wasm remote fetches and results, including success, download failure, and checksum mismatch. |
webhook_patch_attempts_total | Sum | Webhook patching attempts |
webhook_patch_failures_total | Sum | Webhook patching total failures |
webhook_patch_retries_total | Sum | Webhook patching retries |
xds_cache_dependent_config_size | LastValue | Current size of dependent configs |
xds_cache_evictions | Sum | Total number of xds cache evictions. |
xds_cache_reads | Sum | Total number of xds cache xdsCacheReads. |
xds_cache_size | LastValue | Current size of xds cache |
Istio Pilot agent runs in the sidecar or gateway container and bootstraps Envoy.
+| Flags | +Description | +
|---|---|
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
+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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for pilot-agent for the specified shell. +See each sub-command's help for details on how to use the generated script. +
+| Flags | +Description | +
|---|---|
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
+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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the bash shell.
+This script depends on the 'bash-completion' package. +If it is not installed already, you can install it via your OS's package manager.
+To load completions in your current shell session:
+source <(pilot-agent completion bash)
+To load completions for every new session, execute once:
+#### Linux:
+pilot-agent completion bash > /etc/bash_completion.d/pilot-agent
+#### macOS:
+pilot-agent completion bash > $(brew --prefix)/etc/bash_completion.d/pilot-agent
+You will need to start a new shell for this setup to take effect. +
+pilot-agent completion bash
+| Flags | +Description | +
|---|---|
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
+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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the fish shell.
+To load completions in your current shell session:
+pilot-agent completion fish | source
+To load completions for every new session, execute once:
+pilot-agent completion fish > ~/.config/fish/completions/pilot-agent.fish
+You will need to start a new shell for this setup to take effect. +
+pilot-agent completion fish [flags]
+| Flags | +Description | +
|---|---|
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
+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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for powershell.
+To load completions in your current shell session:
+pilot-agent completion powershell | Out-String | Invoke-Expression
+To load completions for every new session, add the output of the above command +to your powershell profile. +
+pilot-agent completion powershell [flags]
+| Flags | +Description | +
|---|---|
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
+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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the zsh shell.
+If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once:
+echo "autoload -U compinit; compinit" >> ~/.zshrc
+To load completions in your current shell session:
+source <(pilot-agent completion zsh)
+To load completions for every new session, execute once:
+#### Linux:
+pilot-agent completion zsh > "${fpath[1]}/_pilot-agent"
+#### macOS:
+pilot-agent completion zsh > $(brew --prefix)/share/zsh/site-functions/_pilot-agent
+You will need to start a new shell for this setup to take effect. +
+pilot-agent completion zsh [flags]
+| Flags | +Description | +
|---|---|
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
+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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Script responsible for cleaning up iptables rules
+pilot-agent istio-clean-iptables [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--dry-run |
+-n |
+Do not call any external dependencies like iptables | +
--istio-inbound-interception-mode <string> |
+-m |
+The mode used to redirect inbound connections to Envoy, either "REDIRECT" or "TPROXY" (default ``) | +
--istio-inbound-tproxy-mark <string> |
+-t |
+(default ``) | +
--log_as_json |
++ | Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
++ | Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
++ | 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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
++ | The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
++ | The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
++ | The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
++ | The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
++ | Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
++ | The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--proxy-gid <string> |
+-g |
+Specify the GID of the user for which the redirection is not applied. (same default value as -u param) (default ``) | +
--proxy-uid <string> |
+-u |
+Specify the UID of the user for which the redirection is not applied. Typically, this is the UID of the proxy container (default ``) | +
--redirect-dns |
++ | Enable capture of dns traffic by istio-agent | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
istio-iptables is responsible for setting up port forwarding for Istio Sidecar.
+pilot-agent istio-iptables [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--capture-all-dns |
++ | Instead of only capturing DNS traffic to DNS server IP, capture all DNS traffic at port 53. This setting is only effective when redirect dns is enabled. | +
--cni-mode |
++ | Whether to run as CNI plugin. | +
--drop-invalid |
++ | Enable invalid drop in the iptables rules. | +
--dry-run |
+-n |
+Do not call any external dependencies like iptables. | +
--envoy-port <string> |
+-p |
+Specify the envoy port to which redirect all TCP traffic (default $ENVOY_PORT = 15001). (default ``) | +
--host-nsenter-exec |
++ | Instead of using the internal go netns, use the nsenter command for switching network namespaces. | +
--inbound-capture-port <string> |
+-z |
+Port to which all inbound TCP traffic to the pod/VM should be redirected to (default $INBOUND_CAPTURE_PORT = 15006). (default ``) | +
--inbound-tunnel-port <string> |
+-e |
+Specify the istio tunnel port for inbound tcp traffic (default $INBOUND_TUNNEL_PORT = 15008). (default ``) | +
--iptables-probe-port <string> |
++ | Set listen port for failure detection. (default `15002`) | +
--iptables-trace-logging |
++ | Insert tracing logs for each iptables rules, using the LOG chain. | +
--istio-exclude-interfaces <string> |
+-c |
+Comma separated list of NIC (optional). Neither inbound nor outbound traffic will be captured. (default ``) | +
--istio-inbound-interception-mode <string> |
+-m |
+The mode used to redirect inbound connections to Envoy, either "REDIRECT" or "TPROXY". (default ``) | +
--istio-inbound-ports <string> |
+-b |
+Comma separated list of inbound ports for which traffic is to be redirected to Envoy (optional). The wildcard character "*" can be used to configure redirection for all ports. An empty list will disable. (default ``) | +
--istio-inbound-tproxy-mark <string> |
+-t |
+(default ``) | +
--istio-inbound-tproxy-route-table <string> |
+-r |
+(default ``) | +
--istio-local-exclude-ports <string> |
+-d |
+Comma separated list of inbound ports to be excluded from redirection to Envoy (optional). Only applies when all inbound traffic (i.e. "*") is being redirected (default to $ISTIO_LOCAL_EXCLUDE_PORTS). (default ``) | +
--istio-local-outbound-ports-exclude <string> |
+-o |
+Comma separated list of outbound ports to be excluded from redirection to Envoy. (default ``) | +
--istio-outbound-ports <string> |
+-q |
+Comma separated list of outbound ports to be explicitly included for redirection to Envoy. (default ``) | +
--istio-service-cidr <string> |
+-i |
+Comma separated list of IP ranges in CIDR form to redirect to envoy (optional). The wildcard character "*" can be used to redirect all outbound traffic. An empty list will disable all outbound. (default ``) | +
--istio-service-exclude-cidr <string> |
+-x |
+Comma separated list of IP ranges in CIDR form to be excluded from redirection. Only applies when all outbound traffic (i.e. "*") is being redirected (default to $ISTIO_SERVICE_EXCLUDE_CIDR). (default ``) | +
--kube-virt-interfaces <string> |
+-k |
+Comma separated list of virtual interfaces whose inbound traffic (from VM) will be treated as outbound. (default ``) | +
--log_as_json |
++ | Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
++ | Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
++ | 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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
++ | The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
++ | The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
++ | The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
++ | The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
++ | Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
++ | The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--network-namespace <string> |
++ | The network namespace that iptables rules should be applied to. (default ``) | +
--probe-timeout <duration> |
++ | Failure detection timeout. (default `5s`) | +
--proxy-gid <string> |
+-g |
+Specify the GID of the user for which the redirection is not applied (same default value as -u param). (default ``) | +
--proxy-uid <string> |
+-u |
+Specify the UID of the user for which the redirection is not applied. Typically, this is the UID of the proxy container. (default ``) | +
--redirect-dns |
++ | Enable capture of dns traffic by istio-agent. | +
--restore-format |
+-f |
+Print iptables rules in iptables-restore interpretable format. | +
--run-validation |
++ | Validate iptables. | +
--skip-rule-apply |
++ | Skip iptables apply. | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
XDS proxy agent
+pilot-agent proxy [flags]
+| Flags | +Description | +
|---|---|
--concurrency <int> |
+number of worker threads to run (default `0`) | +
--domain <string> |
+DNS domain suffix. If not provided uses ${POD_NAMESPACE}.svc.cluster.local (default ``) | +
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
+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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--meshConfig <string> |
+File name for Istio mesh configuration. If not specified, a default mesh will be used. This may be overridden by PROXY_CONFIG environment variable or proxy.istio.io/config annotation. (default `./etc/istio/config/mesh`) | +
--outlierLogPath <string> |
+The log path for outlier detection (default ``) | +
--profiling |
+Enable profiling via web interface host:port/debug/pprof/. | +
--proxyComponentLogLevel <string> |
+The component log level used to start the Envoy proxy. Deprecated, use proxyLogLevel instead (default ``) | +
--proxyLogLevel <string> |
+The log level used to start the Envoy proxy (choose from {trace, debug, info, warning, error, critical, off}).Level may also include one or more scopes, such as 'info,misc:error,upstream:debug' (default `warning,misc:error`) | +
--serviceCluster <string> |
+Service cluster (default `istio-proxy`) | +
--stsPort <int> |
+HTTP Port on which to serve Security Token Service (STS). If zero, STS service will not be provided. (default `0`) | +
--templateFile <string> |
+Go template bootstrap config (default ``) | +
--tokenManagerPlugin <string> |
+Token provider specific plugin name. (default `GoogleTokenExchange`) | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Makes an HTTP request to the Envoy admin API
+pilot-agent request <method> <path> [<body>] [flags]
+| Flags | +Description | +
|---|---|
--debug-port <int32> |
+Set the port to make a local request to. The default points to the Envoy admin API. (default `15000`) | +
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
+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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Prints out build version information
+pilot-agent version [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--log_as_json |
++ | Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
++ | Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
++ | 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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
++ | The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
++ | The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
++ | The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
++ | The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
++ | Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
++ | The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--output <string> |
+-o |
+One of 'yaml' or 'json'. (default ``) | +
--short |
+-s |
+Use --short=false to generate full version information | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Waits until the Envoy proxy is ready
+pilot-agent wait [flags]
+| Flags | +Description | +
|---|---|
--log_as_json |
+Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
+Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] (default ``) | +
--log_output_level <string> |
+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, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
+The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
+The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
+The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
+The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
+Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, controllers, default, delta, dns, gateway, gcecred, googleca, googlecas, grpcgen, healthcheck, ingress status, iptables, klog, kube, mockcred, model, monitoring, retry, sds, security, serviceentry, spiffe, status, stsclient, stsserver, token, trustBundle, validation, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
+The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--periodMillis <int> |
+number of milliseconds to wait between attempts (default `500`) | +
--requestTimeoutMillis <int> |
+number of milliseconds to wait for response (default `500`) | +
--timeoutSeconds <int> |
+maximum number of seconds to wait for Envoy to be ready (default `60`) | +
--url <string> |
+URL to use in requests (default `http://localhost:15021/healthz/ready`) | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
pilot-agent command. Please use with caution as these environment variables are experimental and can change anytime.
+| Variable Name | +Type | +Default Value | +Description | +
|---|---|---|---|
BOOTSTRAP_XDS_AGENT |
+Boolean | +false |
+If set to true, agent retrieves the bootstrap configuration prior to starting Envoy | +
CA_ADDR |
+String | + |
+Address of the spiffe certificate provider. Defaults to discoveryAddress | +
CA_PROVIDER |
+String | +Citadel |
+name of authentication provider | +
CA_ROOT_CA |
+String | + |
+Explicitly set the root CA to expect for the CA connection. | +
CA_TRUSTED_NODE_ACCOUNTS |
+String | + |
+If set, the list of service accounts that are allowed to use node authentication for CSRs. Node authentication allows an identity to create CSRs on behalf of other identities, but only if there is a pod running on the same node with that identity. This is intended for use with node proxies. | +
CERT_SIGNER_DOMAIN |
+String | + |
+The cert signer domain info | +
CLOUD_PLATFORM |
+String | + |
+Cloud Platform on which proxy is running, if not specified, Istio will try to discover the platform. Valid platform values are aws, azure, gcp, none | +
CLUSTER_ID |
+String | +Kubernetes |
+Defines the cluster and service registry that this Istiod instance belongs to | +
CREDENTIAL_FETCHER_TYPE |
+String | +JWT |
+The type of the credential fetcher. Currently supported types include GoogleComputeEngine | +
CREDENTIAL_IDENTITY_PROVIDER |
+String | +GoogleComputeEngine |
+The identity provider for credential. Currently default supported identity provider is GoogleComputeEngine | +
DISABLE_ENVOY |
+Boolean | +false |
+Disables all Envoy agent features. | +
DNS_FORWARD_PARALLEL |
+Boolean | +false |
+If set to true, agent will send parallel DNS queries to all upstream nameservers | +
DNS_PROXY_ADDR |
+String | +localhost:15053 |
+Custom address for the DNS proxy. If it ends with :53 and running as root allows running without iptable DNS capture | +
DRY_RUN_FILE_PATH |
+String | + |
+If provided, StdoutStubDependencies will write the input from stdin to the given file. | +
ECC_CURVE |
+String | +P256 |
+The elliptic curve to use when ECC_SIGNATURE_ALGORITHM is set to ECDSA | +
ECC_SIGNATURE_ALGORITHM |
+String | + |
+The type of ECC signature algorithm to use when generating private keys | +
ENABLE_AUTO_SNI |
+Boolean | +false |
+If enabled, automatically set SNI when `DestinationRules` do not specify the same | +
ENABLE_CA_SERVER |
+Boolean | +true |
+If this is set to false, will not create CA server in istiod. | +
ENABLE_DEBUG_ON_HTTP |
+Boolean | +true |
+If this is set to false, the debug interface will not be enabled, recommended for production | +
ENABLE_ENHANCED_RESOURCE_SCOPING |
+Boolean | +false |
+If enabled, meshConfig.discoverySelectors will limit the CustomResource configurations(like Gateway,VirtualService,DestinationRule,Ingress, etc)that can be processed by pilot. This will also restrict the root-ca certificate distribution. | +
ENABLE_HCM_INTERNAL_NETWORKS |
+Boolean | +false |
+If enable, endpoints defined in mesh networks will be configured as internal addresses in Http Connection Manager | +
ENABLE_LEADER_ELECTION |
+Boolean | +true |
+If enabled (default), starts a leader election client and gains leadership before executing controllers. If false, it assumes that only one instance of istiod is running and skips leader election. | +
ENABLE_MCS_AUTO_EXPORT |
+Boolean | +false |
+If enabled, istiod will automatically generate Kubernetes Multi-Cluster Services (MCS) ServiceExport resources for every service in the mesh. Services defined to be cluster-local in MeshConfig are excluded. | +
ENABLE_MCS_CLUSTER_LOCAL |
+Boolean | +false |
+If enabled, istiod will treat the host `<svc>.<namespace>.svc.cluster.local` as defined by the Kubernetes Multi-Cluster Services (MCS) spec. In this mode, requests to `cluster.local` will be routed to only those endpoints residing within the same cluster as the client. Requires that both ENABLE_MCS_SERVICE_DISCOVERY and ENABLE_MCS_HOST also be enabled. | +
ENABLE_MCS_HOST |
+Boolean | +false |
+If enabled, istiod will configure a Kubernetes Multi-Cluster Services (MCS) host (<svc>.<namespace>.svc.clusterset.local) for each service exported (via ServiceExport) in at least one cluster. Clients must, however, be able to successfully lookup these DNS hosts. That means that either Istio DNS interception must be enabled or an MCS controller must be used. Requires that ENABLE_MCS_SERVICE_DISCOVERY also be enabled. | +
ENABLE_MCS_SERVICE_DISCOVERY |
+Boolean | +false |
+If enabled, istiod will enable Kubernetes Multi-Cluster Services (MCS) service discovery mode. In this mode, service endpoints in a cluster will only be discoverable within the same cluster unless explicitly exported via ServiceExport. | +
ENABLE_MULTICLUSTER_HEADLESS |
+Boolean | +true |
+If true, the DNS name table for a headless service will resolve to same-network endpoints in any cluster. | +
ENABLE_NATIVE_SIDECARS |
+Boolean | +false |
+If set, used Kubernetes native Sidecar container support. Requires SidecarContainer feature flag. | +
ENABLE_OPTIMIZED_CONFIG_REBUILD |
+Boolean | +true |
+If enabled, pilot will only rebuild config for resources that have changed | +
ENABLE_OTEL_BUILTIN_RESOURCE_LABELS |
+Boolean | +false |
+If enabled, envoy will send builtin lables(e.g. node_name) via OTel sink. | +
ENABLE_PROBE_KEEPALIVE_CONNECTIONS |
+Boolean | +false |
+If enabled, readiness probes will keep the connection from pilot-agent to the application alive. This mirrors older Istio versions' behaviors, but not kubelet's. | +
ENABLE_TLS_ON_SIDECAR_INGRESS |
+Boolean | +false |
+If enabled, the TLS configuration on Sidecar.ingress will take effect | +
ENVOY_PROMETHEUS_PORT |
+Integer | +15090 |
+Envoy prometheus redirection port value | +
ENVOY_STATUS_PORT |
+Integer | +15021 |
+Envoy health status port value | +
ENVOY_USER |
+String | +istio-proxy |
+Envoy proxy username | +
EXIT_ON_ZERO_ACTIVE_CONNECTIONS |
+Boolean | +false |
+When set to true, terminates proxy when number of active connections become zero during draining | +
EXTERNAL_ISTIOD |
+Boolean | +false |
+If this is set to true, one Istiod will control remote clusters including CA. | +
FILE_DEBOUNCE_DURATION |
+Time Duration | +100ms |
+The duration for which the file read operation is delayed once file update is detected | +
FILE_MOUNTED_CERTS |
+Boolean | +false |
++ |
GCP_METADATA |
+String | + |
+Pipe separated GCP metadata, schemed as PROJECT_ID|PROJECT_NUMBER|CLUSTER_NAME|CLUSTER_ZONE | +
GCP_QUOTA_PROJECT |
+String | + |
+Allows specification of a quota project to be used in requests to GCP APIs. | +
GKE_CLUSTER_URL |
+String | + |
+The url of GKE cluster | +
GRPC_KEEPALIVE_INTERVAL |
+Time Duration | +30s |
+gRPC Keepalive Interval | +
GRPC_KEEPALIVE_TIMEOUT |
+Time Duration | +10s |
+gRPC Keepalive Timeout | +
GRPC_XDS_BOOTSTRAP |
+String | +etc/istio/proxy/grpc-bootstrap.json |
+Path where gRPC expects to read a bootstrap file. Agent will generate one if set. | +
HTTP_STRIP_FRAGMENT_FROM_PATH_UNSAFE_IF_DISABLED |
+Boolean | +true |
++ |
INBOUND_INTERCEPTION_MODE |
+String | + |
+The mode used to redirect inbound connections to Envoy, either "REDIRECT" or "TPROXY" | +
INBOUND_TPROXY_MARK |
+String | + |
++ |
INJECTION_WEBHOOK_CONFIG_NAME |
+String | +istio-sidecar-injector |
+Name of the mutatingwebhookconfiguration to patch, if istioctl is not used. | +
INSTANCE_IP |
+String | + |
++ |
INVALID_DROP |
+Boolean | +false |
+If set to true, enable the invalid drop iptables rule, default false will cause iptables reset out of window packets | +
IPTABLES_TRACE_LOGGING |
+Boolean | +false |
+When enable, all iptables actions will be logged. This requires NET_ADMIN privilege and has noisy logs; as a result, this is intended for debugging only | +
ISTIOD_CUSTOM_HOST |
+String | + |
+Custom host name of istiod that istiod signs the server cert. Multiple custom host names are supported, and multiple values are separated by commas. | +
ISTIOD_SAN |
+String | + |
+Override the ServerName used to validate Istiod certificate. Can be used as an alternative to setting /etc/hosts for VMs - discovery address will be an IP:port | +
ISTIO_AGENT_ENABLE_WASM_REMOTE_LOAD_CONVERSION |
+Boolean | +true |
+If enabled, Istio agent will intercept ECDS resource update, downloads Wasm module, and replaces Wasm module remote load with downloaded local module file. | +
ISTIO_BOOTSTRAP |
+String | + |
++ |
ISTIO_BOOTSTRAP_OVERRIDE |
+String | + |
++ |
ISTIO_CPU_LIMIT |
+Integer | +0 |
+CPU limit for the current process. Expressed as an integer value, rounded up. | +
ISTIO_DELTA_XDS |
+Boolean | +false |
+If enabled, pilot will only send the delta configs as opposed to the state of the world on a Resource Request. This feature uses the delta xds api, but does not currently send the actual deltas. | +
ISTIO_DUAL_STACK |
+Boolean | +false |
+If true, Istio will enable the Dual Stack feature. | +
ISTIO_ENABLE_CONTROLLER_QUEUE_METRICS |
+Boolean | +false |
+If enabled, publishes metrics for queue depth, latency and processing times. | +
ISTIO_ENABLE_HTTP2_PROBING |
+Boolean | +true |
+If enabled, HTTP2 probes will be enabled for HTTPS probes, following Kubernetes | +
ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSH |
+Boolean | +true |
+If enabled, Istiod will not push changes on arbitrary annotation change. | +
ISTIO_ENVOY_ENABLE_CORE_DUMP |
+Boolean | +false |
++ |
ISTIO_GPRC_MAXRECVMSGSIZE |
+Integer | +4194304 |
+Sets the max receive buffer size of gRPC stream in bytes. | +
ISTIO_GPRC_MAXSTREAMS |
+Integer | +100000 |
+Sets the maximum number of concurrent grpc streams. | +
ISTIO_KUBE_APP_PROBERS |
+String | + |
++ |
ISTIO_KUBE_CLIENT_CONTENT_TYPE |
+String | +protobuf |
+The content type to use for Kubernetes clients. Defaults to protobuf. Valid options: [protobuf, json] | +
ISTIO_META_CERT_SIGNER |
+String | + |
+The cert signer info for workload cert | +
ISTIO_META_CLUSTER_ID |
+String | + |
++ |
ISTIO_META_DNS_CAPTURE |
+Boolean | +false |
+If set to true, enable the capture of outgoing DNS packets on port 53, redirecting to istio-agent on :15053 | +
ISTIO_MULTIROOT_MESH |
+Boolean | +false |
+If enabled, mesh will support certificates signed by more than one trustAnchor for ISTIO_MUTUAL mTLS | +
ISTIO_OUTBOUND_OWNER_GROUPS |
+String | +* |
+Comma separated list of groups whose outgoing traffic is to be redirected to Envoy. +A group can be specified either by name or by a numeric GID. +The wildcard character "*" can be used to configure redirection of traffic from all groups. | +
ISTIO_OUTBOUND_OWNER_GROUPS_EXCLUDE |
+String | + |
+Comma separated list of groups whose outgoing traffic is to be excluded from redirection to Envoy. +A group can be specified either by name or by a numeric GID. +Only applies when traffic from all groups (i.e. "*") is being redirected to Envoy. | +
ISTIO_PROMETHEUS_ANNOTATIONS |
+String | + |
++ |
ISTIO_WATCH_NAMESPACE |
+String | + |
+If set, limit Kubernetes watches to a single namespace. Warning: only a single namespace can be set. | +
ISTIO_WORKLOAD_ENTRY_VALIDATE_IDENTITY |
+Boolean | +true |
+If enabled, will validate the identity of a workload matches the identity of the WorkloadEntry it is associating with for health checks and auto registration. This flag is added for backwards compatibility only and will be removed in future releases | +
JWKS_RESOLVER_INSECURE_SKIP_VERIFY |
+Boolean | +false |
+If enabled, istiod will skip verifying the certificate of the JWKS server. | +
JWT_POLICY |
+String | +third-party-jwt |
+The JWT validation policy. | +
K8S_INGRESS_NS |
+String | +istio-system |
++ |
KUBERNETES_SERVICE_HOST |
+String | + |
+Kubernetes service host, set automatically when running in-cluster | +
K_REVISION |
+String | + |
+KNative revision, set if running in knative | +
LABEL_CANONICAL_SERVICES_FOR_MESH_EXTERNAL_SERVICE_ENTRIES |
+Boolean | +false |
+If enabled, metadata representing canonical services for ServiceEntry resources with a location of mesh_external will be populatedin the cluster metadata for those endpoints. | +
LOCAL_CLUSTER_SECRET_WATCHER |
+Boolean | +false |
+If enabled, the cluster secret watcher will watch the namespace of the external cluster instead of config cluster | +
MCS_API_GROUP |
+String | +multicluster.x-k8s.io |
+The group to be used for the Kubernetes Multi-Cluster Services (MCS) API. | +
MCS_API_VERSION |
+String | +v1alpha1 |
+The version to be used for the Kubernets Multi-Cluster Services (MCS) API. | +
METRIC_GRACEFUL_DELETION_INTERVAL |
+Time Duration | +5m0s |
+Metric expiry graceful deletion interval. No-op if METRIC_ROTATION_INTERVAL is disabled. | +
METRIC_ROTATION_INTERVAL |
+Time Duration | +0s |
+Metric scope rotation interval, set to 0 to disable the metric scope rotation | +
MINIMUM_DRAIN_DURATION |
+Time Duration | +5s |
+The minimum duration for which agent waits before it checks for active connections and terminates proxywhen number of active connections become zero | +
MUTEX_PROFILE_FRACTION |
+Integer | +1000 |
+If set to a non-zero value, enables mutex profiling a rate of 1/MUTEX_PROFILE_FRACTION events. For example, '1000' will record 0.1% of events. Set to 0 to disable entirely. | +
NATIVE_METADATA_EXCHANGE |
+Boolean | +true |
+If set, uses a native implementation of the HTTP metadata exchange filter | +
OUTPUT_CERTS |
+String | + |
+The output directory for the key and certificate. If empty, key and certificate will not be saved. Must be set for VMs using provisioning certificates. | +
PILOT_ALLOW_SIDECAR_SERVICE_INBOUND_LISTENER_MERGE |
+Boolean | +false |
+If set, it allows creating inbound listeners for service ports and sidecar ingress listeners | +
PILOT_ANALYSIS_INTERVAL |
+Time Duration | +10s |
+If analysis is enabled, pilot will run istio analyzers using this value as interval in seconds Istio Resources | +
PILOT_CERT_PROVIDER |
+String | +istiod |
+The provider of Pilot DNS certificate. | +
PILOT_DEBOUNCE_AFTER |
+Time Duration | +100ms |
+The delay added to config/registry events for debouncing. This will delay the push by at least this interval. If no change is detected within this period, the push will happen, otherwise we'll keep delaying until things settle, up to a max of PILOT_DEBOUNCE_MAX. | +
PILOT_DEBOUNCE_MAX |
+Time Duration | +10s |
+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. | +
PILOT_DISTRIBUTION_HISTORY_RETENTION |
+Time Duration | +1m0s |
+If enabled, Pilot will keep track of old versions of distributed config for this duration. | +
PILOT_DRAINING_LABEL |
+String | +istio.io/draining |
+If not empty, endpoints with the label value present will be sent with status DRAINING. | +
PILOT_ENABLE_ALPHA_GATEWAY_API |
+Boolean | +false |
+If this is set to true, support for alpha APIs in the Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed. | +
PILOT_ENABLE_ALPN_FILTER |
+Boolean | +true |
+If true, pilot will add Istio ALPN filters, required for proper protocol sniffing. | +
PILOT_ENABLE_AMBIENT_CONTROLLERS |
+Boolean | +false |
+If enabled, controllers required for ambient will run. This is required to run ambient mesh. | +
PILOT_ENABLE_ANALYSIS |
+Boolean | +false |
+If enabled, pilot will run istio analyzers and write analysis errors to the Status field of any Istio Resources | +
PILOT_ENABLE_CDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache CDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE. | +
PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING |
+Boolean | +false |
+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. | +
PILOT_ENABLE_CROSS_CLUSTER_WORKLOAD_ENTRY |
+Boolean | +true |
+If enabled, pilot will read WorkloadEntry from other clusters, selectable by Services in that cluster. | +
PILOT_ENABLE_EDS_DEBOUNCE |
+Boolean | +true |
+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 | +
PILOT_ENABLE_EDS_FOR_HEADLESS_SERVICES |
+Boolean | +false |
+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. | +
PILOT_ENABLE_GATEWAY_API |
+Boolean | +true |
+If this is set to true, support for Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed. | +
PILOT_ENABLE_GATEWAY_API_DEPLOYMENT_CONTROLLER |
+Boolean | +true |
+If this is set to true, gateway-api resources will automatically provision in cluster deployment, services, etc | +
PILOT_ENABLE_GATEWAY_API_GATEWAYCLASS_CONTROLLER |
+Boolean | +true |
+If this is set to true, istiod will create and manage its default GatewayClasses | +
PILOT_ENABLE_GATEWAY_API_STATUS |
+Boolean | +true |
+If this is set to true, gateway-api resources will have status written to them | +
PILOT_ENABLE_HBONE |
+Boolean | +false |
+If enabled, HBONE support can be configured for proxies. Note: proxies must opt in on a per-proxy basis with ENABLE_HBONE to actually get HBONE config, in addition to this flag. | +
PILOT_ENABLE_HEADLESS_SERVICE_POD_LISTENERS |
+Boolean | +true |
+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. | +
PILOT_ENABLE_INBOUND_PASSTHROUGH |
+Boolean | +true |
+If enabled, inbound clusters will be configured as ORIGINAL_DST clusters. When disabled, requests are always sent to localhost. The primary implication of this is that when enabled, binding to POD_IP will work while localhost will not; when disable, bind to POD_IP will not work, while localhost will. The enabled behavior matches the behavior without Istio enabled at all; this flag exists only for backwards compatibility. Regardless of this setting, the configuration can be overridden with the Sidecar.Ingress.DefaultEndpoint configuration. | +
PILOT_ENABLE_K8S_SELECT_WORKLOAD_ENTRIES |
+Boolean | +true |
+If enabled, Kubernetes services with selectors will select workload entries with matching labels. It is safe to disable it if you are quite sure you don't need this feature | +
PILOT_ENABLE_METADATA_EXCHANGE |
+Boolean | +true |
+If true, pilot will add metadata exchange filters, which will be consumed by telemetry filter. | +
PILOT_ENABLE_MONGO_FILTER |
+Boolean | +true |
+EnableMongoFilter enables injection of `envoy.filters.network.mongo_proxy` in the filter chain. | +
PILOT_ENABLE_MYSQL_FILTER |
+Boolean | +false |
+EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain. | +
PILOT_ENABLE_PERSISTENT_SESSION_FILTER |
+Boolean | +false |
+If enabled, Istiod sets up persistent session filter for listeners, if services have 'PILOT_PERSISTENT_SESSION_LABEL' set. | +
PILOT_ENABLE_QUIC_LISTENERS |
+Boolean | +false |
+If true, QUIC listeners will be generated wherever there are listeners terminating TLS on gateways if the gateway service exposes a UDP port with the same number (for example 443/TCP and 443/UDP) | +
PILOT_ENABLE_RDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache RDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE. | +
PILOT_ENABLE_REDIS_FILTER |
+Boolean | +false |
+EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain. | +
PILOT_ENABLE_ROUTE_COLLAPSE_OPTIMIZATION |
+Boolean | +true |
+If true, Pilot will merge virtual hosts with the same routes into a single virtual host, as an optimization. | +
PILOT_ENABLE_SERVICEENTRY_SELECT_PODS |
+Boolean | +true |
+If enabled, service entries with selectors will select pods from the cluster. It is safe to disable it if you are quite sure you don't need this feature | +
PILOT_ENABLE_STATUS |
+Boolean | +false |
+If enabled, pilot will update the CRD Status field of all istio resources with reconciliation status. | +
PILOT_ENABLE_TELEMETRY_LABEL |
+Boolean | +true |
+If true, pilot will add telemetry related metadata to cluster and endpoint resources, which will be consumed by telemetry filter. | +
PILOT_ENABLE_WORKLOAD_ENTRY_AUTOREGISTRATION |
+Boolean | +true |
+Enables auto-registering WorkloadEntries based on associated WorkloadGroups upon XDS connection by the workload. | +
PILOT_ENABLE_WORKLOAD_ENTRY_HEALTHCHECKS |
+Boolean | +true |
+Enables automatic health checks of WorkloadEntries based on the config provided in the associated WorkloadGroup | +
PILOT_ENABLE_XDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache XDS responses. | +
PILOT_ENABLE_XDS_IDENTITY_CHECK |
+Boolean | +true |
+If enabled, pilot will authorize XDS clients, to ensure they are acting only as namespaces they have permissions for. | +
PILOT_ENDPOINT_TELEMETRY_LABEL |
+Boolean | +true |
+If true, pilot will add telemetry related metadata to Endpoint resource, which will be consumed by telemetry filter. | +
PILOT_ENVOY_FILTER_STATS |
+Boolean | +false |
+If true, Pilot will collect metrics for envoy filter operations. | +
PILOT_FILTER_GATEWAY_CLUSTER_CONFIG |
+Boolean | +false |
+If enabled, Pilot will send only clusters that referenced in gateway virtual services attached to gateway | +
PILOT_HTTP10 |
+Boolean | +false |
+Enables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications. | +
PILOT_INSECURE_MULTICLUSTER_KUBECONFIG_OPTIONS |
+String | + |
+Comma separated list of potentially insecure kubeconfig authentication options that are allowed for multicluster authentication.Support values: all authProviders (`gcp`, `azure`, `exec`, `openstack`), `clientKey`, `clientCertificate`, `tokenFile`, and `exec`. | +
PILOT_JWT_ENABLE_REMOTE_JWKS |
+String | +false |
+Mode of fetching JWKs from JwksUri in RequestAuthentication. Supported value: istiod, false, hybrid, true, envoy. The client fetching JWKs is as following: istiod/false - Istiod; hybrid/true - Envoy and fallback to Istiod if JWKs server is external; envoy - Envoy. | +
PILOT_JWT_PUB_KEY_REFRESH_INTERVAL |
+Time Duration | +20m0s |
+The interval for istiod to fetch the jwks_uri for the jwks public key. | +
PILOT_MAX_REQUESTS_PER_SECOND |
+Floating-Point | +25 |
+Limits the number of incoming XDS requests per second. On larger machines this can be increased to handle more proxies concurrently. | +
PILOT_MULTI_NETWORK_DISCOVER_GATEWAY_API |
+Boolean | +false |
+If true, Pilot will discover labeled Kubernetes gateway objects as multi-network gateways. | +
PILOT_PERSISTENT_SESSION_HEADER_LABEL |
+String | +istio.io/persistent-session-header |
+If not empty, services with this label will use header based persistent sessions | +
PILOT_PERSISTENT_SESSION_LABEL |
+String | +istio.io/persistent-session |
+If not empty, services with this label will use cookie based persistent sessions | +
PILOT_PUSH_THROTTLE |
+Integer | +100 |
+Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes | +
PILOT_REMOTE_CLUSTER_TIMEOUT |
+Time Duration | +30s |
+After this timeout expires, pilot can become ready without syncing data from clusters added via remote-secrets. Setting the timeout to 0 disables this behavior. | +
PILOT_SCOPE_GATEWAY_TO_NAMESPACE |
+Boolean | +false |
+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. | +
PILOT_SEND_UNHEALTHY_ENDPOINTS |
+Boolean | +false |
+If enabled, Pilot will include unhealthy endpoints in EDS pushes and even if they are sent Envoy does not use them for load balancing. To avoid, sending traffic to non ready endpoints, enabling this flag, disables panic threshold in Envoy i.e. Envoy does not load balance requests to unhealthy/non-ready hosts even if the percentage of healthy hosts fall below minimum health percentage(panic threshold). | +
PILOT_SIDECAR_USE_REMOTE_ADDRESS |
+Boolean | +false |
+UseRemoteAddress sets useRemoteAddress to true for sidecar outbound listeners. | +
PILOT_SKIP_VALIDATE_TRUST_DOMAIN |
+Boolean | +false |
+Skip validating the peer is from the same trust domain when mTLS is enabled in authentication policy | +
PILOT_STATUS_BURST |
+Integer | +500 |
+If status is enabled, controls the Burst rate with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config Burst | +
PILOT_STATUS_MAX_WORKERS |
+Integer | +100 |
+The maximum number of workers Pilot will use to keep configuration status up to date. Smaller numbers will result in higher status latency, but larger numbers may impact CPU in high scale environments. | +
PILOT_STATUS_QPS |
+Integer | +100 |
+If status is enabled, controls the QPS with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config QPS | +
PILOT_STATUS_UPDATE_INTERVAL |
+Time Duration | +500ms |
+Interval to update the XDS distribution status. | +
PILOT_TRACE_SAMPLING |
+Floating-Point | +1 |
+Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 1.0. | +
PILOT_WORKLOAD_ENTRY_GRACE_PERIOD |
+Time Duration | +10s |
+The amount of time an auto-registered workload can remain disconnected from all Pilot instances before the associated WorkloadEntry is cleaned up. | +
PILOT_XDS_CACHE_INDEX_CLEAR_INTERVAL |
+Time Duration | +5s |
+The interval for xds cache index clearing. | +
PILOT_XDS_CACHE_SIZE |
+Integer | +60000 |
+The maximum number of cache entries for the XDS cache. | +
PILOT_XDS_CACHE_STATS |
+Boolean | +false |
+If true, Pilot will collect metrics for XDS cache efficiency. | +
PILOT_XDS_SEND_TIMEOUT |
+Time Duration | +0s |
+The timeout to send the XDS configuration to proxies. After this timeout is reached, Pilot will discard that push. | +
PKCS8_KEY |
+Boolean | +false |
+Whether to generate PKCS#8 private keys | +
PLATFORM |
+String | + |
+Platform where Istio is deployed. Possible values are "openshift" and "gcp" | +
POD_NAME |
+String | + |
++ |
POD_NAMESPACE |
+String | + |
++ |
PROV_CERT |
+String | + |
+Set to a directory containing provisioned certs, for VMs | +
PROXY_CONFIG |
+String | + |
+The proxy configuration. This will be set by the injection - gateways will use file mounts. | +
PROXY_CONFIG_XDS_AGENT |
+Boolean | +false |
+If set to true, agent retrieves dynamic proxy-config updates via xds channel | +
PROXY_XDS_DEBUG_VIA_AGENT |
+Boolean | +true |
+If set to true, the agent will listen on tap port and offer pilot's XDS istio.io/debug debug API there. | +
PROXY_XDS_DEBUG_VIA_AGENT_PORT |
+Integer | +15004 |
+Agent debugging port. | +
REQUIRE_3P_TOKEN |
+Boolean | +false |
+Reject k8s default tokens, without audience. If false, default K8S token will be accepted | +
RESOLVE_HOSTNAME_GATEWAYS |
+Boolean | +true |
+If true, hostnames in the LoadBalancer addresses of a Service will be resolved at the control plane for use in cross-network gateways. | +
REWRITE_PROBE_LEGACY_LOCALHOST_DESTINATION |
+Boolean | +false |
+If enabled, readiness probes will be sent to 'localhost'. Otherwise, they will be sent to the Pod's IP, matching Kubernetes' behavior. | +
SECRET_GRACE_PERIOD_RATIO |
+Floating-Point | +0.5 |
+The grace period ratio for the cert rotation, by default 0.5. | +
SECRET_TTL |
+Time Duration | +24h0m0s |
+The cert lifetime requested by istio agent | +
SERVICE_ACCOUNT |
+String | + |
+Name of service account | +
SHARED_MESH_CONFIG |
+String | + |
+Additional config map to load for shared MeshConfig settings. The standard mesh config will take precedence. | +
TOKEN_AUDIENCES |
+String | +istio-ca |
+A list of comma separated audiences to check in the JWT token before issuing a certificate. The token is accepted if it matches with one of the audiences | +
TRUSTED_GATEWAY_CIDR |
+String | + |
+If set, any connections from gateway to Istiod with this CIDR range are treated as trusted for using authentication mechanisms like XFCC. This can only be used when the network where Istiod and the authenticating gateways are running in a trusted/secure network | +
TRUST_DOMAIN |
+String | +cluster.local |
+The trust domain for spiffe certificates | +
UNSAFE_ENABLE_ADMIN_ENDPOINTS |
+Boolean | +false |
+If this is set to true, dangerous admin endpoints will be exposed on the debug interface. Not recommended for production. | +
UNSAFE_PILOT_ENABLE_DELTA_TEST |
+Boolean | +false |
+If enabled, addition runtime tests for Delta XDS efficiency are added. These checks are extremely expensive, so this should be used only for testing, not production. | +
UNSAFE_PILOT_ENABLE_RUNTIME_ASSERTIONS |
+Boolean | +false |
+If enabled, addition runtime asserts will be performed. These checks are both expensive and panic on failure. As a result, this should be used only for testing. | +
USE_EXTERNAL_WORKLOAD_SDS |
+Boolean | +false |
+When set to true, the istio-agent will require an external SDS and will throw an error if the workload SDS socket is not found | +
VALIDATION_WEBHOOK_CONFIG_NAME |
+String | +istio-istio-system |
+If not empty, the controller will automatically patch validatingwebhookconfiguration when the CA certificate changes. Only works in kubernetes environment. | +
VERIFY_CERTIFICATE_AT_CLIENT |
+Boolean | +false |
+If enabled, certificates received by the proxy will be verified against the OS CA certificate bundle. | +
VERIFY_SDS_CERTIFICATE |
+Boolean | +true |
+If enabled, certificates fetched from SDS server will be verified before sending back to proxy. | +
WASM_HTTP_REQUEST_MAX_RETRIES |
+Integer | +5 |
+maximum number of HTTP/HTTPS request retries for pulling a Wasm module via http/https | +
WASM_HTTP_REQUEST_TIMEOUT |
+Time Duration | +15s |
+timeout per a HTTP request for pulling a Wasm module via http/https | +
WASM_INSECURE_REGISTRIES |
+String | + |
+allow agent pull wasm plugin from insecure registries or https server, for example: 'localhost:5000,docker-registry:5000' | +
WASM_MODULE_EXPIRY |
+Time Duration | +24h0m0s |
+cache expiration duration for a wasm module. | +
WASM_PURGE_INTERVAL |
+Time Duration | +1h0m0s |
+interval between checking the expiration of wasm modules | +
WORKLOAD_RSA_KEY_SIZE |
+Integer | +2048 |
+Specify the RSA key size to use for workload certificates. | +
XDS_AUTH |
+Boolean | +true |
+If true, will authenticate XDS clients. | +
XDS_AUTH_PLAINTEXT |
+Boolean | +false |
+authenticate plain text requests - used if Istiod is running on a secure/trusted network | +
XDS_AUTH_PROVIDER |
+String | + |
+Provider for XDS auth | +
XDS_ROOT_CA |
+String | + |
+Explicitly set the root CA to expect for the XDS connection. | +
| Metric Name | Type | Description |
|---|---|---|
auto_registration_deletes_total | Sum | Total number of auto registration cleaned up by periodic timer. |
auto_registration_errors_total | Sum | Total number of auto registration errors. |
auto_registration_success_total | Sum | Total number of successful auto registrations. |
auto_registration_unregister_total | Sum | Total number of unregistrations. |
auto_registration_updates_total | Sum | Total number of auto registration updates. |
cert_expiry_seconds | LastValue | The time remaining, in seconds, before the certificate chain will expire. A negative value indicates the cert is expired. |
controller_sync_errors_total | Sum | Total number of errorMetric syncing controllers. |
dns_requests_total | Sum | Total number of DNS requests. |
dns_upstream_failures_total | Sum | Total number of DNS requests forwarded to upstream. |
dns_upstream_request_duration_seconds | Distribution | Total time in seconds Istio takes to get DNS response from upstream. |
dns_upstream_requests_total | Sum | Total number of DNS requests forwarded to upstream. |
endpoint_no_pod | LastValue | Endpoints without an associated pod. |
envoy_connection_terminations | Sum | The total number of connection errors from envoy |
istio_build | LastValue | Istio component build info |
istiod_connection_failures | Sum | The total number of connection failures to Istiod |
istiod_connection_terminations | Sum | The total number of connection errors to Istiod |
istiod_managed_clusters | LastValue | Number of clusters managed by istiod |
num_failed_outgoing_requests | Sum | Number of failed outgoing requests (e.g. to a token exchange server, CA, etc.) |
num_file_secret_failures_total | Sum | Number of times secret generation failed for files |
num_file_watcher_failures_total | Sum | Number of times file watcher failed to add watchers |
num_outgoing_requests | Sum | Number of total outgoing requests (e.g. to a token exchange server, CA, etc.) |
num_outgoing_retries | Sum | Number of outgoing retry requests (e.g. to a token exchange server, CA, etc.) |
outgoing_latency | Sum | The latency of outgoing requests (e.g. to a token exchange server, CA, etc.) in milliseconds. |
pilot_conflict_inbound_listener | LastValue | Number of conflicting inbound listeners. |
pilot_conflict_outbound_listener_tcp_over_current_tcp | LastValue | Number of conflicting tcp listeners with current tcp listener. |
pilot_debounce_time | Distribution | Delay in seconds between the first config enters debouncing and the merged push request is pushed into the push queue. |
pilot_destrule_subsets | LastValue | Duplicate subsets across destination rules for same host |
pilot_dns_cluster_without_endpoints | LastValue | DNS clusters without endpoints caused by the endpoint field in STRICT_DNS type cluster is not set or the corresponding subset cannot select any endpoint |
pilot_duplicate_envoy_clusters | LastValue | Duplicate envoy clusters caused by service entries with same hostname |
pilot_eds_no_instances | LastValue | Number of clusters without instances. |
pilot_endpoint_not_ready | LastValue | Endpoint found in unready state. |
pilot_envoy_filter_status | LastValue | Status of Envoy filters whether it was applied or errored. |
pilot_inbound_updates | Sum | Total number of updates received by pilot. |
pilot_jwks_resolver_network_fetch_fail_total | Sum | Total number of failed network fetch by pilot jwks resolver |
pilot_jwks_resolver_network_fetch_success_total | Sum | Total number of successfully network fetch by pilot jwks resolver |
pilot_k8s_cfg_events | Sum | Events from k8s config. |
pilot_k8s_endpoints_pending_pod | LastValue | Number of endpoints that do not currently have any corresponding pods. |
pilot_k8s_endpoints_with_no_pods | Sum | Endpoints that does not have any corresponding pods. |
pilot_k8s_reg_events | Sum | Events from k8s registry. |
pilot_no_ip | LastValue | Pods not found in the endpoint table, possibly invalid. |
pilot_proxy_convergence_time | Distribution | Delay in seconds between config change and a proxy receiving all required configuration. |
pilot_proxy_queue_time | Distribution | Time in seconds, a proxy is in the push queue before being dequeued. |
pilot_push_triggers | Sum | Total number of times a push was triggered, labeled by reason for the push. |
pilot_pushcontext_init_seconds | Distribution | Total time in seconds Pilot takes to init pushContext. |
pilot_sds_certificate_errors_total | Sum | Total number of failures to fetch SDS key and certificate. |
pilot_services | LastValue | Total services known to pilot. |
pilot_total_rejected_configs | Sum | Total number of configs that Pilot had to reject or ignore. |
pilot_total_xds_internal_errors | Sum | Total number of internal XDS errors in pilot. |
pilot_total_xds_rejects | Sum | Total number of XDS responses from pilot rejected by proxy. |
pilot_virt_services | LastValue | Total virtual services known to pilot. |
pilot_vservice_dup_domain | LastValue | Virtual services with dup domains. |
pilot_worker_queue_depth | LastValue | Depth of the controller queues |
pilot_worker_queue_duration | Distribution | Time taken to process an item |
pilot_worker_queue_latency | Distribution | Latency before the item is processed |
pilot_xds | LastValue | Number of endpoints connected to this pilot using XDS. |
pilot_xds_cds_reject | LastValue | Pilot rejected CDS configs. |
pilot_xds_config_size_bytes | Distribution | Distribution of configuration sizes pushed to clients |
pilot_xds_eds_reject | LastValue | Pilot rejected EDS. |
pilot_xds_expired_nonce | Sum | Total number of XDS requests with an expired nonce. |
pilot_xds_lds_reject | LastValue | Pilot rejected LDS. |
pilot_xds_push_context_errors | Sum | Number of errors (timeouts) initiating push context. |
pilot_xds_push_time | Distribution | Total time in seconds Pilot takes to push lds, rds, cds and eds. |
pilot_xds_pushes | Sum | Pilot build and send errors for lds, rds, cds and eds. |
pilot_xds_rds_reject | LastValue | Pilot rejected RDS. |
pilot_xds_send_time | Distribution | Total time in seconds Pilot takes to send generated configuration. |
pilot_xds_write_timeout | Sum | Pilot XDS response write timeouts. |
provider_lookup_cluster_failures | Sum | Number of times a cluster lookup failed |
remote_cluster_sync_timeouts_total | Sum | Number of times remote clusters took too long to sync, causing slow startup that excludes remote clusters. |
scrape_failures_total | Sum | The total number of failed scrapes. |
scrapes_total | Sum | The total number of scrapes. |
sidecar_injection_failure_total | Sum | Total number of failed sidecar injection requests. |
sidecar_injection_requests_total | Sum | Total number of sidecar injection requests. |
sidecar_injection_skip_total | Sum | Total number of skipped sidecar injection requests. |
sidecar_injection_success_total | Sum | Total number of successful sidecar injection requests. |
sidecar_injection_time_seconds | Distribution | Total time taken for injection in seconds. |
startup_duration_seconds | LastValue | The time from the process starting to being marked ready. |
wasm_cache_entries | LastValue | number of Wasm remote fetch cache entries. |
wasm_cache_lookup_count | Sum | number of Wasm remote fetch cache lookups. |
wasm_config_conversion_count | Sum | number of Wasm config conversion count and results, including success, no remote load, marshal failure, remote fetch failure, miss remote fetch hint. |
wasm_config_conversion_duration | Distribution | Total time in milliseconds istio-agent spends on converting remote load in Wasm config. |
wasm_remote_fetch_count | Sum | number of Wasm remote fetches and results, including success, download failure, and checksum mismatch. |
webhook_patch_attempts_total | Sum | Webhook patching attempts |
webhook_patch_failures_total | Sum | Webhook patching total failures |
webhook_patch_retries_total | Sum | Webhook patching retries |
xds_cache_dependent_config_size | LastValue | Current size of dependent configs |
xds_cache_evictions | Sum | Total number of xds cache evictions. |
xds_cache_reads | Sum | Total number of xds cache xdsCacheReads. |
xds_cache_size | LastValue | Current size of xds cache |
xds_proxy_requests | Sum | The total number of Xds Proxy Requests |
xds_proxy_responses | Sum | The total number of Xds Proxy Responses |
Istio Pilot provides mesh-wide traffic management, security and policy capabilities in the Istio Service Mesh.
+| Flags | +Description | +
|---|---|
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for pilot-discovery for the specified shell. +See each sub-command's help for details on how to use the generated script. +
+| Flags | +Description | +
|---|---|
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the bash shell.
+This script depends on the 'bash-completion' package. +If it is not installed already, you can install it via your OS's package manager.
+To load completions in your current shell session:
+source <(pilot-discovery completion bash)
+To load completions for every new session, execute once:
+#### Linux:
+pilot-discovery completion bash > /etc/bash_completion.d/pilot-discovery
+#### macOS:
+pilot-discovery completion bash > $(brew --prefix)/etc/bash_completion.d/pilot-discovery
+You will need to start a new shell for this setup to take effect. +
+pilot-discovery completion bash
+| Flags | +Description | +
|---|---|
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the fish shell.
+To load completions in your current shell session:
+pilot-discovery completion fish | source
+To load completions for every new session, execute once:
+pilot-discovery completion fish > ~/.config/fish/completions/pilot-discovery.fish
+You will need to start a new shell for this setup to take effect. +
+pilot-discovery completion fish [flags]
+| Flags | +Description | +
|---|---|
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for powershell.
+To load completions in your current shell session:
+pilot-discovery completion powershell | Out-String | Invoke-Expression
+To load completions for every new session, add the output of the above command +to your powershell profile. +
+pilot-discovery completion powershell [flags]
+| Flags | +Description | +
|---|---|
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Generate the autocompletion script for the zsh shell.
+If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once:
+echo "autoload -U compinit; compinit" >> ~/.zshrc
+To load completions in your current shell session:
+source <(pilot-discovery completion zsh)
+To load completions for every new session, execute once:
+#### Linux:
+pilot-discovery completion zsh > "${fpath[1]}/_pilot-discovery"
+#### macOS:
+pilot-discovery completion zsh > $(brew --prefix)/share/zsh/site-functions/_pilot-discovery
+You will need to start a new shell for this setup to take effect. +
+pilot-discovery completion zsh [flags]
+| Flags | +Description | +
|---|---|
--no-descriptions |
+disable completion descriptions | +
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Start Istio proxy discovery service.
+pilot-discovery discovery [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--caCertFile <string> |
++ | File containing the x509 Server CA Certificate (default ``) | +
--clusterAliases <stringToString> |
++ | Alias names for clusters (default `[]`) | +
--clusterID <string> |
++ | The ID of the cluster that this Istiod instance resides (default `Kubernetes`) | +
--clusterRegistriesNamespace <string> |
++ | Namespace for ConfigMap which stores clusters configs (default `istio-system`) | +
--configDir <string> |
++ | Directory to watch for updates to config yaml files. If specified, the files will be used as the source of config, rather than a CRD client. (default ``) | +
--ctrlz_address <string> |
++ | The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `localhost`) | +
--ctrlz_port <uint16> |
++ | The IP port to use for the ControlZ introspection facility (default `9876`) | +
--domain <string> |
++ | DNS domain suffix (default `cluster.local`) | +
--grpcAddr <string> |
++ | Discovery service gRPC address (default `:15010`) | +
--httpAddr <string> |
++ | Discovery service HTTP address (default `:8080`) | +
--httpsAddr <string> |
++ | Injection and validation service HTTPS address (default `:15017`) | +
--keepaliveInterval <duration> |
++ | The time interval if no activity on the connection it pings the peer to see if the transport is alive (default `30s`) | +
--keepaliveMaxServerConnectionAge <duration> |
++ | Maximum duration a connection will be kept open on the server before a graceful close. (default `2562047h47m16.854775807s`) | +
--keepaliveTimeout <duration> |
++ | After having pinged for keepalive check, the client/server waits for a duration of keepaliveTimeout and if no activity is seen even after that the connection is closed. (default `10s`) | +
--kubeconfig <string> |
++ | Use a Kubernetes configuration file instead of in-cluster configuration (default ``) | +
--kubernetesApiBurst <int> |
++ | Maximum burst for throttle when communicating with the kubernetes API (default `160`) | +
--kubernetesApiQPS <float32> |
++ | Maximum QPS when communicating with the kubernetes API (default `80`) | +
--log_as_json |
++ | Whether to format output as JSON or in plain console-friendly format | +
--log_caller <string> |
++ | Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, file, gateway, grpcgen, ingress status, klog, kube, model, monitor, monitoring, pkica, pkira, processing, retry, rootcertrotator, secretcontroller, security, serverca, serviceentry, spiffe, status, trustBundle, validation, validationController, validationServer, wasm, wle] (default ``) | +
--log_output_level <string> |
++ | 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, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, file, gateway, grpcgen, ingress status, klog, kube, model, monitor, monitoring, pkica, pkira, processing, retry, rootcertrotator, secretcontroller, security, serverca, serviceentry, spiffe, status, trustBundle, validation, validationController, validationServer, wasm, wle] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | +
--log_rotate <string> |
++ | The path for the optional rotating log file (default ``) | +
--log_rotate_max_age <int> |
++ | The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`) | +
--log_rotate_max_backups <int> |
++ | The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) | +
--log_rotate_max_size <int> |
++ | The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) | +
--log_stacktrace_level <string> |
++ | Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [ads, adsc, all, analysis, authn, authorization, ca, controllers, default, delta, file, gateway, grpcgen, ingress status, klog, kube, model, monitor, monitoring, pkica, pkira, processing, retry, rootcertrotator, secretcontroller, security, serverca, serviceentry, spiffe, status, trustBundle, validation, validationController, validationServer, wasm, wle] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`) | +
--log_target <stringArray> |
++ | The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`) | +
--meshConfig <string> |
++ | File name for Istio mesh configuration. If not specified, a default mesh will be used. (default `./etc/istio/config/mesh`) | +
--monitoringAddr <string> |
++ | HTTP address to use for pilot's self-monitoring information (default `:15014`) | +
--namespace <string> |
+-n |
+Select a namespace where the controller resides. If not set, uses ${POD_NAMESPACE} environment variable (default `istio-system`) | +
--networksConfig <string> |
++ | File name for Istio mesh networks configuration. If not specified, a default mesh networks will be used. (default `./etc/istio/config/meshNetworks`) | +
--profile |
++ | Enable profiling via web interface host:port/debug/pprof | +
--registries <stringSlice> |
++ | Comma separated list of platform service registries to read from (choose one or more from {Kubernetes, Mock}) (default `[Kubernetes]`) | +
--secureGRPCAddr <string> |
++ | Discovery service secured gRPC address (default `:15012`) | +
--shutdownDuration <duration> |
++ | Duration the discovery server needs to terminate gracefully (default `10s`) | +
--tls-cipher-suites <stringSlice> |
++ | Comma-separated list of cipher suites for istiod TLS server. If omitted, the default Go cipher suites will be used. +Preferred values: TLS_AES_128_GCM_SHA256, TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_GCM_SHA384. +Insecure values: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_RC4_128_SHA, TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_RC4_128_SHA, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_RC4_128_SHA. (default `[]`) | +
--tlsCertFile <string> |
++ | File containing the x509 Server Certificate (default ``) | +
--tlsKeyFile <string> |
++ | File containing the x509 private key matching --tlsCertFile (default ``) | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Makes an HTTP request to Pilot metrics/debug endpoint
+pilot-discovery request <method> <path> [<body>] [flags]
+| Flags | +Description | +
|---|---|
--vklog <Level> |
+number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
Prints out build version information
+pilot-discovery version [flags]
+| Flags | +Shorthand | +Description | +
|---|---|---|
--output <string> |
+-o |
+One of 'yaml' or 'json'. (default ``) | +
--short |
+-s |
+Use --short=false to generate full version information | +
--vklog <Level> |
++ | number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`) | +
pilot-discovery command. Please use with caution as these environment variables are experimental and can change anytime.
+| Variable Name | +Type | +Default Value | +Description | +
|---|---|---|---|
AUDIENCE |
+String | + |
+Expected audience in the tokens. | +
CA_TRUSTED_NODE_ACCOUNTS |
+String | + |
+If set, the list of service accounts that are allowed to use node authentication for CSRs. Node authentication allows an identity to create CSRs on behalf of other identities, but only if there is a pod running on the same node with that identity. This is intended for use with node proxies. | +
CERT_SIGNER_DOMAIN |
+String | + |
+The cert signer domain info | +
CITADEL_ENABLE_JITTER_FOR_ROOT_CERT_ROTATOR |
+Boolean | +true |
+If true, set up a jitter to start root cert rotator. Jitter selects a backoff time in seconds to start root cert rotator, and the back off time is below root cert check interval. | +
CITADEL_SELF_SIGNED_CA_CERT_TTL |
+Time Duration | +87600h0m0s |
+The TTL of self-signed CA root certificate. | +
CITADEL_SELF_SIGNED_CA_RSA_KEY_SIZE |
+Integer | +2048 |
+Specify the RSA key size to use for self-signed Istio CA certificates. | +
CITADEL_SELF_SIGNED_ROOT_CERT_CHECK_INTERVAL |
+Time Duration | +1h0m0s |
+The interval that self-signed CA checks its root certificate expiration time and rotates root certificate. Setting this interval to zero or a negative value disables automated root cert check and rotation. This interval is suggested to be larger than 10 minutes. | +
CITADEL_SELF_SIGNED_ROOT_CERT_GRACE_PERIOD_PERCENTILE |
+Integer | +20 |
+Grace period percentile for self-signed root cert. | +
CLOUD_PLATFORM |
+String | + |
+Cloud Platform on which proxy is running, if not specified, Istio will try to discover the platform. Valid platform values are aws, azure, gcp, none | +
CLUSTER_ID |
+String | +Kubernetes |
+Defines the cluster and service registry that this Istiod instance belongs to | +
DEFAULT_WORKLOAD_CERT_TTL |
+Time Duration | +24h0m0s |
+The default TTL of issued workload certificates. Applied when the client sets a non-positive TTL in the CSR. | +
ENABLE_AUTO_SNI |
+Boolean | +false |
+If enabled, automatically set SNI when `DestinationRules` do not specify the same | +
ENABLE_CA_SERVER |
+Boolean | +true |
+If this is set to false, will not create CA server in istiod. | +
ENABLE_DEBUG_ON_HTTP |
+Boolean | +true |
+If this is set to false, the debug interface will not be enabled, recommended for production | +
ENABLE_ENHANCED_RESOURCE_SCOPING |
+Boolean | +false |
+If enabled, meshConfig.discoverySelectors will limit the CustomResource configurations(like Gateway,VirtualService,DestinationRule,Ingress, etc)that can be processed by pilot. This will also restrict the root-ca certificate distribution. | +
ENABLE_HCM_INTERNAL_NETWORKS |
+Boolean | +false |
+If enable, endpoints defined in mesh networks will be configured as internal addresses in Http Connection Manager | +
ENABLE_LEADER_ELECTION |
+Boolean | +true |
+If enabled (default), starts a leader election client and gains leadership before executing controllers. If false, it assumes that only one instance of istiod is running and skips leader election. | +
ENABLE_MCS_AUTO_EXPORT |
+Boolean | +false |
+If enabled, istiod will automatically generate Kubernetes Multi-Cluster Services (MCS) ServiceExport resources for every service in the mesh. Services defined to be cluster-local in MeshConfig are excluded. | +
ENABLE_MCS_CLUSTER_LOCAL |
+Boolean | +false |
+If enabled, istiod will treat the host `<svc>.<namespace>.svc.cluster.local` as defined by the Kubernetes Multi-Cluster Services (MCS) spec. In this mode, requests to `cluster.local` will be routed to only those endpoints residing within the same cluster as the client. Requires that both ENABLE_MCS_SERVICE_DISCOVERY and ENABLE_MCS_HOST also be enabled. | +
ENABLE_MCS_HOST |
+Boolean | +false |
+If enabled, istiod will configure a Kubernetes Multi-Cluster Services (MCS) host (<svc>.<namespace>.svc.clusterset.local) for each service exported (via ServiceExport) in at least one cluster. Clients must, however, be able to successfully lookup these DNS hosts. That means that either Istio DNS interception must be enabled or an MCS controller must be used. Requires that ENABLE_MCS_SERVICE_DISCOVERY also be enabled. | +
ENABLE_MCS_SERVICE_DISCOVERY |
+Boolean | +false |
+If enabled, istiod will enable Kubernetes Multi-Cluster Services (MCS) service discovery mode. In this mode, service endpoints in a cluster will only be discoverable within the same cluster unless explicitly exported via ServiceExport. | +
ENABLE_MULTICLUSTER_HEADLESS |
+Boolean | +true |
+If true, the DNS name table for a headless service will resolve to same-network endpoints in any cluster. | +
ENABLE_NATIVE_SIDECARS |
+Boolean | +false |
+If set, used Kubernetes native Sidecar container support. Requires SidecarContainer feature flag. | +
ENABLE_OPTIMIZED_CONFIG_REBUILD |
+Boolean | +true |
+If enabled, pilot will only rebuild config for resources that have changed | +
ENABLE_OTEL_BUILTIN_RESOURCE_LABELS |
+Boolean | +false |
+If enabled, envoy will send builtin lables(e.g. node_name) via OTel sink. | +
ENABLE_PROBE_KEEPALIVE_CONNECTIONS |
+Boolean | +false |
+If enabled, readiness probes will keep the connection from pilot-agent to the application alive. This mirrors older Istio versions' behaviors, but not kubelet's. | +
ENABLE_TLS_ON_SIDECAR_INGRESS |
+Boolean | +false |
+If enabled, the TLS configuration on Sidecar.ingress will take effect | +
EXTERNAL_CA |
+String | + |
+External CA Integration Type. Permitted Values are ISTIOD_RA_KUBERNETES_API or ISTIOD_RA_ISTIO_API | +
EXTERNAL_ISTIOD |
+Boolean | +false |
+If this is set to true, one Istiod will control remote clusters including CA. | +
GCP_METADATA |
+String | + |
+Pipe separated GCP metadata, schemed as PROJECT_ID|PROJECT_NUMBER|CLUSTER_NAME|CLUSTER_ZONE | +
GCP_QUOTA_PROJECT |
+String | + |
+Allows specification of a quota project to be used in requests to GCP APIs. | +
GRPC_KEEPALIVE_INTERVAL |
+Time Duration | +30s |
+gRPC Keepalive Interval | +
GRPC_KEEPALIVE_TIMEOUT |
+Time Duration | +10s |
+gRPC Keepalive Timeout | +
HTTP_STRIP_FRAGMENT_FROM_PATH_UNSAFE_IF_DISABLED |
+Boolean | +true |
++ |
INBOUND_INTERCEPTION_MODE |
+String | + |
+The mode used to redirect inbound connections to Envoy, either "REDIRECT" or "TPROXY" | +
INBOUND_TPROXY_MARK |
+String | + |
++ |
INJECTION_WEBHOOK_CONFIG_NAME |
+String | +istio-sidecar-injector |
+Name of the mutatingwebhookconfiguration to patch, if istioctl is not used. | +
INJECT_ENABLED |
+Boolean | +true |
+Enable mutating webhook handler. | +
ISTIOD_CUSTOM_HOST |
+String | + |
+Custom host name of istiod that istiod signs the server cert. Multiple custom host names are supported, and multiple values are separated by commas. | +
ISTIO_AGENT_ENABLE_WASM_REMOTE_LOAD_CONVERSION |
+Boolean | +true |
+If enabled, Istio agent will intercept ECDS resource update, downloads Wasm module, and replaces Wasm module remote load with downloaded local module file. | +
ISTIO_BOOTSTRAP |
+String | + |
++ |
ISTIO_DELTA_XDS |
+Boolean | +false |
+If enabled, pilot will only send the delta configs as opposed to the state of the world on a Resource Request. This feature uses the delta xds api, but does not currently send the actual deltas. | +
ISTIO_DUAL_STACK |
+Boolean | +false |
+If true, Istio will enable the Dual Stack feature. | +
ISTIO_ENABLE_CONTROLLER_QUEUE_METRICS |
+Boolean | +false |
+If enabled, publishes metrics for queue depth, latency and processing times. | +
ISTIO_ENABLE_HTTP2_PROBING |
+Boolean | +true |
+If enabled, HTTP2 probes will be enabled for HTTPS probes, following Kubernetes | +
ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSH |
+Boolean | +true |
+If enabled, Istiod will not push changes on arbitrary annotation change. | +
ISTIO_GPRC_MAXRECVMSGSIZE |
+Integer | +4194304 |
+Sets the max receive buffer size of gRPC stream in bytes. | +
ISTIO_GPRC_MAXSTREAMS |
+Integer | +100000 |
+Sets the maximum number of concurrent grpc streams. | +
ISTIO_KUBE_CLIENT_CONTENT_TYPE |
+String | +protobuf |
+The content type to use for Kubernetes clients. Defaults to protobuf. Valid options: [protobuf, json] | +
ISTIO_MULTIROOT_MESH |
+Boolean | +false |
+If enabled, mesh will support certificates signed by more than one trustAnchor for ISTIO_MUTUAL mTLS | +
ISTIO_OUTBOUND_OWNER_GROUPS |
+String | +* |
+Comma separated list of groups whose outgoing traffic is to be redirected to Envoy. +A group can be specified either by name or by a numeric GID. +The wildcard character "*" can be used to configure redirection of traffic from all groups. | +
ISTIO_OUTBOUND_OWNER_GROUPS_EXCLUDE |
+String | + |
+Comma separated list of groups whose outgoing traffic is to be excluded from redirection to Envoy. +A group can be specified either by name or by a numeric GID. +Only applies when traffic from all groups (i.e. "*") is being redirected to Envoy. | +
ISTIO_PROMETHEUS_ANNOTATIONS |
+String | + |
++ |
ISTIO_WATCH_NAMESPACE |
+String | + |
+If set, limit Kubernetes watches to a single namespace. Warning: only a single namespace can be set. | +
ISTIO_WORKLOAD_ENTRY_VALIDATE_IDENTITY |
+Boolean | +true |
+If enabled, will validate the identity of a workload matches the identity of the WorkloadEntry it is associating with for health checks and auto registration. This flag is added for backwards compatibility only and will be removed in future releases | +
JWKS_RESOLVER_INSECURE_SKIP_VERIFY |
+Boolean | +false |
+If enabled, istiod will skip verifying the certificate of the JWKS server. | +
JWT_POLICY |
+String | +third-party-jwt |
+The JWT validation policy. | +
JWT_RULE |
+String | + |
+The JWT rule used by istiod authentication | +
K8S_INGRESS_NS |
+String | +istio-system |
++ |
K8S_SIGNER |
+String | + |
+Kubernetes CA Signer type. Valid from Kubernetes 1.18 | +
KUBERNETES_SERVICE_HOST |
+String | + |
+Kubernetes service host, set automatically when running in-cluster | +
K_REVISION |
+String | + |
+KNative revision, set if running in knative | +
LABEL_CANONICAL_SERVICES_FOR_MESH_EXTERNAL_SERVICE_ENTRIES |
+Boolean | +false |
+If enabled, metadata representing canonical services for ServiceEntry resources with a location of mesh_external will be populatedin the cluster metadata for those endpoints. | +
LOCAL_CLUSTER_SECRET_WATCHER |
+Boolean | +false |
+If enabled, the cluster secret watcher will watch the namespace of the external cluster instead of config cluster | +
MAX_WORKLOAD_CERT_TTL |
+Time Duration | +2160h0m0s |
+The max TTL of issued workload certificates. | +
MCS_API_GROUP |
+String | +multicluster.x-k8s.io |
+The group to be used for the Kubernetes Multi-Cluster Services (MCS) API. | +
MCS_API_VERSION |
+String | +v1alpha1 |
+The version to be used for the Kubernets Multi-Cluster Services (MCS) API. | +
METRIC_GRACEFUL_DELETION_INTERVAL |
+Time Duration | +5m0s |
+Metric expiry graceful deletion interval. No-op if METRIC_ROTATION_INTERVAL is disabled. | +
METRIC_ROTATION_INTERVAL |
+Time Duration | +0s |
+Metric scope rotation interval, set to 0 to disable the metric scope rotation | +
MUTEX_PROFILE_FRACTION |
+Integer | +1000 |
+If set to a non-zero value, enables mutex profiling a rate of 1/MUTEX_PROFILE_FRACTION events. For example, '1000' will record 0.1% of events. Set to 0 to disable entirely. | +
NATIVE_METADATA_EXCHANGE |
+Boolean | +true |
+If set, uses a native implementation of the HTTP metadata exchange filter | +
PILOT_ALLOW_SIDECAR_SERVICE_INBOUND_LISTENER_MERGE |
+Boolean | +false |
+If set, it allows creating inbound listeners for service ports and sidecar ingress listeners | +
PILOT_ANALYSIS_INTERVAL |
+Time Duration | +10s |
+If analysis is enabled, pilot will run istio analyzers using this value as interval in seconds Istio Resources | +
PILOT_CERT_PROVIDER |
+String | +istiod |
+The provider of Pilot DNS certificate. | +
PILOT_DEBOUNCE_AFTER |
+Time Duration | +100ms |
+The delay added to config/registry events for debouncing. This will delay the push by at least this interval. If no change is detected within this period, the push will happen, otherwise we'll keep delaying until things settle, up to a max of PILOT_DEBOUNCE_MAX. | +
PILOT_DEBOUNCE_MAX |
+Time Duration | +10s |
+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. | +
PILOT_DISTRIBUTION_HISTORY_RETENTION |
+Time Duration | +1m0s |
+If enabled, Pilot will keep track of old versions of distributed config for this duration. | +
PILOT_DRAINING_LABEL |
+String | +istio.io/draining |
+If not empty, endpoints with the label value present will be sent with status DRAINING. | +
PILOT_ENABLE_ALPHA_GATEWAY_API |
+Boolean | +false |
+If this is set to true, support for alpha APIs in the Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed. | +
PILOT_ENABLE_ALPN_FILTER |
+Boolean | +true |
+If true, pilot will add Istio ALPN filters, required for proper protocol sniffing. | +
PILOT_ENABLE_AMBIENT_CONTROLLERS |
+Boolean | +false |
+If enabled, controllers required for ambient will run. This is required to run ambient mesh. | +
PILOT_ENABLE_ANALYSIS |
+Boolean | +false |
+If enabled, pilot will run istio analyzers and write analysis errors to the Status field of any Istio Resources | +
PILOT_ENABLE_CDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache CDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE. | +
PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING |
+Boolean | +false |
+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. | +
PILOT_ENABLE_CROSS_CLUSTER_WORKLOAD_ENTRY |
+Boolean | +true |
+If enabled, pilot will read WorkloadEntry from other clusters, selectable by Services in that cluster. | +
PILOT_ENABLE_EDS_DEBOUNCE |
+Boolean | +true |
+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 | +
PILOT_ENABLE_EDS_FOR_HEADLESS_SERVICES |
+Boolean | +false |
+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. | +
PILOT_ENABLE_GATEWAY_API |
+Boolean | +true |
+If this is set to true, support for Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed. | +
PILOT_ENABLE_GATEWAY_API_DEPLOYMENT_CONTROLLER |
+Boolean | +true |
+If this is set to true, gateway-api resources will automatically provision in cluster deployment, services, etc | +
PILOT_ENABLE_GATEWAY_API_GATEWAYCLASS_CONTROLLER |
+Boolean | +true |
+If this is set to true, istiod will create and manage its default GatewayClasses | +
PILOT_ENABLE_GATEWAY_API_STATUS |
+Boolean | +true |
+If this is set to true, gateway-api resources will have status written to them | +
PILOT_ENABLE_HBONE |
+Boolean | +false |
+If enabled, HBONE support can be configured for proxies. Note: proxies must opt in on a per-proxy basis with ENABLE_HBONE to actually get HBONE config, in addition to this flag. | +
PILOT_ENABLE_HEADLESS_SERVICE_POD_LISTENERS |
+Boolean | +true |
+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. | +
PILOT_ENABLE_INBOUND_PASSTHROUGH |
+Boolean | +true |
+If enabled, inbound clusters will be configured as ORIGINAL_DST clusters. When disabled, requests are always sent to localhost. The primary implication of this is that when enabled, binding to POD_IP will work while localhost will not; when disable, bind to POD_IP will not work, while localhost will. The enabled behavior matches the behavior without Istio enabled at all; this flag exists only for backwards compatibility. Regardless of this setting, the configuration can be overridden with the Sidecar.Ingress.DefaultEndpoint configuration. | +
PILOT_ENABLE_K8S_SELECT_WORKLOAD_ENTRIES |
+Boolean | +true |
+If enabled, Kubernetes services with selectors will select workload entries with matching labels. It is safe to disable it if you are quite sure you don't need this feature | +
PILOT_ENABLE_METADATA_EXCHANGE |
+Boolean | +true |
+If true, pilot will add metadata exchange filters, which will be consumed by telemetry filter. | +
PILOT_ENABLE_MONGO_FILTER |
+Boolean | +true |
+EnableMongoFilter enables injection of `envoy.filters.network.mongo_proxy` in the filter chain. | +
PILOT_ENABLE_MYSQL_FILTER |
+Boolean | +false |
+EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain. | +
PILOT_ENABLE_PERSISTENT_SESSION_FILTER |
+Boolean | +false |
+If enabled, Istiod sets up persistent session filter for listeners, if services have 'PILOT_PERSISTENT_SESSION_LABEL' set. | +
PILOT_ENABLE_QUIC_LISTENERS |
+Boolean | +false |
+If true, QUIC listeners will be generated wherever there are listeners terminating TLS on gateways if the gateway service exposes a UDP port with the same number (for example 443/TCP and 443/UDP) | +
PILOT_ENABLE_RDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache RDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE. | +
PILOT_ENABLE_REDIS_FILTER |
+Boolean | +false |
+EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain. | +
PILOT_ENABLE_ROUTE_COLLAPSE_OPTIMIZATION |
+Boolean | +true |
+If true, Pilot will merge virtual hosts with the same routes into a single virtual host, as an optimization. | +
PILOT_ENABLE_SERVICEENTRY_SELECT_PODS |
+Boolean | +true |
+If enabled, service entries with selectors will select pods from the cluster. It is safe to disable it if you are quite sure you don't need this feature | +
PILOT_ENABLE_STATUS |
+Boolean | +false |
+If enabled, pilot will update the CRD Status field of all istio resources with reconciliation status. | +
PILOT_ENABLE_TELEMETRY_LABEL |
+Boolean | +true |
+If true, pilot will add telemetry related metadata to cluster and endpoint resources, which will be consumed by telemetry filter. | +
PILOT_ENABLE_WORKLOAD_ENTRY_AUTOREGISTRATION |
+Boolean | +true |
+Enables auto-registering WorkloadEntries based on associated WorkloadGroups upon XDS connection by the workload. | +
PILOT_ENABLE_WORKLOAD_ENTRY_HEALTHCHECKS |
+Boolean | +true |
+Enables automatic health checks of WorkloadEntries based on the config provided in the associated WorkloadGroup | +
PILOT_ENABLE_XDS_CACHE |
+Boolean | +true |
+If true, Pilot will cache XDS responses. | +
PILOT_ENABLE_XDS_IDENTITY_CHECK |
+Boolean | +true |
+If enabled, pilot will authorize XDS clients, to ensure they are acting only as namespaces they have permissions for. | +
PILOT_ENDPOINT_TELEMETRY_LABEL |
+Boolean | +true |
+If true, pilot will add telemetry related metadata to Endpoint resource, which will be consumed by telemetry filter. | +
PILOT_ENVOY_FILTER_STATS |
+Boolean | +false |
+If true, Pilot will collect metrics for envoy filter operations. | +
PILOT_FILTER_GATEWAY_CLUSTER_CONFIG |
+Boolean | +false |
+If enabled, Pilot will send only clusters that referenced in gateway virtual services attached to gateway | +
PILOT_HTTP10 |
+Boolean | +false |
+Enables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications. | +
PILOT_INSECURE_MULTICLUSTER_KUBECONFIG_OPTIONS |
+String | + |
+Comma separated list of potentially insecure kubeconfig authentication options that are allowed for multicluster authentication.Support values: all authProviders (`gcp`, `azure`, `exec`, `openstack`), `clientKey`, `clientCertificate`, `tokenFile`, and `exec`. | +
PILOT_JWT_ENABLE_REMOTE_JWKS |
+String | +false |
+Mode of fetching JWKs from JwksUri in RequestAuthentication. Supported value: istiod, false, hybrid, true, envoy. The client fetching JWKs is as following: istiod/false - Istiod; hybrid/true - Envoy and fallback to Istiod if JWKs server is external; envoy - Envoy. | +
PILOT_JWT_PUB_KEY_REFRESH_INTERVAL |
+Time Duration | +20m0s |
+The interval for istiod to fetch the jwks_uri for the jwks public key. | +
PILOT_MAX_REQUESTS_PER_SECOND |
+Floating-Point | +25 |
+Limits the number of incoming XDS requests per second. On larger machines this can be increased to handle more proxies concurrently. | +
PILOT_MULTI_NETWORK_DISCOVER_GATEWAY_API |
+Boolean | +false |
+If true, Pilot will discover labeled Kubernetes gateway objects as multi-network gateways. | +
PILOT_PERSISTENT_SESSION_HEADER_LABEL |
+String | +istio.io/persistent-session-header |
+If not empty, services with this label will use header based persistent sessions | +
PILOT_PERSISTENT_SESSION_LABEL |
+String | +istio.io/persistent-session |
+If not empty, services with this label will use cookie based persistent sessions | +
PILOT_PUSH_THROTTLE |
+Integer | +100 |
+Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes | +
PILOT_REMOTE_CLUSTER_TIMEOUT |
+Time Duration | +30s |
+After this timeout expires, pilot can become ready without syncing data from clusters added via remote-secrets. Setting the timeout to 0 disables this behavior. | +
PILOT_SCOPE_GATEWAY_TO_NAMESPACE |
+Boolean | +false |
+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. | +
PILOT_SEND_UNHEALTHY_ENDPOINTS |
+Boolean | +false |
+If enabled, Pilot will include unhealthy endpoints in EDS pushes and even if they are sent Envoy does not use them for load balancing. To avoid, sending traffic to non ready endpoints, enabling this flag, disables panic threshold in Envoy i.e. Envoy does not load balance requests to unhealthy/non-ready hosts even if the percentage of healthy hosts fall below minimum health percentage(panic threshold). | +
PILOT_SIDECAR_USE_REMOTE_ADDRESS |
+Boolean | +false |
+UseRemoteAddress sets useRemoteAddress to true for sidecar outbound listeners. | +
PILOT_SKIP_VALIDATE_TRUST_DOMAIN |
+Boolean | +false |
+Skip validating the peer is from the same trust domain when mTLS is enabled in authentication policy | +
PILOT_STATUS_BURST |
+Integer | +500 |
+If status is enabled, controls the Burst rate with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config Burst | +
PILOT_STATUS_MAX_WORKERS |
+Integer | +100 |
+The maximum number of workers Pilot will use to keep configuration status up to date. Smaller numbers will result in higher status latency, but larger numbers may impact CPU in high scale environments. | +
PILOT_STATUS_QPS |
+Integer | +100 |
+If status is enabled, controls the QPS with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config QPS | +
PILOT_STATUS_UPDATE_INTERVAL |
+Time Duration | +500ms |
+Interval to update the XDS distribution status. | +
PILOT_TRACE_SAMPLING |
+Floating-Point | +1 |
+Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 1.0. | +
PILOT_WORKLOAD_ENTRY_GRACE_PERIOD |
+Time Duration | +10s |
+The amount of time an auto-registered workload can remain disconnected from all Pilot instances before the associated WorkloadEntry is cleaned up. | +
PILOT_XDS_CACHE_INDEX_CLEAR_INTERVAL |
+Time Duration | +5s |
+The interval for xds cache index clearing. | +
PILOT_XDS_CACHE_SIZE |
+Integer | +60000 |
+The maximum number of cache entries for the XDS cache. | +
PILOT_XDS_CACHE_STATS |
+Boolean | +false |
+If true, Pilot will collect metrics for XDS cache efficiency. | +
PILOT_XDS_SEND_TIMEOUT |
+Time Duration | +0s |
+The timeout to send the XDS configuration to proxies. After this timeout is reached, Pilot will discard that push. | +
PLATFORM |
+String | + |
+Platform where Istio is deployed. Possible values are "openshift" and "gcp" | +
POD_NAME |
+String | + |
++ |
POD_NAMESPACE |
+String | +istio-system |
++ |
REQUIRE_3P_TOKEN |
+Boolean | +false |
+Reject k8s default tokens, without audience. If false, default K8S token will be accepted | +
RESOLVE_HOSTNAME_GATEWAYS |
+Boolean | +true |
+If true, hostnames in the LoadBalancer addresses of a Service will be resolved at the control plane for use in cross-network gateways. | +
REVISION |
+String | + |
++ |
REWRITE_PROBE_LEGACY_LOCALHOST_DESTINATION |
+Boolean | +false |
+If enabled, readiness probes will be sent to 'localhost'. Otherwise, they will be sent to the Pod's IP, matching Kubernetes' behavior. | +
ROOT_CA_DIR |
+String | +./etc/cacerts |
+Location of a local or mounted CA root | +
SHARED_MESH_CONFIG |
+String | + |
+Additional config map to load for shared MeshConfig settings. The standard mesh config will take precedence. | +
TOKEN_AUDIENCES |
+String | +istio-ca |
+A list of comma separated audiences to check in the JWT token before issuing a certificate. The token is accepted if it matches with one of the audiences | +
TOKEN_ISSUER |
+String | + |
+OIDC token issuer. If set, will be used to check the tokens. | +
TRUSTED_GATEWAY_CIDR |
+String | + |
+If set, any connections from gateway to Istiod with this CIDR range are treated as trusted for using authentication mechanisms like XFCC. This can only be used when the network where Istiod and the authenticating gateways are running in a trusted/secure network | +
UNSAFE_ENABLE_ADMIN_ENDPOINTS |
+Boolean | +false |
+If this is set to true, dangerous admin endpoints will be exposed on the debug interface. Not recommended for production. | +
UNSAFE_PILOT_ENABLE_DELTA_TEST |
+Boolean | +false |
+If enabled, addition runtime tests for Delta XDS efficiency are added. These checks are extremely expensive, so this should be used only for testing, not production. | +
UNSAFE_PILOT_ENABLE_RUNTIME_ASSERTIONS |
+Boolean | +false |
+If enabled, addition runtime asserts will be performed. These checks are both expensive and panic on failure. As a result, this should be used only for testing. | +
USE_REMOTE_CERTS |
+Boolean | +false |
+Whether to try to load CA certs from config Kubernetes cluster. Used for external Istiod. | +
VALIDATION_WEBHOOK_CONFIG_NAME |
+String | +istio-istio-system |
+If not empty, the controller will automatically patch validatingwebhookconfiguration when the CA certificate changes. Only works in kubernetes environment. | +
VERIFY_CERTIFICATE_AT_CLIENT |
+Boolean | +false |
+If enabled, certificates received by the proxy will be verified against the OS CA certificate bundle. | +
VERIFY_SDS_CERTIFICATE |
+Boolean | +true |
+If enabled, certificates fetched from SDS server will be verified before sending back to proxy. | +
XDS_AUTH |
+Boolean | +true |
+If true, will authenticate XDS clients. | +
XDS_AUTH_PLAINTEXT |
+Boolean | +false |
+authenticate plain text requests - used if Istiod is running on a secure/trusted network | +
| Metric Name | Type | Description |
|---|---|---|
auto_registration_deletes_total | Sum | Total number of auto registration cleaned up by periodic timer. |
auto_registration_errors_total | Sum | Total number of auto registration errors. |
auto_registration_success_total | Sum | Total number of successful auto registrations. |
auto_registration_unregister_total | Sum | Total number of unregistrations. |
auto_registration_updates_total | Sum | Total number of auto registration updates. |
citadel_server_authentication_failure_count | Sum | The number of authentication failures. |
citadel_server_cert_chain_expiry_timestamp | LastValue | The unix timestamp, in seconds, when Citadel cert chain will expire. A negative time indicates the cert is expired. |
citadel_server_csr_count | Sum | The number of CSRs received by Citadel server. |
citadel_server_csr_parsing_err_count | Sum | The number of errors occurred when parsing the CSR. |
citadel_server_csr_sign_err_count | Sum | The number of errors occurred when signing the CSR. |
citadel_server_id_extraction_err_count | Sum | The number of errors occurred when extracting the ID from CSR. |
citadel_server_root_cert_expiry_timestamp | LastValue | The unix timestamp, in seconds, when Citadel root cert will expire. A negative time indicates the cert is expired. |
citadel_server_success_cert_issuance_count | Sum | The number of certificates issuances that have succeeded. |
controller_sync_errors_total | Sum | Total number of errorMetric syncing controllers. |
endpoint_no_pod | LastValue | Endpoints without an associated pod. |
galley_validation_config_load_error | Sum | k8s webhook configuration (re)load error |
galley_validation_config_update_error | Sum | k8s webhook configuration update error |
galley_validation_config_updates | Sum | k8s webhook configuration updates |
galley_validation_failed | Sum | Resource validation failed |
galley_validation_http_error | Sum | Resource validation http serve errors |
galley_validation_passed | Sum | Resource is valid |
istio_build | LastValue | Istio component build info |
istiod_managed_clusters | LastValue | Number of clusters managed by istiod |
istiod_uptime_seconds | LastValue | Current istiod server uptime in seconds |
num_outgoing_retries | Sum | Number of outgoing retry requests (e.g. to a token exchange server, CA, etc.) |
pilot_conflict_inbound_listener | LastValue | Number of conflicting inbound listeners. |
pilot_conflict_outbound_listener_tcp_over_current_tcp | LastValue | Number of conflicting tcp listeners with current tcp listener. |
pilot_debounce_time | Distribution | Delay in seconds between the first config enters debouncing and the merged push request is pushed into the push queue. |
pilot_destrule_subsets | LastValue | Duplicate subsets across destination rules for same host |
pilot_dns_cluster_without_endpoints | LastValue | DNS clusters without endpoints caused by the endpoint field in STRICT_DNS type cluster is not set or the corresponding subset cannot select any endpoint |
pilot_duplicate_envoy_clusters | LastValue | Duplicate envoy clusters caused by service entries with same hostname |
pilot_eds_no_instances | LastValue | Number of clusters without instances. |
pilot_endpoint_not_ready | LastValue | Endpoint found in unready state. |
pilot_envoy_filter_status | LastValue | Status of Envoy filters whether it was applied or errored. |
pilot_inbound_updates | Sum | Total number of updates received by pilot. |
pilot_info | LastValue | Pilot version and build information. |
pilot_jwks_resolver_network_fetch_fail_total | Sum | Total number of failed network fetch by pilot jwks resolver |
pilot_jwks_resolver_network_fetch_success_total | Sum | Total number of successfully network fetch by pilot jwks resolver |
pilot_k8s_cfg_events | Sum | Events from k8s config. |
pilot_k8s_endpoints_pending_pod | LastValue | Number of endpoints that do not currently have any corresponding pods. |
pilot_k8s_endpoints_with_no_pods | Sum | Endpoints that does not have any corresponding pods. |
pilot_k8s_reg_events | Sum | Events from k8s registry. |
pilot_no_ip | LastValue | Pods not found in the endpoint table, possibly invalid. |
pilot_proxy_convergence_time | Distribution | Delay in seconds between config change and a proxy receiving all required configuration. |
pilot_proxy_queue_time | Distribution | Time in seconds, a proxy is in the push queue before being dequeued. |
pilot_push_triggers | Sum | Total number of times a push was triggered, labeled by reason for the push. |
pilot_pushcontext_init_seconds | Distribution | Total time in seconds Pilot takes to init pushContext. |
pilot_sds_certificate_errors_total | Sum | Total number of failures to fetch SDS key and certificate. |
pilot_services | LastValue | Total services known to pilot. |
pilot_total_rejected_configs | Sum | Total number of configs that Pilot had to reject or ignore. |
pilot_total_xds_internal_errors | Sum | Total number of internal XDS errors in pilot. |
pilot_total_xds_rejects | Sum | Total number of XDS responses from pilot rejected by proxy. |
pilot_virt_services | LastValue | Total virtual services known to pilot. |
pilot_vservice_dup_domain | LastValue | Virtual services with dup domains. |
pilot_worker_queue_depth | LastValue | Depth of the controller queues |
pilot_worker_queue_duration | Distribution | Time taken to process an item |
pilot_worker_queue_latency | Distribution | Latency before the item is processed |
pilot_xds | LastValue | Number of endpoints connected to this pilot using XDS. |
pilot_xds_cds_reject | LastValue | Pilot rejected CDS configs. |
pilot_xds_config_size_bytes | Distribution | Distribution of configuration sizes pushed to clients |
pilot_xds_eds_reject | LastValue | Pilot rejected EDS. |
pilot_xds_expired_nonce | Sum | Total number of XDS requests with an expired nonce. |
pilot_xds_lds_reject | LastValue | Pilot rejected LDS. |
pilot_xds_push_context_errors | Sum | Number of errors (timeouts) initiating push context. |
pilot_xds_push_time | Distribution | Total time in seconds Pilot takes to push lds, rds, cds and eds. |
pilot_xds_pushes | Sum | Pilot build and send errors for lds, rds, cds and eds. |
pilot_xds_rds_reject | LastValue | Pilot rejected RDS. |
pilot_xds_send_time | Distribution | Total time in seconds Pilot takes to send generated configuration. |
pilot_xds_write_timeout | Sum | Pilot XDS response write timeouts. |
provider_lookup_cluster_failures | Sum | Number of times a cluster lookup failed |
remote_cluster_sync_timeouts_total | Sum | Number of times remote clusters took too long to sync, causing slow startup that excludes remote clusters. |
scrape_failures_total | Sum | The total number of failed scrapes. |
scrapes_total | Sum | The total number of scrapes. |
sidecar_injection_failure_total | Sum | Total number of failed sidecar injection requests. |
sidecar_injection_requests_total | Sum | Total number of sidecar injection requests. |
sidecar_injection_skip_total | Sum | Total number of skipped sidecar injection requests. |
sidecar_injection_success_total | Sum | Total number of successful sidecar injection requests. |
sidecar_injection_time_seconds | Distribution | Total time taken for injection in seconds. |
startup_duration_seconds | LastValue | The time from the process starting to being marked ready. |
wasm_cache_entries | LastValue | number of Wasm remote fetch cache entries. |
wasm_cache_lookup_count | Sum | number of Wasm remote fetch cache lookups. |
wasm_config_conversion_count | Sum | number of Wasm config conversion count and results, including success, no remote load, marshal failure, remote fetch failure, miss remote fetch hint. |
wasm_config_conversion_duration | Distribution | Total time in milliseconds istio-agent spends on converting remote load in Wasm config. |
wasm_remote_fetch_count | Sum | number of Wasm remote fetches and results, including success, download failure, and checksum mismatch. |
webhook_patch_attempts_total | Sum | Webhook patching attempts |
webhook_patch_failures_total | Sum | Webhook patching total failures |
webhook_patch_retries_total | Sum | Webhook patching retries |
xds_cache_dependent_config_size | LastValue | Current size of dependent configs |
xds_cache_evictions | Sum | Total number of xds cache evictions. |
xds_cache_reads | Sum | Total number of xds cache xdsCacheReads. |
xds_cache_size | LastValue | Current size of xds cache |
Configuration affecting the service mesh as a whole.
@@ -67,26 +67,6 @@Connection timeout used by Envoy. (MUST BE >=1ms) Default timeout is 10s.
- -protocolDetectionTimeoutDurationAutomatic protocol detection uses a set of heuristics to -determine whether the connection is using TLS or not (on the -server side), as well as the application protocol being used -(e.g., http vs tcp). These heuristics rely on the client sending -the first bits of data. For server first protocols like MySQL, -MongoDB, etc. Envoy will timeout on the protocol detection after -the specified period, defaulting to non mTLS plain TCP -traffic. Set this field to tweak the period that Envoy will wait -for the client to send the first bits of data. (MUST BE >=1ms or -0s to disable). Default detection timeout is 0s (no timeout).
-metadataExchangeHeadersMetadataExchangeHeadersControls Istio metadata exchange headers X-Envoy-Peer-Metadata and X-Envoy-Peer-Metadata-Id.
+By default, the behavior is unspecified.
+If IN_MESH, these headers will not be appended to outbound requests from sidecars to services not in-mesh.
Network provides information about the endpoints in a routable L3 @@ -4227,6 +4246,34 @@
| Name | +Description | +||||
|---|---|---|---|---|---|
UNDEFINED |
+
+ Existing Istio behavior for the metadata exchange headers is unchanged. + + |
+||||
IN_MESH |
+
+ Only append the istio metadata exchange headers for services considered in-mesh.
+Traffic is considered in-mesh if it is secured with Istio mutual TLS. This means that |
REDIRECT |
The |
diff --git a/content/zh/docs/reference/config/networking/virtual-service/index.html b/content/zh/docs/reference/config/networking/virtual-service/index.html
index 7fd986d5f69e..e88060808d7e 100644
--- a/content/zh/docs/reference/config/networking/virtual-service/index.html
+++ b/content/zh/docs/reference/config/networking/virtual-service/index.html
@@ -8,7 +8,7 @@
generator: protoc-gen-docs
schema: istio.networking.v1alpha3.VirtualService
aliases: [/zh/docs/reference/config/networking/v1alpha3/virtual-service]
-number_of_entries: 28
+number_of_entries: 29
---
+No + | + +|
mirrors |
+HTTPMirrorPolicy[] |
+
+ Specifies the destinations to mirror HTTP traffic in addition +to the original destination. Mirrored traffic is on a +best effort basis where the sidecar/gateway will not wait for the +mirrored destinations to respond before returning the response from the +original destination. Statistics will be generated for the mirrored +destination. + |
No
@@ -2495,7 +2511,8 @@ HTTPRetrybetween retries will be determined automatically (25ms+). When requesttimeout of the HTTP route
or per_try_timeout is configured, the actual number of retries attempted also depends on
-the specified request timeout and per_try_timeout values.
+the specified request timeout and per_try_timeout values. MUST BE >= 0. If 0, retries will be disabled.
+The maximum possible number of requests made will be 1 + attempts.
|
@@ -2734,6 +2751,52 @@ HTTPFaultInjectionAbort Http request attempts and return error codes back to downstream service, giving the impression that the upstream service is faulty. + |
++No + | +
HTTPMirrorPolicy can be used to specify the destinations to mirror HTTP traffic in addition +to the original destination. Mirrored traffic is on a +best effort basis where the sidecar/gateway will not wait for the +mirrored destinations to respond before returning the response from the +original destination. Statistics will be generated for the mirrored +destination.
+ + +PluginType indicates the type of Wasm Extension to be used.
+There are two types of Extensions: HTTP and NETWORK.
+HTTP Extension work at “Layer 7”(for example as an HTTP filters in Envoy).
+The detailed HTTP interface for can be found at [C++] (https://github.com/proxy-wasm/proxy-wasm-cpp-host/blob/b7e690703c7f26707438a2f1ebd7c197bc8f0296/include/proxy-wasm/context_interface.h#L199)
+and [Rust] (https://github.com/proxy-wasm/proxy-wasm-rust-sdk/blob/6b47aec926bc29971c727471d6f4c972ec407c7f/src/traits.rs#L309).
+NETWORK Extension work at “Layer 4”(for example, as a network filter in Envoy).
+The detailed NETWORK interface for can be found at [C++] (https://github.com/proxy-wasm/proxy-wasm-cpp-host/blob/b7e690703c7f26707438a2f1ebd7c197bc8f0296/include/proxy-wasm/context_interface.h#L257)
+and [Rust] (https://github.com/proxy-wasm/proxy-wasm-rust-sdk/blob/6b47aec926bc29971c727471d6f4c972ec407c7f/src/traits.rs#L257).
+The NETWORK Extension can be applied to HTTP traffic as well.
| Name | +Description | +
|---|---|
UNSPECIFIED_PLUGIN_TYPE |
+
+ Defaults to HTTP. + + |
+
HTTP |
+
+ Use HTTP Wasm Extension. + + |
+
NETWORK |
+
+ Use Network Wasm Extension. + |