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
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ ms.author: greglin
11
11
12
12
# Annotations for Application Gateway Ingress Controller
13
13
14
-
You can annotate the Kubernetes ingress resource with arbitrary key/value pairs. Application Gateway Ingress Controller (AGIC) relies on annotations to program Azure Application Gateway features that aren't configurable via the ingress YAML. Ingress annotations are applied to all HTTP settings, back-end pools, and listeners derived from an ingress resource.
14
+
You can annotate the Kubernetes ingress resource with arbitrary key/value pairs. Application Gateway Ingress Controller (AGIC) relies on annotations to program Azure Application Gateway features that 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
@@ -48,7 +48,7 @@ For AGIC to observe an ingress resource, the resource *must be annotated* with `
48
48
49
49
## Backend Path Prefix
50
50
51
-
The following annotation allows the back-end path specified in an ingress resource to be rewritten with the specified prefix. Use it to expose services whose endpoints are different from the endpoint names that you use 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. Use it 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
@@ -82,11 +82,11 @@ spec:
82
82
83
83
The preceding example defines 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
-
The example defines only one rule. However, the annotations apply to the entire ingress resource. So if you define multiple rules, you set up the back-end 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.
85
+
The 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.
86
86
87
87
## Backend Hostname
88
88
89
-
Use the following annotation to specify the host name that Application Gateway should use while talking to the pods.
89
+
Use the following annotation to specify the hostname that Application Gateway should use while talking to the pods.
90
90
91
91
### Usage
92
92
@@ -120,15 +120,15 @@ spec:
120
120
121
121
## Custom Health Probe
122
122
123
-
You can [configure Application Gateway](./application-gateway-probe-overview.md) to send custom health probes to the backend address pool. When the following annotations are present, the Kubernetes ingress controller [creates a custom probe](./application-gateway-create-probe-portal.md) to monitor the back-end application. The controller then applies the changes to Application Gateway.
123
+
You can [configure Application Gateway](./application-gateway-probe-overview.md) to send custom health probes to the backend address pool. When the following annotations are present, the Kubernetes ingress controller [creates a custom probe](./application-gateway-create-probe-portal.md) to monitor the backend application. The controller then applies the changes to Application Gateway.
124
124
125
-
- `health-probe-hostname`: This annotation allows a custom host name on the health probe.
125
+
- `health-probe-hostname`: This annotation allows a custom hostname on the health probe.
126
126
- `health-probe-port`: This annotation configures a custom port for the health probe.
127
127
- `health-probe-path`: This annotation defines a path for the health probe.
128
128
- `health-probe-status-code`: This annotation allows the health probe to accept different HTTP status codes.
129
129
- `health-probe-interval`: This annotation defines the interval at which the health probe runs.
130
130
- `health-probe-timeout`: This annotation defines how long the health probe waits for a response before failing the probe.
131
-
- `health-probe-unhealthy-threshold`: This annotation defines how many health probes must fail for the back end to be marked as unhealthy.
131
+
- `health-probe-unhealthy-threshold`: This annotation defines how many health probes must fail for the backend to be marked as unhealthy.
132
132
133
133
### Usage
134
134
@@ -214,7 +214,7 @@ spec:
214
214
Use the following annotations if you want to use connection draining:
215
215
216
216
- `connection-draining`: This annotation specifies whether to enable connection draining.
217
-
- `connection-draining-timeout`: This annotation specifies a timeout, after which Application Gateway terminates the requests to the draining back-end endpoint.
217
+
- `connection-draining-timeout`: This annotation specifies a timeout, after which Application Gateway terminates the requests to the draining backend endpoint.
218
218
219
219
### Usage
220
220
@@ -354,7 +354,7 @@ spec:
354
354
355
355
## Override Frontend Port
356
356
357
-
Use the following annotation to configure a front-end listener to use ports other than 80 for HTTP and 443 for HTTPS.
357
+
Use the following annotation to configure a frontend listener to use ports other than 80 for HTTP and 443 for HTTPS.
358
358
359
359
If the port is within the Application Gateway authorized range (1 to 64999), the listener is created on this specific port. If you set an invalid port or no port in the annotation, the configuration uses the default of 80 or 443.
360
360
@@ -432,7 +432,7 @@ spec:
432
432
433
433
## Hostname Extension
434
434
435
-
You can configure Application Gateway to accept multiple host names. Use the `hostname-extension` annotation to define multiple host names, including wildcard host names. This action appends the host names onto the FQDN that's defined in the ingress `spec.rules.host` information on the front-end listener, so it's [configured as a multisite listener](./multiple-site-overview.md).
435
+
You can configure Application Gateway to accept multiple hostnames. Use the `hostname-extension` annotation to define multiple hostnames, including wildcard hostnames. This action appends the hostnames onto the FQDN that's defined in the ingress `spec.rules.host` information on the frontend listener, so it's [configured as a multisite listener](./multiple-site-overview.md).
436
436
437
437
### Usage
438
438
@@ -465,7 +465,7 @@ spec:
465
465
number: 443
466
466
```
467
467
468
-
The preceding example configures the listener to accept traffic for the host names `hostname1.contoso.com` and `hostname2.contoso.com`.
468
+
The preceding example configures the listener to accept traffic for the hostnames `hostname1.contoso.com` and `hostname2.contoso.com`.
469
469
470
470
## WAF Policy for Path
471
471
@@ -663,7 +663,7 @@ HTTP headers allow a client and server to pass additional information with a req
663
663
664
664
With the URL rewrite capability, you can:
665
665
666
-
- Rewrite the host name, path, and query string of the request URL.
666
+
- Rewrite the hostname, path, and query string of the request URL.
667
667
- Choose to rewrite the URL of all requests or only requests that match one or more of the conditions that you set. These conditions are based on the request and response properties (request header, response header, and server variables).
668
668
- Choose to route the request based on either the original URL or the rewritten URL.
0 commit comments