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
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,13 +11,13 @@ ms.author: greglin
11
11
12
12
# Annotations for Application Gateway Ingress Controller
13
13
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.
15
15
16
16
## List of supported annotations
17
17
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`.
19
19
20
-
| Annotation Key| Value Type| Default Value| Allowed Values|
20
+
| Annotation key| Value type| Default value| Allowed values|
@@ -48,7 +48,7 @@ For an Ingress resource to be observed by AGIC, it **must be annotated** with `k
48
48
49
49
## Backend Path Prefix
50
50
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.
52
52
53
53
### Usage
54
54
@@ -80,14 +80,14 @@ spec:
80
80
number: 80
81
81
```
82
82
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/`.
84
84
85
85
> [!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.
87
87
88
88
## Backend Hostname
89
89
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.
91
91
92
92
### Usage
93
93
@@ -320,7 +320,7 @@ spec:
320
320
The following annotation allows you to specify whether to expose this endpoint on Private IP of Application Gateway.
321
321
322
322
> [!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.
324
324
325
325
### Usage
326
326
@@ -390,7 +390,7 @@ spec:
390
390
```
391
391
392
392
> [!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`.
394
394
395
395
## Backend Protocol
396
396
@@ -467,7 +467,7 @@ spec:
467
467
```
468
468
469
469
> [!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"
471
471
472
472
## WAF Policy for Path
473
473
@@ -521,7 +521,7 @@ The SSL certificate [can be configured to Application Gateway](/cli/azure/networ
521
521
Please refer to appgw-ssl-certificate feature for more details.
522
522
523
523
> [!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.
525
525
526
526
### Usage
527
527
@@ -659,12 +659,12 @@ spec:
659
659
660
660
## Rewrite Rule Set Custom Resource
661
661
662
-
> [!Note]
662
+
> [!NOTE]
663
663
> [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.
664
664
> 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).
665
665
> Header Rewrite rules for Application Gateway for Containers may be found [here for Gateway API](./for-containers/how-to-header-rewrite-gateway-api.md).
666
666
667
-
> [!Note]
667
+
> [!NOTE]
668
668
> 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.
669
669
670
670
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:
744
744
number: 8080
745
745
```
746
746
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