Skip to content

Commit bd38d50

Browse files
committed
fixed grammar and other minor items during review
1 parent e1d0e8d commit bd38d50

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

articles/application-gateway/ingress-controller-annotations.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,21 @@ The Kubernetes Ingress resource can be annotated with arbitrary key/value pairs.
1919

2020
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.
2121

22-
| Annotation Key | Value Type | Default Value | Allowed Values
22+
| Annotation Key | Value Type | Default Value | Allowed Values |
2323
| -- | -- | -- | -- |
24-
| [appgw.ingress.kubernetes.io/backend-path-prefix](#backend-path-prefix) | `string` | `nil` | |
24+
| [appgw.ingress.kubernetes.io/backend-path-prefix](#backend-path-prefix) | `string` | `nil` ||
2525
| [appgw.ingress.kubernetes.io/ssl-redirect](#tls-redirect) | `bool` | `false` | |
26-
| [appgw.ingress.kubernetes.io/connection-draining](#connection-draining) | `bool` | `false` | |
27-
| [appgw.ingress.kubernetes.io/connection-draining-timeout](#connection-draining) | `int32` (seconds) | `30` | |
28-
| [appgw.ingress.kubernetes.io/cookie-based-affinity](#cookie-based-affinity) | `bool` | `false` | |
29-
| [appgw.ingress.kubernetes.io/request-timeout](#request-timeout) | `int32` (seconds) | `30` | |
30-
| [appgw.ingress.kubernetes.io/use-private-ip](#use-private-ip) | `bool` | `false` | |
26+
| [appgw.ingress.kubernetes.io/connection-draining](#connection-draining) | `bool` | `false` ||
27+
| [appgw.ingress.kubernetes.io/connection-draining-timeout](#connection-draining) | `int32` (seconds) | `30` ||
28+
| [appgw.ingress.kubernetes.io/cookie-based-affinity](#cookie-based-affinity) | `bool` | `false` ||
29+
| [appgw.ingress.kubernetes.io/request-timeout](#request-timeout) | `int32` (seconds) | `30` ||
30+
| [appgw.ingress.kubernetes.io/use-private-ip](#use-private-ip) | `bool` | `false` ||
3131
| [appgw.ingress.kubernetes.io/backend-protocol](#backend-protocol) | `string` | `http` | `http`, `https` |
32-
| [appgw.ingress.kubernetes.io/rewrite-rule-set](#rewrite-rule-set) | `string` | `nil` | |
32+
| [appgw.ingress.kubernetes.io/rewrite-rule-set](#rewrite-rule-set) | `string` | `nil` ||
3333

3434
## Backend Path Prefix
3535

36-
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.
3737

3838
### Usage
3939

@@ -65,10 +65,10 @@ spec:
6565
number: 80
6666
```
6767
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/`.
6969

7070
> [!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.
7272

7373
## TLS Redirect
7474

@@ -114,7 +114,7 @@ spec:
114114
## Connection Draining
115115

116116
`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.
118118

119119
### Usage
120120

@@ -150,7 +150,7 @@ spec:
150150

151151
## Cookie Based Affinity
152152

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.
154154

155155
### Usage
156156

@@ -184,7 +184,7 @@ spec:
184184

185185
## Request Timeout
186186

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.
188188

189189
### Usage
190190

@@ -218,11 +218,11 @@ spec:
218218

219219
## Use Private IP
220220

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.
222222

223223
> [!NOTE]
224224
> * 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.
226226

227227
### Usage
228228

@@ -256,11 +256,12 @@ spec:
256256

257257
## Backend Protocol
258258

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`.
260260

261261
> [!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.
264265

265266
### Usage
266267

@@ -294,7 +295,7 @@ spec:
294295

295296
## Rewrite Rule Set
296297

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.
298299

299300
### Usage
300301

0 commit comments

Comments
 (0)