forked from istio/api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathannotations.pb.html
349 lines (160 loc) · 8.21 KB
/
annotations.pb.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
---
title: Resource Annotations
description: Resource annotations used by Istio.
location: https://istio.io/docs/reference/config/annotations.html
weight: 29
---
<p>
This page presents the various <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/">resource annotations</a> that
Istio supports to control its behavior.
</p>
<table class="annotations">
<thead>
<tr>
<th>Annotation Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>kubernetes.io/ingress.class</code></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>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>policy.istio.io/check</code></td>
<td>Determines the policy for behavior when unable to connect to Mixer. If not set, FAIL_CLOSE is set, rejecting requests.</td>
</tr>
<tr>
<td><code>policy.istio.io/checkBaseRetryWaitTime</code></td>
<td>Base time to wait between retries, will be adjusted by backoff and jitter. In duration format. If not set, this will be 80ms.</td>
</tr>
<tr>
<td><code>policy.istio.io/checkMaxRetryWaitTime</code></td>
<td>Maximum time to wait between retries to Mixer. In duration format. If not set, this will be 1000ms.</td>
</tr>
<tr>
<td><code>policy.istio.io/checkRetries</code></td>
<td>The maximum number of retries on transport errors to Mixer. If not set, this will be 0, indicating no retries.</td>
</tr>
<tr>
<td><code>policy.istio.io/lang</code></td>
<td>Selects the attribute expression langauge runtime for Mixer..</td>
</tr>
<tr>
<td><code>readiness.status.sidecar.istio.io/applicationPorts</code></td>
<td>Specifies the list of ports exposed by the application container. Used by the istio-proxy 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>Specifies the failure threshold for the istio-proxy readiness probe.</td>
</tr>
<tr>
<td><code>readiness.status.sidecar.istio.io/initialDelaySeconds</code></td>
<td>Specifies the initial delay (in seconds) for the istio-proxy readiness probe.</td>
</tr>
<tr>
<td><code>readiness.status.sidecar.istio.io/periodSeconds</code></td>
<td>Specifies the period (in seconds) for the istio-proxy readiness probe.</td>
</tr>
<tr>
<td><code>sidecar.istio.io/bootstrapOverride</code></td>
<td>Specifies an alternative Envoy bootstrap configuration file.</td>
</tr>
<tr>
<td><code>sidecar.istio.io/componentLogLevel</code></td>
<td>Specifies the component log level for Envoy.</td>
</tr>
<tr>
<td><code>sidecar.istio.io/controlPlaneAuthPolicy</code></td>
<td>Specifies the auth policy used by the Istio control plane. If NONE, traffic will not be encrypted. If MUTUAL_TLS, traffic between istio-proxy sidecars will be wrapped into mutual TLS connections.</td>
</tr>
<tr>
<td><code>sidecar.istio.io/discoveryAddress</code></td>
<td>Specifies the XDS discovery address to be used by the istio-proxy sidecar.</td>
</tr>
<tr>
<td><code>sidecar.istio.io/inject</code></td>
<td>Specifies whether or not an istio-proxy sidecar should be automatically injected into the workload.</td>
</tr>
<tr>
<td><code>sidecar.istio.io/interceptionMode</code></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>Specifies the log level for Envoy.</td>
</tr>
<tr>
<td><code>sidecar.istio.io/proxyCPU</code></td>
<td>Specifies the requested CPU setting for the istio-proxy sidecar.</td>
</tr>
<tr>
<td><code>sidecar.istio.io/proxyImage</code></td>
<td>Specifies the Docker image to be used by the istio-proxy sidecar.</td>
</tr>
<tr>
<td><code>sidecar.istio.io/proxyMemory</code></td>
<td>Specifies the requested memory setting for the istio-proxy sidecar.</td>
</tr>
<tr>
<td><code>sidecar.istio.io/rewriteAppHTTPProbers</code></td>
<td>Rewrite HTTP readiness and liveness probes to be redirected to istio-proxy sidecar.</td>
</tr>
<tr>
<td><code>sidecar.istio.io/statsInclusionPrefixes</code></td>
<td>Specifies the comma separated list of prefixes of the stats to be emitted by Envoy.</td>
</tr>
<tr>
<td><code>sidecar.istio.io/statsInclusionRegexps</code></td>
<td>Specifies the comma separated list of regexes the stats should match to be emitted by Envoy.</td>
</tr>
<tr>
<td><code>sidecar.istio.io/statsInclusionSuffixes</code></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>Generated by istio-proxy 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>Specifies one or more user volumes (as a JSON array) to be added to the istio-proxy sidecar.</td>
</tr>
<tr>
<td><code>sidecar.istio.io/userVolumeMount</code></td>
<td>Specifies one or more user volume mounts (as a JSON array) to be added to the istio-proxy sidecar.</td>
</tr>
<tr>
<td><code>status.sidecar.istio.io/port</code></td>
<td>Specifies the HTTP status Port for the istio-proxy sidecar. If zero, the istio-proxy will not provide status.</td>
</tr>
<tr>
<td><code>traffic.sidecar.istio.io/excludeInboundPorts</code></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>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>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>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>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/kubevirtInterfaces</code></td>
<td>A comma separated list of virtual interfaces whose inbound traffic (from VM) will be treated as outbound.</td>
</tr>
</tbody>
</table>