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
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,11 +13,11 @@ ms.author: greglin
13
13
14
14
## Introductions
15
15
16
-
The Kubernetes Ingress resource can be annotated with arbitrary key/value pairs. AGIC relies on annotations to program Application Gateway features, which are not configurable via the Ingress YAML. Ingress annotations are applied to all HTTP setting, backend pools, and listeners derived from an ingress resource.
16
+
The Kubernetes Ingress resource can be annotated with arbitrary key/value pairs. AGIC relies on annotations to program Application Gateway features, which aren't configurable using the Ingress YAML. Ingress annotations are applied to all HTTP settings, backend pools, and listeners derived from an ingress resource.
17
17
18
18
## List of supported annotations
19
19
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 will work with the Ingress resource in question.
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
22
| Annotation Key | Value Type | Default Value | Allowed Values
23
23
| -- | -- | -- | -- |
@@ -65,7 +65,7 @@ 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 will have a path prefix override for the path `/hello` to `/test/`.
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/`.
69
69
70
70
> [!NOTE]
71
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.
@@ -75,8 +75,8 @@ In the example above, we have defined an ingress resource named `go-server-ingre
75
75
Application Gateway [can be configured](./redirect-overview.md)
76
76
to automatically redirect HTTP URLs to their HTTPS counterparts. When this
77
77
annotation is present and TLS is properly configured, Kubernetes Ingress
78
-
controller will create a [routing rule with a redirection configuration](./redirect-http-to-https-portal.md#add-a-routing-rule-with-a-redirection-configuration)
79
-
and apply the changes to your Application Gateway. The redirect created will be HTTP `301 Moved Permanently`.
78
+
controller creates a [routing rule with a redirection configuration](./redirect-http-to-https-portal.md#add-a-routing-rule-with-a-redirection-configuration)
79
+
and applies the changes to your Application Gateway. The redirect created will be HTTP `301 Moved Permanently`.
80
80
81
81
### Usage
82
82
@@ -113,8 +113,8 @@ spec:
113
113
114
114
## Connection Draining
115
115
116
-
`connection-draining`: This annotation allows users to specify whether to enable connection draining.
117
-
`connection-draining-timeout`: This annotation allows users to specify a timeout after which Application Gateway will terminate the requests to the draining backend endpoint.
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.
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 to specify whether to enable cookie based affinity.
153
+
This 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 to specify the request timeout in seconds after which Application Gateway will fail the request if response is not received.
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.
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 us to specify whether to expose this endpoint on Private IP of Application Gateway.
221
+
This annotation allows you to specify whether to expose this endpoint on Private IP of Application Gateway.
222
222
223
223
> [!NOTE]
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 in 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 will reflected in the controller logs and ingress events for those ingresses with `NoPrivateIP` warning.
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.
226
226
227
227
### Usage
228
228
@@ -256,11 +256,11 @@ spec:
256
256
257
257
## Backend Protocol
258
258
259
-
This annotation allows us to specify the protocol that Application Gateway should use while talking to the Pods. Supported Protocols: `http`, `https`
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`.
260
260
261
261
> [!NOTE]
262
-
> * While self-signed certificates are supported on Application Gateway, currently, AGIC only support `https` when Pods are using certificate signed by a well-known CA.
263
-
> * Make sure to 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
+
> * Do not use port 80 with HTTPS and port 443 with HTTP on the pods.
0 commit comments