Skip to content

Commit e1d0e8d

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

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ ms.author: greglin
1313

1414
## Introductions
1515

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

1818
## List of supported annotations
1919

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

2222
| Annotation Key | Value Type | Default Value | Allowed Values
2323
| -- | -- | -- | -- |
@@ -65,7 +65,7 @@ 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 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/`.
6969

7070
> [!NOTE]
7171
> 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
7575
Application Gateway [can be configured](./redirect-overview.md)
7676
to automatically redirect HTTP URLs to their HTTPS counterparts. When this
7777
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`.
8080

8181
### Usage
8282

@@ -113,8 +113,8 @@ spec:
113113

114114
## Connection Draining
115115

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

119119
### Usage
120120

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

151151
## Cookie Based Affinity
152152

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

155155
### Usage
156156

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

185185
## Request Timeout
186186

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

189189
### Usage
190190

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

219219
## Use Private IP
220220

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

223223
> [!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.
226226

227227
### Usage
228228

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

257257
## Backend Protocol
258258

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

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

265265
### Usage
266266

0 commit comments

Comments
 (0)