You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/application-gateway/ingress-controller-annotations.md
+21-20Lines changed: 21 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,21 +19,21 @@ The Kubernetes Ingress resource can be annotated with arbitrary key/value pairs.
19
19
20
20
For an Ingress resource to be observed by AGIC, it **must be annotated** with `kubernetes.io/ingress.class: azure/application-gateway`. Only then AGIC works with the Ingress resource in question.
21
21
22
-
| Annotation Key | Value Type | Default Value | Allowed Values
22
+
| Annotation Key | Value Type | Default Value | Allowed Values|
This annotation allows the backend path specified in an ingress resource to be rewritten with prefix specified in this annotation. This allows users to expose services whose endpoints are different than endpoint names used to expose a service in an ingress resource.
36
+
The following annotation allows the backend path specified in an ingress resource to be rewritten with prefix specified in this annotation. It allows users to expose services whose endpoints are different than endpoint names used to expose a service in an ingress resource.
37
37
38
38
### Usage
39
39
@@ -65,10 +65,10 @@ spec:
65
65
number: 80
66
66
```
67
67
68
-
In the example above, we have defined an ingress resource named `go-server-ingress-bkprefix` with an annotation `appgw.ingress.kubernetes.io/backend-path-prefix: "/test/"`. The annotation tells application gateway to create an HTTP setting, which has a path prefix override for the path `/hello` to `/test/`.
68
+
In the previous example, you've defined an ingress resource named `go-server-ingress-bkprefix` with an annotation `appgw.ingress.kubernetes.io/backend-path-prefix: "/test/"`. The annotation tells application gateway to create an HTTP setting, which has a path prefix override for the path `/hello` to `/test/`.
69
69
70
70
> [!NOTE]
71
-
> In the above example we have only one rule defined. However, the annotations are applicable to the entire ingress resource, so if a user had defined multiple rules, the backend path prefix would be set up for each of the paths specified. Thus, if a user wants different rules with different path prefixes (even for the same service) they would need to define different ingress resources.
71
+
> In the above example, only one rule is defined. However, the annotations are applicable to the entire ingress resource, so if a user defined multiple rules, the backend path prefix would be set up for each of the paths specified. If a user wants different rules with different path prefixes (even for the same service), they would need to define different ingress resources.
72
72
73
73
## TLS Redirect
74
74
@@ -114,7 +114,7 @@ spec:
114
114
## Connection Draining
115
115
116
116
`connection-draining`: This annotation allows us to specify whether to enable connection draining.
117
-
`connection-draining-timeout`: This annotation allows us to specify a timeout after which Application Gateway will terminate the requests to the draining backend endpoint.
117
+
`connection-draining-timeout`: This annotation allows us to specify a timeout, after which Application Gateway terminates the requests to the draining backend endpoint.
118
118
119
119
### Usage
120
120
@@ -150,7 +150,7 @@ spec:
150
150
151
151
## Cookie Based Affinity
152
152
153
-
This annotation allows you to specify whether to enable cookie based affinity.
153
+
The following annotation allows you to specify whether to enable cookie based affinity.
154
154
155
155
### Usage
156
156
@@ -184,7 +184,7 @@ spec:
184
184
185
185
## Request Timeout
186
186
187
-
This annotation allows you to specify the request timeout in seconds after which Application Gateway will fail the request if response is not received.
187
+
The following annotation allows you to specify the request timeout in seconds, after which Application Gateway fails the request if response is not received.
188
188
189
189
### Usage
190
190
@@ -218,11 +218,11 @@ spec:
218
218
219
219
## Use Private IP
220
220
221
-
This annotation allows you to specify whether to expose this endpoint on Private IP of Application Gateway.
221
+
The following annotation allows you to specify whether to expose this endpoint on Private IP of Application Gateway.
222
222
223
223
> [!NOTE]
224
224
> * Application Gateway doesn't support multiple IPs on the same port (example: 80/443). Ingress with annotation `appgw.ingress.kubernetes.io/use-private-ip: "false"` and another with `appgw.ingress.kubernetes.io/use-private-ip: "true"` on `HTTP` will cause AGIC to fail while updating the Application Gateway.
225
-
> * For Application Gateway that doesn't have a private IP, Ingresses with `appgw.ingress.kubernetes.io/use-private-ip: "true"` will be ignored. This is reflected in the controller logs and ingress events for those ingresses with `NoPrivateIP` warning.
225
+
> * For Application Gateway that doesn't have a private IP, Ingresses with `appgw.ingress.kubernetes.io/use-private-ip: "true"` is ignored. This is reflected in the controller logs and ingress events for those ingresses with `NoPrivateIP` warning.
226
226
227
227
### Usage
228
228
@@ -256,11 +256,12 @@ spec:
256
256
257
257
## Backend Protocol
258
258
259
-
This annotation allows you to specify the protocol that Application Gateway should use while talking to the Pods. Supported Protocols are `http` and `https`.
259
+
The following annotation allows you to specify the protocol that Application Gateway should use while communicating with the pods. Supported Protocols are `http` and `https`.
260
260
261
261
> [!NOTE]
262
-
> * While self-signed certificates are supported on Application Gateway, currently AGIC only supports `https` when Pods are using a certificate signed by a well-known CA.
263
-
> * Do not use port 80 with HTTPS and port 443 with HTTP on the pods.
262
+
> While self-signed certificates are supported on Application Gateway, currently AGIC only supports `https` when pods are using a certificate signed by a well-known CA.
263
+
>
264
+
> Don't use port 80 with HTTPS and port 443 with HTTP on the pods.
264
265
265
266
### Usage
266
267
@@ -294,7 +295,7 @@ spec:
294
295
295
296
## Rewrite Rule Set
296
297
297
-
This annotation allows you to assign an existing rewrite rule set to the corresponding request routing rule.
298
+
The following annotation allows you to assign an existing rewrite rule set to the corresponding request routing rule.
0 commit comments