Skip to content

Commit 119bb28

Browse files
committed
edit pass: ingress-controller-annotations
1 parent fbb23b2 commit 119bb28

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

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

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

1212
# Annotations for Application Gateway Ingress Controller
1313

14-
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.
14+
The Kubernetes Ingress resource can be annotated with arbitrary key/value pairs. Application Gateway Ingress Controller (AGIC) relies on annotations to program Azure Application Gateway features, which aren't configurable via the Ingress YAML. Ingress annotations are applied to all HTTP settings, backend pools, and listeners derived from an ingress resource.
1515

1616
## List of supported annotations
1717

18-
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.
18+
For AGIC to observe an Ingress resource, the resource *must be annotated* with `kubernetes.io/ingress.class: azure/application-gateway`.
1919

20-
| Annotation Key | Value Type | Default Value | Allowed Values |
20+
| Annotation key | Value type | Default value | Allowed values |
2121
| -- | -- | -- | -- |
2222
| [appgw.ingress.kubernetes.io/backend-path-prefix](#backend-path-prefix) | `string` | `nil` ||
2323
| [appgw.ingress.kubernetes.io/backend-hostname](#backend-hostname) | `string` | `nil` ||
@@ -48,7 +48,7 @@ For an Ingress resource to be observed by AGIC, it **must be annotated** with `k
4848

4949
## Backend Path Prefix
5050

51-
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.
51+
The following annotation allows the backend path specified in an ingress resource to be rewritten with the specified prefix. It allows users to expose services whose endpoints are different from the endpoint names that you use to expose a service in an ingress resource.
5252

5353
### Usage
5454

@@ -80,14 +80,14 @@ spec:
8080
number: 80
8181
```
8282
83-
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/`.
83+
In the preceding example, you defined an ingress resource named `go-server-ingress-bkprefix` with an annotation named `appgw.ingress.kubernetes.io/backend-path-prefix: "/test/"`. The annotation tells Application Gateway to create an HTTP setting that has a path prefix override for the path `/hello` to `/test/`.
8484

8585
> [!NOTE]
86-
> 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.
86+
> The preceding example defines only one rule. However, the annotations apply to the entire ingress resource. So if you define multiple rules, you set up the backend path prefix for each of the specified paths. If you want different rules with different path prefixes (even for the same service), you need to define different ingress resources.
8787

8888
## Backend Hostname
8989

90-
This annotation allows us to specify the host name that Application Gateway should use while talking to the Pods.
90+
Use the following annotation to specify the host name that Application Gateway should use while talking to the pods.
9191

9292
### Usage
9393

@@ -320,7 +320,7 @@ spec:
320320
The following annotation allows you to specify whether to expose this endpoint on Private IP of Application Gateway.
321321

322322
> [!NOTE]
323-
> * 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.
323+
> 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.
324324

325325
### Usage
326326

@@ -390,7 +390,7 @@ spec:
390390
```
391391

392392
> [!NOTE]
393-
>External request will need to target http://somehost:8080 instead of http://somehost.
393+
> External request will need to target `http://somehost:8080` instead of `http://somehost`.
394394

395395
## Backend Protocol
396396

@@ -467,7 +467,7 @@ spec:
467467
```
468468

469469
> [!NOTE]
470-
> In the above example the listener would be configured to accept traffic for the hostnames "hostname1.contoso.com" and "hostname2.contoso.com"
470+
> In the preceding example, the listener would be configured to accept traffic for the hostnames "hostname1.contoso.com" and "hostname2.contoso.com"
471471

472472
## WAF Policy for Path
473473

@@ -521,7 +521,7 @@ The SSL certificate [can be configured to Application Gateway](/cli/azure/networ
521521
Please refer to appgw-ssl-certificate feature for more details.
522522

523523
> [!NOTE]
524-
> Annotation "appgw-ssl-certificate" will be ignored when TLS Spec is defined in ingress at the same time. If a user wants different certs with different hosts(multi tls certificate termination), they would need to define different ingress resources.
524+
> Annotation "appgw-ssl-certificate" will be ignored when TLS Spec is defined in ingress at the same time. If a user wants different certs with different hosts(multi tls certificate termination), they would need to define different ingress resources.
525525

526526
### Usage
527527

@@ -659,12 +659,12 @@ spec:
659659

660660
## Rewrite Rule Set Custom Resource
661661

662-
> [!Note]
662+
> [!NOTE]
663663
> [Application Gateway for Containers](https://aka.ms/agc) has been released, which introduces numerous performance, resilience, and feature changes. Please consider leveraging Application Gateway for Containers for your next deployment.
664664
> URL Rewrite rules for Application Gateway for Containers may be found [here for Gateway API](./for-containers/how-to-url-rewrite-gateway-api.md) and [here for Ingress API](for-containers/how-to-url-rewrite-ingress-api.md).
665665
> Header Rewrite rules for Application Gateway for Containers may be found [here for Gateway API](./for-containers/how-to-header-rewrite-gateway-api.md).
666666

667-
> [!Note]
667+
> [!NOTE]
668668
> This feature is supported since 1.6.0-rc1. Use [`appgw.ingress.kubernetes.io/rewrite-rule-set`](#rewrite-rule-set), which allows using an existing rewrite rule set on Application Gateway.
669669

670670
Application Gateway allows you to rewrite selected content of requests and responses. With this feature, you can translate URLs, query string parameters as well as modify request and response headers. It also allows you to add conditions to ensure that the URL or the specified headers are rewritten only when certain conditions are met. These conditions are based on the request and response information. Rewrite Rule Set Custom Resource brings this feature to AGIC.
@@ -744,4 +744,4 @@ spec:
744744
number: 8080
745745
```
746746

747-
In the above example the request routing rule would have a priority of 10 set.
747+
In the preceding example, the request routing rule would have a priority of 10 set.

0 commit comments

Comments
 (0)