mirror of https://github.com/istio/istio.io.git
583 lines
12 KiB
HTML
583 lines
12 KiB
HTML
---
|
|
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/istio/api' REPO
|
|
source_repo: https://github.com/istio/api
|
|
title: Resource Annotations
|
|
description: Resource annotations used by Istio.
|
|
location: https://istio.io/docs/reference/config/annotations/
|
|
weight: 60
|
|
---
|
|
<p>
|
|
This page presents the various resource <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/">annotations</a> that
|
|
Istio supports to control its behavior.
|
|
</p>
|
|
|
|
<table class="annotations">
|
|
<thead>
|
|
<tr>
|
|
<th>Annotation Name</th>
|
|
<th>Feature Status</th>
|
|
<th>Resource Types</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>galley.istio.io/analyze-suppress</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Any]</td>
|
|
<td>A comma separated list of configuration analysis message codes to suppress when Istio analyzers are run. For example, to suppress reporting of IST0103 (PodMissingProxy) and IST0108 (UnknownAnnotation) on a resource, apply the annotation 'galley.istio.io/analyze-suppress=IST0108,IST0103'. If the value is '*', then all configuration analysis messages are suppressed.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>inject.istio.io/templates</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>The name of the inject template(s) to use, as a comma separate list. See https://istio.io/latest/docs/setup/additional-setup/sidecar-injection/#custom-templates-experimental for more information.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>install.operator.istio.io/chart-owner</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Any]</td>
|
|
<td>Represents the name of the chart used to create this resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>install.operator.istio.io/owner-generation</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Any]</td>
|
|
<td>Represents the generation to which the resource was last reconciled.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>install.operator.istio.io/version</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Any]</td>
|
|
<td>Represents the Istio version associated with the resource</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>kubernetes.io/ingress.class</code></td>
|
|
|
|
<td>Stable</td>
|
|
|
|
<td>[Ingress]</td>
|
|
<td>Annotation on an Ingress resources denoting the class of controllers responsible for it.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>networking.istio.io/exportTo</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Service]</td>
|
|
<td>Specifies the namespaces to which this service should be exported to. A value of '*' indicates it is reachable within the mesh '.' indicates it is reachable within its namespace.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>prometheus.istio.io/merge-metrics</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies if application Prometheus metric will be merged with Envoy metrics for this workload.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>proxy.istio.io/config</code></td>
|
|
|
|
<td>Beta</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Overrides for the proxy configuration for this specific proxy. Available options can be found at https://istio.io/docs/reference/config/istio.mesh.v1alpha1/#ProxyConfig.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>readiness.status.sidecar.istio.io/applicationPorts</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies the list of ports exposed by the application container. Used by the Envoy sidecar readiness probe to determine that Envoy is configured and ready to receive traffic.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>readiness.status.sidecar.istio.io/failureThreshold</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies the failure threshold for the Envoy sidecar readiness probe.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>readiness.status.sidecar.istio.io/initialDelaySeconds</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies the initial delay (in seconds) for the Envoy sidecar readiness probe.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>readiness.status.sidecar.istio.io/periodSeconds</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies the period (in seconds) for the Envoy sidecar readiness probe.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>sidecar.istio.io/agentLogLevel</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies the log output level for pilot-agent.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>sidecar.istio.io/bootstrapOverride</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies an alternative Envoy bootstrap configuration file.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>sidecar.istio.io/componentLogLevel</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies the component log level for Envoy.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr class="deprecated">
|
|
|
|
<td><code>sidecar.istio.io/controlPlaneAuthPolicy</code></td>
|
|
|
|
<td>Deprecated</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies the auth policy used by the Istio control plane. If NONE, traffic will not be encrypted. If MUTUAL_TLS, traffic between Envoy sidecar will be wrapped into mutual TLS connections.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr class="deprecated">
|
|
|
|
<td><code>sidecar.istio.io/discoveryAddress</code></td>
|
|
|
|
<td>Deprecated</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies the XDS discovery address to be used by the Envoy sidecar.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>sidecar.istio.io/enableCoreDump</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies whether or not an Envoy sidecar should enable core dump.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>sidecar.istio.io/inject</code></td>
|
|
|
|
<td>Beta</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies whether or not an Envoy sidecar should be automatically injected into the workload.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>sidecar.istio.io/interceptionMode</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies the mode used to redirect inbound connections to Envoy (REDIRECT or TPROXY).</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>sidecar.istio.io/logLevel</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies the log level for Envoy.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>sidecar.istio.io/proxyCPU</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies the requested CPU setting for the Envoy sidecar.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>sidecar.istio.io/proxyCPULimit</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies the CPU limit for the Envoy sidecar.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>sidecar.istio.io/proxyImage</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies the Docker image to be used by the Envoy sidecar.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>sidecar.istio.io/proxyMemory</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies the requested memory setting for the Envoy sidecar.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>sidecar.istio.io/proxyMemoryLimit</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies the memory limit for the Envoy sidecar.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>sidecar.istio.io/rewriteAppHTTPProbers</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Rewrite HTTP readiness and liveness probes to be redirected to the Envoy sidecar.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr class="deprecated">
|
|
|
|
<td><code>sidecar.istio.io/statsInclusionPrefixes</code></td>
|
|
|
|
<td>Deprecated</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies the comma separated list of prefixes of the stats to be emitted by Envoy.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr class="deprecated">
|
|
|
|
<td><code>sidecar.istio.io/statsInclusionRegexps</code></td>
|
|
|
|
<td>Deprecated</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies the comma separated list of regexes the stats should match to be emitted by Envoy.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr class="deprecated">
|
|
|
|
<td><code>sidecar.istio.io/statsInclusionSuffixes</code></td>
|
|
|
|
<td>Deprecated</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies the comma separated list of suffixes of the stats to be emitted by Envoy.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>sidecar.istio.io/status</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Generated by Envoy sidecar injection that indicates the status of the operation. Includes a version hash of the executed template, as well as names of injected resources.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>sidecar.istio.io/userVolume</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies one or more user volumes (as a JSON array) to be added to the Envoy sidecar.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>sidecar.istio.io/userVolumeMount</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies one or more user volume mounts (as a JSON array) to be added to the Envoy sidecar.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>status.sidecar.istio.io/port</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>Specifies the HTTP status Port for the Envoy sidecar. If zero, the sidecar will not provide status.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>traffic.sidecar.istio.io/excludeInboundPorts</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>A comma separated list of inbound ports to be excluded from redirection to Envoy. Only applies when all inbound traffic (i.e. '*') is being redirected.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>traffic.sidecar.istio.io/excludeOutboundIPRanges</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>A 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.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>traffic.sidecar.istio.io/excludeOutboundPorts</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>A comma separated list of outbound ports to be excluded from redirection to Envoy.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>traffic.sidecar.istio.io/includeInboundPorts</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>A comma separated list of inbound ports for which traffic is to be redirected to Envoy. The wildcard character '*' can be used to configure redirection for all ports. An empty list will disable all inbound redirection.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>traffic.sidecar.istio.io/includeOutboundIPRanges</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>A 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 redirection.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>traffic.sidecar.istio.io/includeOutboundPorts</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>A comma separated list of outbound ports for which traffic is to be redirected to Envoy, regardless of the destination IP.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td><code>traffic.sidecar.istio.io/kubevirtInterfaces</code></td>
|
|
|
|
<td>Alpha</td>
|
|
|
|
<td>[Pod]</td>
|
|
<td>A comma separated list of virtual interfaces whose inbound traffic (from VM) will be treated as outbound.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|